apidoc/api_data.json

   1 [
   2   {
   3     "type": "delete",
   4     "url": "/api/actions/{id}",
   5     "title": "Deletes a Action",
   6     "examples": [
   7       {
   8         "title": "Example usage:",
   9         "content": "curl https://{domain}/api/actions/{id} -v -u {name}:{password} -X DELETE",
  10         "type": "json"
  11       }
  12     ],
  13     "name": "DeleteActions",
  14     "group": "Actions",
  15     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
  16     "version": "0.0.0",
  17     "filename": "server/api/action/index.js",
  18     "groupTitle": "Actions"
  19   },
  20   {
  21     "type": "put",
  22     "url": "/api/actions/{id}",
  23     "title": "Update an existing Action",
  24     "examples": [
  25       {
  26         "title": "Example usage:",
  27         "content": "curl https://{domain}/api/actions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
  28         "type": "json"
  29       }
  30     ],
  31     "name": "updateActions",
  32     "group": "Actions",
  33     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
  34     "version": "0.0.0",
  35     "filename": "server/api/action/index.js",
  36     "groupTitle": "Actions"
  37   },
  38   {
  39     "type": "post",
  40     "url": "/api/analytics/custom_reports",
  41     "title": "Creates a new Analytic Custom Report",
  42     "examples": [
  43       {
  44         "title": "Example usage:",
  45         "content": "curl https://{domain}/api/analytics/custom_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
  46         "type": "json"
  47       }
  48     ],
  49     "name": "CreateAnalytic_Custom_Reports",
  50     "group": "Analytic_Custom_Reports",
  51     "parameter": {
  52       "fields": {
  53         "Body": [
  54           {
  55             "group": "Body",
  56             "type": "String",
  57             "optional": false,
  58             "field": "name",
  59             "description": ""
  60           },
  61           {
  62             "group": "Body",
  63             "type": "String",
  64             "optional": true,
  65             "field": "description",
  66             "description": ""
  67           },
  68           {
  69             "group": "Body",
  70             "type": "String",
  71             "optional": true,
  72             "field": "parent",
  73             "description": ""
  74           },
  75           {
  76             "group": "Body",
  77             "type": "String",
  78             "optional": true,
  79             "field": "table",
  80             "description": ""
  81           },
  82           {
  83             "group": "Body",
  84             "type": "Text",
  85             "optional": true,
  86             "field": "conditions",
  87             "description": ""
  88           },
  89           {
  90             "group": "Body",
  91             "type": "Text",
  92             "optional": true,
  93             "field": "joins",
  94             "description": ""
  95           }
  96         ]
  97       }
  98     },
  99     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 100     "version": "0.0.0",
 101     "filename": "server/api/analyticCustomReport/index.js",
 102     "groupTitle": "Analytic_Custom_Reports"
 103   },
 104   {
 105     "type": "delete",
 106     "url": "/api/analytics/custom_reports/{id}",
 107     "title": "Deletes a Analytic Custom Report",
 108     "examples": [
 109       {
 110         "title": "Example usage:",
 111         "content": "curl https://{domain}/api/analytics/custom_reports/{id} -v -u {name}:{password} -X DELETE",
 112         "type": "json"
 113       }
 114     ],
 115     "name": "DeleteAnalytic_Custom_Reports",
 116     "group": "Analytic_Custom_Reports",
 117     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 118     "version": "0.0.0",
 119     "filename": "server/api/analyticCustomReport/index.js",
 120     "groupTitle": "Analytic_Custom_Reports"
 121   },
 122   {
 123     "type": "get",
 124     "url": "/api/analytics/custom_reports",
 125     "title": "Gets a list of Analytic Custom Reports",
 126     "examples": [
 127       {
 128         "title": "Example usage:",
 129         "content": "curl https://{domain}/api/analytics/custom_reports -v -u {name}:{password}",
 130         "type": "json"
 131       }
 132     ],
 133     "name": "GetAnalytic_Custom_Reports",
 134     "group": "Analytic_Custom_Reports",
 135     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/custom_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/custom_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/custom_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/custom_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/custom_reports?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
 136     "version": "0.0.0",
 137     "filename": "server/api/analyticCustomReport/index.js",
 138     "groupTitle": "Analytic_Custom_Reports"
 139   },
 140   {
 141     "type": "get",
 142     "url": "/api/analytics/custom_reports/{id}",
 143     "title": "Gets a single Analytic Custom Report",
 144     "examples": [
 145       {
 146         "title": "Example usage:",
 147         "content": "curl https://{domain}/api/analytics/custom_reports/{id} -v -u {name}:{password}",
 148         "type": "json"
 149       }
 150     ],
 151     "name": "ShowAnalytic_Custom_Reports",
 152     "group": "Analytic_Custom_Reports",
 153     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 154     "version": "0.0.0",
 155     "filename": "server/api/analyticCustomReport/index.js",
 156     "groupTitle": "Analytic_Custom_Reports"
 157   },
 158   {
 159     "type": "get",
 160     "url": "/api/analytics/custom_reports/{id}/preview",
 161     "title": "Report Preview",
 162     "examples": [
 163       {
 164         "title": "Example usage:",
 165         "content": "curl https://{domain}/api/analytics/custom_reports/{id}/preview -v -u {name}:{password} -X GET",
 166         "type": "json"
 167       }
 168     ],
 169     "name": "preview",
 170     "group": "Analytic_Custom_Reports",
 171     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 172     "version": "0.0.0",
 173     "filename": "server/api/analyticCustomReport/index.js",
 174     "groupTitle": "Analytic_Custom_Reports"
 175   },
 176   {
 177     "type": "get",
 178     "url": "/api/analytics/custom_reports/{id}/query",
 179     "title": "Report Query SQL",
 180     "examples": [
 181       {
 182         "title": "Example usage:",
 183         "content": "curl https://{domain}/api/analytics/custom_reports/{id}/query -v -u {name}:{password} -X GET",
 184         "type": "json"
 185       }
 186     ],
 187     "name": "query",
 188     "group": "Analytic_Custom_Reports",
 189     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 190     "version": "0.0.0",
 191     "filename": "server/api/analyticCustomReport/index.js",
 192     "groupTitle": "Analytic_Custom_Reports"
 193   },
 194   {
 195     "type": "get",
 196     "url": "/api/analytics/custom_reports/{id}/run",
 197     "title": "Report Run",
 198     "examples": [
 199       {
 200         "title": "Example usage:",
 201         "content": "curl https://{domain}/api/analytics/custom_reports/{id}/run -v -u {name}:{password} -X GET",
 202         "type": "json"
 203       }
 204     ],
 205     "name": "run",
 206     "group": "Analytic_Custom_Reports",
 207     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 208     "version": "0.0.0",
 209     "filename": "server/api/analyticCustomReport/index.js",
 210     "groupTitle": "Analytic_Custom_Reports"
 211   },
 212   {
 213     "type": "put",
 214     "url": "/api/analytics/custom_reports/{id}",
 215     "title": "Update an existing Analytic Custom Report",
 216     "examples": [
 217       {
 218         "title": "Example usage:",
 219         "content": "curl https://{domain}/api/analytics/custom_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
 220         "type": "json"
 221       }
 222     ],
 223     "name": "updateAnalytic_Custom_Reports",
 224     "group": "Analytic_Custom_Reports",
 225     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 226     "version": "0.0.0",
 227     "filename": "server/api/analyticCustomReport/index.js",
 228     "groupTitle": "Analytic_Custom_Reports"
 229   },
 230   {
 231     "type": "post",
 232     "url": "/api/analytics/default_reports",
 233     "title": "Creates a new Analytic Default Report",
 234     "examples": [
 235       {
 236         "title": "Example usage:",
 237         "content": "curl https://{domain}/api/analytics/default_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
 238         "type": "json"
 239       }
 240     ],
 241     "name": "CreateAnalytic_Default_Reports",
 242     "group": "Analytic_Default_Reports",
 243     "parameter": {
 244       "fields": {
 245         "Body": [
 246           {
 247             "group": "Body",
 248             "type": "String",
 249             "optional": false,
 250             "field": "name",
 251             "description": ""
 252           },
 253           {
 254             "group": "Body",
 255             "type": "String",
 256             "optional": true,
 257             "field": "description",
 258             "description": ""
 259           },
 260           {
 261             "group": "Body",
 262             "type": "String",
 263             "optional": true,
 264             "field": "parent",
 265             "description": ""
 266           },
 267           {
 268             "group": "Body",
 269             "type": "String",
 270             "optional": true,
 271             "field": "table",
 272             "description": ""
 273           },
 274           {
 275             "group": "Body",
 276             "type": "Text",
 277             "optional": true,
 278             "field": "conditions",
 279             "description": ""
 280           },
 281           {
 282             "group": "Body",
 283             "type": "Text",
 284             "optional": true,
 285             "field": "joins",
 286             "description": ""
 287           }
 288         ]
 289       }
 290     },
 291     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 292     "version": "0.0.0",
 293     "filename": "server/api/analyticDefaultReport/index.js",
 294     "groupTitle": "Analytic_Default_Reports"
 295   },
 296   {
 297     "type": "delete",
 298     "url": "/api/analytics/default_reports/{id}",
 299     "title": "Deletes a Analytic Default Report",
 300     "examples": [
 301       {
 302         "title": "Example usage:",
 303         "content": "curl https://{domain}/api/analytics/default_reports/{id} -v -u {name}:{password} -X DELETE",
 304         "type": "json"
 305       }
 306     ],
 307     "name": "DeleteAnalytic_Default_Reports",
 308     "group": "Analytic_Default_Reports",
 309     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 310     "version": "0.0.0",
 311     "filename": "server/api/analyticDefaultReport/index.js",
 312     "groupTitle": "Analytic_Default_Reports"
 313   },
 314   {
 315     "type": "get",
 316     "url": "/api/analytics/default_reports",
 317     "title": "Gets a list of Analytic Default Reports",
 318     "examples": [
 319       {
 320         "title": "Example usage:",
 321         "content": "curl https://{domain}/api/analytics/default_reports -v -u {name}:{password}",
 322         "type": "json"
 323       }
 324     ],
 325     "name": "GetAnalytic_Default_Reports",
 326     "group": "Analytic_Default_Reports",
 327     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/default_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/default_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/default_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/default_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/default_reports?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
 328     "version": "0.0.0",
 329     "filename": "server/api/analyticDefaultReport/index.js",
 330     "groupTitle": "Analytic_Default_Reports"
 331   },
 332   {
 333     "type": "get",
 334     "url": "/api/analytics/default_reports/{id}",
 335     "title": "Gets a single Analytic Default Report",
 336     "examples": [
 337       {
 338         "title": "Example usage:",
 339         "content": "curl https://{domain}/api/analytics/default_reports/{id} -v -u {name}:{password}",
 340         "type": "json"
 341       }
 342     ],
 343     "name": "ShowAnalytic_Default_Reports",
 344     "group": "Analytic_Default_Reports",
 345     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 346     "version": "0.0.0",
 347     "filename": "server/api/analyticDefaultReport/index.js",
 348     "groupTitle": "Analytic_Default_Reports"
 349   },
 350   {
 351     "type": "get",
 352     "url": "/api/analytics/default_reports/{id}/preview",
 353     "title": "Report Preview",
 354     "examples": [
 355       {
 356         "title": "Example usage:",
 357         "content": "curl https://{domain}/api/analytics/default_reports/{id}/preview -v -u {name}:{password} -X GET",
 358         "type": "json"
 359       }
 360     ],
 361     "name": "preview",
 362     "group": "Analytic_Default_Reports",
 363     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 364     "version": "0.0.0",
 365     "filename": "server/api/analyticDefaultReport/index.js",
 366     "groupTitle": "Analytic_Default_Reports"
 367   },
 368   {
 369     "type": "get",
 370     "url": "/api/analytics/default_reports/{id}/query",
 371     "title": "Report Query SQL",
 372     "examples": [
 373       {
 374         "title": "Example usage:",
 375         "content": "curl https://{domain}/api/analytics/default_reports/{id}/query -v -u {name}:{password} -X GET",
 376         "type": "json"
 377       }
 378     ],
 379     "name": "query",
 380     "group": "Analytic_Default_Reports",
 381     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 382     "version": "0.0.0",
 383     "filename": "server/api/analyticDefaultReport/index.js",
 384     "groupTitle": "Analytic_Default_Reports"
 385   },
 386   {
 387     "type": "get",
 388     "url": "/api/analytics/default_reports/{id}/run",
 389     "title": "Report Run",
 390     "examples": [
 391       {
 392         "title": "Example usage:",
 393         "content": "curl https://{domain}/api/analytics/default_reports/{id}/run -v -u {name}:{password} -X GET",
 394         "type": "json"
 395       }
 396     ],
 397     "name": "run",
 398     "group": "Analytic_Default_Reports",
 399     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 400     "version": "0.0.0",
 401     "filename": "server/api/analyticDefaultReport/index.js",
 402     "groupTitle": "Analytic_Default_Reports"
 403   },
 404   {
 405     "type": "put",
 406     "url": "/api/analytics/default_reports/{id}",
 407     "title": "Update an existing Analytic Default Report",
 408     "examples": [
 409       {
 410         "title": "Example usage:",
 411         "content": "curl https://{domain}/api/analytics/default_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
 412         "type": "json"
 413       }
 414     ],
 415     "name": "updateAnalytic_Default_Reports",
 416     "group": "Analytic_Default_Reports",
 417     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 418     "version": "0.0.0",
 419     "filename": "server/api/analyticDefaultReport/index.js",
 420     "groupTitle": "Analytic_Default_Reports"
 421   },
 422   {
 423     "type": "post",
 424     "url": "/api/analytics/extracted_reports",
 425     "title": "Creates a new Analytic Extracted Report",
 426     "examples": [
 427       {
 428         "title": "Example usage:",
 429         "content": "curl https://{domain}/api/analytics/extracted_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
 430         "type": "json"
 431       }
 432     ],
 433     "name": "CreateAnalytic_Extacted_Reports",
 434     "group": "Analytic_Extracted_Reports",
 435     "parameter": {
 436       "fields": {
 437         "Body": [
 438           {
 439             "group": "Body",
 440             "type": "String",
 441             "optional": false,
 442             "field": "name",
 443             "description": ""
 444           },
 445           {
 446             "group": "Body",
 447             "type": "String",
 448             "optional": false,
 449             "field": "basename",
 450             "description": ""
 451           },
 452           {
 453             "group": "Body",
 454             "type": "String",
 455             "allowedValues": [
 456               "\"csv\"",
 457               "\"pdf\"",
 458               "\"xlsx\""
 459             ],
 460             "optional": false,
 461             "field": "output",
 462             "description": ""
 463           },
 464           {
 465             "group": "Body",
 466             "type": "String",
 467             "optional": false,
 468             "field": "savename",
 469             "description": ""
 470           },
 471           {
 472             "group": "Body",
 473             "type": "String",
 474             "optional": true,
 475             "field": "startDate",
 476             "description": ""
 477           },
 478           {
 479             "group": "Body",
 480             "type": "String",
 481             "optional": true,
 482             "field": "endDate",
 483             "description": ""
 484           },
 485           {
 486             "group": "Body",
 487             "type": "String",
 488             "optional": true,
 489             "field": "status",
 490             "description": ""
 491           },
 492           {
 493             "group": "Body",
 494             "type": "String",
 495             "allowedValues": [
 496               "\"manual\"",
 497               "\"scheduled\""
 498             ],
 499             "optional": false,
 500             "field": "type",
 501             "description": ""
 502           },
 503           {
 504             "group": "Body",
 505             "type": "Integer",
 506             "optional": true,
 507             "field": "reportId",
 508             "description": ""
 509           },
 510           {
 511             "group": "Body",
 512             "type": "String",
 513             "optional": true,
 514             "field": "reportType",
 515             "description": ""
 516           }
 517         ]
 518       }
 519     },
 520     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 521     "version": "0.0.0",
 522     "filename": "server/api/analyticExtractedReport/index.js",
 523     "groupTitle": "Analytic_Extracted_Reports"
 524   },
 525   {
 526     "type": "delete",
 527     "url": "/api/analytics/extracted_reports/{id}",
 528     "title": "Deletes a Analytic Extracted Report",
 529     "examples": [
 530       {
 531         "title": "Example usage:",
 532         "content": "curl https://{domain}/api/analytics/extracted_reports/{id} -v -u {name}:{password} -X DELETE",
 533         "type": "json"
 534       }
 535     ],
 536     "name": "DeleteAnalytic_Extacted_Reports",
 537     "group": "Analytic_Extracted_Reports",
 538     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 539     "version": "0.0.0",
 540     "filename": "server/api/analyticExtractedReport/index.js",
 541     "groupTitle": "Analytic_Extracted_Reports"
 542   },
 543   {
 544     "type": "get",
 545     "url": "/api/analytics/extracted_reports",
 546     "title": "Gets a list of Analytic Extacted Reports",
 547     "examples": [
 548       {
 549         "title": "Example usage:",
 550         "content": "curl https://{domain}/api/analytics/extracted_reports -v -u {name}:{password}",
 551         "type": "json"
 552       }
 553     ],
 554     "name": "GetAnalytic_Extacted_Reports",
 555     "group": "Analytic_Extracted_Reports",
 556     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/extracted_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/extracted_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/extracted_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/extracted_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/extracted_reports?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
 557     "version": "0.0.0",
 558     "filename": "server/api/analyticExtractedReport/index.js",
 559     "groupTitle": "Analytic_Extracted_Reports"
 560   },
 561   {
 562     "type": "get",
 563     "url": "/api/analytics/extracted_reports/{id}",
 564     "title": "Gets a single Analytic Extracted Report",
 565     "examples": [
 566       {
 567         "title": "Example usage:",
 568         "content": "curl https://{domain}/api/analytics/extracted_reports/{id} -v -u {name}:{password}",
 569         "type": "json"
 570       }
 571     ],
 572     "name": "ShowAnalytic_Extacted_Reports",
 573     "group": "Analytic_Extracted_Reports",
 574     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 575     "version": "0.0.0",
 576     "filename": "server/api/analyticExtractedReport/index.js",
 577     "groupTitle": "Analytic_Extracted_Reports"
 578   },
 579   {
 580     "type": "get",
 581     "url": "/api/analytics/extracted_reports/{id}/download",
 582     "title": "Download Extracted Report",
 583     "examples": [
 584       {
 585         "title": "Example usage:",
 586         "content": "curl https://{domain}/api/analytics/extracted_reports/{id}/download -v -u {name}:{password} -X GET",
 587         "type": "json"
 588       }
 589     ],
 590     "name": "download",
 591     "group": "Analytic_Extracted_Reports",
 592     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 593     "version": "0.0.0",
 594     "filename": "server/api/analyticExtractedReport/index.js",
 595     "groupTitle": "Analytic_Extracted_Reports"
 596   },
 597   {
 598     "type": "put",
 599     "url": "/api/analytics/extracted_reports/{id}",
 600     "title": "Update an existing Analytic Extracted Report",
 601     "examples": [
 602       {
 603         "title": "Example usage:",
 604         "content": "curl https://{domain}/api/analytics/extracted_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
 605         "type": "json"
 606       }
 607     ],
 608     "name": "updateAnalytic_Extacted_Reports",
 609     "group": "Analytic_Extracted_Reports",
 610     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 611     "version": "0.0.0",
 612     "filename": "server/api/analyticExtractedReport/index.js",
 613     "groupTitle": "Analytic_Extracted_Reports"
 614   },
 615   {
 616     "type": "post",
 617     "url": "/api/analytics/field_reports/create_many",
 618     "title": "Creates many Analytic Field Reports",
 619     "examples": [
 620       {
 621         "title": "Example usage:",
 622         "content": "curl https://{domain}/api/analytics/field_reports/create_many -d '[{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}]' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
 623         "type": "json"
 624       }
 625     ],
 626     "name": "BulkCreateAnalytic_Field_Reports",
 627     "group": "Analytic_Field_Reports",
 628     "parameter": {
 629       "fields": {
 630         "Body": [
 631           {
 632             "group": "Body",
 633             "type": "Text",
 634             "optional": true,
 635             "field": "field",
 636             "description": ""
 637           },
 638           {
 639             "group": "Body",
 640             "type": "String",
 641             "optional": true,
 642             "field": "alias",
 643             "description": ""
 644           },
 645           {
 646             "group": "Body",
 647             "type": "String",
 648             "optional": true,
 649             "field": "function",
 650             "description": ""
 651           },
 652           {
 653             "group": "Body",
 654             "type": "String",
 655             "optional": true,
 656             "field": "format",
 657             "description": ""
 658           },
 659           {
 660             "group": "Body",
 661             "type": "Boolean",
 662             "optional": true,
 663             "field": "groupBy",
 664             "description": ""
 665           },
 666           {
 667             "group": "Body",
 668             "type": "String",
 669             "optional": true,
 670             "field": "orderBy",
 671             "description": ""
 672           },
 673           {
 674             "group": "Body",
 675             "type": "Boolean",
 676             "optional": true,
 677             "field": "custom",
 678             "description": ""
 679           }
 680         ]
 681       }
 682     },
 683     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 684     "version": "0.0.0",
 685     "filename": "server/api/analyticFieldReport/index.js",
 686     "groupTitle": "Analytic_Field_Reports"
 687   },
 688   {
 689     "type": "delete",
 690     "url": "/api/analytics/field_reports/destroy_many?ids={ids}",
 691     "title": "Deletes many Analytic Field Reports",
 692     "examples": [
 693       {
 694         "title": "Example usage:",
 695         "content": "curl https://{domain}/api/analytics/field_reports/destroy_many?ids=1&ids=2&ids=3 -v -u {name}:{password} -X DELETE",
 696         "type": "json"
 697       }
 698     ],
 699     "name": "BulkDeleteAnalytic_Field_Reports",
 700     "group": "Analytic_Field_Reports",
 701     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 702     "version": "0.0.0",
 703     "filename": "server/api/analyticFieldReport/index.js",
 704     "groupTitle": "Analytic_Field_Reports"
 705   },
 706   {
 707     "type": "post",
 708     "url": "/api/analytics/field_reports",
 709     "title": "Creates a new Analytic Field Report",
 710     "examples": [
 711       {
 712         "title": "Example usage:",
 713         "content": "curl https://{domain}/api/analytics/field_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
 714         "type": "json"
 715       }
 716     ],
 717     "name": "CreateAnalytic_Field_Reports",
 718     "group": "Analytic_Field_Reports",
 719     "parameter": {
 720       "fields": {
 721         "Body": [
 722           {
 723             "group": "Body",
 724             "type": "Text",
 725             "optional": true,
 726             "field": "field",
 727             "description": ""
 728           },
 729           {
 730             "group": "Body",
 731             "type": "String",
 732             "optional": true,
 733             "field": "alias",
 734             "description": ""
 735           },
 736           {
 737             "group": "Body",
 738             "type": "String",
 739             "optional": true,
 740             "field": "function",
 741             "description": ""
 742           },
 743           {
 744             "group": "Body",
 745             "type": "String",
 746             "optional": true,
 747             "field": "format",
 748             "description": ""
 749           },
 750           {
 751             "group": "Body",
 752             "type": "Boolean",
 753             "optional": true,
 754             "field": "groupBy",
 755             "description": ""
 756           },
 757           {
 758             "group": "Body",
 759             "type": "String",
 760             "optional": true,
 761             "field": "orderBy",
 762             "description": ""
 763           },
 764           {
 765             "group": "Body",
 766             "type": "Boolean",
 767             "optional": true,
 768             "field": "custom",
 769             "description": ""
 770           }
 771         ]
 772       }
 773     },
 774     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 775     "version": "0.0.0",
 776     "filename": "server/api/analyticFieldReport/index.js",
 777     "groupTitle": "Analytic_Field_Reports"
 778   },
 779   {
 780     "type": "delete",
 781     "url": "/api/analytics/field_reports/{id}",
 782     "title": "Deletes a Analytic Field Report",
 783     "examples": [
 784       {
 785         "title": "Example usage:",
 786         "content": "curl https://{domain}/api/analytics/field_reports/{id} -v -u {name}:{password} -X DELETE",
 787         "type": "json"
 788       }
 789     ],
 790     "name": "DeleteAnalytic_Field_Reports",
 791     "group": "Analytic_Field_Reports",
 792     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 793     "version": "0.0.0",
 794     "filename": "server/api/analyticFieldReport/index.js",
 795     "groupTitle": "Analytic_Field_Reports"
 796   },
 797   {
 798     "type": "get",
 799     "url": "/api/analytics/field_reports",
 800     "title": "Gets a list of Analytic Field Reports",
 801     "examples": [
 802       {
 803         "title": "Example usage:",
 804         "content": "curl https://{domain}/api/analytics/field_reports -v -u {name}:{password}",
 805         "type": "json"
 806       }
 807     ],
 808     "name": "GetAnalytic_Field_Reports",
 809     "group": "Analytic_Field_Reports",
 810     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/field_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/field_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/field_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/field_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/field_reports?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
 811     "version": "0.0.0",
 812     "filename": "server/api/analyticFieldReport/index.js",
 813     "groupTitle": "Analytic_Field_Reports"
 814   },
 815   {
 816     "type": "get",
 817     "url": "/api/analytics/field_reports/{id}",
 818     "title": "Gets a single Analytic Field Report",
 819     "examples": [
 820       {
 821         "title": "Example usage:",
 822         "content": "curl https://{domain}/api/analytics/field_reports/{id} -v -u {name}:{password}",
 823         "type": "json"
 824       }
 825     ],
 826     "name": "ShowAnalytic_Field_Reports",
 827     "group": "Analytic_Field_Reports",
 828     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 829     "version": "0.0.0",
 830     "filename": "server/api/analyticFieldReport/index.js",
 831     "groupTitle": "Analytic_Field_Reports"
 832   },
 833   {
 834     "type": "post",
 835     "url": "/api/analytics/field_reports/{id}/create_many",
 836     "title": "Rewrite fields set",
 837     "examples": [
 838       {
 839         "title": "Example usage:",
 840         "content": "curl https://{domain}/api/analytics/field_reports/{id}/create_many -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
 841         "type": "json"
 842       }
 843     ],
 844     "name": "addFields",
 845     "group": "Analytic_Field_Reports",
 846     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 847     "version": "0.0.0",
 848     "filename": "server/api/analyticFieldReport/index.js",
 849     "groupTitle": "Analytic_Field_Reports"
 850   },
 851   {
 852     "type": "put",
 853     "url": "/api/analytics/field_reports/{id}",
 854     "title": "Update an existing Analytic Field Report",
 855     "examples": [
 856       {
 857         "title": "Example usage:",
 858         "content": "curl https://{domain}/api/analytics/field_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
 859         "type": "json"
 860       }
 861     ],
 862     "name": "updateAnalytic_Field_Reports",
 863     "group": "Analytic_Field_Reports",
 864     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 865     "version": "0.0.0",
 866     "filename": "server/api/analyticFieldReport/index.js",
 867     "groupTitle": "Analytic_Field_Reports"
 868   },
 869   {
 870     "type": "post",
 871     "url": "/api/analytics/metrics",
 872     "title": "Creates a new Analytic Metrics",
 873     "examples": [
 874       {
 875         "title": "Example usage:",
 876         "content": "curl https://{domain}/api/analytics/metrics -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
 877         "type": "json"
 878       }
 879     ],
 880     "name": "CreateAnalytic_Metric",
 881     "group": "Analytic_Metrics",
 882     "parameter": {
 883       "fields": {
 884         "Body": [
 885           {
 886             "group": "Body",
 887             "type": "String",
 888             "optional": false,
 889             "field": "name",
 890             "description": ""
 891           },
 892           {
 893             "group": "Body",
 894             "type": "String",
 895             "optional": true,
 896             "field": "table",
 897             "description": ""
 898           },
 899           {
 900             "group": "Body",
 901             "type": "Text",
 902             "optional": true,
 903             "field": "metric",
 904             "description": ""
 905           },
 906           {
 907             "group": "Body",
 908             "type": "String",
 909             "optional": true,
 910             "field": "description",
 911             "description": ""
 912           }
 913         ]
 914       }
 915     },
 916     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 917     "version": "0.0.0",
 918     "filename": "server/api/analyticMetric/index.js",
 919     "groupTitle": "Analytic_Metrics"
 920   },
 921   {
 922     "type": "delete",
 923     "url": "/api/analytics/metrics/{id}",
 924     "title": "Deletes a Analytic Metrics",
 925     "examples": [
 926       {
 927         "title": "Example usage:",
 928         "content": "curl https://{domain}/api/analytics/metrics/{id} -v -u {name}:{password} -X DELETE",
 929         "type": "json"
 930       }
 931     ],
 932     "name": "DeleteAnalytic_Metric",
 933     "group": "Analytic_Metrics",
 934     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 935     "version": "0.0.0",
 936     "filename": "server/api/analyticMetric/index.js",
 937     "groupTitle": "Analytic_Metrics"
 938   },
 939   {
 940     "type": "get",
 941     "url": "/api/analytics/metrics",
 942     "title": "Gets a list of Analytic Metric",
 943     "examples": [
 944       {
 945         "title": "Example usage:",
 946         "content": "curl https://{domain}/api/analytics/metrics -v -u {name}:{password}",
 947         "type": "json"
 948       }
 949     ],
 950     "name": "GetAnalytic_Metric",
 951     "group": "Analytic_Metrics",
 952     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/metrics?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/metrics?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/metrics?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/metrics?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/metrics?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
 953     "version": "0.0.0",
 954     "filename": "server/api/analyticMetric/index.js",
 955     "groupTitle": "Analytic_Metrics"
 956   },
 957   {
 958     "type": "get",
 959     "url": "/api/analytics/metrics/{id}",
 960     "title": "Gets a single Analytic Metrics",
 961     "examples": [
 962       {
 963         "title": "Example usage:",
 964         "content": "curl https://{domain}/api/analytics/metrics/{id} -v -u {name}:{password}",
 965         "type": "json"
 966       }
 967     ],
 968     "name": "ShowAnalytic_Metric",
 969     "group": "Analytic_Metrics",
 970     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 971     "version": "0.0.0",
 972     "filename": "server/api/analyticMetric/index.js",
 973     "groupTitle": "Analytic_Metrics"
 974   },
 975   {
 976     "type": "put",
 977     "url": "/api/analytics/metrics/{id}",
 978     "title": "Update an existing Analytic Metrics",
 979     "examples": [
 980       {
 981         "title": "Example usage:",
 982         "content": "curl https://{domain}/api/analytics/metrics/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
 983         "type": "json"
 984       }
 985     ],
 986     "name": "updateAnalytic_Metric",
 987     "group": "Analytic_Metrics",
 988     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 989     "version": "0.0.0",
 990     "filename": "server/api/analyticMetric/index.js",
 991     "groupTitle": "Analytic_Metrics"
 992   },
 993   {
 994     "type": "post",
 995     "url": "/api/analytics/tree_reports",
 996     "title": "Creates a new Analytic Tree Report",
 997     "examples": [
 998       {
 999         "title": "Example usage:",
1000         "content": "curl https://{domain}/api/analytics/tree_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1001         "type": "json"
1002       }
1003     ],
1004     "name": "CreateAnalytic_Tree_Reports",
1005     "group": "Analytic_Tree_Reports",
1006     "parameter": {
1007       "fields": {
1008         "Body": [
1009           {
1010             "group": "Body",
1011             "type": "Text",
1012             "optional": false,
1013             "field": "tree",
1014             "description": ""
1015           }
1016         ]
1017       }
1018     },
1019     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1020     "version": "0.0.0",
1021     "filename": "server/api/analyticTreeReport/index.js",
1022     "groupTitle": "Analytic_Tree_Reports"
1023   },
1024   {
1025     "type": "delete",
1026     "url": "/api/analytics/tree_reports/{id}",
1027     "title": "Deletes a Analytic Tree Report",
1028     "examples": [
1029       {
1030         "title": "Example usage:",
1031         "content": "curl https://{domain}/api/analytics/tree_reports/{id} -v -u {name}:{password} -X DELETE",
1032         "type": "json"
1033       }
1034     ],
1035     "name": "DeleteAnalytic_Tree_Reports",
1036     "group": "Analytic_Tree_Reports",
1037     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1038     "version": "0.0.0",
1039     "filename": "server/api/analyticTreeReport/index.js",
1040     "groupTitle": "Analytic_Tree_Reports"
1041   },
1042   {
1043     "type": "get",
1044     "url": "/api/analytics/tree_reports",
1045     "title": "Gets a list of Analytic Tree Reports",
1046     "examples": [
1047       {
1048         "title": "Example usage:",
1049         "content": "curl https://{domain}/api/analytics/tree_reports -v -u {name}:{password}",
1050         "type": "json"
1051       }
1052     ],
1053     "name": "GetAnalytic_Tree_Reports",
1054     "group": "Analytic_Tree_Reports",
1055     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/tree_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/tree_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/tree_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/tree_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/tree_reports?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1056     "version": "0.0.0",
1057     "filename": "server/api/analyticTreeReport/index.js",
1058     "groupTitle": "Analytic_Tree_Reports"
1059   },
1060   {
1061     "type": "get",
1062     "url": "/api/analytics/tree_reports/{id}",
1063     "title": "Gets a single Analytic Tree Report",
1064     "examples": [
1065       {
1066         "title": "Example usage:",
1067         "content": "curl https://{domain}/api/analytics/tree_reports/{id} -v -u {name}:{password}",
1068         "type": "json"
1069       }
1070     ],
1071     "name": "ShowAnalytic_Tree_Reports",
1072     "group": "Analytic_Tree_Reports",
1073     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1074     "version": "0.0.0",
1075     "filename": "server/api/analyticTreeReport/index.js",
1076     "groupTitle": "Analytic_Tree_Reports"
1077   },
1078   {
1079     "type": "put",
1080     "url": "/api/analytics/tree_reports/{id}",
1081     "title": "Update an existing Analytic Tree Report",
1082     "examples": [
1083       {
1084         "title": "Example usage:",
1085         "content": "curl https://{domain}/api/analytics/tree_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1086         "type": "json"
1087       }
1088     ],
1089     "name": "updateAnalytic_Tree_Reports",
1090     "group": "Analytic_Tree_Reports",
1091     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1092     "version": "0.0.0",
1093     "filename": "server/api/analyticTreeReport/index.js",
1094     "groupTitle": "Analytic_Tree_Reports"
1095   },
1096   {
1097     "type": "post",
1098     "url": "/api/attachments/clone",
1099     "title": "Clone an existing Attachment",
1100     "examples": [
1101       {
1102         "title": "Example usage:",
1103         "content": "curl https://{domain}/api/attachments/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1104         "type": "json"
1105       }
1106     ],
1107     "name": "CloneAttachments",
1108     "group": "Attachments",
1109     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1110     "version": "0.0.0",
1111     "filename": "server/api/attachment/index.js",
1112     "groupTitle": "Attachments"
1113   },
1114   {
1115     "type": "delete",
1116     "url": "/api/attachments/{id}",
1117     "title": "Deletes a Attachment",
1118     "examples": [
1119       {
1120         "title": "Example usage:",
1121         "content": "curl https://{domain}/api/attachments/{id} -v -u {name}:{password} -X DELETE",
1122         "type": "json"
1123       }
1124     ],
1125     "name": "DeleteAttachments",
1126     "group": "Attachments",
1127     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1128     "version": "0.0.0",
1129     "filename": "server/api/attachment/index.js",
1130     "groupTitle": "Attachments"
1131   },
1132   {
1133     "type": "get",
1134     "url": "/api/attachments",
1135     "title": "Gets a list of Attachments",
1136     "examples": [
1137       {
1138         "title": "Example usage:",
1139         "content": "curl https://{domain}/api/attachments -v -u {name}:{password}",
1140         "type": "json"
1141       }
1142     ],
1143     "name": "GetAttachments",
1144     "group": "Attachments",
1145     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/attachments?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/attachments?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/attachments?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/attachments?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/attachments?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1146     "version": "0.0.0",
1147     "filename": "server/api/attachment/index.js",
1148     "groupTitle": "Attachments"
1149   },
1150   {
1151     "type": "get",
1152     "url": "/api/attachments/{id}",
1153     "title": "Gets a single Attachment",
1154     "examples": [
1155       {
1156         "title": "Example usage:",
1157         "content": "curl https://{domain}/api/attachments/{id} -v -u {name}:{password}",
1158         "type": "json"
1159       }
1160     ],
1161     "name": "ShowAttachments",
1162     "group": "Attachments",
1163     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1164     "version": "0.0.0",
1165     "filename": "server/api/attachment/index.js",
1166     "groupTitle": "Attachments"
1167   },
1168   {
1169     "type": "post",
1170     "url": "/api/attachments",
1171     "title": "Add attachment",
1172     "examples": [
1173       {
1174         "title": "Example usage:",
1175         "content": "curl https://{domain}/api/attachments -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
1176         "type": "json"
1177       }
1178     ],
1179     "name": "create",
1180     "group": "Attachments",
1181     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1182     "version": "0.0.0",
1183     "filename": "server/api/attachment/index.js",
1184     "groupTitle": "Attachments"
1185   },
1186   {
1187     "type": "get",
1188     "url": "/api/attachments/:id/download",
1189     "title": "Download attachment",
1190     "examples": [
1191       {
1192         "title": "Example usage:",
1193         "content": "curl https://{domain}/api/attachments/:id/download -v -u {name}:{password} -X GET",
1194         "type": "json"
1195       }
1196     ],
1197     "name": "download",
1198     "group": "Attachments",
1199     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1200     "version": "0.0.0",
1201     "filename": "server/api/attachment/index.js",
1202     "groupTitle": "Attachments"
1203   },
1204   {
1205     "type": "get",
1206     "url": "/api/chat/interactions/{id}/attachment_download",
1207     "title": "Download attachment",
1208     "examples": [
1209       {
1210         "title": "Example usage:",
1211         "content": "curl https://{domain}/api/chat/interactions/{id}/attachment_download -v -u {name}:{password} -X GET",
1212         "type": "json"
1213       }
1214     ],
1215     "name": "show",
1216     "group": "Attachments",
1217     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1218     "version": "0.0.0",
1219     "filename": "server/api/chatInteraction/index.js",
1220     "groupTitle": "Attachments"
1221   },
1222   {
1223     "type": "put",
1224     "url": "/api/attachments/{id}",
1225     "title": "Update an existing Attachment",
1226     "examples": [
1227       {
1228         "title": "Example usage:",
1229         "content": "curl https://{domain}/api/attachments/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1230         "type": "json"
1231       }
1232     ],
1233     "name": "updateAttachments",
1234     "group": "Attachments",
1235     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1236     "version": "0.0.0",
1237     "filename": "server/api/attachment/index.js",
1238     "groupTitle": "Attachments"
1239   },
1240   {
1241     "type": "post",
1242     "url": "/api/auth/local/forgot",
1243     "title": "Creates a new password reset token",
1244     "examples": [
1245       {
1246         "title": "Example usage:",
1247         "content": "curl https://{domain}/api/auth/local/forgot -d '{\"email\": \"john.doe@xcally.com\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1248         "type": "json"
1249       }
1250     ],
1251     "name": "Local_Forgot_Password",
1252     "group": "Authentication",
1253     "parameter": {
1254       "fields": {
1255         "Body": [
1256           {
1257             "group": "Body",
1258             "type": "String",
1259             "optional": false,
1260             "field": "email",
1261             "description": ""
1262           }
1263         ]
1264       }
1265     },
1266     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1267     "version": "0.0.0",
1268     "filename": "server/api/authLocal/index.js",
1269     "groupTitle": "Authentication"
1270   },
1271   {
1272     "type": "post",
1273     "url": "/api/auth/local/reset/:token",
1274     "title": "Reset user password",
1275     "examples": [
1276       {
1277         "title": "Example usage:",
1278         "content": "curl https://{domain}/api/auth/local/reset/94b422c1fkdjhg766a198da6997yu6gcc963641d -d '{\"password\": \"My_newP@ssw0rd\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1279         "type": "json"
1280       }
1281     ],
1282     "name": "Local_Reset_Password",
1283     "group": "Authentication",
1284     "parameter": {
1285       "fields": {
1286         "Body": [
1287           {
1288             "group": "Body",
1289             "type": "String",
1290             "optional": false,
1291             "field": "password",
1292             "description": ""
1293           }
1294         ]
1295       }
1296     },
1297     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1298     "version": "0.0.0",
1299     "filename": "server/api/authLocal/index.js",
1300     "groupTitle": "Authentication"
1301   },
1302   {
1303     "type": "post",
1304     "url": "/api/auth/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": "secondDisposition",
2188             "description": ""
2189           },
2190           {
2191             "group": "Body",
2192             "type": "String",
2193             "optional": true,
2194             "field": "thirdDisposition",
2195             "description": ""
2196           },
2197           {
2198             "group": "Body",
2199             "type": "String",
2200             "optional": true,
2201             "field": "note",
2202             "description": ""
2203           },
2204           {
2205             "group": "Body",
2206             "type": "String",
2207             "optional": true,
2208             "field": "browserName",
2209             "description": ""
2210           },
2211           {
2212             "group": "Body",
2213             "type": "String",
2214             "optional": true,
2215             "field": "browserVersion",
2216             "description": ""
2217           },
2218           {
2219             "group": "Body",
2220             "type": "String",
2221             "optional": true,
2222             "field": "osName",
2223             "description": ""
2224           },
2225           {
2226             "group": "Body",
2227             "type": "String",
2228             "optional": true,
2229             "field": "osVersion",
2230             "description": ""
2231           },
2232           {
2233             "group": "Body",
2234             "type": "String",
2235             "optional": true,
2236             "field": "deviceModel",
2237             "description": ""
2238           },
2239           {
2240             "group": "Body",
2241             "type": "String",
2242             "optional": true,
2243             "field": "deviceVendor",
2244             "description": ""
2245           },
2246           {
2247             "group": "Body",
2248             "type": "String",
2249             "optional": true,
2250             "field": "deviceType",
2251             "description": ""
2252           },
2253           {
2254             "group": "Body",
2255             "type": "Text",
2256             "optional": true,
2257             "field": "referer",
2258             "description": ""
2259           },
2260           {
2261             "group": "Body",
2262             "type": "String",
2263             "optional": true,
2264             "field": "customerIp",
2265             "description": ""
2266           },
2267           {
2268             "group": "Body",
2269             "type": "Text",
2270             "optional": true,
2271             "field": "formData",
2272             "description": ""
2273           },
2274           {
2275             "group": "Body",
2276             "type": "String",
2277             "optional": true,
2278             "field": "read1stAt",
2279             "description": ""
2280           },
2281           {
2282             "group": "Body",
2283             "type": "String",
2284             "optional": true,
2285             "field": "lastMsgAt",
2286             "description": ""
2287           },
2288           {
2289             "group": "Body",
2290             "type": "String",
2291             "allowedValues": [
2292               "\"in\"",
2293               "\"out\""
2294             ],
2295             "optional": false,
2296             "field": "lastMsgDirection",
2297             "description": ""
2298           },
2299           {
2300             "group": "Body",
2301             "type": "String",
2302             "optional": true,
2303             "field": "closeReason",
2304             "description": ""
2305           },
2306           {
2307             "group": "Body",
2308             "type": "String",
2309             "optional": true,
2310             "field": "customerPort",
2311             "description": ""
2312           },
2313           {
2314             "group": "Body",
2315             "type": "Text",
2316             "optional": true,
2317             "field": "vidaooSessionId",
2318             "description": ""
2319           }
2320         ]
2321       }
2322     },
2323     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2324     "version": "0.0.0",
2325     "filename": "server/api/chatInteraction/index.js",
2326     "groupTitle": "Chat_Interactions"
2327   },
2328   {
2329     "type": "delete",
2330     "url": "/api/chat/interactions/{id}",
2331     "title": "Deletes a Interaction",
2332     "examples": [
2333       {
2334         "title": "Example usage:",
2335         "content": "curl https://{domain}/api/chat/interactions/{id} -v -u {name}:{password} -X DELETE",
2336         "type": "json"
2337       }
2338     ],
2339     "name": "DeleteInteractions",
2340     "group": "Chat_Interactions",
2341     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2342     "version": "0.0.0",
2343     "filename": "server/api/chatInteraction/index.js",
2344     "groupTitle": "Chat_Interactions"
2345   },
2346   {
2347     "type": "get",
2348     "url": "/api/chat/interactions/describe",
2349     "title": "Gets table info about Interactions",
2350     "examples": [
2351       {
2352         "title": "Example usage:",
2353         "content": "curl https://{domain}/api/chat/interactions/describe -v -u {name}:{password}",
2354         "type": "json"
2355       }
2356     ],
2357     "name": "DescribeInteractions",
2358     "group": "Chat_Interactions",
2359     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2360     "version": "0.0.0",
2361     "filename": "server/api/chatInteraction/index.js",
2362     "groupTitle": "Chat_Interactions"
2363   },
2364   {
2365     "type": "get",
2366     "url": "/api/chat/interactions",
2367     "title": "Gets a list of Interactions",
2368     "examples": [
2369       {
2370         "title": "Example usage:",
2371         "content": "curl https://{domain}/api/chat/interactions -v -u {name}:{password}",
2372         "type": "json"
2373       }
2374     ],
2375     "name": "GetInteractions",
2376     "group": "Chat_Interactions",
2377     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/interactions?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/interactions?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/interactions?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/interactions?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/interactions?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
2378     "version": "0.0.0",
2379     "filename": "server/api/chatInteraction/index.js",
2380     "groupTitle": "Chat_Interactions"
2381   },
2382   {
2383     "type": "delete",
2384     "url": "/api/chat/interactions/{id}/tags",
2385     "title": "Removes tags from interaction",
2386     "examples": [
2387       {
2388         "title": "Example usage:",
2389         "content": "curl https://{domain}/api/chat/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
2390         "type": "json"
2391       }
2392     ],
2393     "name": "RemoveTags",
2394     "group": "Chat_Interactions",
2395     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2396     "version": "0.0.0",
2397     "filename": "server/api/chatInteraction/index.js",
2398     "groupTitle": "Chat_Interactions"
2399   },
2400   {
2401     "type": "get",
2402     "url": "/api/chat/interactions/{id}",
2403     "title": "Gets a single Interaction",
2404     "examples": [
2405       {
2406         "title": "Example usage:",
2407         "content": "curl https://{domain}/api/chat/interactions/{id} -v -u {name}:{password}",
2408         "type": "json"
2409       }
2410     ],
2411     "name": "ShowInteractions",
2412     "group": "Chat_Interactions",
2413     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2414     "version": "0.0.0",
2415     "filename": "server/api/chatInteraction/index.js",
2416     "groupTitle": "Chat_Interactions"
2417   },
2418   {
2419     "type": "put",
2420     "url": "/api/chat/interactions/{id}/abandon",
2421     "title": "Abandon interaction",
2422     "examples": [
2423       {
2424         "title": "Example usage:",
2425         "content": "curl https://{domain}/api/chat/interactions/{id}/abandon -d '{\"channel\": \"chat\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
2426         "type": "json"
2427       }
2428     ],
2429     "name": "abandon",
2430     "group": "Chat_Interactions",
2431     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <p>This API is used to set as abandon an interaction and stop the routing.</p>",
2432     "version": "0.0.0",
2433     "filename": "server/api/chatInteraction/index.js",
2434     "groupTitle": "Chat_Interactions"
2435   },
2436   {
2437     "type": "put",
2438     "url": "/api/chat/interactions/{id}/close",
2439     "title": "Close Interaction",
2440     "examples": [
2441       {
2442         "title": "Example usage:",
2443         "content": "curl https://{domain}/api/chat/interactions/{id}/close -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2444         "type": "json"
2445       }
2446     ],
2447     "name": "addMessage",
2448     "group": "Chat_Interactions",
2449     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2450     "version": "0.0.0",
2451     "filename": "server/api/chatInteraction/index.js",
2452     "groupTitle": "Chat_Interactions"
2453   },
2454   {
2455     "type": "post",
2456     "url": "/api/chat/interactions/{id}/messages",
2457     "title": "Creates new messages",
2458     "examples": [
2459       {
2460         "title": "Example usage:",
2461         "content": "curl https://{domain}/api/chat/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2462         "type": "json"
2463       }
2464     ],
2465     "name": "addMessage",
2466     "group": "Chat_Interactions",
2467     "parameter": {
2468       "fields": {
2469         "Body": [
2470           {
2471             "group": "Body",
2472             "type": "Text",
2473             "optional": false,
2474             "field": "body",
2475             "description": ""
2476           },
2477           {
2478             "group": "Body",
2479             "type": "Boolean",
2480             "optional": true,
2481             "field": "read",
2482             "description": ""
2483           },
2484           {
2485             "group": "Body",
2486             "type": "Boolean",
2487             "optional": true,
2488             "field": "secret",
2489             "description": ""
2490           },
2491           {
2492             "group": "Body",
2493             "type": "String",
2494             "allowedValues": [
2495               "\"in\"",
2496               "\"out\""
2497             ],
2498             "optional": false,
2499             "field": "direction",
2500             "description": ""
2501           },
2502           {
2503             "group": "Body",
2504             "type": "String",
2505             "optional": true,
2506             "field": "readAt",
2507             "description": ""
2508           },
2509           {
2510             "group": "Body",
2511             "type": "String",
2512             "optional": true,
2513             "field": "providerName",
2514             "description": ""
2515           },
2516           {
2517             "group": "Body",
2518             "type": "Text",
2519             "optional": true,
2520             "field": "providerResponse",
2521             "description": ""
2522           }
2523         ]
2524       }
2525     },
2526     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2527     "version": "0.0.0",
2528     "filename": "server/api/chatInteraction/index.js",
2529     "groupTitle": "Chat_Interactions"
2530   },
2531   {
2532     "type": "post",
2533     "url": "/api/chat/interactions/{id}/attachment_upload",
2534     "title": "Add attachment",
2535     "examples": [
2536       {
2537         "title": "Example usage:",
2538         "content": "curl https://{domain}/api/chat/interactions/{id}/attachment_upload -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
2539         "type": "json"
2540       }
2541     ],
2542     "name": "attachmentUpload",
2543     "group": "Chat_Interactions",
2544     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2545     "version": "0.0.0",
2546     "filename": "server/api/chatInteraction/index.js",
2547     "groupTitle": "Chat_Interactions"
2548   },
2549   {
2550     "type": "post",
2551     "url": "/api/chat/interactions/{id}/vidaoo",
2552     "title": "Create Vidaoo Session",
2553     "examples": [
2554       {
2555         "title": "Example usage:",
2556         "content": "curl https://{domain}/api/chat/interactions/{id}/vidaoo  -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2557         "type": "json"
2558       }
2559     ],
2560     "name": "createVidaooSession",
2561     "group": "Chat_Interactions",
2562     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2563     "version": "0.0.0",
2564     "filename": "server/api/chatInteraction/index.js",
2565     "groupTitle": "Chat_Interactions"
2566   },
2567   {
2568     "type": "put",
2569     "url": "/api/chat/interactions/{id}/custom_update",
2570     "title": "Update interaction",
2571     "examples": [
2572       {
2573         "title": "Example usage:",
2574         "content": "curl https://{domain}/api/chat/interactions/{id}/custom_update -d '{\"channel\": \"chat\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
2575         "type": "json"
2576       }
2577     ],
2578     "name": "customUpdate",
2579     "group": "Chat_Interactions",
2580     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <p>This API is used to update an interaction.</p>",
2581     "version": "0.0.0",
2582     "filename": "server/api/chatInteraction/index.js",
2583     "groupTitle": "Chat_Interactions"
2584   },
2585   {
2586     "type": "get",
2587     "url": "/api/chat/interactions/{id}/download",
2588     "title": "Gets interaction",
2589     "examples": [
2590       {
2591         "title": "Example usage:",
2592         "content": "curl https://{domain}/api/chat/interactions/{id}/download -v -u {name}:{password} -X GET",
2593         "type": "json"
2594       }
2595     ],
2596     "name": "download",
2597     "group": "Chat_Interactions",
2598     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2599     "version": "0.0.0",
2600     "filename": "server/api/chatInteraction/index.js",
2601     "groupTitle": "Chat_Interactions"
2602   },
2603   {
2604     "type": "get",
2605     "url": "/api/chat/interactions/{id}/messages",
2606     "title": "Gets interaction messages",
2607     "examples": [
2608       {
2609         "title": "Example usage:",
2610         "content": "curl https://{domain}/api/chat/interactions/{id}/messages -v -u {name}:{password} -X GET",
2611         "type": "json"
2612       }
2613     ],
2614     "name": "getMessages",
2615     "group": "Chat_Interactions",
2616     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2617     "version": "0.0.0",
2618     "filename": "server/api/chatInteraction/index.js",
2619     "groupTitle": "Chat_Interactions"
2620   },
2621   {
2622     "type": "get",
2623     "url": "/api/chat/interactions/{id}/my_messages",
2624     "title": "Gets interaction messages",
2625     "examples": [
2626       {
2627         "title": "Example usage:",
2628         "content": "curl https://{domain}/api/chat/interactions/{id}/my_messages -v -u {name}:{password} -X GET",
2629         "type": "json"
2630       }
2631     ],
2632     "name": "getMyMessages",
2633     "group": "Chat_Interactions",
2634     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2635     "version": "0.0.0",
2636     "filename": "server/api/chatInteraction/index.js",
2637     "groupTitle": "Chat_Interactions"
2638   },
2639   {
2640     "type": "put",
2641     "url": "/api/chat/interactions/{id}",
2642     "title": "Update an existing Interaction",
2643     "examples": [
2644       {
2645         "title": "Example usage:",
2646         "content": "curl https://{domain}/api/chat/interactions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
2647         "type": "json"
2648       }
2649     ],
2650     "name": "updateInteractions",
2651     "group": "Chat_Interactions",
2652     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2653     "version": "0.0.0",
2654     "filename": "server/api/chatInteraction/index.js",
2655     "groupTitle": "Chat_Interactions"
2656   },
2657   {
2658     "type": "post",
2659     "url": "/api/chat/internal/messages",
2660     "title": "Creates a new Message",
2661     "examples": [
2662       {
2663         "title": "Example usage:",
2664         "content": "curl https://{domain}/api/chat/internal/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2665         "type": "json"
2666       }
2667     ],
2668     "name": "CreateMessages",
2669     "group": "Chat_Internal_Messages",
2670     "parameter": {
2671       "fields": {
2672         "Body": [
2673           {
2674             "group": "Body",
2675             "type": "Text",
2676             "optional": false,
2677             "field": "body",
2678             "description": ""
2679           },
2680           {
2681             "group": "Body",
2682             "type": "Boolean",
2683             "optional": true,
2684             "field": "read",
2685             "description": ""
2686           },
2687           {
2688             "group": "Body",
2689             "type": "Integer",
2690             "optional": true,
2691             "field": "ChatInternalMessageId",
2692             "description": ""
2693           }
2694         ]
2695       }
2696     },
2697     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2698     "version": "0.0.0",
2699     "filename": "server/api/chatInternalMessage/index.js",
2700     "groupTitle": "Chat_Internal_Messages"
2701   },
2702   {
2703     "type": "delete",
2704     "url": "/api/chat/internal/messages/{id}",
2705     "title": "Deletes a Message",
2706     "examples": [
2707       {
2708         "title": "Example usage:",
2709         "content": "curl https://{domain}/api/chat/internal/messages/{id} -v -u {name}:{password} -X DELETE",
2710         "type": "json"
2711       }
2712     ],
2713     "name": "DeleteMessages",
2714     "group": "Chat_Internal_Messages",
2715     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2716     "version": "0.0.0",
2717     "filename": "server/api/chatInternalMessage/index.js",
2718     "groupTitle": "Chat_Internal_Messages"
2719   },
2720   {
2721     "type": "get",
2722     "url": "/api/chat/internal/messages/describe",
2723     "title": "Gets table info about Messages",
2724     "examples": [
2725       {
2726         "title": "Example usage:",
2727         "content": "curl https://{domain}/api/chat/internal/messages/describe -v -u {name}:{password}",
2728         "type": "json"
2729       }
2730     ],
2731     "name": "DescribeMessages",
2732     "group": "Chat_Internal_Messages",
2733     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2734     "version": "0.0.0",
2735     "filename": "server/api/chatInternalMessage/index.js",
2736     "groupTitle": "Chat_Internal_Messages"
2737   },
2738   {
2739     "type": "get",
2740     "url": "/api/chat/internal/messages",
2741     "title": "Gets a list of Messages",
2742     "examples": [
2743       {
2744         "title": "Example usage:",
2745         "content": "curl https://{domain}/api/chat/internal/messages -v -u {name}:{password}",
2746         "type": "json"
2747       }
2748     ],
2749     "name": "GetMessages",
2750     "group": "Chat_Internal_Messages",
2751     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/internal/messages?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/internal/messages?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/internal/messages?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/internal/messages?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/internal/messages?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
2752     "version": "0.0.0",
2753     "filename": "server/api/chatInternalMessage/index.js",
2754     "groupTitle": "Chat_Internal_Messages"
2755   },
2756   {
2757     "type": "get",
2758     "url": "/api/chat/internal/messages/{id}",
2759     "title": "Gets a single Message",
2760     "examples": [
2761       {
2762         "title": "Example usage:",
2763         "content": "curl https://{domain}/api/chat/internal/messages/{id} -v -u {name}:{password}",
2764         "type": "json"
2765       }
2766     ],
2767     "name": "ShowMessages",
2768     "group": "Chat_Internal_Messages",
2769     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2770     "version": "0.0.0",
2771     "filename": "server/api/chatInternalMessage/index.js",
2772     "groupTitle": "Chat_Internal_Messages"
2773   },
2774   {
2775     "type": "put",
2776     "url": "/api/chat/internal/messages/{id}",
2777     "title": "Update an existing Message",
2778     "examples": [
2779       {
2780         "title": "Example usage:",
2781         "content": "curl https://{domain}/api/chat/internal/messages/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
2782         "type": "json"
2783       }
2784     ],
2785     "name": "updateMessages",
2786     "group": "Chat_Internal_Messages",
2787     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2788     "version": "0.0.0",
2789     "filename": "server/api/chatInternalMessage/index.js",
2790     "groupTitle": "Chat_Internal_Messages"
2791   },
2792   {
2793     "type": "post",
2794     "url": "/api/chat/messages",
2795     "title": "Creates a new Message",
2796     "examples": [
2797       {
2798         "title": "Example usage:",
2799         "content": "curl https://{domain}/api/chat/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2800         "type": "json"
2801       }
2802     ],
2803     "name": "CreateMessages",
2804     "group": "Chat_Messages",
2805     "parameter": {
2806       "fields": {
2807         "Body": [
2808           {
2809             "group": "Body",
2810             "type": "Text",
2811             "optional": false,
2812             "field": "body",
2813             "description": ""
2814           },
2815           {
2816             "group": "Body",
2817             "type": "Boolean",
2818             "optional": true,
2819             "field": "read",
2820             "description": ""
2821           },
2822           {
2823             "group": "Body",
2824             "type": "Boolean",
2825             "optional": true,
2826             "field": "secret",
2827             "description": ""
2828           },
2829           {
2830             "group": "Body",
2831             "type": "String",
2832             "allowedValues": [
2833               "\"in\"",
2834               "\"out\""
2835             ],
2836             "optional": false,
2837             "field": "direction",
2838             "description": ""
2839           },
2840           {
2841             "group": "Body",
2842             "type": "String",
2843             "optional": true,
2844             "field": "readAt",
2845             "description": ""
2846           },
2847           {
2848             "group": "Body",
2849             "type": "String",
2850             "optional": true,
2851             "field": "providerName",
2852             "description": ""
2853           },
2854           {
2855             "group": "Body",
2856             "type": "Text",
2857             "optional": true,
2858             "field": "providerResponse",
2859             "description": ""
2860           }
2861         ]
2862       }
2863     },
2864     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2865     "version": "0.0.0",
2866     "filename": "server/api/chatMessage/index.js",
2867     "groupTitle": "Chat_Messages"
2868   },
2869   {
2870     "type": "delete",
2871     "url": "/api/chat/messages/{id}",
2872     "title": "Deletes a Message",
2873     "examples": [
2874       {
2875         "title": "Example usage:",
2876         "content": "curl https://{domain}/api/chat/messages/{id} -v -u {name}:{password} -X DELETE",
2877         "type": "json"
2878       }
2879     ],
2880     "name": "DeleteMessages",
2881     "group": "Chat_Messages",
2882     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2883     "version": "0.0.0",
2884     "filename": "server/api/chatMessage/index.js",
2885     "groupTitle": "Chat_Messages"
2886   },
2887   {
2888     "type": "get",
2889     "url": "/api/chat/messages/describe",
2890     "title": "Gets table info about Messages",
2891     "examples": [
2892       {
2893         "title": "Example usage:",
2894         "content": "curl https://{domain}/api/chat/messages/describe -v -u {name}:{password}",
2895         "type": "json"
2896       }
2897     ],
2898     "name": "DescribeMessages",
2899     "group": "Chat_Messages",
2900     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2901     "version": "0.0.0",
2902     "filename": "server/api/chatMessage/index.js",
2903     "groupTitle": "Chat_Messages"
2904   },
2905   {
2906     "type": "get",
2907     "url": "/api/chat/messages",
2908     "title": "Gets a list of Messages",
2909     "examples": [
2910       {
2911         "title": "Example usage:",
2912         "content": "curl https://{domain}/api/chat/messages -v -u {name}:{password}",
2913         "type": "json"
2914       }
2915     ],
2916     "name": "GetMessages",
2917     "group": "Chat_Messages",
2918     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/messages?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/messages?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/messages?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/messages?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/messages?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
2919     "version": "0.0.0",
2920     "filename": "server/api/chatMessage/index.js",
2921     "groupTitle": "Chat_Messages"
2922   },
2923   {
2924     "type": "get",
2925     "url": "/api/chat/messages/{id}",
2926     "title": "Gets a single Message",
2927     "examples": [
2928       {
2929         "title": "Example usage:",
2930         "content": "curl https://{domain}/api/chat/messages/{id} -v -u {name}:{password}",
2931         "type": "json"
2932       }
2933     ],
2934     "name": "ShowMessages",
2935     "group": "Chat_Messages",
2936     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2937     "version": "0.0.0",
2938     "filename": "server/api/chatMessage/index.js",
2939     "groupTitle": "Chat_Messages"
2940   },
2941   {
2942     "type": "put",
2943     "url": "/api/chat/messages/{id}",
2944     "title": "Update an existing Message",
2945     "examples": [
2946       {
2947         "title": "Example usage:",
2948         "content": "curl https://{domain}/api/chat/messages/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
2949         "type": "json"
2950       }
2951     ],
2952     "name": "updateMessages",
2953     "group": "Chat_Messages",
2954     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2955     "version": "0.0.0",
2956     "filename": "server/api/chatMessage/index.js",
2957     "groupTitle": "Chat_Messages"
2958   },
2959   {
2960     "type": "post",
2961     "url": "/api/chat/offline_messages",
2962     "title": "Creates a new OfflineMessage",
2963     "examples": [
2964       {
2965         "title": "Example usage:",
2966         "content": "curl https://{domain}/api/chat/offline_messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2967         "type": "json"
2968       }
2969     ],
2970     "name": "CreateOfflineMessages",
2971     "group": "Chat_Offline_Messages",
2972     "parameter": {
2973       "fields": {
2974         "Body": [
2975           {
2976             "group": "Body",
2977             "type": "Text",
2978             "optional": false,
2979             "field": "body",
2980             "description": ""
2981           }
2982         ]
2983       }
2984     },
2985     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2986     "version": "0.0.0",
2987     "filename": "server/api/chatOfflineMessage/index.js",
2988     "groupTitle": "Chat_Offline_Messages"
2989   },
2990   {
2991     "type": "delete",
2992     "url": "/api/chat/offline_messages/{id}",
2993     "title": "Deletes a OfflineMessage",
2994     "examples": [
2995       {
2996         "title": "Example usage:",
2997         "content": "curl https://{domain}/api/chat/offline_messages/{id} -v -u {name}:{password} -X DELETE",
2998         "type": "json"
2999       }
3000     ],
3001     "name": "DeleteOfflineMessages",
3002     "group": "Chat_Offline_Messages",
3003     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3004     "version": "0.0.0",
3005     "filename": "server/api/chatOfflineMessage/index.js",
3006     "groupTitle": "Chat_Offline_Messages"
3007   },
3008   {
3009     "type": "get",
3010     "url": "/api/chat/offline_messages/describe",
3011     "title": "Gets table info about OfflineMessages",
3012     "examples": [
3013       {
3014         "title": "Example usage:",
3015         "content": "curl https://{domain}/api/chat/offline_messages/describe -v -u {name}:{password}",
3016         "type": "json"
3017       }
3018     ],
3019     "name": "DescribeOfflineMessages",
3020     "group": "Chat_Offline_Messages",
3021     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3022     "version": "0.0.0",
3023     "filename": "server/api/chatOfflineMessage/index.js",
3024     "groupTitle": "Chat_Offline_Messages"
3025   },
3026   {
3027     "type": "get",
3028     "url": "/api/chat/offline_messages",
3029     "title": "Gets a list of OfflineMessages",
3030     "examples": [
3031       {
3032         "title": "Example usage:",
3033         "content": "curl https://{domain}/api/chat/offline_messages -v -u {name}:{password}",
3034         "type": "json"
3035       }
3036     ],
3037     "name": "GetOfflineMessages",
3038     "group": "Chat_Offline_Messages",
3039     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/offline_messages?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/offline_messages?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/offline_messages?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/offline_messages?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/offline_messages?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
3040     "version": "0.0.0",
3041     "filename": "server/api/chatOfflineMessage/index.js",
3042     "groupTitle": "Chat_Offline_Messages"
3043   },
3044   {
3045     "type": "get",
3046     "url": "/api/chat/offline_messages/{id}",
3047     "title": "Gets a single OfflineMessage",
3048     "examples": [
3049       {
3050         "title": "Example usage:",
3051         "content": "curl https://{domain}/api/chat/offline_messages/{id} -v -u {name}:{password}",
3052         "type": "json"
3053       }
3054     ],
3055     "name": "ShowOfflineMessages",
3056     "group": "Chat_Offline_Messages",
3057     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3058     "version": "0.0.0",
3059     "filename": "server/api/chatOfflineMessage/index.js",
3060     "groupTitle": "Chat_Offline_Messages"
3061   },
3062   {
3063     "type": "put",
3064     "url": "/api/chat/offline_messages/{id}",
3065     "title": "Update an existing OfflineMessage",
3066     "examples": [
3067       {
3068         "title": "Example usage:",
3069         "content": "curl https://{domain}/api/chat/offline_messages/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
3070         "type": "json"
3071       }
3072     ],
3073     "name": "updateOfflineMessages",
3074     "group": "Chat_Offline_Messages",
3075     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3076     "version": "0.0.0",
3077     "filename": "server/api/chatOfflineMessage/index.js",
3078     "groupTitle": "Chat_Offline_Messages"
3079   },
3080   {
3081     "type": "post",
3082     "url": "/api/chat/proactive_actions",
3083     "title": "Creates a new Proactive Action",
3084     "examples": [
3085       {
3086         "title": "Example usage:",
3087         "content": "curl https://{domain}/api/chat/proactive_actions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3088         "type": "json"
3089       }
3090     ],
3091     "name": "CreateProactive_Actions",
3092     "group": "Chat_Proactive_Actions",
3093     "parameter": {
3094       "fields": {
3095         "Body": [
3096           {
3097             "group": "Body",
3098             "type": "String",
3099             "optional": false,
3100             "field": "name",
3101             "description": ""
3102           },
3103           {
3104             "group": "Body",
3105             "type": "String",
3106             "allowedValues": [
3107               "\"mouseOver\"",
3108               "\"timeout\""
3109             ],
3110             "optional": true,
3111             "field": "type",
3112             "description": ""
3113           },
3114           {
3115             "group": "Body",
3116             "type": "String",
3117             "optional": true,
3118             "field": "selector",
3119             "description": ""
3120           },
3121           {
3122             "group": "Body",
3123             "type": "Integer",
3124             "optional": true,
3125             "field": "timeout",
3126             "description": ""
3127           }
3128         ]
3129       }
3130     },
3131     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3132     "version": "0.0.0",
3133     "filename": "server/api/chatProactiveAction/index.js",
3134     "groupTitle": "Chat_Proactive_Actions"
3135   },
3136   {
3137     "type": "delete",
3138     "url": "/api/chat/proactive_actions/{id}",
3139     "title": "Deletes a Proactive Action",
3140     "examples": [
3141       {
3142         "title": "Example usage:",
3143         "content": "curl https://{domain}/api/chat/proactive_actions/{id} -v -u {name}:{password} -X DELETE",
3144         "type": "json"
3145       }
3146     ],
3147     "name": "DeleteProactive_Actions",
3148     "group": "Chat_Proactive_Actions",
3149     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3150     "version": "0.0.0",
3151     "filename": "server/api/chatProactiveAction/index.js",
3152     "groupTitle": "Chat_Proactive_Actions"
3153   },
3154   {
3155     "type": "get",
3156     "url": "/api/chat/proactive_actions/{id}",
3157     "title": "Gets a single Proactive Action",
3158     "examples": [
3159       {
3160         "title": "Example usage:",
3161         "content": "curl https://{domain}/api/chat/proactive_actions/{id} -v -u {name}:{password}",
3162         "type": "json"
3163       }
3164     ],
3165     "name": "ShowProactive_Actions",
3166     "group": "Chat_Proactive_Actions",
3167     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3168     "version": "0.0.0",
3169     "filename": "server/api/chatProactiveAction/index.js",
3170     "groupTitle": "Chat_Proactive_Actions"
3171   },
3172   {
3173     "type": "put",
3174     "url": "/api/chat/proactive_actions/{id}",
3175     "title": "Update an existing Proactive Action",
3176     "examples": [
3177       {
3178         "title": "Example usage:",
3179         "content": "curl https://{domain}/api/chat/proactive_actions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
3180         "type": "json"
3181       }
3182     ],
3183     "name": "updateProactive_Actions",
3184     "group": "Chat_Proactive_Actions",
3185     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3186     "version": "0.0.0",
3187     "filename": "server/api/chatProactiveAction/index.js",
3188     "groupTitle": "Chat_Proactive_Actions"
3189   },
3190   {
3191     "type": "post",
3192     "url": "/api/chat/reports/queue",
3193     "title": "Creates a new Chat Queue Report",
3194     "examples": [
3195       {
3196         "title": "Example usage:",
3197         "content": "curl https://{domain}/api/chat/reports/queue -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3198         "type": "json"
3199       }
3200     ],
3201     "name": "CreateChat_Queue_Reports",
3202     "group": "Chat_Queue_Reports",
3203     "parameter": {
3204       "fields": {
3205         "Body": [
3206           {
3207             "group": "Body",
3208             "type": "String",
3209             "optional": false,
3210             "field": "uniqueid",
3211             "description": ""
3212           },
3213           {
3214             "group": "Body",
3215             "type": "String",
3216             "optional": true,
3217             "field": "from",
3218             "description": ""
3219           },
3220           {
3221             "group": "Body",
3222             "type": "String",
3223             "optional": true,
3224             "field": "joinAt",
3225             "description": ""
3226           },
3227           {
3228             "group": "Body",
3229             "type": "String",
3230             "optional": true,
3231             "field": "leaveAt",
3232             "description": ""
3233           },
3234           {
3235             "group": "Body",
3236             "type": "String",
3237             "optional": true,
3238             "field": "acceptAt",
3239             "description": ""
3240           },
3241           {
3242             "group": "Body",
3243             "type": "String",
3244             "optional": true,
3245             "field": "exitAt",
3246             "description": ""
3247           },
3248           {
3249             "group": "Body",
3250             "type": "String",
3251             "optional": true,
3252             "field": "reason",
3253             "description": ""
3254           }
3255         ]
3256       }
3257     },
3258     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3259     "version": "0.0.0",
3260     "filename": "server/api/chatQueueReport/index.js",
3261     "groupTitle": "Chat_Queue_Reports"
3262   },
3263   {
3264     "type": "delete",
3265     "url": "/api/chat/reports/queue/{id}",
3266     "title": "Deletes a Chat Queue Report",
3267     "examples": [
3268       {
3269         "title": "Example usage:",
3270         "content": "curl https://{domain}/api/chat/reports/queue/{id} -v -u {name}:{password} -X DELETE",
3271         "type": "json"
3272       }
3273     ],
3274     "name": "DeleteChat_Queue_Reports",
3275     "group": "Chat_Queue_Reports",
3276     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3277     "version": "0.0.0",
3278     "filename": "server/api/chatQueueReport/index.js",
3279     "groupTitle": "Chat_Queue_Reports"
3280   },
3281   {
3282     "type": "get",
3283     "url": "/api/chat/reports/queue/describe",
3284     "title": "Gets table info about Chat Queue Reports",
3285     "examples": [
3286       {
3287         "title": "Example usage:",
3288         "content": "curl https://{domain}/api/chat/reports/queue/describe -v -u {name}:{password}",
3289         "type": "json"
3290       }
3291     ],
3292     "name": "DescribeChat_Queue_Reports",
3293     "group": "Chat_Queue_Reports",
3294     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3295     "version": "0.0.0",
3296     "filename": "server/api/chatQueueReport/index.js",
3297     "groupTitle": "Chat_Queue_Reports"
3298   },
3299   {
3300     "type": "get",
3301     "url": "/api/chat/reports/queue",
3302     "title": "Gets a list of Chat Queue Reports",
3303     "examples": [
3304       {
3305         "title": "Example usage:",
3306         "content": "curl https://{domain}/api/chat/reports/queue -v -u {name}:{password}",
3307         "type": "json"
3308       }
3309     ],
3310     "name": "GetChat_Queue_Reports",
3311     "group": "Chat_Queue_Reports",
3312     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/reports/queue?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/reports/queue?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/reports/queue?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/reports/queue?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/reports/queue?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
3313     "version": "0.0.0",
3314     "filename": "server/api/chatQueueReport/index.js",
3315     "groupTitle": "Chat_Queue_Reports"
3316   },
3317   {
3318     "type": "get",
3319     "url": "/api/chat/reports/queue/{id}",
3320     "title": "Gets a single Chat Queue Report",
3321     "examples": [
3322       {
3323         "title": "Example usage:",
3324         "content": "curl https://{domain}/api/chat/reports/queue/{id} -v -u {name}:{password}",
3325         "type": "json"
3326       }
3327     ],
3328     "name": "ShowChat_Queue_Reports",
3329     "group": "Chat_Queue_Reports",
3330     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3331     "version": "0.0.0",
3332     "filename": "server/api/chatQueueReport/index.js",
3333     "groupTitle": "Chat_Queue_Reports"
3334   },
3335   {
3336     "type": "put",
3337     "url": "/api/chat/reports/queue/{id}",
3338     "title": "Update an existing Chat Queue Report",
3339     "examples": [
3340       {
3341         "title": "Example usage:",
3342         "content": "curl https://{domain}/api/chat/reports/queue/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
3343         "type": "json"
3344       }
3345     ],
3346     "name": "updateChat_Queue_Reports",
3347     "group": "Chat_Queue_Reports",
3348     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3349     "version": "0.0.0",
3350     "filename": "server/api/chatQueueReport/index.js",
3351     "groupTitle": "Chat_Queue_Reports"
3352   },
3353   {
3354     "type": "post",
3355     "url": "/api/chat/queues/{id}/users",
3356     "title": "Add agents to a queue",
3357     "examples": [
3358       {
3359         "title": "Example usage:",
3360         "content": "curl https://{domain}/api/chat/queues/{id}/users -d '{\"ids\": [1,2], \"penalty\": 2}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
3361         "type": "json"
3362       }
3363     ],
3364     "name": "AddAgents",
3365     "group": "Chat_Queues",
3366     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3367     "version": "0.0.0",
3368     "filename": "server/api/chatQueue/index.js",
3369     "groupTitle": "Chat_Queues"
3370   },
3371   {
3372     "type": "post",
3373     "url": "/api/chat/queues/{id}/teams",
3374     "title": "Add teams to a queue",
3375     "examples": [
3376       {
3377         "title": "Example usage:",
3378         "content": "curl https://{domain}/api/chat/queues/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
3379         "type": "json"
3380       }
3381     ],
3382     "name": "AddTeams",
3383     "group": "Chat_Queues",
3384     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3385     "version": "0.0.0",
3386     "filename": "server/api/chatQueue/index.js",
3387     "groupTitle": "Chat_Queues"
3388   },
3389   {
3390     "type": "post",
3391     "url": "/api/chat/queues",
3392     "title": "Creates a new Queue",
3393     "examples": [
3394       {
3395         "title": "Example usage:",
3396         "content": "curl https://{domain}/api/chat/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3397         "type": "json"
3398       }
3399     ],
3400     "name": "CreateQueues",
3401     "group": "Chat_Queues",
3402     "parameter": {
3403       "fields": {
3404         "Body": [
3405           {
3406             "group": "Body",
3407             "type": "String",
3408             "optional": false,
3409             "field": "name",
3410             "description": ""
3411           },
3412           {
3413             "group": "Body",
3414             "type": "String",
3415             "optional": true,
3416             "field": "description",
3417             "description": ""
3418           },
3419           {
3420             "group": "Body",
3421             "type": "Integer",
3422             "optional": true,
3423             "field": "timeout",
3424             "description": ""
3425           },
3426           {
3427             "group": "Body",
3428             "type": "String",
3429             "allowedValues": [
3430               "\"rrmemory\"",
3431               "\"beepall\"",
3432               "\"roundrobin\""
3433             ],
3434             "optional": true,
3435             "field": "strategy",
3436             "description": ""
3437           }
3438         ]
3439       }
3440     },
3441     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3442     "version": "0.0.0",
3443     "filename": "server/api/chatQueue/index.js",
3444     "groupTitle": "Chat_Queues"
3445   },
3446   {
3447     "type": "delete",
3448     "url": "/api/chat/queues/{id}",
3449     "title": "Deletes a Queue",
3450     "examples": [
3451       {
3452         "title": "Example usage:",
3453         "content": "curl https://{domain}/api/chat/queues/{id} -v -u {name}:{password} -X DELETE",
3454         "type": "json"
3455       }
3456     ],
3457     "name": "DeleteQueues",
3458     "group": "Chat_Queues",
3459     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3460     "version": "0.0.0",
3461     "filename": "server/api/chatQueue/index.js",
3462     "groupTitle": "Chat_Queues"
3463   },
3464   {
3465     "type": "get",
3466     "url": "/api/chat/queues/describe",
3467     "title": "Gets table info about Queues",
3468     "examples": [
3469       {
3470         "title": "Example usage:",
3471         "content": "curl https://{domain}/api/chat/queues/describe -v -u {name}:{password}",
3472         "type": "json"
3473       }
3474     ],
3475     "name": "DescribeQueues",
3476     "group": "Chat_Queues",
3477     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3478     "version": "0.0.0",
3479     "filename": "server/api/chatQueue/index.js",
3480     "groupTitle": "Chat_Queues"
3481   },
3482   {
3483     "type": "get",
3484     "url": "/api/chat/queues/{id}/users",
3485     "title": "Gets queue agents",
3486     "examples": [
3487       {
3488         "title": "Example usage:",
3489         "content": "curl https://{domain}/api/chat/queues/{id}/users -v -u {name}:{password} -X POST",
3490         "type": "json"
3491       }
3492     ],
3493     "name": "GetAgents",
3494     "group": "Chat_Queues",
3495     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3496     "version": "0.0.0",
3497     "filename": "server/api/chatQueue/index.js",
3498     "groupTitle": "Chat_Queues"
3499   },
3500   {
3501     "type": "get",
3502     "url": "/api/chat/queues/{id}/members",
3503     "title": "GetMembers",
3504     "examples": [
3505       {
3506         "title": "Example usage:",
3507         "content": "curl https://{domain}/api/chat/queues/{id}/members  -v -u {name}:{password}",
3508         "type": "json"
3509       }
3510     ],
3511     "name": "GetMembers",
3512     "group": "Chat_Queues",
3513     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3514     "version": "0.0.0",
3515     "filename": "server/api/chatQueue/index.js",
3516     "groupTitle": "Chat_Queues"
3517   },
3518   {
3519     "type": "get",
3520     "url": "/api/chat/queues",
3521     "title": "Gets a list of Queues",
3522     "examples": [
3523       {
3524         "title": "Example usage:",
3525         "content": "curl https://{domain}/api/chat/queues -v -u {name}:{password}",
3526         "type": "json"
3527       }
3528     ],
3529     "name": "GetQueues",
3530     "group": "Chat_Queues",
3531     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/queues?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/queues?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/queues?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/queues?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/queues?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
3532     "version": "0.0.0",
3533     "filename": "server/api/chatQueue/index.js",
3534     "groupTitle": "Chat_Queues"
3535   },
3536   {
3537     "type": "get",
3538     "url": "/api/chat/queues/{id}/teams",
3539     "title": "Gets queues list",
3540     "examples": [
3541       {
3542         "title": "Example usage:",
3543         "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password}",
3544         "type": "json"
3545       }
3546     ],
3547     "name": "GetTeams",
3548     "group": "Chat_Queues",
3549     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3550     "version": "0.0.0",
3551     "filename": "server/api/chatQueue/index.js",
3552     "groupTitle": "Chat_Queues"
3553   },
3554   {
3555     "type": "delete",
3556     "url": "/api/chat/queues/{id}/users",
3557     "title": "Removes agents from a queue",
3558     "examples": [
3559       {
3560         "title": "Example usage:",
3561         "content": "curl https://{domain}/api/chat/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
3562         "type": "json"
3563       }
3564     ],
3565     "name": "RemoveAgents",
3566     "group": "Chat_Queues",
3567     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3568     "version": "0.0.0",
3569     "filename": "server/api/chatQueue/index.js",
3570     "groupTitle": "Chat_Queues"
3571   },
3572   {
3573     "type": "get",
3574     "url": "/api/chat/queues/{id}",
3575     "title": "Gets a single Queue",
3576     "examples": [
3577       {
3578         "title": "Example usage:",
3579         "content": "curl https://{domain}/api/chat/queues/{id} -v -u {name}:{password}",
3580         "type": "json"
3581       }
3582     ],
3583     "name": "ShowQueues",
3584     "group": "Chat_Queues",
3585     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3586     "version": "0.0.0",
3587     "filename": "server/api/chatQueue/index.js",
3588     "groupTitle": "Chat_Queues"
3589   },
3590   {
3591     "type": "put",
3592     "url": "/api/chat/queues/{id}",
3593     "title": "Update an existing Queue",
3594     "examples": [
3595       {
3596         "title": "Example usage:",
3597         "content": "curl https://{domain}/api/chat/queues/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
3598         "type": "json"
3599       }
3600     ],
3601     "name": "updateQueues",
3602     "group": "Chat_Queues",
3603     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3604     "version": "0.0.0",
3605     "filename": "server/api/chatQueue/index.js",
3606     "groupTitle": "Chat_Queues"
3607   },
3608   {
3609     "type": "post",
3610     "url": "/api/chat/reports/transfer",
3611     "title": "Creates a new Chat Transfer Report",
3612     "examples": [
3613       {
3614         "title": "Example usage:",
3615         "content": "curl https://{domain}/api/chat/reports/transfer -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3616         "type": "json"
3617       }
3618     ],
3619     "name": "CreateChat_Transfer_Reports",
3620     "group": "Chat_Transfer_Reports",
3621     "parameter": {
3622       "fields": {
3623         "Body": [
3624           {
3625             "group": "Body",
3626             "type": "String",
3627             "optional": false,
3628             "field": "uniqueid",
3629             "description": ""
3630           },
3631           {
3632             "group": "Body",
3633             "type": "String",
3634             "allowedValues": [
3635               "\"account\"",
3636               "\"agent\"",
3637               "\"queue\""
3638             ],
3639             "optional": false,
3640             "field": "type",
3641             "description": ""
3642           },
3643           {
3644             "group": "Body",
3645             "type": "String",
3646             "optional": false,
3647             "field": "transferredAt",
3648             "description": ""
3649           }
3650         ]
3651       }
3652     },
3653     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3654     "version": "0.0.0",
3655     "filename": "server/api/chatTransferReport/index.js",
3656     "groupTitle": "Chat_Transfer_Reports"
3657   },
3658   {
3659     "type": "delete",
3660     "url": "/api/chat/reports/transfer/{id}",
3661     "title": "Deletes a Chat Transfer Report",
3662     "examples": [
3663       {
3664         "title": "Example usage:",
3665         "content": "curl https://{domain}/api/chat/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
3666         "type": "json"
3667       }
3668     ],
3669     "name": "DeleteChat_Transfer_Reports",
3670     "group": "Chat_Transfer_Reports",
3671     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3672     "version": "0.0.0",
3673     "filename": "server/api/chatTransferReport/index.js",
3674     "groupTitle": "Chat_Transfer_Reports"
3675   },
3676   {
3677     "type": "get",
3678     "url": "/api/chat/reports/transfer/describe",
3679     "title": "Gets table info about Chat Transfer Reports",
3680     "examples": [
3681       {
3682         "title": "Example usage:",
3683         "content": "curl https://{domain}/api/chat/reports/transfer/describe -v -u {name}:{password}",
3684         "type": "json"
3685       }
3686     ],
3687     "name": "DescribeChat_Transfer_Reports",
3688     "group": "Chat_Transfer_Reports",
3689     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3690     "version": "0.0.0",
3691     "filename": "server/api/chatTransferReport/index.js",
3692     "groupTitle": "Chat_Transfer_Reports"
3693   },
3694   {
3695     "type": "get",
3696     "url": "/api/chat/reports/transfer",
3697     "title": "Gets a list of Chat Transfer Reports",
3698     "examples": [
3699       {
3700         "title": "Example usage:",
3701         "content": "curl https://{domain}/api/chat/reports/transfer -v -u {name}:{password}",
3702         "type": "json"
3703       }
3704     ],
3705     "name": "GetChat_Transfer_Reports",
3706     "group": "Chat_Transfer_Reports",
3707     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/reports/transfer?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/reports/transfer?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/reports/transfer?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/reports/transfer?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/reports/transfer?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
3708     "version": "0.0.0",
3709     "filename": "server/api/chatTransferReport/index.js",
3710     "groupTitle": "Chat_Transfer_Reports"
3711   },
3712   {
3713     "type": "get",
3714     "url": "/api/chat/reports/transfer/{id}",
3715     "title": "Gets a single Chat Transfer Report",
3716     "examples": [
3717       {
3718         "title": "Example usage:",
3719         "content": "curl https://{domain}/api/chat/reports/transfer/{id} -v -u {name}:{password}",
3720         "type": "json"
3721       }
3722     ],
3723     "name": "ShowChat_Transfer_Reports",
3724     "group": "Chat_Transfer_Reports",
3725     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3726     "version": "0.0.0",
3727     "filename": "server/api/chatTransferReport/index.js",
3728     "groupTitle": "Chat_Transfer_Reports"
3729   },
3730   {
3731     "type": "put",
3732     "url": "/api/chat/reports/transfer/{id}",
3733     "title": "Update an existing Chat Transfer Report",
3734     "examples": [
3735       {
3736         "title": "Example usage:",
3737         "content": "curl https://{domain}/api/chat/reports/transfer/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
3738         "type": "json"
3739       }
3740     ],
3741     "name": "updateChat_Transfer_Reports",
3742     "group": "Chat_Transfer_Reports",
3743     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3744     "version": "0.0.0",
3745     "filename": "server/api/chatTransferReport/index.js",
3746     "groupTitle": "Chat_Transfer_Reports"
3747   },
3748   {
3749     "type": "post",
3750     "url": "/api/chat/websites/{id}/users",
3751     "title": "Add agents to a website",
3752     "examples": [
3753       {
3754         "title": "Example usage:",
3755         "content": "curl https://{domain}/api/chat/websites/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
3756         "type": "json"
3757       }
3758     ],
3759     "name": "AddAgents",
3760     "group": "Chat_Websites",
3761     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3762     "version": "0.0.0",
3763     "filename": "server/api/chatWebsite/index.js",
3764     "groupTitle": "Chat_Websites"
3765   },
3766   {
3767     "type": "post",
3768     "url": "/api/chat/websites",
3769     "title": "Creates a new Website",
3770     "examples": [
3771       {
3772         "title": "Example usage:",
3773         "content": "curl https://{domain}/api/chat/websites -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3774         "type": "json"
3775       }
3776     ],
3777     "name": "CreateWebsites",
3778     "group": "Chat_Websites",
3779     "parameter": {
3780       "fields": {
3781         "Body": [
3782           {
3783             "group": "Body",
3784             "type": "String",
3785             "optional": false,
3786             "field": "name",
3787             "description": ""
3788           },
3789           {
3790             "group": "Body",
3791             "type": "String",
3792             "optional": false,
3793             "field": "address",
3794             "description": ""
3795           },
3796           {
3797             "group": "Body",
3798             "type": "String",
3799             "optional": true,
3800             "field": "description",
3801             "description": ""
3802           },
3803           {
3804             "group": "Body",
3805             "type": "String",
3806             "optional": true,
3807             "field": "mapKey",
3808             "description": ""
3809           },
3810           {
3811             "group": "Body",
3812             "type": "String",
3813             "optional": true,
3814             "field": "mapKeyOffline",
3815             "description": ""
3816           },
3817           {
3818             "group": "Body",
3819             "type": "String",
3820             "optional": false,
3821             "field": "key",
3822             "description": ""
3823           },
3824           {
3825             "group": "Body",
3826             "type": "String",
3827             "optional": true,
3828             "field": "agentAlias",
3829             "description": ""
3830           },
3831           {
3832             "group": "Body",
3833             "type": "String",
3834             "optional": true,
3835             "field": "customerAlias",
3836             "description": ""
3837           },
3838           {
3839             "group": "Body",
3840             "type": "String",
3841             "optional": false,
3842             "field": "color",
3843             "description": ""
3844           },
3845           {
3846             "group": "Body",
3847             "type": "String",
3848             "optional": false,
3849             "field": "color_button",
3850             "description": ""
3851           },
3852           {
3853             "group": "Body",
3854             "type": "String",
3855             "optional": false,
3856             "field": "textColor",
3857             "description": ""
3858           },
3859           {
3860             "group": "Body",
3861             "type": "Integer",
3862             "optional": true,
3863             "field": "fontSize",
3864             "description": ""
3865           },
3866           {
3867             "group": "Body",
3868             "type": "String",
3869             "optional": true,
3870             "field": "remote",
3871             "description": ""
3872           },
3873           {
3874             "group": "Body",
3875             "type": "Boolean",
3876             "optional": true,
3877             "field": "animation",
3878             "description": ""
3879           },
3880           {
3881             "group": "Body",
3882             "type": "String",
3883             "allowedValues": [
3884               "\"rounded\"",
3885               "\"squared\""
3886             ],
3887             "optional": true,
3888             "field": "header_shape",
3889             "description": ""
3890           },
3891           {
3892             "group": "Body",
3893             "type": "String",
3894             "optional": true,
3895             "field": "header_online",
3896             "description": ""
3897           },
3898           {
3899             "group": "Body",
3900             "type": "String",
3901             "optional": true,
3902             "field": "start_chat_button",
3903             "description": ""
3904           },
3905           {
3906             "group": "Body",
3907             "type": "String",
3908             "optional": true,
3909             "field": "offline_chat_button",
3910             "description": ""
3911           },
3912           {
3913             "group": "Body",
3914             "type": "String",
3915             "optional": true,
3916             "field": "header_offline",
3917             "description": ""
3918           },
3919           {
3920             "group": "Body",
3921             "type": "Boolean",
3922             "optional": true,
3923             "field": "download_transcript",
3924             "description": ""
3925           },
3926           {
3927             "group": "Body",
3928             "type": "Integer",
3929             "optional": true,
3930             "field": "timeout",
3931             "description": ""
3932           },
3933           {
3934             "group": "Body",
3935             "type": "String",
3936             "optional": true,
3937             "field": "whiteLabel",
3938             "description": ""
3939           },
3940           {
3941             "group": "Body",
3942             "type": "Boolean",
3943             "optional": true,
3944             "field": "defaultWhiteLabel",
3945             "description": ""
3946           },
3947           {
3948             "group": "Body",
3949             "type": "Text",
3950             "optional": true,
3951             "field": "sitepic",
3952             "description": ""
3953           },
3954           {
3955             "group": "Body",
3956             "type": "String",
3957             "optional": true,
3958             "field": "closingQuestion",
3959             "description": ""
3960           },
3961           {
3962             "group": "Body",
3963             "type": "String",
3964             "optional": true,
3965             "field": "formSubmitSuccessMessage",
3966             "description": ""
3967           },
3968           {
3969             "group": "Body",
3970             "type": "String",
3971             "optional": true,
3972             "field": "formSubmitFailureMessage",
3973             "description": ""
3974           },
3975           {
3976             "group": "Body",
3977             "type": "String",
3978             "optional": true,
3979             "field": "noteTitle",
3980             "description": ""
3981           },
3982           {
3983             "group": "Body",
3984             "type": "String",
3985             "optional": true,
3986             "field": "placeholderMessage",
3987             "description": ""
3988           },
3989           {
3990             "group": "Body",
3991             "type": "String",
3992             "optional": true,
3993             "field": "closingMessage",
3994             "description": ""
3995           },
3996           {
3997             "group": "Body",
3998             "type": "String",
3999             "optional": true,
4000             "field": "closingMessageButton",
4001             "description": ""
4002           },
4003           {
4004             "group": "Body",
4005             "type": "String",
4006             "optional": true,
4007             "field": "skipMessageButton",
4008             "description": ""
4009           },
4010           {
4011             "group": "Body",
4012             "type": "Boolean",
4013             "optional": true,
4014             "field": "conditionAgreement",
4015             "description": ""
4016           },
4017           {
4018             "group": "Body",
4019             "type": "Boolean",
4020             "optional": true,
4021             "field": "enableRating",
4022             "description": ""
4023           },
4024           {
4025             "group": "Body",
4026             "type": "Boolean",
4027             "optional": true,
4028             "field": "enableFeedback",
4029             "description": ""
4030           },
4031           {
4032             "group": "Body",
4033             "type": "Boolean",
4034             "optional": true,
4035             "field": "enableSendButton",
4036             "description": ""
4037           },
4038           {
4039             "group": "Body",
4040             "type": "String",
4041             "optional": true,
4042             "field": "feedbackTitle",
4043             "description": ""
4044           },
4045           {
4046             "group": "Body",
4047             "type": "String",
4048             "allowedValues": [
4049               "\"star\"",
4050               "\"thumb\""
4051             ],
4052             "optional": true,
4053             "field": "ratingType",
4054             "description": ""
4055           },
4056           {
4057             "group": "Body",
4058             "type": "Integer",
4059             "optional": true,
4060             "field": "ratingStarsNumber",
4061             "description": ""
4062           },
4063           {
4064             "group": "Body",
4065             "type": "Text",
4066             "optional": true,
4067             "field": "onlineForm",
4068             "description": ""
4069           },
4070           {
4071             "group": "Body",
4072             "type": "Text",
4073             "optional": true,
4074             "field": "offlineForm",
4075             "description": ""
4076           },
4077           {
4078             "group": "Body",
4079             "type": "String",
4080             "optional": true,
4081             "field": "token",
4082             "description": ""
4083           },
4084           {
4085             "group": "Body",
4086             "type": "Boolean",
4087             "optional": true,
4088             "field": "autoclose",
4089             "description": ""
4090           },
4091           {
4092             "group": "Body",
4093             "type": "Boolean",
4094             "optional": true,
4095             "field": "enableCustomerWriting",
4096             "description": ""
4097           },
4098           {
4099             "group": "Body",
4100             "type": "Boolean",
4101             "optional": true,
4102             "field": "forwardTranscript",
4103             "description": ""
4104           },
4105           {
4106             "group": "Body",
4107             "type": "String",
4108             "optional": true,
4109             "field": "forwardTranscriptMessage",
4110             "description": ""
4111           },
4112           {
4113             "group": "Body",
4114             "type": "Boolean",
4115             "optional": true,
4116             "field": "forwardOffline",
4117             "description": ""
4118           },
4119           {
4120             "group": "Body",
4121             "type": "String",
4122             "optional": true,
4123             "field": "forwardOfflineAddress",
4124             "description": ""
4125           },
4126           {
4127             "group": "Body",
4128             "type": "String",
4129             "optional": true,
4130             "field": "waitingTitle",
4131             "description": ""
4132           },
4133           {
4134             "group": "Body",
4135             "type": "String",
4136             "optional": true,
4137             "field": "waitingMessage",
4138             "description": ""
4139           },
4140           {
4141             "group": "Body",
4142             "type": "String",
4143             "optional": true,
4144             "field": "offlineMessageSubject",
4145             "description": ""
4146           },
4147           {
4148             "group": "Body",
4149             "type": "String",
4150             "optional": true,
4151             "field": "offlineMessageBody",
4152             "description": ""
4153           },
4154           {
4155             "group": "Body",
4156             "type": "Boolean",
4157             "optional": true,
4158             "field": "enableUnmanagedNote",
4159             "description": ""
4160           },
4161           {
4162             "group": "Body",
4163             "type": "String",
4164             "optional": true,
4165             "field": "unmanagedMessage",
4166             "description": ""
4167           },
4168           {
4169             "group": "Body",
4170             "type": "String",
4171             "optional": true,
4172             "field": "skipUnmanaged",
4173             "description": ""
4174           },
4175           {
4176             "group": "Body",
4177             "type": "String",
4178             "optional": true,
4179             "field": "sendUnmanaged",
4180             "description": ""
4181           },
4182           {
4183             "group": "Body",
4184             "type": "Boolean",
4185             "optional": true,
4186             "field": "enableCustomerAttachment",
4187             "description": ""
4188           },
4189           {
4190             "group": "Body",
4191             "type": "Boolean",
4192             "optional": true,
4193             "field": "enableCustomerCheckmarks",
4194             "description": ""
4195           },
4196           {
4197             "group": "Body",
4198             "type": "Text",
4199             "optional": true,
4200             "field": "agentAvatar",
4201             "description": ""
4202           },
4203           {
4204             "group": "Body",
4205             "type": "Boolean",
4206             "optional": true,
4207             "field": "showAgentAvatar",
4208             "description": ""
4209           },
4210           {
4211             "group": "Body",
4212             "type": "String",
4213             "optional": true,
4214             "field": "timezone",
4215             "description": ""
4216           },
4217           {
4218             "group": "Body",
4219             "type": "Text",
4220             "optional": true,
4221             "field": "notificationTemplate",
4222             "description": ""
4223           },
4224           {
4225             "group": "Body",
4226             "type": "Boolean",
4227             "optional": true,
4228             "field": "notificationSound",
4229             "description": ""
4230           },
4231           {
4232             "group": "Body",
4233             "type": "Boolean",
4234             "optional": true,
4235             "field": "notificationShake",
4236             "description": ""
4237           },
4238           {
4239             "group": "Body",
4240             "type": "Boolean",
4241             "optional": true,
4242             "field": "hideWhenOffline",
4243             "description": ""
4244           },
4245           {
4246             "group": "Body",
4247             "type": "String",
4248             "optional": true,
4249             "field": "agentIdentifier",
4250             "description": ""
4251           },
4252           {
4253             "group": "Body",
4254             "type": "Integer",
4255             "optional": true,
4256             "field": "waitForTheAssignedAgent",
4257             "description": ""
4258           },
4259           {
4260             "group": "Body",
4261             "type": "String",
4262             "optional": true,
4263             "field": "alignment",
4264             "description": ""
4265           },
4266           {
4267             "group": "Body",
4268             "type": "Integer",
4269             "optional": true,
4270             "field": "verticalAlignment",
4271             "description": ""
4272           },
4273           {
4274             "group": "Body",
4275             "type": "String",
4276             "optional": true,
4277             "field": "messagesAlignment",
4278             "description": ""
4279           },
4280           {
4281             "group": "Body",
4282             "type": "String",
4283             "optional": true,
4284             "field": "defaultTitle",
4285             "description": ""
4286           },
4287           {
4288             "group": "Body",
4289             "type": "Text",
4290             "optional": true,
4291             "field": "customerAvatar",
4292             "description": ""
4293           },
4294           {
4295             "group": "Body",
4296             "type": "Boolean",
4297             "optional": true,
4298             "field": "showCustomerAvatar",
4299             "description": ""
4300           },
4301           {
4302             "group": "Body",
4303             "type": "Integer",
4304             "optional": true,
4305             "field": "messageFontSize",
4306             "description": ""
4307           },
4308           {
4309             "group": "Body",
4310             "type": "String",
4311             "optional": false,
4312             "field": "backgroundColor",
4313             "description": ""
4314           },
4315           {
4316             "group": "Body",
4317             "type": "Boolean",
4318             "optional": true,
4319             "field": "queueTransfer",
4320             "description": ""
4321           },
4322           {
4323             "group": "Body",
4324             "type": "Integer",
4325             "optional": true,
4326             "field": "queueTransferTimeout",
4327             "description": ""
4328           },
4329           {
4330             "group": "Body",
4331             "type": "Boolean",
4332             "optional": true,
4333             "field": "agentTransfer",
4334             "description": ""
4335           },
4336           {
4337             "group": "Body",
4338             "type": "Integer",
4339             "optional": true,
4340             "field": "agentTransferTimeout",
4341             "description": ""
4342           },
4343           {
4344             "group": "Body",
4345             "type": "String",
4346             "optional": true,
4347             "field": "systemAlias",
4348             "description": ""
4349           },
4350           {
4351             "group": "Body",
4352             "type": "Text",
4353             "optional": true,
4354             "field": "systemAvatar",
4355             "description": ""
4356           },
4357           {
4358             "group": "Body",
4359             "type": "Integer",
4360             "optional": true,
4361             "field": "mandatoryDispositionPauseId",
4362             "description": "<p>Status to put when mandatory disposition is enabled</p>"
4363           },
4364           {
4365             "group": "Body",
4366             "type": "Boolean",
4367             "optional": true,
4368             "field": "mandatoryDisposition",
4369             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
4370           },
4371           {
4372             "group": "Body",
4373             "type": "Boolean",
4374             "optional": true,
4375             "field": "vidaooEscalation",
4376             "description": ""
4377           },
4378           {
4379             "group": "Body",
4380             "type": "String",
4381             "optional": true,
4382             "field": "vidaooApiKey",
4383             "description": ""
4384           }
4385         ]
4386       }
4387     },
4388     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4389     "version": "0.0.0",
4390     "filename": "server/api/chatWebsite/index.js",
4391     "groupTitle": "Chat_Websites"
4392   },
4393   {
4394     "type": "delete",
4395     "url": "/api/chat/websites/{id}",
4396     "title": "Deletes a Website",
4397     "examples": [
4398       {
4399         "title": "Example usage:",
4400         "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password} -X DELETE",
4401         "type": "json"
4402       }
4403     ],
4404     "name": "DeleteWebsites",
4405     "group": "Chat_Websites",
4406     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4407     "version": "0.0.0",
4408     "filename": "server/api/chatWebsite/index.js",
4409     "groupTitle": "Chat_Websites"
4410   },
4411   {
4412     "type": "get",
4413     "url": "/api/chat/websites/describe",
4414     "title": "Gets table info about Websites",
4415     "examples": [
4416       {
4417         "title": "Example usage:",
4418         "content": "curl https://{domain}/api/chat/websites/describe -v -u {name}:{password}",
4419         "type": "json"
4420       }
4421     ],
4422     "name": "DescribeWebsites",
4423     "group": "Chat_Websites",
4424     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4425     "version": "0.0.0",
4426     "filename": "server/api/chatWebsite/index.js",
4427     "groupTitle": "Chat_Websites"
4428   },
4429   {
4430     "type": "get",
4431     "url": "/api/chat/websites/{id}/users",
4432     "title": "Gets agents from website",
4433     "examples": [
4434       {
4435         "title": "Example usage:",
4436         "content": "curl https://{domain}/api/chat/websites/{id}/users -v -u {name}:{password} -X GET",
4437         "type": "json"
4438       }
4439     ],
4440     "name": "GetAgents",
4441     "group": "Chat_Websites",
4442     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4443     "version": "0.0.0",
4444     "filename": "server/api/chatWebsite/index.js",
4445     "groupTitle": "Chat_Websites"
4446   },
4447   {
4448     "type": "get",
4449     "url": "/api/chat/websites",
4450     "title": "Gets a list of Websites",
4451     "examples": [
4452       {
4453         "title": "Example usage:",
4454         "content": "curl https://{domain}/api/chat/websites -v -u {name}:{password}",
4455         "type": "json"
4456       }
4457     ],
4458     "name": "GetWebsites",
4459     "group": "Chat_Websites",
4460     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
4461     "version": "0.0.0",
4462     "filename": "server/api/chatWebsite/index.js",
4463     "groupTitle": "Chat_Websites"
4464   },
4465   {
4466     "type": "delete",
4467     "url": "/api/chat/websites/{id}/users",
4468     "title": "Removes agents from a website",
4469     "examples": [
4470       {
4471         "title": "Example usage:",
4472         "content": "curl https://{domain}/api/chat/websites/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4473         "type": "json"
4474       }
4475     ],
4476     "name": "RemoveAgents",
4477     "group": "Chat_Websites",
4478     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4479     "version": "0.0.0",
4480     "filename": "server/api/chatWebsite/index.js",
4481     "groupTitle": "Chat_Websites"
4482   },
4483   {
4484     "type": "delete",
4485     "url": "/api/chat/websites/{id}/canned_answers",
4486     "title": "Removes canned answers from account",
4487     "examples": [
4488       {
4489         "title": "Example usage:",
4490         "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4491         "type": "json"
4492       }
4493     ],
4494     "name": "RemoveAnswers",
4495     "group": "Chat_Websites",
4496     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4497     "version": "0.0.0",
4498     "filename": "server/api/chatWebsite/index.js",
4499     "groupTitle": "Chat_Websites"
4500   },
4501   {
4502     "type": "delete",
4503     "url": "/api/chat/websites/{id}/dispositions",
4504     "title": "Removes canned answers from account",
4505     "examples": [
4506       {
4507         "title": "Example usage:",
4508         "content": "curl https://{domain}/api/chat/websites/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4509         "type": "json"
4510       }
4511     ],
4512     "name": "RemoveDispositions",
4513     "group": "Chat_Websites",
4514     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4515     "version": "0.0.0",
4516     "filename": "server/api/chatWebsite/index.js",
4517     "groupTitle": "Chat_Websites"
4518   },
4519   {
4520     "type": "get",
4521     "url": "/api/chat/websites/{id}",
4522     "title": "Gets a single Website",
4523     "examples": [
4524       {
4525         "title": "Example usage:",
4526         "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password}",
4527         "type": "json"
4528       }
4529     ],
4530     "name": "ShowWebsites",
4531     "group": "Chat_Websites",
4532     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4533     "version": "0.0.0",
4534     "filename": "server/api/chatWebsite/index.js",
4535     "groupTitle": "Chat_Websites"
4536   },
4537   {
4538     "type": "put",
4539     "url": "/api/chat/messages/{id}/accept",
4540     "title": "Accepts message",
4541     "examples": [
4542       {
4543         "title": "Example usage:",
4544         "content": "curl https://{domain}/api/chat/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
4545         "type": "json"
4546       }
4547     ],
4548     "name": "acceptMessage",
4549     "group": "Chat_Websites",
4550     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4551     "version": "0.0.0",
4552     "filename": "server/api/chatMessage/index.js",
4553     "groupTitle": "Chat_Websites"
4554   },
4555   {
4556     "type": "post",
4557     "url": "/api/chat/websites/{id}/canned_answers",
4558     "title": "Creates new canned answer",
4559     "examples": [
4560       {
4561         "title": "Example usage:",
4562         "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",
4563         "type": "json"
4564       }
4565     ],
4566     "name": "addAnswer",
4567     "group": "Chat_Websites",
4568     "parameter": {
4569       "fields": {
4570         "Body": [
4571           {
4572             "group": "Body",
4573             "type": "String",
4574             "optional": false,
4575             "field": "key",
4576             "description": ""
4577           },
4578           {
4579             "group": "Body",
4580             "type": "Text",
4581             "optional": false,
4582             "field": "value",
4583             "description": ""
4584           },
4585           {
4586             "group": "Body",
4587             "type": "String",
4588             "optional": true,
4589             "field": "description",
4590             "description": ""
4591           },
4592           {
4593             "group": "Body",
4594             "type": "Virtual",
4595             "optional": true,
4596             "field": "name",
4597             "description": ""
4598           }
4599         ]
4600       }
4601     },
4602     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4603     "version": "0.0.0",
4604     "filename": "server/api/chatWebsite/index.js",
4605     "groupTitle": "Chat_Websites"
4606   },
4607   {
4608     "type": "post",
4609     "url": "/api/chat/websites/{id}/applications",
4610     "title": "Creates new applications",
4611     "examples": [
4612       {
4613         "title": "Example usage:",
4614         "content": "curl https://{domain}/api/chat/websites/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4615         "type": "json"
4616       }
4617     ],
4618     "name": "addApplications",
4619     "group": "Chat_Websites",
4620     "parameter": {
4621       "fields": {
4622         "Body": [
4623           {
4624             "group": "Body",
4625             "type": "Integer",
4626             "optional": false,
4627             "field": "priority",
4628             "description": ""
4629           },
4630           {
4631             "group": "Body",
4632             "type": "String",
4633             "optional": false,
4634             "field": "app",
4635             "description": ""
4636           },
4637           {
4638             "group": "Body",
4639             "type": "Text",
4640             "optional": true,
4641             "field": "appdata",
4642             "description": ""
4643           },
4644           {
4645             "group": "Body",
4646             "type": "String",
4647             "optional": true,
4648             "field": "description",
4649             "description": ""
4650           },
4651           {
4652             "group": "Body",
4653             "type": "String",
4654             "optional": true,
4655             "field": "interval",
4656             "description": ""
4657           }
4658         ]
4659       }
4660     },
4661     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4662     "version": "0.0.0",
4663     "filename": "server/api/chatWebsite/index.js",
4664     "groupTitle": "Chat_Websites"
4665   },
4666   {
4667     "type": "post",
4668     "url": "/api/chat/websites/{id}/avatar",
4669     "title": "Add avatar",
4670     "examples": [
4671       {
4672         "title": "Example usage:",
4673         "content": "curl https://{domain}/api/chat/websites/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
4674         "type": "json"
4675       }
4676     ],
4677     "name": "addAvatar",
4678     "group": "Chat_Websites",
4679     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4680     "version": "0.0.0",
4681     "filename": "server/api/chatWebsite/index.js",
4682     "groupTitle": "Chat_Websites"
4683   },
4684   {
4685     "type": "post",
4686     "url": "/api/chat/websites/{id}/customer_avatar",
4687     "title": "Add customer avatar",
4688     "examples": [
4689       {
4690         "title": "Example usage:",
4691         "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",
4692         "type": "json"
4693       }
4694     ],
4695     "name": "addCustomerAvatar",
4696     "group": "Chat_Websites",
4697     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4698     "version": "0.0.0",
4699     "filename": "server/api/chatWebsite/index.js",
4700     "groupTitle": "Chat_Websites"
4701   },
4702   {
4703     "type": "post",
4704     "url": "/api/chat/websites/{id}/dispositions",
4705     "title": "Creates new disposition",
4706     "examples": [
4707       {
4708         "title": "Example usage:",
4709         "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4710         "type": "json"
4711       }
4712     ],
4713     "name": "addDisposition",
4714     "group": "Chat_Websites",
4715     "parameter": {
4716       "fields": {
4717         "Body": [
4718           {
4719             "group": "Body",
4720             "type": "String",
4721             "optional": false,
4722             "field": "name",
4723             "description": ""
4724           },
4725           {
4726             "group": "Body",
4727             "type": "String",
4728             "allowedValues": [
4729               "\"first\"",
4730               "\"second\"",
4731               "\"third\""
4732             ],
4733             "optional": false,
4734             "field": "level",
4735             "description": ""
4736           },
4737           {
4738             "group": "Body",
4739             "type": "String",
4740             "optional": true,
4741             "field": "description",
4742             "description": ""
4743           }
4744         ]
4745       }
4746     },
4747     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4748     "version": "0.0.0",
4749     "filename": "server/api/chatWebsite/index.js",
4750     "groupTitle": "Chat_Websites"
4751   },
4752   {
4753     "type": "post",
4754     "url": "/api/chat/accounts/{id}/interactions",
4755     "title": "Creates new interactions",
4756     "examples": [
4757       {
4758         "title": "Example usage:",
4759         "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",
4760         "type": "json"
4761       }
4762     ],
4763     "name": "addInteraction",
4764     "group": "Chat_Websites",
4765     "parameter": {
4766       "fields": {
4767         "Body": [
4768           {
4769             "group": "Body",
4770             "type": "Boolean",
4771             "optional": true,
4772             "field": "closed",
4773             "description": ""
4774           },
4775           {
4776             "group": "Body",
4777             "type": "Integer",
4778             "optional": true,
4779             "field": "ratingValue",
4780             "description": ""
4781           },
4782           {
4783             "group": "Body",
4784             "type": "String",
4785             "allowedValues": [
4786               "\"star\"",
4787               "\"thumb\""
4788             ],
4789             "optional": true,
4790             "field": "ratingType",
4791             "description": ""
4792           },
4793           {
4794             "group": "Body",
4795             "type": "Text",
4796             "optional": true,
4797             "field": "ratingMessage",
4798             "description": ""
4799           },
4800           {
4801             "group": "Body",
4802             "type": "Text",
4803             "optional": true,
4804             "field": "pathTranscript",
4805             "description": ""
4806           },
4807           {
4808             "group": "Body",
4809             "type": "String",
4810             "optional": true,
4811             "field": "mailTranscript",
4812             "description": ""
4813           },
4814           {
4815             "group": "Body",
4816             "type": "String",
4817             "optional": true,
4818             "field": "closedAt",
4819             "description": ""
4820           },
4821           {
4822             "group": "Body",
4823             "type": "String",
4824             "optional": true,
4825             "field": "disposition",
4826             "description": ""
4827           },
4828           {
4829             "group": "Body",
4830             "type": "String",
4831             "optional": true,
4832             "field": "secondDisposition",
4833             "description": ""
4834           },
4835           {
4836             "group": "Body",
4837             "type": "String",
4838             "optional": true,
4839             "field": "thirdDisposition",
4840             "description": ""
4841           },
4842           {
4843             "group": "Body",
4844             "type": "String",
4845             "optional": true,
4846             "field": "note",
4847             "description": ""
4848           },
4849           {
4850             "group": "Body",
4851             "type": "String",
4852             "optional": true,
4853             "field": "browserName",
4854             "description": ""
4855           },
4856           {
4857             "group": "Body",
4858             "type": "String",
4859             "optional": true,
4860             "field": "browserVersion",
4861             "description": ""
4862           },
4863           {
4864             "group": "Body",
4865             "type": "String",
4866             "optional": true,
4867             "field": "osName",
4868             "description": ""
4869           },
4870           {
4871             "group": "Body",
4872             "type": "String",
4873             "optional": true,
4874             "field": "osVersion",
4875             "description": ""
4876           },
4877           {
4878             "group": "Body",
4879             "type": "String",
4880             "optional": true,
4881             "field": "deviceModel",
4882             "description": ""
4883           },
4884           {
4885             "group": "Body",
4886             "type": "String",
4887             "optional": true,
4888             "field": "deviceVendor",
4889             "description": ""
4890           },
4891           {
4892             "group": "Body",
4893             "type": "String",
4894             "optional": true,
4895             "field": "deviceType",
4896             "description": ""
4897           },
4898           {
4899             "group": "Body",
4900             "type": "Text",
4901             "optional": true,
4902             "field": "referer",
4903             "description": ""
4904           },
4905           {
4906             "group": "Body",
4907             "type": "String",
4908             "optional": true,
4909             "field": "customerIp",
4910             "description": ""
4911           },
4912           {
4913             "group": "Body",
4914             "type": "Text",
4915             "optional": true,
4916             "field": "formData",
4917             "description": ""
4918           },
4919           {
4920             "group": "Body",
4921             "type": "String",
4922             "optional": true,
4923             "field": "read1stAt",
4924             "description": ""
4925           },
4926           {
4927             "group": "Body",
4928             "type": "String",
4929             "optional": true,
4930             "field": "lastMsgAt",
4931             "description": ""
4932           },
4933           {
4934             "group": "Body",
4935             "type": "String",
4936             "allowedValues": [
4937               "\"in\"",
4938               "\"out\""
4939             ],
4940             "optional": false,
4941             "field": "lastMsgDirection",
4942             "description": ""
4943           },
4944           {
4945             "group": "Body",
4946             "type": "String",
4947             "optional": true,
4948             "field": "closeReason",
4949             "description": ""
4950           },
4951           {
4952             "group": "Body",
4953             "type": "String",
4954             "optional": true,
4955             "field": "customerPort",
4956             "description": ""
4957           },
4958           {
4959             "group": "Body",
4960             "type": "Text",
4961             "optional": true,
4962             "field": "vidaooSessionId",
4963             "description": ""
4964           }
4965         ]
4966       }
4967     },
4968     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4969     "version": "0.0.0",
4970     "filename": "server/api/chatWebsite/index.js",
4971     "groupTitle": "Chat_Websites"
4972   },
4973   {
4974     "type": "post",
4975     "url": "/api/chat/websites/{id}/logo",
4976     "title": "Add logo",
4977     "examples": [
4978       {
4979         "title": "Example usage:",
4980         "content": "curl https://{domain}/api/chat/websites/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
4981         "type": "json"
4982       }
4983     ],
4984     "name": "addLogo",
4985     "group": "Chat_Websites",
4986     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4987     "version": "0.0.0",
4988     "filename": "server/api/chatWebsite/index.js",
4989     "groupTitle": "Chat_Websites"
4990   },
4991   {
4992     "type": "post",
4993     "url": "/api/chat/websites/{id}/proactive_actions",
4994     "title": "Creates new Proactive Actions",
4995     "examples": [
4996       {
4997         "title": "Example usage:",
4998         "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",
4999         "type": "json"
5000       }
5001     ],
5002     "name": "addProactiveActions",
5003     "group": "Chat_Websites",
5004     "parameter": {
5005       "fields": {
5006         "Body": [
5007           {
5008             "group": "Body",
5009             "type": "String",
5010             "optional": false,
5011             "field": "name",
5012             "description": ""
5013           },
5014           {
5015             "group": "Body",
5016             "type": "String",
5017             "allowedValues": [
5018               "\"mouseOver\"",
5019               "\"timeout\""
5020             ],
5021             "optional": true,
5022             "field": "type",
5023             "description": ""
5024           },
5025           {
5026             "group": "Body",
5027             "type": "String",
5028             "optional": true,
5029             "field": "selector",
5030             "description": ""
5031           },
5032           {
5033             "group": "Body",
5034             "type": "Integer",
5035             "optional": true,
5036             "field": "timeout",
5037             "description": ""
5038           }
5039         ]
5040       }
5041     },
5042     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5043     "version": "0.0.0",
5044     "filename": "server/api/chatWebsite/index.js",
5045     "groupTitle": "Chat_Websites"
5046   },
5047   {
5048     "type": "post",
5049     "url": "/api/chat/websites/{id}/system_avatar",
5050     "title": "Add system avatar",
5051     "examples": [
5052       {
5053         "title": "Example usage:",
5054         "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",
5055         "type": "json"
5056       }
5057     ],
5058     "name": "addSystemAvatar",
5059     "group": "Chat_Websites",
5060     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5061     "version": "0.0.0",
5062     "filename": "server/api/chatWebsite/index.js",
5063     "groupTitle": "Chat_Websites"
5064   },
5065   {
5066     "type": "get",
5067     "url": "/api/chat/websites/{id}/canned_answers",
5068     "title": "Gets account canned answers",
5069     "examples": [
5070       {
5071         "title": "Example usage:",
5072         "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers -v -u {name}:{password} -X GET",
5073         "type": "json"
5074       }
5075     ],
5076     "name": "getAnswers",
5077     "group": "Chat_Websites",
5078     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5079     "version": "0.0.0",
5080     "filename": "server/api/chatWebsite/index.js",
5081     "groupTitle": "Chat_Websites"
5082   },
5083   {
5084     "type": "get",
5085     "url": "/api/chat/websites/{id}/applications",
5086     "title": "Gets Website Applications",
5087     "examples": [
5088       {
5089         "title": "Example usage:",
5090         "content": "curl https://{domain}/api/chat/websites/{id}/applications -v -u {name}:{password} -X GET",
5091         "type": "json"
5092       }
5093     ],
5094     "name": "getApplications",
5095     "group": "Chat_Websites",
5096     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5097     "version": "0.0.0",
5098     "filename": "server/api/chatWebsite/index.js",
5099     "groupTitle": "Chat_Websites"
5100   },
5101   {
5102     "type": "get",
5103     "url": "/api/chat/websites/{id}/avatar",
5104     "title": "Get avatar",
5105     "examples": [
5106       {
5107         "title": "Example usage:",
5108         "content": "curl https://{domain}/api/chat/websites/{id}/avatar -v -u {name}:{password} -X GET",
5109         "type": "json"
5110       }
5111     ],
5112     "name": "getAvatar",
5113     "group": "Chat_Websites",
5114     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5115     "version": "0.0.0",
5116     "filename": "server/api/chatWebsite/index.js",
5117     "groupTitle": "Chat_Websites"
5118   },
5119   {
5120     "type": "get",
5121     "url": "/api/chat/websites/{id}/customer_avatar",
5122     "title": "Get Customer Avatar",
5123     "examples": [
5124       {
5125         "title": "Example usage:",
5126         "content": "curl https://{domain}/api/chat/websites/{id}/customer_avatar -v -u {name}:{password} -X GET",
5127         "type": "json"
5128       }
5129     ],
5130     "name": "getCustomerAvatar",
5131     "group": "Chat_Websites",
5132     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5133     "version": "0.0.0",
5134     "filename": "server/api/chatWebsite/index.js",
5135     "groupTitle": "Chat_Websites"
5136   },
5137   {
5138     "type": "get",
5139     "url": "/api/chat/websites/{id}/dispositions",
5140     "title": "Gets account dispositions",
5141     "examples": [
5142       {
5143         "title": "Example usage:",
5144         "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -v -u {name}:{password} -X GET",
5145         "type": "json"
5146       }
5147     ],
5148     "name": "getDispositions",
5149     "group": "Chat_Websites",
5150     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5151     "version": "0.0.0",
5152     "filename": "server/api/chatWebsite/index.js",
5153     "groupTitle": "Chat_Websites"
5154   },
5155   {
5156     "type": "get",
5157     "url": "/api/chat/websites/{id}/fields",
5158     "title": "Gets Website Fields",
5159     "examples": [
5160       {
5161         "title": "Example usage:",
5162         "content": "curl https://{domain}/api/chat/websites/{id}/fields -v -u {name}:{password} -X GET",
5163         "type": "json"
5164       }
5165     ],
5166     "name": "getFields",
5167     "group": "Chat_Websites",
5168     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5169     "version": "0.0.0",
5170     "filename": "server/api/chatWebsite/index.js",
5171     "groupTitle": "Chat_Websites"
5172   },
5173   {
5174     "type": "get",
5175     "url": "/api/chat/websites/{id}/interactions",
5176     "title": "Gets Website Interactions",
5177     "examples": [
5178       {
5179         "title": "Example usage:",
5180         "content": "curl https://{domain}/api/chat/websites/{id}/interactions -v -u {name}:{password} -X GET",
5181         "type": "json"
5182       }
5183     ],
5184     "name": "getInteraction",
5185     "group": "Chat_Websites",
5186     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5187     "version": "0.0.0",
5188     "filename": "server/api/chatWebsite/index.js",
5189     "groupTitle": "Chat_Websites"
5190   },
5191   {
5192     "type": "get",
5193     "url": "/api/chat/websites/{id}/logo",
5194     "title": "Get logo",
5195     "examples": [
5196       {
5197         "title": "Example usage:",
5198         "content": "curl https://{domain}/api/chat/websites/{id}/logo -v -u {name}:{password} -X GET",
5199         "type": "json"
5200       }
5201     ],
5202     "name": "getLogo",
5203     "group": "Chat_Websites",
5204     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5205     "version": "0.0.0",
5206     "filename": "server/api/chatWebsite/index.js",
5207     "groupTitle": "Chat_Websites"
5208   },
5209   {
5210     "type": "get",
5211     "url": "/api/chat/websites/{id}/offline_messages",
5212     "title": "Gets Website Offline Messages",
5213     "examples": [
5214       {
5215         "title": "Example usage:",
5216         "content": "curl https://{domain}/api/chat/websites/{id}/offline_messages -v -u {name}:{password} -X GET",
5217         "type": "json"
5218       }
5219     ],
5220     "name": "getOfflineMessages",
5221     "group": "Chat_Websites",
5222     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5223     "version": "0.0.0",
5224     "filename": "server/api/chatWebsite/index.js",
5225     "groupTitle": "Chat_Websites"
5226   },
5227   {
5228     "type": "get",
5229     "url": "/api/chat/websites/{id}/proactive_actions",
5230     "title": "Gets Website Proactive Actions",
5231     "examples": [
5232       {
5233         "title": "Example usage:",
5234         "content": "curl https://{domain}/api/chat/websites/{id}/proactive_actions -v -u {name}:{password} -X GET",
5235         "type": "json"
5236       }
5237     ],
5238     "name": "getProactiveActions",
5239     "group": "Chat_Websites",
5240     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5241     "version": "0.0.0",
5242     "filename": "server/api/chatWebsite/index.js",
5243     "groupTitle": "Chat_Websites"
5244   },
5245   {
5246     "type": "get",
5247     "url": "/api/chat/websites/{id}/snippet",
5248     "title": "Gets Website Snippet",
5249     "examples": [
5250       {
5251         "title": "Example usage:",
5252         "content": "curl https://{domain}/api/chat/websites/{id}/snippet -v -u {name}:{password} -X GET",
5253         "type": "json"
5254       }
5255     ],
5256     "name": "getSnippet",
5257     "group": "Chat_Websites",
5258     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5259     "version": "0.0.0",
5260     "filename": "server/api/chatWebsite/index.js",
5261     "groupTitle": "Chat_Websites"
5262   },
5263   {
5264     "type": "get",
5265     "url": "/api/chat/websites/{id}/system_avatar",
5266     "title": "Get System Avatar",
5267     "examples": [
5268       {
5269         "title": "Example usage:",
5270         "content": "curl https://{domain}/api/chat/websites/{id}/system_avatar -v -u {name}:{password} -X GET",
5271         "type": "json"
5272       }
5273     ],
5274     "name": "getSystemAvatar",
5275     "group": "Chat_Websites",
5276     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5277     "version": "0.0.0",
5278     "filename": "server/api/chatWebsite/index.js",
5279     "groupTitle": "Chat_Websites"
5280   },
5281   {
5282     "type": "post",
5283     "url": "/api/chat/websites/{id}/notify",
5284     "title": "Notify new message",
5285     "examples": [
5286       {
5287         "title": "Example usage:",
5288         "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",
5289         "type": "json"
5290       }
5291     ],
5292     "name": "notify",
5293     "group": "Chat_Websites",
5294     "description": "<p>Motion 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>",
5295     "version": "0.0.0",
5296     "filename": "server/api/chatWebsite/index.js",
5297     "groupTitle": "Chat_Websites"
5298   },
5299   {
5300     "type": "post",
5301     "url": "/api/chat/websites/{id}/offline",
5302     "title": "Offline message",
5303     "examples": [
5304       {
5305         "title": "Example usage:",
5306         "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",
5307         "type": "json"
5308       }
5309     ],
5310     "name": "offline",
5311     "group": "Chat_Websites",
5312     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5313     "version": "0.0.0",
5314     "filename": "server/api/chatWebsite/index.js",
5315     "groupTitle": "Chat_Websites"
5316   },
5317   {
5318     "type": "put",
5319     "url": "/api/chat/messages/{id}/reject",
5320     "title": "Rejects message",
5321     "examples": [
5322       {
5323         "title": "Example usage:",
5324         "content": "curl https://{domain}/api/chat/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
5325         "type": "json"
5326       }
5327     ],
5328     "name": "rejectMessage",
5329     "group": "Chat_Websites",
5330     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5331     "version": "0.0.0",
5332     "filename": "server/api/chatMessage/index.js",
5333     "groupTitle": "Chat_Websites"
5334   },
5335   {
5336     "type": "put",
5337     "url": "/api/chat/websites/{id}",
5338     "title": "Update an existing Website",
5339     "examples": [
5340       {
5341         "title": "Example usage:",
5342         "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",
5343         "type": "json"
5344       }
5345     ],
5346     "name": "updateWebsites",
5347     "group": "Chat_Websites",
5348     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5349     "version": "0.0.0",
5350     "filename": "server/api/chatWebsite/index.js",
5351     "groupTitle": "Chat_Websites"
5352   },
5353   {
5354     "type": "post",
5355     "url": "/api/cloudProviders",
5356     "title": "Creates a new CloudProvider",
5357     "examples": [
5358       {
5359         "title": "Example usage:",
5360         "content": "curl https://{domain}/api/cloudProviders -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5361         "type": "json"
5362       }
5363     ],
5364     "name": "CreateCloudProviders",
5365     "group": "CloudProviders",
5366     "parameter": {
5367       "fields": {
5368         "Body": [
5369           {
5370             "group": "Body",
5371             "type": "String",
5372             "optional": false,
5373             "field": "name",
5374             "description": ""
5375           },
5376           {
5377             "group": "Body",
5378             "type": "String",
5379             "allowedValues": [
5380               "\"AmazonAWS\"",
5381               "\"Google\""
5382             ],
5383             "optional": false,
5384             "field": "service",
5385             "description": ""
5386           },
5387           {
5388             "group": "Body",
5389             "type": "String",
5390             "optional": true,
5391             "field": "data1",
5392             "description": ""
5393           },
5394           {
5395             "group": "Body",
5396             "type": "String",
5397             "optional": true,
5398             "field": "data2",
5399             "description": ""
5400           }
5401         ]
5402       }
5403     },
5404     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5405     "version": "0.0.0",
5406     "filename": "server/api/cloudProvider/index.js",
5407     "groupTitle": "CloudProviders"
5408   },
5409   {
5410     "type": "delete",
5411     "url": "/api/cloudProviders/{id}",
5412     "title": "Deletes a CloudProvider",
5413     "examples": [
5414       {
5415         "title": "Example usage:",
5416         "content": "curl https://{domain}/api/cloudProviders/{id} -v -u {name}:{password} -X DELETE",
5417         "type": "json"
5418       }
5419     ],
5420     "name": "DeleteCloudProviders",
5421     "group": "CloudProviders",
5422     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5423     "version": "0.0.0",
5424     "filename": "server/api/cloudProvider/index.js",
5425     "groupTitle": "CloudProviders"
5426   },
5427   {
5428     "type": "get",
5429     "url": "/api/cloudProviders",
5430     "title": "Gets a list of CloudProviders",
5431     "examples": [
5432       {
5433         "title": "Example usage:",
5434         "content": "curl https://{domain}/api/cloudProviders -v -u {name}:{password}",
5435         "type": "json"
5436       }
5437     ],
5438     "name": "GetCloudProviders",
5439     "group": "CloudProviders",
5440     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
5441     "version": "0.0.0",
5442     "filename": "server/api/cloudProvider/index.js",
5443     "groupTitle": "CloudProviders"
5444   },
5445   {
5446     "type": "get",
5447     "url": "/api/cloudProviders/{id}",
5448     "title": "Gets a single CloudProvider",
5449     "examples": [
5450       {
5451         "title": "Example usage:",
5452         "content": "curl https://{domain}/api/cloudProviders/{id} -v -u {name}:{password}",
5453         "type": "json"
5454       }
5455     ],
5456     "name": "ShowCloudProviders",
5457     "group": "CloudProviders",
5458     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5459     "version": "0.0.0",
5460     "filename": "server/api/cloudProvider/index.js",
5461     "groupTitle": "CloudProviders"
5462   },
5463   {
5464     "type": "put",
5465     "url": "/api/cloudProviders/{id}",
5466     "title": "Update an existing CloudProvider",
5467     "examples": [
5468       {
5469         "title": "Example usage:",
5470         "content": "curl https://{domain}/api/cloudProviders/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
5471         "type": "json"
5472       }
5473     ],
5474     "name": "updateCloudProviders",
5475     "group": "CloudProviders",
5476     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5477     "version": "0.0.0",
5478     "filename": "server/api/cloudProvider/index.js",
5479     "groupTitle": "CloudProviders"
5480   },
5481   {
5482     "type": "post",
5483     "url": "/api/cm/companies",
5484     "title": "Creates a new Company",
5485     "examples": [
5486       {
5487         "title": "Example usage:",
5488         "content": "curl https://{domain}/api/cm/companies -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5489         "type": "json"
5490       }
5491     ],
5492     "name": "CreateCompanies",
5493     "group": "Cm_Companies",
5494     "parameter": {
5495       "fields": {
5496         "Body": [
5497           {
5498             "group": "Body",
5499             "type": "String",
5500             "optional": false,
5501             "field": "name",
5502             "description": ""
5503           },
5504           {
5505             "group": "Body",
5506             "type": "String",
5507             "optional": true,
5508             "field": "vat",
5509             "description": ""
5510           },
5511           {
5512             "group": "Body",
5513             "type": "String",
5514             "optional": true,
5515             "field": "companyId",
5516             "description": ""
5517           },
5518           {
5519             "group": "Body",
5520             "type": "String",
5521             "optional": true,
5522             "field": "website",
5523             "description": ""
5524           },
5525           {
5526             "group": "Body",
5527             "type": "String",
5528             "optional": true,
5529             "field": "phone",
5530             "description": ""
5531           },
5532           {
5533             "group": "Body",
5534             "type": "String",
5535             "optional": true,
5536             "field": "fax",
5537             "description": ""
5538           },
5539           {
5540             "group": "Body",
5541             "type": "String",
5542             "optional": true,
5543             "field": "type",
5544             "description": ""
5545           },
5546           {
5547             "group": "Body",
5548             "type": "String",
5549             "optional": true,
5550             "field": "street",
5551             "description": ""
5552           },
5553           {
5554             "group": "Body",
5555             "type": "String",
5556             "optional": true,
5557             "field": "postalCode",
5558             "description": ""
5559           },
5560           {
5561             "group": "Body",
5562             "type": "String",
5563             "optional": true,
5564             "field": "city",
5565             "description": ""
5566           },
5567           {
5568             "group": "Body",
5569             "type": "String",
5570             "optional": true,
5571             "field": "country",
5572             "description": ""
5573           },
5574           {
5575             "group": "Body",
5576             "type": "String",
5577             "optional": true,
5578             "field": "email",
5579             "description": ""
5580           },
5581           {
5582             "group": "Body",
5583             "type": "String",
5584             "optional": true,
5585             "field": "emailDomain",
5586             "description": ""
5587           },
5588           {
5589             "group": "Body",
5590             "type": "String",
5591             "optional": true,
5592             "field": "sStreet",
5593             "description": ""
5594           },
5595           {
5596             "group": "Body",
5597             "type": "String",
5598             "optional": true,
5599             "field": "sPostalCode",
5600             "description": ""
5601           },
5602           {
5603             "group": "Body",
5604             "type": "String",
5605             "optional": true,
5606             "field": "sCity",
5607             "description": ""
5608           },
5609           {
5610             "group": "Body",
5611             "type": "String",
5612             "optional": true,
5613             "field": "sCountry",
5614             "description": ""
5615           },
5616           {
5617             "group": "Body",
5618             "type": "String",
5619             "optional": true,
5620             "field": "description",
5621             "description": ""
5622           }
5623         ]
5624       }
5625     },
5626     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5627     "version": "0.0.0",
5628     "filename": "server/api/cmCompany/index.js",
5629     "groupTitle": "Cm_Companies"
5630   },
5631   {
5632     "type": "delete",
5633     "url": "/api/cm/companies/{id}",
5634     "title": "Deletes a Company",
5635     "examples": [
5636       {
5637         "title": "Example usage:",
5638         "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password} -X DELETE",
5639         "type": "json"
5640       }
5641     ],
5642     "name": "DeleteCompanies",
5643     "group": "Cm_Companies",
5644     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5645     "version": "0.0.0",
5646     "filename": "server/api/cmCompany/index.js",
5647     "groupTitle": "Cm_Companies"
5648   },
5649   {
5650     "type": "get",
5651     "url": "/api/cm/companies/describe",
5652     "title": "Gets table info about Companies",
5653     "examples": [
5654       {
5655         "title": "Example usage:",
5656         "content": "curl https://{domain}/api/cm/companies/describe -v -u {name}:{password}",
5657         "type": "json"
5658       }
5659     ],
5660     "name": "DescribeCompanies",
5661     "group": "Cm_Companies",
5662     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5663     "version": "0.0.0",
5664     "filename": "server/api/cmCompany/index.js",
5665     "groupTitle": "Cm_Companies"
5666   },
5667   {
5668     "type": "get",
5669     "url": "/api/cm/companies",
5670     "title": "Gets a list of Companies",
5671     "examples": [
5672       {
5673         "title": "Example usage:",
5674         "content": "curl https://{domain}/api/cm/companies -v -u {name}:{password}",
5675         "type": "json"
5676       }
5677     ],
5678     "name": "GetCompanies",
5679     "group": "Cm_Companies",
5680     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
5681     "version": "0.0.0",
5682     "filename": "server/api/cmCompany/index.js",
5683     "groupTitle": "Cm_Companies"
5684   },
5685   {
5686     "type": "get",
5687     "url": "/api/cm/companies/{id}",
5688     "title": "Gets a single Company",
5689     "examples": [
5690       {
5691         "title": "Example usage:",
5692         "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password}",
5693         "type": "json"
5694       }
5695     ],
5696     "name": "ShowCompanies",
5697     "group": "Cm_Companies",
5698     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5699     "version": "0.0.0",
5700     "filename": "server/api/cmCompany/index.js",
5701     "groupTitle": "Cm_Companies"
5702   },
5703   {
5704     "type": "post",
5705     "url": "/api/cm/companies/{id}/contacts",
5706     "title": "Creates new contacts",
5707     "examples": [
5708       {
5709         "title": "Example usage:",
5710         "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",
5711         "type": "json"
5712       }
5713     ],
5714     "name": "addContacts",
5715     "group": "Cm_Companies",
5716     "parameter": {
5717       "fields": {
5718         "Body": [
5719           {
5720             "group": "Body",
5721             "type": "String",
5722             "optional": false,
5723             "field": "firstName",
5724             "description": ""
5725           },
5726           {
5727             "group": "Body",
5728             "type": "String",
5729             "optional": true,
5730             "field": "lastName",
5731             "description": ""
5732           },
5733           {
5734             "group": "Body",
5735             "type": "String",
5736             "optional": true,
5737             "field": "street",
5738             "description": ""
5739           },
5740           {
5741             "group": "Body",
5742             "type": "String",
5743             "optional": true,
5744             "field": "postalCode",
5745             "description": ""
5746           },
5747           {
5748             "group": "Body",
5749             "type": "String",
5750             "optional": true,
5751             "field": "city",
5752             "description": ""
5753           },
5754           {
5755             "group": "Body",
5756             "type": "String",
5757             "optional": true,
5758             "field": "country",
5759             "description": ""
5760           },
5761           {
5762             "group": "Body",
5763             "type": "String",
5764             "optional": true,
5765             "field": "dateOfBirth",
5766             "description": ""
5767           },
5768           {
5769             "group": "Body",
5770             "type": "Text",
5771             "optional": true,
5772             "field": "description",
5773             "description": ""
5774           },
5775           {
5776             "group": "Body",
5777             "type": "String",
5778             "optional": true,
5779             "field": "phone",
5780             "description": ""
5781           },
5782           {
5783             "group": "Body",
5784             "type": "String",
5785             "optional": true,
5786             "field": "mobile",
5787             "description": ""
5788           },
5789           {
5790             "group": "Body",
5791             "type": "String",
5792             "optional": true,
5793             "field": "fax",
5794             "description": ""
5795           },
5796           {
5797             "group": "Body",
5798             "type": "String",
5799             "optional": true,
5800             "field": "email",
5801             "description": ""
5802           },
5803           {
5804             "group": "Body",
5805             "type": "String",
5806             "optional": true,
5807             "field": "url",
5808             "description": ""
5809           },
5810           {
5811             "group": "Body",
5812             "type": "String",
5813             "optional": true,
5814             "field": "facebook",
5815             "description": ""
5816           },
5817           {
5818             "group": "Body",
5819             "type": "String",
5820             "optional": true,
5821             "field": "fb_data",
5822             "description": ""
5823           },
5824           {
5825             "group": "Body",
5826             "type": "String",
5827             "optional": true,
5828             "field": "twitter",
5829             "description": ""
5830           },
5831           {
5832             "group": "Body",
5833             "type": "String",
5834             "optional": true,
5835             "field": "skype",
5836             "description": ""
5837           },
5838           {
5839             "group": "Body",
5840             "type": "String",
5841             "optional": true,
5842             "field": "teams",
5843             "description": ""
5844           },
5845           {
5846             "group": "Body",
5847             "type": "String",
5848             "optional": true,
5849             "field": "viber",
5850             "description": ""
5851           },
5852           {
5853             "group": "Body",
5854             "type": "String",
5855             "optional": true,
5856             "field": "line",
5857             "description": ""
5858           },
5859           {
5860             "group": "Body",
5861             "type": "String",
5862             "optional": true,
5863             "field": "wechat",
5864             "description": ""
5865           },
5866           {
5867             "group": "Body",
5868             "type": "String",
5869             "optional": true,
5870             "field": "telegram",
5871             "description": ""
5872           },
5873           {
5874             "group": "Body",
5875             "type": "Integer",
5876             "optional": true,
5877             "field": "UserId",
5878             "description": ""
5879           },
5880           {
5881             "group": "Body",
5882             "type": "Integer",
5883             "optional": true,
5884             "field": "priority",
5885             "description": ""
5886           },
5887           {
5888             "group": "Body",
5889             "type": "String",
5890             "optional": true,
5891             "field": "scheduledat",
5892             "description": ""
5893           }
5894         ]
5895       }
5896     },
5897     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5898     "version": "0.0.0",
5899     "filename": "server/api/cmCompany/index.js",
5900     "groupTitle": "Cm_Companies"
5901   },
5902   {
5903     "type": "get",
5904     "url": "/api/cm/companies/{id}/contacts",
5905     "title": "Gets List Contacts",
5906     "examples": [
5907       {
5908         "title": "Example usage:",
5909         "content": "curl https://{domain}/api/fax/companies/{id}/contacts -v -u {name}:{password} -X GET",
5910         "type": "json"
5911       }
5912     ],
5913     "name": "getContacts",
5914     "group": "Cm_Companies",
5915     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5916     "version": "0.0.0",
5917     "filename": "server/api/cmCompany/index.js",
5918     "groupTitle": "Cm_Companies"
5919   },
5920   {
5921     "type": "put",
5922     "url": "/api/cm/companies/{id}",
5923     "title": "Update an existing Company",
5924     "examples": [
5925       {
5926         "title": "Example usage:",
5927         "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",
5928         "type": "json"
5929       }
5930     ],
5931     "name": "updateCompanies",
5932     "group": "Cm_Companies",
5933     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5934     "version": "0.0.0",
5935     "filename": "server/api/cmCompany/index.js",
5936     "groupTitle": "Cm_Companies"
5937   },
5938   {
5939     "type": "delete",
5940     "url": "/api/cm/contacts/{id}",
5941     "title": "Deletes a Contact",
5942     "examples": [
5943       {
5944         "title": "Example usage:",
5945         "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X DELETE",
5946         "type": "json"
5947       }
5948     ],
5949     "name": "DeleteContacts",
5950     "group": "Cm_Contacts",
5951     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5952     "version": "0.0.0",
5953     "filename": "server/api/cmContact/index.js",
5954     "groupTitle": "Cm_Contacts"
5955   },
5956   {
5957     "type": "get",
5958     "url": "/api/cm/contacts/describe",
5959     "title": "Gets table info about Contacts",
5960     "examples": [
5961       {
5962         "title": "Example usage:",
5963         "content": "curl https://{domain}/api/cm/contacts/describe -v -u {name}:{password}",
5964         "type": "json"
5965       }
5966     ],
5967     "name": "DescribeContacts",
5968     "group": "Cm_Contacts",
5969     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5970     "version": "0.0.0",
5971     "filename": "server/api/cmContact/index.js",
5972     "groupTitle": "Cm_Contacts"
5973   },
5974   {
5975     "type": "get",
5976     "url": "/api/cm/contacts",
5977     "title": "Gets a list of Contacts",
5978     "examples": [
5979       {
5980         "title": "Example usage:",
5981         "content": "curl https://{domain}/api/cm/contacts -v -u {name}:{password}",
5982         "type": "json"
5983       }
5984     ],
5985     "name": "GetContacts",
5986     "group": "Cm_Contacts",
5987     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
5988     "version": "0.0.0",
5989     "filename": "server/api/cmContact/index.js",
5990     "groupTitle": "Cm_Contacts"
5991   },
5992   {
5993     "type": "get",
5994     "url": "/api/cm/contacts/{id}/finals",
5995     "title": "Gets contact hopper finals",
5996     "examples": [
5997       {
5998         "title": "Example usage:",
5999         "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_finals -v -u {name}:{password}  -X GET",
6000         "type": "json"
6001       }
6002     ],
6003     "name": "GetHopperFinals",
6004     "group": "Cm_Contacts",
6005     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6006     "version": "0.0.0",
6007     "filename": "server/api/cmContact/index.js",
6008     "groupTitle": "Cm_Contacts"
6009   },
6010   {
6011     "type": "get",
6012     "url": "/api/cm/contacts/{id}/hopper_histories",
6013     "title": "Gets contact hopper histories",
6014     "examples": [
6015       {
6016         "title": "Example usage:",
6017         "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_histories -v -u {name}:{password} -X GET",
6018         "type": "json"
6019       }
6020     ],
6021     "name": "GetHopperHistories",
6022     "group": "Cm_Contacts",
6023     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6024     "version": "0.0.0",
6025     "filename": "server/api/cmContact/index.js",
6026     "groupTitle": "Cm_Contacts"
6027   },
6028   {
6029     "type": "get",
6030     "url": "/api/cm/contacts/{id}/hoppers",
6031     "title": "Gets contact hoppers",
6032     "examples": [
6033       {
6034         "title": "Example usage:",
6035         "content": "curl https://{domain}/api/cm/contacts/{id}/hoppers -v -u {name}:{password} -X GET",
6036         "type": "json"
6037       }
6038     ],
6039     "name": "GetHoppers",
6040     "group": "Cm_Contacts",
6041     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6042     "version": "0.0.0",
6043     "filename": "server/api/cmContact/index.js",
6044     "groupTitle": "Cm_Contacts"
6045   },
6046   {
6047     "type": "post",
6048     "url": "/api/cm/contacts/create_many",
6049     "title": "Create Contacts",
6050     "examples": [
6051       {
6052         "title": "Example usage:",
6053         "content": "curl https://{domain}/api/cm/contacts/create_many -d '[{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",
6054         "type": "json"
6055       }
6056     ],
6057     "name": "bulkCreate",
6058     "group": "Cm_Contacts",
6059     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6060     "version": "0.0.0",
6061     "filename": "server/api/cmContact/index.js",
6062     "groupTitle": "Cm_Contacts"
6063   },
6064   {
6065     "type": "post",
6066     "url": "/api/cm/contacts",
6067     "title": "Create Contact",
6068     "examples": [
6069       {
6070         "title": "Example usage:",
6071         "content": "curl https://{domain}/api/cm/contacts -d '{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}' -v -u {name}:{password} -X POST",
6072         "type": "json"
6073       }
6074     ],
6075     "name": "create",
6076     "group": "Cm_Contacts",
6077     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6078     "version": "0.0.0",
6079     "filename": "server/api/cmContact/index.js",
6080     "groupTitle": "Cm_Contacts"
6081   },
6082   {
6083     "type": "get",
6084     "url": "/api/cm/contacts/{id}/journey",
6085     "title": "Gets customer journey",
6086     "examples": [
6087       {
6088         "title": "Example usage:",
6089         "content": "curl https://{domain}/api/cm/contacts/{id}/journey -v -u {name}:{password}  -X GET",
6090         "type": "json"
6091       }
6092     ],
6093     "name": "getJourney",
6094     "group": "Cm_Contacts",
6095     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6096     "version": "0.0.0",
6097     "filename": "server/api/cmContact/index.js",
6098     "groupTitle": "Cm_Contacts"
6099   },
6100   {
6101     "type": "get",
6102     "url": "/api/cm/contacts/{id}/jscripty_sessions",
6103     "title": "Gets contact hopper blacks",
6104     "examples": [
6105       {
6106         "title": "Example usage:",
6107         "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_black -v -u {name}:{password}  -X GET",
6108         "type": "json"
6109       }
6110     ],
6111     "name": "getJscriptySessions",
6112     "group": "Cm_Contacts",
6113     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6114     "version": "0.0.0",
6115     "filename": "server/api/cmContact/index.js",
6116     "groupTitle": "Cm_Contacts"
6117   },
6118   {
6119     "type": "get",
6120     "url": "/api/cm/contacts/{id}/tags",
6121     "title": "Gets configurations tags",
6122     "examples": [
6123       {
6124         "title": "Example usage:",
6125         "content": "curl https://{domain}/api/cm/contacts/{id}/tags -v -u {name}:{password} -X GET",
6126         "type": "json"
6127       }
6128     ],
6129     "name": "getTags",
6130     "group": "Cm_Contacts",
6131     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6132     "version": "0.0.0",
6133     "filename": "server/api/cmContact/index.js",
6134     "groupTitle": "Cm_Contacts"
6135   },
6136   {
6137     "type": "post",
6138     "url": "/api/cm/contacts/merge",
6139     "title": "Merge Contact",
6140     "examples": [
6141       {
6142         "title": "Example usage:",
6143         "content": "curl https://{domain}/api/cm/contacts/merge -d '{\"from\": 1, \"to\": 2}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6144         "type": "json"
6145       }
6146     ],
6147     "name": "merge",
6148     "group": "Cm_Contacts",
6149     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6150     "version": "0.0.0",
6151     "filename": "server/api/cmContact/index.js",
6152     "groupTitle": "Cm_Contacts"
6153   },
6154   {
6155     "type": "post",
6156     "url": "/api/cm/contacts/{id}/tags",
6157     "title": "Sets new tags",
6158     "examples": [
6159       {
6160         "title": "Example usage:",
6161         "content": "curl https://{domain}/api/cm/contacts/{id}/tags -d '{\"ids\": [1,12]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6162         "type": "json"
6163       }
6164     ],
6165     "name": "setTags",
6166     "group": "Cm_Contacts",
6167     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6168     "version": "0.0.0",
6169     "filename": "server/api/cmContact/index.js",
6170     "groupTitle": "Cm_Contacts"
6171   },
6172   {
6173     "type": "get",
6174     "url": "/api/cm/contacts/{id}",
6175     "title": "Gets a single Contact",
6176     "examples": [
6177       {
6178         "title": "Example usage:",
6179         "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X GET",
6180         "type": "json"
6181       }
6182     ],
6183     "name": "show",
6184     "group": "Cm_Contacts",
6185     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6186     "version": "0.0.0",
6187     "filename": "server/api/cmContact/index.js",
6188     "groupTitle": "Cm_Contacts"
6189   },
6190   {
6191     "type": "put",
6192     "url": "/api/cm/contacts/{id}",
6193     "title": "Update a single Contact",
6194     "examples": [
6195       {
6196         "title": "Example usage:",
6197         "content": "curl https://{domain}/api/cm/contacts/{id} -d '{\"firstName\": \"John\", \"lastName\": \"Doe\"}' -v -u {name}:{password} -X PUT",
6198         "type": "json"
6199       }
6200     ],
6201     "name": "update",
6202     "group": "Cm_Contacts",
6203     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6204     "version": "0.0.0",
6205     "filename": "server/api/cmContact/index.js",
6206     "groupTitle": "Cm_Contacts"
6207   },
6208   {
6209     "type": "delete",
6210     "url": "/api/cm/custom_fields/{id}",
6211     "title": "Deletes a Custom Field",
6212     "examples": [
6213       {
6214         "title": "Example usage:",
6215         "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password} -X DELETE",
6216         "type": "json"
6217       }
6218     ],
6219     "name": "DeleteCustom_Fields",
6220     "group": "Cm_Custom_Fields",
6221     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6222     "version": "0.0.0",
6223     "filename": "server/api/cmCustomField/index.js",
6224     "groupTitle": "Cm_Custom_Fields"
6225   },
6226   {
6227     "type": "get",
6228     "url": "/api/cm/custom_fields",
6229     "title": "Gets a list of Custom Fields",
6230     "examples": [
6231       {
6232         "title": "Example usage:",
6233         "content": "curl https://{domain}/api/cm/custom_fields -v -u {name}:{password}",
6234         "type": "json"
6235       }
6236     ],
6237     "name": "GetCustom_Fields",
6238     "group": "Cm_Custom_Fields",
6239     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6240     "version": "0.0.0",
6241     "filename": "server/api/cmCustomField/index.js",
6242     "groupTitle": "Cm_Custom_Fields"
6243   },
6244   {
6245     "type": "get",
6246     "url": "/api/cm/custom_fields/{id}",
6247     "title": "Gets a single Custom Field",
6248     "examples": [
6249       {
6250         "title": "Example usage:",
6251         "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password}",
6252         "type": "json"
6253       }
6254     ],
6255     "name": "ShowCustom_Fields",
6256     "group": "Cm_Custom_Fields",
6257     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6258     "version": "0.0.0",
6259     "filename": "server/api/cmCustomField/index.js",
6260     "groupTitle": "Cm_Custom_Fields"
6261   },
6262   {
6263     "type": "put",
6264     "url": "/api/cm/custom_fields/{id}",
6265     "title": "Update an existing Custom Field",
6266     "examples": [
6267       {
6268         "title": "Example usage:",
6269         "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",
6270         "type": "json"
6271       }
6272     ],
6273     "name": "updateCustom_Fields",
6274     "group": "Cm_Custom_Fields",
6275     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6276     "version": "0.0.0",
6277     "filename": "server/api/cmCustomField/index.js",
6278     "groupTitle": "Cm_Custom_Fields"
6279   },
6280   {
6281     "type": "post",
6282     "url": "/api/cm/hopper",
6283     "title": "Creates a new Hopper",
6284     "examples": [
6285       {
6286         "title": "Example usage:",
6287         "content": "curl https://{domain}/api/cm/hopper -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
6288         "type": "json"
6289       }
6290     ],
6291     "name": "CreateHopper",
6292     "group": "Cm_Hopper",
6293     "parameter": {
6294       "fields": {
6295         "Body": [
6296           {
6297             "group": "Body",
6298             "type": "String",
6299             "optional": false,
6300             "field": "phone",
6301             "description": ""
6302           },
6303           {
6304             "group": "Body",
6305             "type": "Boolean",
6306             "optional": true,
6307             "field": "active",
6308             "description": ""
6309           },
6310           {
6311             "group": "Body",
6312             "type": "String",
6313             "optional": true,
6314             "field": "scheduledat",
6315             "description": ""
6316           },
6317           {
6318             "group": "Body",
6319             "type": "Integer",
6320             "optional": true,
6321             "field": "countbusyretry",
6322             "description": ""
6323           },
6324           {
6325             "group": "Body",
6326             "type": "Integer",
6327             "optional": true,
6328             "field": "countcongestionretry",
6329             "description": ""
6330           },
6331           {
6332             "group": "Body",
6333             "type": "Integer",
6334             "optional": true,
6335             "field": "countnoanswerretry",
6336             "description": ""
6337           },
6338           {
6339             "group": "Body",
6340             "type": "Boolean",
6341             "optional": true,
6342             "field": "callback",
6343             "description": ""
6344           },
6345           {
6346             "group": "Body",
6347             "type": "String",
6348             "optional": true,
6349             "field": "callbackuniqueid",
6350             "description": ""
6351           },
6352           {
6353             "group": "Body",
6354             "type": "String",
6355             "optional": true,
6356             "field": "callbackat",
6357             "description": ""
6358           },
6359           {
6360             "group": "Body",
6361             "type": "Integer",
6362             "optional": true,
6363             "field": "priority",
6364             "description": ""
6365           },
6366           {
6367             "group": "Body",
6368             "type": "Boolean",
6369             "optional": true,
6370             "field": "recallme",
6371             "description": ""
6372           },
6373           {
6374             "group": "Body",
6375             "type": "Integer",
6376             "optional": true,
6377             "field": "ContactId",
6378             "description": ""
6379           },
6380           {
6381             "group": "Body",
6382             "type": "Integer",
6383             "optional": true,
6384             "field": "ListId",
6385             "description": ""
6386           },
6387           {
6388             "group": "Body",
6389             "type": "Integer",
6390             "optional": true,
6391             "field": "UserId",
6392             "description": ""
6393           },
6394           {
6395             "group": "Body",
6396             "type": "Integer",
6397             "optional": true,
6398             "field": "VoiceQueueId",
6399             "description": ""
6400           },
6401           {
6402             "group": "Body",
6403             "type": "Integer",
6404             "optional": true,
6405             "field": "CampaignId",
6406             "description": ""
6407           },
6408           {
6409             "group": "Body",
6410             "type": "Integer",
6411             "optional": true,
6412             "field": "countnosuchnumberretry",
6413             "description": ""
6414           },
6415           {
6416             "group": "Body",
6417             "type": "Integer",
6418             "optional": true,
6419             "field": "countdropretry",
6420             "description": ""
6421           },
6422           {
6423             "group": "Body",
6424             "type": "Integer",
6425             "optional": true,
6426             "field": "countabandonedretry",
6427             "description": ""
6428           },
6429           {
6430             "group": "Body",
6431             "type": "Integer",
6432             "optional": true,
6433             "field": "countmachineretry",
6434             "description": ""
6435           },
6436           {
6437             "group": "Body",
6438             "type": "Integer",
6439             "optional": true,
6440             "field": "countagentrejectretry",
6441             "description": ""
6442           }
6443         ]
6444       }
6445     },
6446     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6447     "version": "0.0.0",
6448     "filename": "server/api/cmHopper/index.js",
6449     "groupTitle": "Cm_Hopper"
6450   },
6451   {
6452     "type": "get",
6453     "url": "/api/cm/hopper/describe",
6454     "title": "Gets table info about Hopper",
6455     "examples": [
6456       {
6457         "title": "Example usage:",
6458         "content": "curl https://{domain}/api/cm/hopper/describe -v -u {name}:{password}",
6459         "type": "json"
6460       }
6461     ],
6462     "name": "DescribeHopper",
6463     "group": "Cm_Hopper",
6464     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6465     "version": "0.0.0",
6466     "filename": "server/api/cmHopper/index.js",
6467     "groupTitle": "Cm_Hopper"
6468   },
6469   {
6470     "type": "get",
6471     "url": "/api/cm/hopper",
6472     "title": "Gets a list of Hopper",
6473     "examples": [
6474       {
6475         "title": "Example usage:",
6476         "content": "curl https://{domain}/api/cm/hopper -v -u {name}:{password}",
6477         "type": "json"
6478       }
6479     ],
6480     "name": "GetHopper",
6481     "group": "Cm_Hopper",
6482     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6483     "version": "0.0.0",
6484     "filename": "server/api/cmHopper/index.js",
6485     "groupTitle": "Cm_Hopper"
6486   },
6487   {
6488     "type": "get",
6489     "url": "/api/cm/hopper/{id}",
6490     "title": "Gets a single Hopper",
6491     "examples": [
6492       {
6493         "title": "Example usage:",
6494         "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password}",
6495         "type": "json"
6496       }
6497     ],
6498     "name": "ShowHopper",
6499     "group": "Cm_Hopper",
6500     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6501     "version": "0.0.0",
6502     "filename": "server/api/cmHopper/index.js",
6503     "groupTitle": "Cm_Hopper"
6504   },
6505   {
6506     "type": "delete",
6507     "url": "/api/cm/hopper_black/{id}",
6508     "title": "Deletes a Hopper Black",
6509     "examples": [
6510       {
6511         "title": "Example usage:",
6512         "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password} -X DELETE",
6513         "type": "json"
6514       }
6515     ],
6516     "name": "DeleteHopper_Black",
6517     "group": "Cm_Hopper_Black",
6518     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6519     "version": "0.0.0",
6520     "filename": "server/api/cmHopperBlack/index.js",
6521     "groupTitle": "Cm_Hopper_Black"
6522   },
6523   {
6524     "type": "get",
6525     "url": "/api/cm/hopper_black/describe",
6526     "title": "Gets table info about Hopper Black",
6527     "examples": [
6528       {
6529         "title": "Example usage:",
6530         "content": "curl https://{domain}/api/cm/hopper_black/describe -v -u {name}:{password}",
6531         "type": "json"
6532       }
6533     ],
6534     "name": "DescribeHopper_Black",
6535     "group": "Cm_Hopper_Black",
6536     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6537     "version": "0.0.0",
6538     "filename": "server/api/cmHopperBlack/index.js",
6539     "groupTitle": "Cm_Hopper_Black"
6540   },
6541   {
6542     "type": "get",
6543     "url": "/api/cm/hopper_black",
6544     "title": "Gets a list of Hopper Black",
6545     "examples": [
6546       {
6547         "title": "Example usage:",
6548         "content": "curl https://{domain}/api/cm/hopper_black -v -u {name}:{password}",
6549         "type": "json"
6550       }
6551     ],
6552     "name": "GetHopper_Black",
6553     "group": "Cm_Hopper_Black",
6554     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6555     "version": "0.0.0",
6556     "filename": "server/api/cmHopperBlack/index.js",
6557     "groupTitle": "Cm_Hopper_Black"
6558   },
6559   {
6560     "type": "get",
6561     "url": "/api/cm/hopper_black/{id}",
6562     "title": "Gets a single Hopper Black",
6563     "examples": [
6564       {
6565         "title": "Example usage:",
6566         "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password}",
6567         "type": "json"
6568       }
6569     ],
6570     "name": "ShowHopper_Black",
6571     "group": "Cm_Hopper_Black",
6572     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6573     "version": "0.0.0",
6574     "filename": "server/api/cmHopperBlack/index.js",
6575     "groupTitle": "Cm_Hopper_Black"
6576   },
6577   {
6578     "type": "put",
6579     "url": "/api/cm/hopper_black/{id}",
6580     "title": "Update an existing Hopper Black",
6581     "examples": [
6582       {
6583         "title": "Example usage:",
6584         "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",
6585         "type": "json"
6586       }
6587     ],
6588     "name": "updateHopper_Black",
6589     "group": "Cm_Hopper_Black",
6590     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6591     "version": "0.0.0",
6592     "filename": "server/api/cmHopperBlack/index.js",
6593     "groupTitle": "Cm_Hopper_Black"
6594   },
6595   {
6596     "type": "post",
6597     "url": "/api/cm/hopper_final/checkContactHopper",
6598     "title": "Check if contact is in hopper",
6599     "examples": [
6600       {
6601         "title": "Example usage:",
6602         "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",
6603         "type": "json"
6604       }
6605     ],
6606     "name": "/checkContactHopper",
6607     "group": "Cm_Hopper_Final",
6608     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6609     "version": "0.0.0",
6610     "filename": "server/api/cmHopperFinal/index.js",
6611     "groupTitle": "Cm_Hopper_Final"
6612   },
6613   {
6614     "type": "get",
6615     "url": "/api/cm/hopper_final/describe",
6616     "title": "Gets table info about HopperFinal",
6617     "examples": [
6618       {
6619         "title": "Example usage:",
6620         "content": "curl https://{domain}/api/cm/hopper_final/describe -v -u {name}:{password}",
6621         "type": "json"
6622       }
6623     ],
6624     "name": "DescribeHopperFinal",
6625     "group": "Cm_Hopper_Final",
6626     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6627     "version": "0.0.0",
6628     "filename": "server/api/cmHopperFinal/index.js",
6629     "groupTitle": "Cm_Hopper_Final"
6630   },
6631   {
6632     "type": "get",
6633     "url": "/api/cm/hopper_final",
6634     "title": "Gets a list of HopperFinal",
6635     "examples": [
6636       {
6637         "title": "Example usage:",
6638         "content": "curl https://{domain}/api/cm/hopper_final -v -u {name}:{password}",
6639         "type": "json"
6640       }
6641     ],
6642     "name": "GetHopperFinal",
6643     "group": "Cm_Hopper_Final",
6644     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6645     "version": "0.0.0",
6646     "filename": "server/api/cmHopperFinal/index.js",
6647     "groupTitle": "Cm_Hopper_Final"
6648   },
6649   {
6650     "type": "get",
6651     "url": "/api/cm/hopper_final/{id}",
6652     "title": "Gets a single HopperFinal",
6653     "examples": [
6654       {
6655         "title": "Example usage:",
6656         "content": "curl https://{domain}/api/cm/hopper_final/{id} -v -u {name}:{password}",
6657         "type": "json"
6658       }
6659     ],
6660     "name": "ShowHopperFinal",
6661     "group": "Cm_Hopper_Final",
6662     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6663     "version": "0.0.0",
6664     "filename": "server/api/cmHopperFinal/index.js",
6665     "groupTitle": "Cm_Hopper_Final"
6666   },
6667   {
6668     "type": "get",
6669     "url": "/api/cm/hopper_final/campaign/countAttributes/{id}",
6670     "title": "Return number contacts for attributes",
6671     "examples": [
6672       {
6673         "title": "Example usage:",
6674         "content": "curl https://{domain}/api/hopper_final/campaign/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
6675         "type": "json"
6676       }
6677     ],
6678     "name": "countContactsIvrCampaignHopperFinal",
6679     "group": "Cm_Hopper_Final",
6680     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6681     "version": "0.0.0",
6682     "filename": "server/api/cmHopperFinal/index.js",
6683     "groupTitle": "Cm_Hopper_Final"
6684   },
6685   {
6686     "type": "get",
6687     "url": "/api/cm/hopper_final/voice/queue/countAttributes/{id}",
6688     "title": "Return number contacts for attributes",
6689     "examples": [
6690       {
6691         "title": "Example usage:",
6692         "content": "curl https://{domain}/api/hopper_final/voice/queue/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
6693         "type": "json"
6694       }
6695     ],
6696     "name": "countContactsQueueCampaignHopperFinal",
6697     "group": "Cm_Hopper_Final",
6698     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6699     "version": "0.0.0",
6700     "filename": "server/api/cmHopperFinal/index.js",
6701     "groupTitle": "Cm_Hopper_Final"
6702   },
6703   {
6704     "type": "post",
6705     "url": "/api/cm/hopper_final/campaign/{id}",
6706     "title": "Move contacts in hopper",
6707     "examples": [
6708       {
6709         "title": "Example usage:",
6710         "content": "curl https://{domain}/api/hopper_final/campaign/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6711         "type": "json"
6712       }
6713     ],
6714     "name": "moveContactsIvrCampaignHopperFinal",
6715     "group": "Cm_Hopper_Final",
6716     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6717     "version": "0.0.0",
6718     "filename": "server/api/cmHopperFinal/index.js",
6719     "groupTitle": "Cm_Hopper_Final"
6720   },
6721   {
6722     "type": "post",
6723     "url": "/api/cm/hopper_final/voice/queue/{id}",
6724     "title": "Move contacts in hopper",
6725     "examples": [
6726       {
6727         "title": "Example usage:",
6728         "content": "curl https://{domain}/api/hopper_final/voice/queue/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password}",
6729         "type": "json"
6730       }
6731     ],
6732     "name": "moveContactsQueueCampaignHopperFinal",
6733     "group": "Cm_Hopper_Final",
6734     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6735     "version": "0.0.0",
6736     "filename": "server/api/cmHopperFinal/index.js",
6737     "groupTitle": "Cm_Hopper_Final"
6738   },
6739   {
6740     "type": "put",
6741     "url": "/api/cm/hopper_final/{id}",
6742     "title": "Update a single hopper final",
6743     "examples": [
6744       {
6745         "title": "Example usage:",
6746         "content": "curl https://{domain}/api/hopper_final/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
6747         "type": "json"
6748       }
6749     ],
6750     "name": "update",
6751     "group": "Cm_Hopper_Final",
6752     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6753     "version": "0.0.0",
6754     "filename": "server/api/cmHopperFinal/index.js",
6755     "groupTitle": "Cm_Hopper_Final"
6756   },
6757   {
6758     "type": "post",
6759     "url": "/api/cm/hopper_history",
6760     "title": "Creates a new HopperHistory",
6761     "examples": [
6762       {
6763         "title": "Example usage:",
6764         "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",
6765         "type": "json"
6766       }
6767     ],
6768     "name": "CreateHopperHistory",
6769     "group": "Cm_Hopper_History",
6770     "parameter": {
6771       "fields": {
6772         "Body": [
6773           {
6774             "group": "Body",
6775             "type": "Integer",
6776             "optional": true,
6777             "field": "state",
6778             "description": ""
6779           },
6780           {
6781             "group": "Body",
6782             "type": "String",
6783             "optional": true,
6784             "field": "statedesc",
6785             "description": ""
6786           },
6787           {
6788             "group": "Body",
6789             "type": "String",
6790             "optional": true,
6791             "field": "scheduledat",
6792             "description": ""
6793           },
6794           {
6795             "group": "Body",
6796             "type": "Integer",
6797             "optional": true,
6798             "field": "countbusyretry",
6799             "description": ""
6800           },
6801           {
6802             "group": "Body",
6803             "type": "Integer",
6804             "optional": true,
6805             "field": "countcongestionretry",
6806             "description": ""
6807           },
6808           {
6809             "group": "Body",
6810             "type": "Integer",
6811             "optional": true,
6812             "field": "countnoanswerretry",
6813             "description": ""
6814           },
6815           {
6816             "group": "Body",
6817             "type": "Integer",
6818             "optional": true,
6819             "field": "countglobal",
6820             "description": ""
6821           },
6822           {
6823             "group": "Body",
6824             "type": "String",
6825             "optional": true,
6826             "field": "uniqueid",
6827             "description": ""
6828           },
6829           {
6830             "group": "Body",
6831             "type": "String",
6832             "optional": true,
6833             "field": "originatecalleridnum",
6834             "description": ""
6835           },
6836           {
6837             "group": "Body",
6838             "type": "String",
6839             "optional": true,
6840             "field": "originatecalleridname",
6841             "description": ""
6842           },
6843           {
6844             "group": "Body",
6845             "type": "String",
6846             "optional": true,
6847             "field": "calleridnum",
6848             "description": ""
6849           },
6850           {
6851             "group": "Body",
6852             "type": "String",
6853             "optional": true,
6854             "field": "calleridname",
6855             "description": ""
6856           },
6857           {
6858             "group": "Body",
6859             "type": "String",
6860             "optional": true,
6861             "field": "starttime",
6862             "description": ""
6863           },
6864           {
6865             "group": "Body",
6866             "type": "String",
6867             "optional": true,
6868             "field": "responsetime",
6869             "description": ""
6870           },
6871           {
6872             "group": "Body",
6873             "type": "String",
6874             "optional": true,
6875             "field": "answertime",
6876             "description": ""
6877           },
6878           {
6879             "group": "Body",
6880             "type": "String",
6881             "optional": true,
6882             "field": "droptime",
6883             "description": ""
6884           },
6885           {
6886             "group": "Body",
6887             "type": "String",
6888             "optional": true,
6889             "field": "endtime",
6890             "description": ""
6891           },
6892           {
6893             "group": "Body",
6894             "type": "Integer",
6895             "optional": true,
6896             "field": "ringtime",
6897             "description": ""
6898           },
6899           {
6900             "group": "Body",
6901             "type": "Integer",
6902             "optional": true,
6903             "field": "holdtime",
6904             "description": ""
6905           },
6906           {
6907             "group": "Body",
6908             "type": "Integer",
6909             "optional": true,
6910             "field": "talktime",
6911             "description": ""
6912           },
6913           {
6914             "group": "Body",
6915             "type": "Integer",
6916             "optional": true,
6917             "field": "followuptime",
6918             "description": ""
6919           },
6920           {
6921             "group": "Body",
6922             "type": "String",
6923             "optional": true,
6924             "field": "dropreason",
6925             "description": ""
6926           },
6927           {
6928             "group": "Body",
6929             "type": "String",
6930             "optional": true,
6931             "field": "campaign",
6932             "description": ""
6933           },
6934           {
6935             "group": "Body",
6936             "type": "String",
6937             "optional": true,
6938             "field": "campaigntype",
6939             "description": ""
6940           },
6941           {
6942             "group": "Body",
6943             "type": "String",
6944             "optional": true,
6945             "field": "membername",
6946             "description": ""
6947           },
6948           {
6949             "group": "Body",
6950             "type": "String",
6951             "optional": true,
6952             "field": "reason",
6953             "description": ""
6954           },
6955           {
6956             "group": "Body",
6957             "type": "Boolean",
6958             "optional": true,
6959             "field": "amd",
6960             "description": ""
6961           },
6962           {
6963             "group": "Body",
6964             "type": "Boolean",
6965             "optional": true,
6966             "field": "fax",
6967             "description": ""
6968           },
6969           {
6970             "group": "Body",
6971             "type": "Boolean",
6972             "optional": true,
6973             "field": "callback",
6974             "description": ""
6975           },
6976           {
6977             "group": "Body",
6978             "type": "String",
6979             "optional": true,
6980             "field": "callbackuniqueid",
6981             "description": ""
6982           },
6983           {
6984             "group": "Body",
6985             "type": "String",
6986             "optional": true,
6987             "field": "callbackat",
6988             "description": ""
6989           },
6990           {
6991             "group": "Body",
6992             "type": "Boolean",
6993             "optional": true,
6994             "field": "recallme",
6995             "description": ""
6996           },
6997           {
6998             "group": "Body",
6999             "type": "String",
7000             "optional": true,
7001             "field": "editedat",
7002             "description": ""
7003           },
7004           {
7005             "group": "Body",
7006             "type": "Boolean",
7007             "optional": true,
7008             "field": "edited",
7009             "description": ""
7010           },
7011           {
7012             "group": "Body",
7013             "type": "Integer",
7014             "optional": true,
7015             "field": "countnosuchnumberretry",
7016             "description": ""
7017           },
7018           {
7019             "group": "Body",
7020             "type": "Integer",
7021             "optional": true,
7022             "field": "countdropretry",
7023             "description": ""
7024           },
7025           {
7026             "group": "Body",
7027             "type": "Integer",
7028             "optional": true,
7029             "field": "countabandonedretry",
7030             "description": ""
7031           },
7032           {
7033             "group": "Body",
7034             "type": "Integer",
7035             "optional": true,
7036             "field": "countmachineretry",
7037             "description": ""
7038           },
7039           {
7040             "group": "Body",
7041             "type": "Integer",
7042             "optional": true,
7043             "field": "countagentrejectretry",
7044             "description": ""
7045           }
7046         ]
7047       }
7048     },
7049     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7050     "version": "0.0.0",
7051     "filename": "server/api/cmHopperHistory/index.js",
7052     "groupTitle": "Cm_Hopper_History"
7053   },
7054   {
7055     "type": "get",
7056     "url": "/api/cm/hopper_history/describe",
7057     "title": "Gets table info about HopperHistory",
7058     "examples": [
7059       {
7060         "title": "Example usage:",
7061         "content": "curl https://{domain}/api/cm/hopper_history/describe -v -u {name}:{password}",
7062         "type": "json"
7063       }
7064     ],
7065     "name": "DescribeHopperHistory",
7066     "group": "Cm_Hopper_History",
7067     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7068     "version": "0.0.0",
7069     "filename": "server/api/cmHopperHistory/index.js",
7070     "groupTitle": "Cm_Hopper_History"
7071   },
7072   {
7073     "type": "get",
7074     "url": "/api/cm/hopper_history",
7075     "title": "Gets a list of HopperHistory",
7076     "examples": [
7077       {
7078         "title": "Example usage:",
7079         "content": "curl https://{domain}/api/cm/hopper_history -v -u {name}:{password}",
7080         "type": "json"
7081       }
7082     ],
7083     "name": "GetHopperHistory",
7084     "group": "Cm_Hopper_History",
7085     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
7086     "version": "0.0.0",
7087     "filename": "server/api/cmHopperHistory/index.js",
7088     "groupTitle": "Cm_Hopper_History"
7089   },
7090   {
7091     "type": "get",
7092     "url": "/api/cm/hopper_history/{id}",
7093     "title": "Gets a single HopperHistory",
7094     "examples": [
7095       {
7096         "title": "Example usage:",
7097         "content": "curl https://{domain}/api/cm/hopper_history/{id} -v -u {name}:{password}",
7098         "type": "json"
7099       }
7100     ],
7101     "name": "ShowHopperHistory",
7102     "group": "Cm_Hopper_History",
7103     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7104     "version": "0.0.0",
7105     "filename": "server/api/cmHopperHistory/index.js",
7106     "groupTitle": "Cm_Hopper_History"
7107   },
7108   {
7109     "type": "put",
7110     "url": "/api/cm/hopper_history/{id}",
7111     "title": "Update a single hopper history",
7112     "examples": [
7113       {
7114         "title": "Example usage:",
7115         "content": "curl https://{domain}/api/hopper_history/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
7116         "type": "json"
7117       }
7118     ],
7119     "name": "update",
7120     "group": "Cm_Hopper_History",
7121     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7122     "version": "0.0.0",
7123     "filename": "server/api/cmHopperHistory/index.js",
7124     "groupTitle": "Cm_Hopper_History"
7125   },
7126   {
7127     "type": "delete",
7128     "url": "/api/cm/hopper/{id}",
7129     "title": "Delete Hopper",
7130     "examples": [
7131       {
7132         "title": "Example usage:",
7133         "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password} -X DELETE",
7134         "type": "json"
7135       }
7136     ],
7137     "name": "destroy",
7138     "group": "Cm_Hopper",
7139     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7140     "version": "0.0.0",
7141     "filename": "server/api/cmHopper/index.js",
7142     "groupTitle": "Cm_Hopper"
7143   },
7144   {
7145     "type": "get",
7146     "url": "/api/cm/hopper/opencontacts",
7147     "title": "Gets Open Contacts",
7148     "examples": [
7149       {
7150         "title": "Example usage:",
7151         "content": "curl https://{domain}/api/cm/hopper/opencontacts -v -u {name}:{password} -X GET",
7152         "type": "json"
7153       }
7154     ],
7155     "name": "getOpenContacts",
7156     "group": "Cm_Hopper",
7157     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7158     "version": "0.0.0",
7159     "filename": "server/api/cmHopper/index.js",
7160     "groupTitle": "Cm_Hopper"
7161   },
7162   {
7163     "type": "post",
7164     "url": "/api/cm/hopper/preview",
7165     "title": "Gets Preview Dialer Contacts",
7166     "examples": [
7167       {
7168         "title": "Example usage:",
7169         "content": "curl https://{domain}/api/cm/hopper/preview -d '{\"hopperIds\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
7170         "type": "json"
7171       }
7172     ],
7173     "name": "getPreview",
7174     "group": "Cm_Hopper",
7175     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7176     "version": "0.0.0",
7177     "filename": "server/api/cmHopper/index.js",
7178     "groupTitle": "Cm_Hopper"
7179   },
7180   {
7181     "type": "put",
7182     "url": "/api/cm/hopper/{id}",
7183     "title": "Update an existing Hopper",
7184     "examples": [
7185       {
7186         "title": "Example usage:",
7187         "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",
7188         "type": "json"
7189       }
7190     ],
7191     "name": "updateHopper",
7192     "group": "Cm_Hopper",
7193     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7194     "version": "0.0.0",
7195     "filename": "server/api/cmHopper/index.js",
7196     "groupTitle": "Cm_Hopper"
7197   },
7198   {
7199     "type": "post",
7200     "url": "/api/cm/lists",
7201     "title": "Creates a new List",
7202     "examples": [
7203       {
7204         "title": "Example usage:",
7205         "content": "curl https://{domain}/api/cm/lists -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7206         "type": "json"
7207       }
7208     ],
7209     "name": "CreateLists",
7210     "group": "Cm_Lists",
7211     "parameter": {
7212       "fields": {
7213         "Body": [
7214           {
7215             "group": "Body",
7216             "type": "String",
7217             "optional": false,
7218             "field": "name",
7219             "description": ""
7220           },
7221           {
7222             "group": "Body",
7223             "type": "String",
7224             "optional": true,
7225             "field": "description",
7226             "description": ""
7227           },
7228           {
7229             "group": "Body",
7230             "type": "String",
7231             "optional": true,
7232             "field": "dialPrefix",
7233             "description": ""
7234           }
7235         ]
7236       }
7237     },
7238     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7239     "version": "0.0.0",
7240     "filename": "server/api/cmList/index.js",
7241     "groupTitle": "Cm_Lists"
7242   },
7243   {
7244     "type": "delete",
7245     "url": "/api/cm/lists/{id}",
7246     "title": "Deletes a List",
7247     "examples": [
7248       {
7249         "title": "Example usage:",
7250         "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password} -X DELETE",
7251         "type": "json"
7252       }
7253     ],
7254     "name": "DeleteLists",
7255     "group": "Cm_Lists",
7256     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7257     "version": "0.0.0",
7258     "filename": "server/api/cmList/index.js",
7259     "groupTitle": "Cm_Lists"
7260   },
7261   {
7262     "type": "get",
7263     "url": "/api/cm/lists/describe",
7264     "title": "Gets table info about Lists",
7265     "examples": [
7266       {
7267         "title": "Example usage:",
7268         "content": "curl https://{domain}/api/cm/lists/describe -v -u {name}:{password}",
7269         "type": "json"
7270       }
7271     ],
7272     "name": "DescribeLists",
7273     "group": "Cm_Lists",
7274     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7275     "version": "0.0.0",
7276     "filename": "server/api/cmList/index.js",
7277     "groupTitle": "Cm_Lists"
7278   },
7279   {
7280     "type": "get",
7281     "url": "/api/cm/lists/{id}/users",
7282     "title": "Gets agents from list",
7283     "examples": [
7284       {
7285         "title": "Example usage:",
7286         "content": "curl https://{domain}/api/cm/lists/{id}/users -v -u {name}:{password} -X GET",
7287         "type": "json"
7288       }
7289     ],
7290     "name": "GetAgents",
7291     "group": "Cm_Lists",
7292     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7293     "version": "0.0.0",
7294     "filename": "server/api/cmList/index.js",
7295     "groupTitle": "Cm_Lists"
7296   },
7297   {
7298     "type": "get",
7299     "url": "/api/cm/lists",
7300     "title": "Gets a list of Lists",
7301     "examples": [
7302       {
7303         "title": "Example usage:",
7304         "content": "curl https://{domain}/api/cm/lists -v -u {name}:{password}",
7305         "type": "json"
7306       }
7307     ],
7308     "name": "GetLists",
7309     "group": "Cm_Lists",
7310     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
7311     "version": "0.0.0",
7312     "filename": "server/api/cmList/index.js",
7313     "groupTitle": "Cm_Lists"
7314   },
7315   {
7316     "type": "delete",
7317     "url": "/api/cm/lists/{id}/users",
7318     "title": "Removes agents from a list",
7319     "examples": [
7320       {
7321         "title": "Example usage:",
7322         "content": "curl https://{domain}/api/cm/lists/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
7323         "type": "json"
7324       }
7325     ],
7326     "name": "RemoveAgents",
7327     "group": "Cm_Lists",
7328     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7329     "version": "0.0.0",
7330     "filename": "server/api/cmList/index.js",
7331     "groupTitle": "Cm_Lists"
7332   },
7333   {
7334     "type": "delete",
7335     "url": "/api/cm/lists/{id}/dispositions",
7336     "title": "Removes dispositions from account",
7337     "examples": [
7338       {
7339         "title": "Example usage:",
7340         "content": "curl https://{domain}/api/cm/lists/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
7341         "type": "json"
7342       }
7343     ],
7344     "name": "RemoveDispositions",
7345     "group": "Cm_Lists",
7346     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7347     "version": "0.0.0",
7348     "filename": "server/api/cmList/index.js",
7349     "groupTitle": "Cm_Lists"
7350   },
7351   {
7352     "type": "get",
7353     "url": "/api/cm/lists/{id}",
7354     "title": "Gets a single List",
7355     "examples": [
7356       {
7357         "title": "Example usage:",
7358         "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password}",
7359         "type": "json"
7360       }
7361     ],
7362     "name": "ShowLists",
7363     "group": "Cm_Lists",
7364     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7365     "version": "0.0.0",
7366     "filename": "server/api/cmList/index.js",
7367     "groupTitle": "Cm_Lists"
7368   },
7369   {
7370     "type": "post",
7371     "url": "/api/cm/lists/{id}/users",
7372     "title": "Adds agents to a list",
7373     "examples": [
7374       {
7375         "title": "Example usage:",
7376         "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",
7377         "type": "json"
7378       }
7379     ],
7380     "name": "addAgents",
7381     "group": "Cm_Lists",
7382     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7383     "version": "0.0.0",
7384     "filename": "server/api/cmList/index.js",
7385     "groupTitle": "Cm_Lists"
7386   },
7387   {
7388     "type": "post",
7389     "url": "/api/cm/lists/{id}/contacts",
7390     "title": "Creates new contacts",
7391     "examples": [
7392       {
7393         "title": "Example usage:",
7394         "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",
7395         "type": "json"
7396       }
7397     ],
7398     "name": "addContacts",
7399     "group": "Cm_Lists",
7400     "parameter": {
7401       "fields": {
7402         "Body": [
7403           {
7404             "group": "Body",
7405             "type": "String",
7406             "optional": false,
7407             "field": "firstName",
7408             "description": ""
7409           },
7410           {
7411             "group": "Body",
7412             "type": "String",
7413             "optional": true,
7414             "field": "lastName",
7415             "description": ""
7416           },
7417           {
7418             "group": "Body",
7419             "type": "String",
7420             "optional": true,
7421             "field": "street",
7422             "description": ""
7423           },
7424           {
7425             "group": "Body",
7426             "type": "String",
7427             "optional": true,
7428             "field": "postalCode",
7429             "description": ""
7430           },
7431           {
7432             "group": "Body",
7433             "type": "String",
7434             "optional": true,
7435             "field": "city",
7436             "description": ""
7437           },
7438           {
7439             "group": "Body",
7440             "type": "String",
7441             "optional": true,
7442             "field": "country",
7443             "description": ""
7444           },
7445           {
7446             "group": "Body",
7447             "type": "String",
7448             "optional": true,
7449             "field": "dateOfBirth",
7450             "description": ""
7451           },
7452           {
7453             "group": "Body",
7454             "type": "Text",
7455             "optional": true,
7456             "field": "description",
7457             "description": ""
7458           },
7459           {
7460             "group": "Body",
7461             "type": "String",
7462             "optional": true,
7463             "field": "phone",
7464             "description": ""
7465           },
7466           {
7467             "group": "Body",
7468             "type": "String",
7469             "optional": true,
7470             "field": "mobile",
7471             "description": ""
7472           },
7473           {
7474             "group": "Body",
7475             "type": "String",
7476             "optional": true,
7477             "field": "fax",
7478             "description": ""
7479           },
7480           {
7481             "group": "Body",
7482             "type": "String",
7483             "optional": true,
7484             "field": "email",
7485             "description": ""
7486           },
7487           {
7488             "group": "Body",
7489             "type": "String",
7490             "optional": true,
7491             "field": "url",
7492             "description": ""
7493           },
7494           {
7495             "group": "Body",
7496             "type": "String",
7497             "optional": true,
7498             "field": "facebook",
7499             "description": ""
7500           },
7501           {
7502             "group": "Body",
7503             "type": "String",
7504             "optional": true,
7505             "field": "fb_data",
7506             "description": ""
7507           },
7508           {
7509             "group": "Body",
7510             "type": "String",
7511             "optional": true,
7512             "field": "twitter",
7513             "description": ""
7514           },
7515           {
7516             "group": "Body",
7517             "type": "String",
7518             "optional": true,
7519             "field": "skype",
7520             "description": ""
7521           },
7522           {
7523             "group": "Body",
7524             "type": "String",
7525             "optional": true,
7526             "field": "teams",
7527             "description": ""
7528           },
7529           {
7530             "group": "Body",
7531             "type": "String",
7532             "optional": true,
7533             "field": "viber",
7534             "description": ""
7535           },
7536           {
7537             "group": "Body",
7538             "type": "String",
7539             "optional": true,
7540             "field": "line",
7541             "description": ""
7542           },
7543           {
7544             "group": "Body",
7545             "type": "String",
7546             "optional": true,
7547             "field": "wechat",
7548             "description": ""
7549           },
7550           {
7551             "group": "Body",
7552             "type": "String",
7553             "optional": true,
7554             "field": "telegram",
7555             "description": ""
7556           },
7557           {
7558             "group": "Body",
7559             "type": "Integer",
7560             "optional": true,
7561             "field": "UserId",
7562             "description": ""
7563           },
7564           {
7565             "group": "Body",
7566             "type": "Integer",
7567             "optional": true,
7568             "field": "priority",
7569             "description": ""
7570           },
7571           {
7572             "group": "Body",
7573             "type": "String",
7574             "optional": true,
7575             "field": "scheduledat",
7576             "description": ""
7577           }
7578         ]
7579       }
7580     },
7581     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7582     "version": "0.0.0",
7583     "filename": "server/api/cmList/index.js",
7584     "groupTitle": "Cm_Lists"
7585   },
7586   {
7587     "type": "post",
7588     "url": "/api/cm/lists/{id}/fields",
7589     "title": "Creates a new custom field",
7590     "examples": [
7591       {
7592         "title": "Example usage:",
7593         "content": "curl https://{domain}/api/cm/lists/{id}/fields -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7594         "type": "json"
7595       }
7596     ],
7597     "name": "addCustomField",
7598     "group": "Cm_Lists",
7599     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7600     "version": "0.0.0",
7601     "filename": "server/api/cmList/index.js",
7602     "groupTitle": "Cm_Lists"
7603   },
7604   {
7605     "type": "post",
7606     "url": "/api/cm/lists/{id}/dispositions",
7607     "title": "Creates new disposition",
7608     "examples": [
7609       {
7610         "title": "Example usage:",
7611         "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7612         "type": "json"
7613       }
7614     ],
7615     "name": "addDisposition",
7616     "group": "Cm_Lists",
7617     "parameter": {
7618       "fields": {
7619         "Body": [
7620           {
7621             "group": "Body",
7622             "type": "String",
7623             "optional": false,
7624             "field": "name",
7625             "description": ""
7626           },
7627           {
7628             "group": "Body",
7629             "type": "String",
7630             "allowedValues": [
7631               "\"first\"",
7632               "\"second\"",
7633               "\"third\""
7634             ],
7635             "optional": false,
7636             "field": "level",
7637             "description": ""
7638           },
7639           {
7640             "group": "Body",
7641             "type": "String",
7642             "optional": true,
7643             "field": "description",
7644             "description": ""
7645           }
7646         ]
7647       }
7648     },
7649     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7650     "version": "0.0.0",
7651     "filename": "server/api/cmList/index.js",
7652     "groupTitle": "Cm_Lists"
7653   },
7654   {
7655     "type": "get",
7656     "url": "/api/cm/lists/{id}/contacts",
7657     "title": "Gets List Contacts",
7658     "examples": [
7659       {
7660         "title": "Example usage:",
7661         "content": "curl https://{domain}/api/cm/lists/{id}/contacts -v -u {name}:{password} -X GET",
7662         "type": "json"
7663       }
7664     ],
7665     "name": "getContacts",
7666     "group": "Cm_Lists",
7667     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7668     "version": "0.0.0",
7669     "filename": "server/api/cmList/index.js",
7670     "groupTitle": "Cm_Lists"
7671   },
7672   {
7673     "type": "get",
7674     "url": "/api/cm/lists/{id}/fields",
7675     "title": "Gets Custom Fields",
7676     "examples": [
7677       {
7678         "title": "Example usage:",
7679         "content": "curl https://{domain}/api/cm/lists/{id}/fields -v -u {name}:{password} -X GET",
7680         "type": "json"
7681       }
7682     ],
7683     "name": "getCustomFields",
7684     "group": "Cm_Lists",
7685     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7686     "version": "0.0.0",
7687     "filename": "server/api/cmList/index.js",
7688     "groupTitle": "Cm_Lists"
7689   },
7690   {
7691     "type": "get",
7692     "url": "/api/cm/lists/{id}/dispositions",
7693     "title": "Gets list dispositions",
7694     "examples": [
7695       {
7696         "title": "Example usage:",
7697         "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -v -u {name}:{password} -X GET",
7698         "type": "json"
7699       }
7700     ],
7701     "name": "getDispositions",
7702     "group": "Cm_Lists",
7703     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7704     "version": "0.0.0",
7705     "filename": "server/api/cmList/index.js",
7706     "groupTitle": "Cm_Lists"
7707   },
7708   {
7709     "type": "get",
7710     "url": "/api/cm/lists/{id}/contacts/csv",
7711     "title": "Gets CSV List Contacts",
7712     "examples": [
7713       {
7714         "title": "Example usage:",
7715         "content": "curl https://{domain}/api/cm/lists/{id}/contacts/csv -v -u {name}:{password} -X GET",
7716         "type": "json"
7717       }
7718     ],
7719     "name": "grunt",
7720     "group": "Cm_Lists",
7721     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7722     "version": "0.0.0",
7723     "filename": "server/api/cmList/index.js",
7724     "groupTitle": "Cm_Lists"
7725   },
7726   {
7727     "type": "put",
7728     "url": "/api/cm/lists/{id}",
7729     "title": "Update an existing List",
7730     "examples": [
7731       {
7732         "title": "Example usage:",
7733         "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",
7734         "type": "json"
7735       }
7736     ],
7737     "name": "updateLists",
7738     "group": "Cm_Lists",
7739     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7740     "version": "0.0.0",
7741     "filename": "server/api/cmList/index.js",
7742     "groupTitle": "Cm_Lists"
7743   },
7744   {
7745     "type": "post",
7746     "url": "/api/cm/contacts/upload/:id",
7747     "title": "Import new contacts by csv",
7748     "examples": [
7749       {
7750         "title": "Example usage:",
7751         "content": "curl https://{domain}/api/cm/contacts/upload/:id -v -u {name}:{password} -X POST",
7752         "type": "json"
7753       }
7754     ],
7755     "name": "import",
7756     "group": "Cm_contacts",
7757     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7758     "version": "0.0.0",
7759     "filename": "server/api/cmContact/index.js",
7760     "groupTitle": "Cm_contacts"
7761   },
7762   {
7763     "type": "post",
7764     "url": "/api/cm/contacts/upload",
7765     "title": "Upload csv",
7766     "examples": [
7767       {
7768         "title": "Example usage:",
7769         "content": "curl https://{domain}/api/cm/contacts/upload -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
7770         "type": "json"
7771       }
7772     ],
7773     "name": "upload",
7774     "group": "Cm_contacts",
7775     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7776     "version": "0.0.0",
7777     "filename": "server/api/cmContact/index.js",
7778     "groupTitle": "Cm_contacts"
7779   },
7780   {
7781     "type": "post",
7782     "url": "/api/cm/contacts/csv",
7783     "title": "Create new contacts by csv",
7784     "examples": [
7785       {
7786         "title": "Example usage:",
7787         "content": "curl https://{domain}/api/cm/contacts/csv -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
7788         "type": "json"
7789       }
7790     ],
7791     "name": "uploadCsv",
7792     "group": "Cm_contacts",
7793     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7794     "version": "0.0.0",
7795     "filename": "server/api/cmContact/index.js",
7796     "groupTitle": "Cm_contacts"
7797   },
7798   {
7799     "type": "delete",
7800     "url": "/api/conditions/{id}",
7801     "title": "Deletes a Condition",
7802     "examples": [
7803       {
7804         "title": "Example usage:",
7805         "content": "curl https://{domain}/api/conditions/{id} -v -u {name}:{password} -X DELETE",
7806         "type": "json"
7807       }
7808     ],
7809     "name": "DeleteConditions",
7810     "group": "Conditions",
7811     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7812     "version": "0.0.0",
7813     "filename": "server/api/condition/index.js",
7814     "groupTitle": "Conditions"
7815   },
7816   {
7817     "type": "put",
7818     "url": "/api/conditions/{id}",
7819     "title": "Update an existing Condition",
7820     "examples": [
7821       {
7822         "title": "Example usage:",
7823         "content": "curl https://{domain}/api/conditions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
7824         "type": "json"
7825       }
7826     ],
7827     "name": "updateConditions",
7828     "group": "Conditions",
7829     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7830     "version": "0.0.0",
7831     "filename": "server/api/condition/index.js",
7832     "groupTitle": "Conditions"
7833   },
7834   {
7835     "type": "post",
7836     "url": "/api/cm/custom_field",
7837     "title": "Create a new custom field",
7838     "examples": [
7839       {
7840         "title": "Example usage:",
7841         "content": "curl https://{domain}/api/cm/custom_field  -d '{\"name\": \"mycf\", \"type\": \"text\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7842         "type": "json"
7843       }
7844     ],
7845     "name": "CreateCustomField",
7846     "group": "Custom_Fields",
7847     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7848     "version": "0.0.0",
7849     "filename": "server/api/cmCustomField/index.js",
7850     "groupTitle": "Custom_Fields"
7851   },
7852   {
7853     "type": "post",
7854     "url": "/api/dashboards/items",
7855     "title": "Create dasboard item",
7856     "examples": [
7857       {
7858         "title": "Example usage:",
7859         "content": "curl https://{domain}/api/dashboards/items \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
7860         "type": "json"
7861       }
7862     ],
7863     "name": "Create",
7864     "group": "Dashboard_Items",
7865     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7866     "version": "0.0.0",
7867     "filename": "server/api/dashboardItem/index.js",
7868     "groupTitle": "Dashboard_Items"
7869   },
7870   {
7871     "type": "delete",
7872     "url": "/api/dashboards/items/{id}",
7873     "title": "Deletes a Dashboard Item",
7874     "examples": [
7875       {
7876         "title": "Example usage:",
7877         "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X DELETE",
7878         "type": "json"
7879       }
7880     ],
7881     "name": "DeleteDashboard_Items",
7882     "group": "Dashboard_Items",
7883     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7884     "version": "0.0.0",
7885     "filename": "server/api/dashboardItem/index.js",
7886     "groupTitle": "Dashboard_Items"
7887   },
7888   {
7889     "type": "get",
7890     "url": "/api/dashboards/items/{id}",
7891     "title": "Gets a single Dashboard Item",
7892     "examples": [
7893       {
7894         "title": "Example usage:",
7895         "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password}",
7896         "type": "json"
7897       }
7898     ],
7899     "name": "ShowDashboard_Items",
7900     "group": "Dashboard_Items",
7901     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7902     "version": "0.0.0",
7903     "filename": "server/api/dashboardItem/index.js",
7904     "groupTitle": "Dashboard_Items"
7905   },
7906   {
7907     "type": "put",
7908     "url": "/api/dashboards/items/{id}",
7909     "title": "Update an existing item",
7910     "examples": [
7911       {
7912         "title": "Example usage:",
7913         "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X PUT",
7914         "type": "json"
7915       }
7916     ],
7917     "name": "Update",
7918     "group": "Dashboard_Items",
7919     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7920     "version": "0.0.0",
7921     "filename": "server/api/dashboardItem/index.js",
7922     "groupTitle": "Dashboard_Items"
7923   },
7924   {
7925     "type": "post",
7926     "url": "/api/dashboards/clone",
7927     "title": "Clone an existing Dashboard",
7928     "examples": [
7929       {
7930         "title": "Example usage:",
7931         "content": "curl https://{domain}/api/dashboards/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7932         "type": "json"
7933       }
7934     ],
7935     "name": "CloneDashboards",
7936     "group": "Dashboards",
7937     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7938     "version": "0.0.0",
7939     "filename": "server/api/dashboard/index.js",
7940     "groupTitle": "Dashboards"
7941   },
7942   {
7943     "type": "post",
7944     "url": "/api/dashboards",
7945     "title": "Creates a new Dashboard",
7946     "examples": [
7947       {
7948         "title": "Example usage:",
7949         "content": "curl https://{domain}/api/dashboards -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7950         "type": "json"
7951       }
7952     ],
7953     "name": "CreateDashboards",
7954     "group": "Dashboards",
7955     "parameter": {
7956       "fields": {
7957         "Body": [
7958           {
7959             "group": "Body",
7960             "type": "String",
7961             "optional": false,
7962             "field": "name",
7963             "description": ""
7964           },
7965           {
7966             "group": "Body",
7967             "type": "String",
7968             "optional": true,
7969             "field": "description",
7970             "description": ""
7971           }
7972         ]
7973       }
7974     },
7975     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7976     "version": "0.0.0",
7977     "filename": "server/api/dashboard/index.js",
7978     "groupTitle": "Dashboards"
7979   },
7980   {
7981     "type": "delete",
7982     "url": "/api/dashboards/{id}",
7983     "title": "Deletes a Dashboard",
7984     "examples": [
7985       {
7986         "title": "Example usage:",
7987         "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password} -X DELETE",
7988         "type": "json"
7989       }
7990     ],
7991     "name": "DeleteDashboards",
7992     "group": "Dashboards",
7993     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7994     "version": "0.0.0",
7995     "filename": "server/api/dashboard/index.js",
7996     "groupTitle": "Dashboards"
7997   },
7998   {
7999     "type": "get",
8000     "url": "/api/dashboards",
8001     "title": "Gets a list of Dashboards",
8002     "examples": [
8003       {
8004         "title": "Example usage:",
8005         "content": "curl https://{domain}/api/dashboards -v -u {name}:{password}",
8006         "type": "json"
8007       }
8008     ],
8009     "name": "GetDashboards",
8010     "group": "Dashboards",
8011     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8012     "version": "0.0.0",
8013     "filename": "server/api/dashboard/index.js",
8014     "groupTitle": "Dashboards"
8015   },
8016   {
8017     "type": "get",
8018     "url": "/api/dashboards/{id}",
8019     "title": "Gets a single Dashboard",
8020     "examples": [
8021       {
8022         "title": "Example usage:",
8023         "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password}",
8024         "type": "json"
8025       }
8026     ],
8027     "name": "ShowDashboards",
8028     "group": "Dashboards",
8029     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8030     "version": "0.0.0",
8031     "filename": "server/api/dashboard/index.js",
8032     "groupTitle": "Dashboards"
8033   },
8034   {
8035     "type": "post",
8036     "url": "/api/dashboards/{id}/items",
8037     "title": "Creates new item",
8038     "examples": [
8039       {
8040         "title": "Example usage:",
8041         "content": "curl https://{domain}/api/dashboards/{id}/items -d '{\"type\": \"counter\", \"...\": \"...\"}]' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
8042         "type": "json"
8043       }
8044     ],
8045     "name": "addItem",
8046     "group": "Dashboards",
8047     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8048     "version": "0.0.0",
8049     "filename": "server/api/dashboard/index.js",
8050     "groupTitle": "Dashboards"
8051   },
8052   {
8053     "type": "get",
8054     "url": "/api/dashboards/{id}/items",
8055     "title": "Gets items",
8056     "examples": [
8057       {
8058         "title": "Example usage:",
8059         "content": "curl https://{domain}/api/dashboards/{id}/items -v -u {name}:{password} -X GET",
8060         "type": "json"
8061       }
8062     ],
8063     "name": "getItems",
8064     "group": "Dashboards",
8065     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8066     "version": "0.0.0",
8067     "filename": "server/api/dashboard/index.js",
8068     "groupTitle": "Dashboards"
8069   },
8070   {
8071     "type": "put",
8072     "url": "/api/dashboards/{id}",
8073     "title": "Update an existing Dashboard",
8074     "examples": [
8075       {
8076         "title": "Example usage:",
8077         "content": "curl https://{domain}/api/dashboards/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8078         "type": "json"
8079       }
8080     ],
8081     "name": "updateDashboards",
8082     "group": "Dashboards",
8083     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8084     "version": "0.0.0",
8085     "filename": "server/api/dashboard/index.js",
8086     "groupTitle": "Dashboards"
8087   },
8088   {
8089     "type": "post",
8090     "url": "/api/integrations/desk/accounts",
8091     "title": "Creates a new Desk Account",
8092     "examples": [
8093       {
8094         "title": "Example usage:",
8095         "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",
8096         "type": "json"
8097       }
8098     ],
8099     "name": "CreateDesk_Accounts",
8100     "group": "Desk_Accounts",
8101     "parameter": {
8102       "fields": {
8103         "Body": [
8104           {
8105             "group": "Body",
8106             "type": "String",
8107             "optional": true,
8108             "field": "name",
8109             "description": ""
8110           },
8111           {
8112             "group": "Body",
8113             "type": "String",
8114             "optional": true,
8115             "field": "description",
8116             "description": ""
8117           },
8118           {
8119             "group": "Body",
8120             "type": "String",
8121             "optional": true,
8122             "field": "username",
8123             "description": ""
8124           },
8125           {
8126             "group": "Body",
8127             "type": "String",
8128             "optional": true,
8129             "field": "remoteUri",
8130             "description": ""
8131           },
8132           {
8133             "group": "Body",
8134             "type": "String",
8135             "allowedValues": [
8136               "\"basic\""
8137             ],
8138             "optional": true,
8139             "field": "authType",
8140             "description": ""
8141           },
8142           {
8143             "group": "Body",
8144             "type": "String",
8145             "optional": true,
8146             "field": "password",
8147             "description": ""
8148           },
8149           {
8150             "group": "Body",
8151             "type": "String",
8152             "optional": true,
8153             "field": "consumerKey",
8154             "description": ""
8155           },
8156           {
8157             "group": "Body",
8158             "type": "String",
8159             "optional": true,
8160             "field": "consumerSecret",
8161             "description": ""
8162           },
8163           {
8164             "group": "Body",
8165             "type": "String",
8166             "optional": true,
8167             "field": "token",
8168             "description": ""
8169           },
8170           {
8171             "group": "Body",
8172             "type": "String",
8173             "optional": true,
8174             "field": "tokenSecret",
8175             "description": ""
8176           },
8177           {
8178             "group": "Body",
8179             "type": "String",
8180             "optional": false,
8181             "field": "serverUrl",
8182             "description": ""
8183           },
8184           {
8185             "group": "Body",
8186             "type": "String",
8187             "allowedValues": [
8188               "\"integrationTab\"",
8189               "\"newTab\""
8190             ],
8191             "optional": true,
8192             "field": "type",
8193             "description": ""
8194           }
8195         ]
8196       }
8197     },
8198     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8199     "version": "0.0.0",
8200     "filename": "server/api/intDeskAccount/index.js",
8201     "groupTitle": "Desk_Accounts"
8202   },
8203   {
8204     "type": "delete",
8205     "url": "/api/integrations/desk/accounts/{id}",
8206     "title": "Deletes a Desk Account",
8207     "examples": [
8208       {
8209         "title": "Example usage:",
8210         "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password} -X DELETE",
8211         "type": "json"
8212       }
8213     ],
8214     "name": "DeleteDesk_Accounts",
8215     "group": "Desk_Accounts",
8216     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8217     "version": "0.0.0",
8218     "filename": "server/api/intDeskAccount/index.js",
8219     "groupTitle": "Desk_Accounts"
8220   },
8221   {
8222     "type": "get",
8223     "url": "/api/integrations/desk/accounts",
8224     "title": "Gets a list of Desk Accounts",
8225     "examples": [
8226       {
8227         "title": "Example usage:",
8228         "content": "curl https://{domain}/api/integrations/desk/accounts -v -u {name}:{password}",
8229         "type": "json"
8230       }
8231     ],
8232     "name": "GetDesk_Accounts",
8233     "group": "Desk_Accounts",
8234     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8235     "version": "0.0.0",
8236     "filename": "server/api/intDeskAccount/index.js",
8237     "groupTitle": "Desk_Accounts"
8238   },
8239   {
8240     "type": "get",
8241     "url": "/api/integrations/desk/accounts/{id}",
8242     "title": "Gets a single Desk Account",
8243     "examples": [
8244       {
8245         "title": "Example usage:",
8246         "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password}",
8247         "type": "json"
8248       }
8249     ],
8250     "name": "ShowDesk_Accounts",
8251     "group": "Desk_Accounts",
8252     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8253     "version": "0.0.0",
8254     "filename": "server/api/intDeskAccount/index.js",
8255     "groupTitle": "Desk_Accounts"
8256   },
8257   {
8258     "type": "post",
8259     "url": "/api/integrations/desk/accounts/{id}/configurations",
8260     "title": "Creates new configuration",
8261     "examples": [
8262       {
8263         "title": "Example usage:",
8264         "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",
8265         "type": "json"
8266       }
8267     ],
8268     "name": "addConfiguration",
8269     "group": "Desk_Accounts",
8270     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8271     "version": "0.0.0",
8272     "filename": "server/api/intDeskAccount/index.js",
8273     "groupTitle": "Desk_Accounts"
8274   },
8275   {
8276     "type": "get",
8277     "url": "/api/integrations/desk/accounts/{id}/configurations",
8278     "title": "Gets account configurations",
8279     "examples": [
8280       {
8281         "title": "Example usage:",
8282         "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
8283         "type": "json"
8284       }
8285     ],
8286     "name": "getConfigurations",
8287     "group": "Desk_Accounts",
8288     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8289     "version": "0.0.0",
8290     "filename": "server/api/intDeskAccount/index.js",
8291     "groupTitle": "Desk_Accounts"
8292   },
8293   {
8294     "type": "get",
8295     "url": "/api/integrations/desk/accounts/{id}/fields",
8296     "title": "Gets account fields",
8297     "examples": [
8298       {
8299         "title": "Example usage:",
8300         "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/fields -v -u {name}:{password} -X GET",
8301         "type": "json"
8302       }
8303     ],
8304     "name": "getFields",
8305     "group": "Desk_Accounts",
8306     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8307     "version": "0.0.0",
8308     "filename": "server/api/intDeskAccount/index.js",
8309     "groupTitle": "Desk_Accounts"
8310   },
8311   {
8312     "type": "put",
8313     "url": "/api/integrations/desk/accounts/{id}",
8314     "title": "Update an existing Desk Account",
8315     "examples": [
8316       {
8317         "title": "Example usage:",
8318         "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",
8319         "type": "json"
8320       }
8321     ],
8322     "name": "updateDesk_Accounts",
8323     "group": "Desk_Accounts",
8324     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8325     "version": "0.0.0",
8326     "filename": "server/api/intDeskAccount/index.js",
8327     "groupTitle": "Desk_Accounts"
8328   },
8329   {
8330     "type": "post",
8331     "url": "/api/integrations/desk/configurations",
8332     "title": "Creates a new Desk Configuration",
8333     "examples": [
8334       {
8335         "title": "Example usage:",
8336         "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",
8337         "type": "json"
8338       }
8339     ],
8340     "name": "CreateDesk_Configurations",
8341     "group": "Desk_Configurations",
8342     "parameter": {
8343       "fields": {
8344         "Body": [
8345           {
8346             "group": "Body",
8347             "type": "String",
8348             "optional": true,
8349             "field": "name",
8350             "description": ""
8351           },
8352           {
8353             "group": "Body",
8354             "type": "String",
8355             "optional": true,
8356             "field": "description",
8357             "description": ""
8358           }
8359         ]
8360       }
8361     },
8362     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8363     "version": "0.0.0",
8364     "filename": "server/api/intDeskConfiguration/index.js",
8365     "groupTitle": "Desk_Configurations"
8366   },
8367   {
8368     "type": "delete",
8369     "url": "/api/integrations/desk/configurations/{id}",
8370     "title": "Deletes a Desk Configuration",
8371     "examples": [
8372       {
8373         "title": "Example usage:",
8374         "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password} -X DELETE",
8375         "type": "json"
8376       }
8377     ],
8378     "name": "DeleteDesk_Configurations",
8379     "group": "Desk_Configurations",
8380     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8381     "version": "0.0.0",
8382     "filename": "server/api/intDeskConfiguration/index.js",
8383     "groupTitle": "Desk_Configurations"
8384   },
8385   {
8386     "type": "get",
8387     "url": "/api/integrations/desk/configurations",
8388     "title": "Gets a list of Desk Configurations",
8389     "examples": [
8390       {
8391         "title": "Example usage:",
8392         "content": "curl https://{domain}/api/integrations/desk/configurations -v -u {name}:{password}",
8393         "type": "json"
8394       }
8395     ],
8396     "name": "GetDesk_Configurations",
8397     "group": "Desk_Configurations",
8398     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8399     "version": "0.0.0",
8400     "filename": "server/api/intDeskConfiguration/index.js",
8401     "groupTitle": "Desk_Configurations"
8402   },
8403   {
8404     "type": "get",
8405     "url": "/api/integrations/desk/configurations/{id}",
8406     "title": "Gets a single Desk Configuration",
8407     "examples": [
8408       {
8409         "title": "Example usage:",
8410         "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password}",
8411         "type": "json"
8412       }
8413     ],
8414     "name": "ShowDesk_Configurations",
8415     "group": "Desk_Configurations",
8416     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8417     "version": "0.0.0",
8418     "filename": "server/api/intDeskConfiguration/index.js",
8419     "groupTitle": "Desk_Configurations"
8420   },
8421   {
8422     "type": "get",
8423     "url": "/api/integrations/desk/configurations/{id}/descriptions",
8424     "title": "Gets configurations descriptions",
8425     "examples": [
8426       {
8427         "title": "Example usage:",
8428         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
8429         "type": "json"
8430       }
8431     ],
8432     "name": "getDescriptions",
8433     "group": "Desk_Configurations",
8434     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8435     "version": "0.0.0",
8436     "filename": "server/api/intDeskConfiguration/index.js",
8437     "groupTitle": "Desk_Configurations"
8438   },
8439   {
8440     "type": "get",
8441     "url": "/api/integrations/desk/configurations/{id}/fields",
8442     "title": "Gets configurations fields",
8443     "examples": [
8444       {
8445         "title": "Example usage:",
8446         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/fields -v -u {name}:{password} -X GET",
8447         "type": "json"
8448       }
8449     ],
8450     "name": "getFields",
8451     "group": "Desk_Configurations",
8452     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8453     "version": "0.0.0",
8454     "filename": "server/api/intDeskConfiguration/index.js",
8455     "groupTitle": "Desk_Configurations"
8456   },
8457   {
8458     "type": "get",
8459     "url": "/api/integrations/desk/configurations/{id}/subjects",
8460     "title": "Gets configurations subjects",
8461     "examples": [
8462       {
8463         "title": "Example usage:",
8464         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
8465         "type": "json"
8466       }
8467     ],
8468     "name": "getSubjects",
8469     "group": "Desk_Configurations",
8470     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8471     "version": "0.0.0",
8472     "filename": "server/api/intDeskConfiguration/index.js",
8473     "groupTitle": "Desk_Configurations"
8474   },
8475   {
8476     "type": "get",
8477     "url": "/api/integrations/desk/configurations/{id}/tags",
8478     "title": "Gets configurations tags",
8479     "examples": [
8480       {
8481         "title": "Example usage:",
8482         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/tags -v -u {name}:{password} -X GET",
8483         "type": "json"
8484       }
8485     ],
8486     "name": "getTags",
8487     "group": "Desk_Configurations",
8488     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8489     "version": "0.0.0",
8490     "filename": "server/api/intDeskConfiguration/index.js",
8491     "groupTitle": "Desk_Configurations"
8492   },
8493   {
8494     "type": "post",
8495     "url": "/api/integrations/desk/configurations/{id}/tags",
8496     "title": "Sets new tags",
8497     "examples": [
8498       {
8499         "title": "Example usage:",
8500         "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",
8501         "type": "json"
8502       }
8503     ],
8504     "name": "setTags",
8505     "group": "Desk_Configurations",
8506     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8507     "version": "0.0.0",
8508     "filename": "server/api/intDeskConfiguration/index.js",
8509     "groupTitle": "Desk_Configurations"
8510   },
8511   {
8512     "type": "put",
8513     "url": "/api/integrations/desk/configurations/{id}",
8514     "title": "Update an existing Desk Configuration",
8515     "examples": [
8516       {
8517         "title": "Example usage:",
8518         "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",
8519         "type": "json"
8520       }
8521     ],
8522     "name": "updateDesk_Configurations",
8523     "group": "Desk_Configurations",
8524     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8525     "version": "0.0.0",
8526     "filename": "server/api/intDeskConfiguration/index.js",
8527     "groupTitle": "Desk_Configurations"
8528   },
8529   {
8530     "type": "post",
8531     "url": "/api/integrations/desk/fields",
8532     "title": "Creates a new Desk Field",
8533     "examples": [
8534       {
8535         "title": "Example usage:",
8536         "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",
8537         "type": "json"
8538       }
8539     ],
8540     "name": "CreateDesk_Fields",
8541     "group": "Desk_Fields",
8542     "parameter": {
8543       "fields": {
8544         "Body": [
8545           {
8546             "group": "Body",
8547             "type": "String",
8548             "allowedValues": [
8549               "\"string\"",
8550               "\"variable\"",
8551               "\"customVariable\"",
8552               "\"keyValue\""
8553             ],
8554             "optional": true,
8555             "field": "type",
8556             "description": ""
8557           },
8558           {
8559             "group": "Body",
8560             "type": "String",
8561             "optional": true,
8562             "field": "content",
8563             "description": ""
8564           },
8565           {
8566             "group": "Body",
8567             "type": "String",
8568             "optional": true,
8569             "field": "key",
8570             "description": ""
8571           },
8572           {
8573             "group": "Body",
8574             "type": "String",
8575             "allowedValues": [
8576               "\"string\"",
8577               "\"variable\"",
8578               "\"customVariable\""
8579             ],
8580             "optional": true,
8581             "field": "keyType",
8582             "description": ""
8583           },
8584           {
8585             "group": "Body",
8586             "type": "String",
8587             "optional": true,
8588             "field": "keyContent",
8589             "description": ""
8590           },
8591           {
8592             "group": "Body",
8593             "type": "String",
8594             "optional": true,
8595             "field": "idField",
8596             "description": ""
8597           },
8598           {
8599             "group": "Body",
8600             "type": "String",
8601             "optional": true,
8602             "field": "nameField",
8603             "description": ""
8604           },
8605           {
8606             "group": "Body",
8607             "type": "Boolean",
8608             "optional": true,
8609             "field": "customField",
8610             "description": ""
8611           },
8612           {
8613             "group": "Body",
8614             "type": "String",
8615             "optional": true,
8616             "field": "variableName",
8617             "description": ""
8618           }
8619         ]
8620       }
8621     },
8622     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8623     "version": "0.0.0",
8624     "filename": "server/api/intDeskField/index.js",
8625     "groupTitle": "Desk_Fields"
8626   },
8627   {
8628     "type": "delete",
8629     "url": "/api/integrations/desk/fields/{id}",
8630     "title": "Deletes a Desk Field",
8631     "examples": [
8632       {
8633         "title": "Example usage:",
8634         "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password} -X DELETE",
8635         "type": "json"
8636       }
8637     ],
8638     "name": "DeleteDesk_Fields",
8639     "group": "Desk_Fields",
8640     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8641     "version": "0.0.0",
8642     "filename": "server/api/intDeskField/index.js",
8643     "groupTitle": "Desk_Fields"
8644   },
8645   {
8646     "type": "get",
8647     "url": "/api/integrations/desk/fields",
8648     "title": "Gets a list of Desk Fields",
8649     "examples": [
8650       {
8651         "title": "Example usage:",
8652         "content": "curl https://{domain}/api/integrations/desk/fields -v -u {name}:{password}",
8653         "type": "json"
8654       }
8655     ],
8656     "name": "GetDesk_Fields",
8657     "group": "Desk_Fields",
8658     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8659     "version": "0.0.0",
8660     "filename": "server/api/intDeskField/index.js",
8661     "groupTitle": "Desk_Fields"
8662   },
8663   {
8664     "type": "get",
8665     "url": "/api/integrations/desk/fields/{id}",
8666     "title": "Gets a single Desk Field",
8667     "examples": [
8668       {
8669         "title": "Example usage:",
8670         "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password}",
8671         "type": "json"
8672       }
8673     ],
8674     "name": "ShowDesk_Fields",
8675     "group": "Desk_Fields",
8676     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8677     "version": "0.0.0",
8678     "filename": "server/api/intDeskField/index.js",
8679     "groupTitle": "Desk_Fields"
8680   },
8681   {
8682     "type": "put",
8683     "url": "/api/integrations/desk/fields/{id}",
8684     "title": "Update an existing Desk Field",
8685     "examples": [
8686       {
8687         "title": "Example usage:",
8688         "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",
8689         "type": "json"
8690       }
8691     ],
8692     "name": "updateDesk_Fields",
8693     "group": "Desk_Fields",
8694     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8695     "version": "0.0.0",
8696     "filename": "server/api/intDeskField/index.js",
8697     "groupTitle": "Desk_Fields"
8698   },
8699   {
8700     "type": "post",
8701     "url": "/api/dispositions",
8702     "title": "Creates a new Disposition",
8703     "examples": [
8704       {
8705         "title": "Example usage:",
8706         "content": "curl https://{domain}/api/dispositions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8707         "type": "json"
8708       }
8709     ],
8710     "name": "CreateDispositions",
8711     "group": "Dispositions",
8712     "parameter": {
8713       "fields": {
8714         "Body": [
8715           {
8716             "group": "Body",
8717             "type": "String",
8718             "optional": false,
8719             "field": "name",
8720             "description": ""
8721           },
8722           {
8723             "group": "Body",
8724             "type": "String",
8725             "allowedValues": [
8726               "\"first\"",
8727               "\"second\"",
8728               "\"third\""
8729             ],
8730             "optional": false,
8731             "field": "level",
8732             "description": ""
8733           },
8734           {
8735             "group": "Body",
8736             "type": "String",
8737             "optional": true,
8738             "field": "description",
8739             "description": ""
8740           }
8741         ]
8742       }
8743     },
8744     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8745     "version": "0.0.0",
8746     "filename": "server/api/disposition/index.js",
8747     "groupTitle": "Dispositions"
8748   },
8749   {
8750     "type": "delete",
8751     "url": "/api/dispositions/{id}",
8752     "title": "Deletes a Disposition",
8753     "examples": [
8754       {
8755         "title": "Example usage:",
8756         "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password} -X DELETE",
8757         "type": "json"
8758       }
8759     ],
8760     "name": "DeleteDispositions",
8761     "group": "Dispositions",
8762     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8763     "version": "0.0.0",
8764     "filename": "server/api/disposition/index.js",
8765     "groupTitle": "Dispositions"
8766   },
8767   {
8768     "type": "get",
8769     "url": "/api/dispositions",
8770     "title": "Gets a list of Dispositions",
8771     "examples": [
8772       {
8773         "title": "Example usage:",
8774         "content": "curl https://{domain}/api/dispositions -v -u {name}:{password}",
8775         "type": "json"
8776       }
8777     ],
8778     "name": "GetDispositions",
8779     "group": "Dispositions",
8780     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8781     "version": "0.0.0",
8782     "filename": "server/api/disposition/index.js",
8783     "groupTitle": "Dispositions"
8784   },
8785   {
8786     "type": "get",
8787     "url": "/api/dispositions/{id}",
8788     "title": "Gets a single Disposition",
8789     "examples": [
8790       {
8791         "title": "Example usage:",
8792         "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password}",
8793         "type": "json"
8794       }
8795     ],
8796     "name": "ShowDispositions",
8797     "group": "Dispositions",
8798     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8799     "version": "0.0.0",
8800     "filename": "server/api/disposition/index.js",
8801     "groupTitle": "Dispositions"
8802   },
8803   {
8804     "type": "put",
8805     "url": "/api/dispositions/{id}",
8806     "title": "Update an existing Disposition",
8807     "examples": [
8808       {
8809         "title": "Example usage:",
8810         "content": "curl https://{domain}/api/dispositions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8811         "type": "json"
8812       }
8813     ],
8814     "name": "updateDispositions",
8815     "group": "Dispositions",
8816     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8817     "version": "0.0.0",
8818     "filename": "server/api/disposition/index.js",
8819     "groupTitle": "Dispositions"
8820   },
8821   {
8822     "type": "post",
8823     "url": "/api/integrations/dynamics365/accounts",
8824     "title": "Creates a new Dynamics365 Account",
8825     "examples": [
8826       {
8827         "title": "Example usage:",
8828         "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",
8829         "type": "json"
8830       }
8831     ],
8832     "name": "CreateDynamics365_Accounts",
8833     "group": "Dynamics365_Accounts",
8834     "parameter": {
8835       "fields": {
8836         "Body": [
8837           {
8838             "group": "Body",
8839             "type": "String",
8840             "optional": true,
8841             "field": "name",
8842             "description": ""
8843           },
8844           {
8845             "group": "Body",
8846             "type": "String",
8847             "optional": true,
8848             "field": "username",
8849             "description": ""
8850           },
8851           {
8852             "group": "Body",
8853             "type": "String",
8854             "optional": true,
8855             "field": "password",
8856             "description": ""
8857           },
8858           {
8859             "group": "Body",
8860             "type": "String",
8861             "optional": true,
8862             "field": "remoteUri",
8863             "description": ""
8864           },
8865           {
8866             "group": "Body",
8867             "type": "String",
8868             "optional": true,
8869             "field": "tenantId",
8870             "description": ""
8871           },
8872           {
8873             "group": "Body",
8874             "type": "String",
8875             "optional": true,
8876             "field": "clientId",
8877             "description": ""
8878           },
8879           {
8880             "group": "Body",
8881             "type": "String",
8882             "optional": true,
8883             "field": "clientSecret",
8884             "description": ""
8885           },
8886           {
8887             "group": "Body",
8888             "type": "String",
8889             "optional": false,
8890             "field": "serverUrl",
8891             "description": ""
8892           },
8893           {
8894             "group": "Body",
8895             "type": "String",
8896             "optional": true,
8897             "field": "description",
8898             "description": ""
8899           }
8900         ]
8901       }
8902     },
8903     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8904     "version": "0.0.0",
8905     "filename": "server/api/intDynamics365Account/index.js",
8906     "groupTitle": "Dynamics365_Accounts"
8907   },
8908   {
8909     "type": "delete",
8910     "url": "/api/integrations/dynamics365/accounts/{id}",
8911     "title": "Deletes a Dynamics365 Account",
8912     "examples": [
8913       {
8914         "title": "Example usage:",
8915         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password} -X DELETE",
8916         "type": "json"
8917       }
8918     ],
8919     "name": "DeleteDynamics365_Accounts",
8920     "group": "Dynamics365_Accounts",
8921     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8922     "version": "0.0.0",
8923     "filename": "server/api/intDynamics365Account/index.js",
8924     "groupTitle": "Dynamics365_Accounts"
8925   },
8926   {
8927     "type": "get",
8928     "url": "/api/integrations/dynamics365/accounts",
8929     "title": "Gets a list of Dynamics365 Accounts",
8930     "examples": [
8931       {
8932         "title": "Example usage:",
8933         "content": "curl https://{domain}/api/integrations/dynamics365/accounts -v -u {name}:{password}",
8934         "type": "json"
8935       }
8936     ],
8937     "name": "GetDynamics365_Accounts",
8938     "group": "Dynamics365_Accounts",
8939     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8940     "version": "0.0.0",
8941     "filename": "server/api/intDynamics365Account/index.js",
8942     "groupTitle": "Dynamics365_Accounts"
8943   },
8944   {
8945     "type": "get",
8946     "url": "/api/integrations/dynamics365/accounts/{id}",
8947     "title": "Gets a single Dynamics365 Account",
8948     "examples": [
8949       {
8950         "title": "Example usage:",
8951         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password}",
8952         "type": "json"
8953       }
8954     ],
8955     "name": "ShowDynamics365_Accounts",
8956     "group": "Dynamics365_Accounts",
8957     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8958     "version": "0.0.0",
8959     "filename": "server/api/intDynamics365Account/index.js",
8960     "groupTitle": "Dynamics365_Accounts"
8961   },
8962   {
8963     "type": "post",
8964     "url": "/api/integrations/dynamics365/accounts/{id}/configurations",
8965     "title": "Creates new configuration",
8966     "examples": [
8967       {
8968         "title": "Example usage:",
8969         "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",
8970         "type": "json"
8971       }
8972     ],
8973     "name": "addConfiguration",
8974     "group": "Dynamics365_Accounts",
8975     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8976     "version": "0.0.0",
8977     "filename": "server/api/intDynamics365Account/index.js",
8978     "groupTitle": "Dynamics365_Accounts"
8979   },
8980   {
8981     "type": "get",
8982     "url": "/api/integrations/dynamics365/accounts/{id}/configurations",
8983     "title": "Gets account configurations",
8984     "examples": [
8985       {
8986         "title": "Example usage:",
8987         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/configurations -v -u {name}:{password} -X GET",
8988         "type": "json"
8989       }
8990     ],
8991     "name": "getConfigurations",
8992     "group": "Dynamics365_Accounts",
8993     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8994     "version": "0.0.0",
8995     "filename": "server/api/intDynamics365Account/index.js",
8996     "groupTitle": "Dynamics365_Accounts"
8997   },
8998   {
8999     "type": "get",
9000     "url": "/api/integrations/dynamics365/accounts/{id}/fields",
9001     "title": "Gets account fields",
9002     "examples": [
9003       {
9004         "title": "Example usage:",
9005         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/fields -v -u {name}:{password} -X GET",
9006         "type": "json"
9007       }
9008     ],
9009     "name": "getFields",
9010     "group": "Dynamics365_Accounts",
9011     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9012     "version": "0.0.0",
9013     "filename": "server/api/intDynamics365Account/index.js",
9014     "groupTitle": "Dynamics365_Accounts"
9015   },
9016   {
9017     "type": "put",
9018     "url": "/api/integrations/dynamics365/accounts/{id}",
9019     "title": "Update an existing Dynamics365 Account",
9020     "examples": [
9021       {
9022         "title": "Example usage:",
9023         "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",
9024         "type": "json"
9025       }
9026     ],
9027     "name": "updateDynamics365_Accounts",
9028     "group": "Dynamics365_Accounts",
9029     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9030     "version": "0.0.0",
9031     "filename": "server/api/intDynamics365Account/index.js",
9032     "groupTitle": "Dynamics365_Accounts"
9033   },
9034   {
9035     "type": "post",
9036     "url": "/api/integrations/dynamics365/configurations",
9037     "title": "Creates a new Dynamics365 Configuration",
9038     "examples": [
9039       {
9040         "title": "Example usage:",
9041         "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",
9042         "type": "json"
9043       }
9044     ],
9045     "name": "CreateDynamics365_Configurations",
9046     "group": "Dynamics365_Configurations",
9047     "parameter": {
9048       "fields": {
9049         "Body": [
9050           {
9051             "group": "Body",
9052             "type": "String",
9053             "optional": true,
9054             "field": "name",
9055             "description": ""
9056           },
9057           {
9058             "group": "Body",
9059             "type": "String",
9060             "optional": true,
9061             "field": "description",
9062             "description": ""
9063           },
9064           {
9065             "group": "Body",
9066             "type": "String",
9067             "allowedValues": [
9068               "\"incident\"",
9069               "\"phonecall\""
9070             ],
9071             "optional": true,
9072             "field": "ticketType",
9073             "description": ""
9074           }
9075         ]
9076       }
9077     },
9078     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9079     "version": "0.0.0",
9080     "filename": "server/api/intDynamics365Configuration/index.js",
9081     "groupTitle": "Dynamics365_Configurations"
9082   },
9083   {
9084     "type": "delete",
9085     "url": "/api/integrations/dynamics365/configurations/{id}",
9086     "title": "Deletes a Dynamics365 Configuration",
9087     "examples": [
9088       {
9089         "title": "Example usage:",
9090         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password} -X DELETE",
9091         "type": "json"
9092       }
9093     ],
9094     "name": "DeleteDynamics365_Configurations",
9095     "group": "Dynamics365_Configurations",
9096     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9097     "version": "0.0.0",
9098     "filename": "server/api/intDynamics365Configuration/index.js",
9099     "groupTitle": "Dynamics365_Configurations"
9100   },
9101   {
9102     "type": "get",
9103     "url": "/api/integrations/dynamics365/configurations",
9104     "title": "Gets a list of Dynamics365 Configurations",
9105     "examples": [
9106       {
9107         "title": "Example usage:",
9108         "content": "curl https://{domain}/api/integrations/dynamics365/configurations -v -u {name}:{password}",
9109         "type": "json"
9110       }
9111     ],
9112     "name": "GetDynamics365_Configurations",
9113     "group": "Dynamics365_Configurations",
9114     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9115     "version": "0.0.0",
9116     "filename": "server/api/intDynamics365Configuration/index.js",
9117     "groupTitle": "Dynamics365_Configurations"
9118   },
9119   {
9120     "type": "get",
9121     "url": "/api/integrations/dynamics365/configurations/{id}",
9122     "title": "Gets a single Dynamics365 Configuration",
9123     "examples": [
9124       {
9125         "title": "Example usage:",
9126         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password}",
9127         "type": "json"
9128       }
9129     ],
9130     "name": "ShowDynamics365_Configurations",
9131     "group": "Dynamics365_Configurations",
9132     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9133     "version": "0.0.0",
9134     "filename": "server/api/intDynamics365Configuration/index.js",
9135     "groupTitle": "Dynamics365_Configurations"
9136   },
9137   {
9138     "type": "get",
9139     "url": "/api/integrations/dynamics365/configurations/{id}/descriptions",
9140     "title": "Gets configurations descriptions",
9141     "examples": [
9142       {
9143         "title": "Example usage:",
9144         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
9145         "type": "json"
9146       }
9147     ],
9148     "name": "getDescriptions",
9149     "group": "Dynamics365_Configurations",
9150     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9151     "version": "0.0.0",
9152     "filename": "server/api/intDynamics365Configuration/index.js",
9153     "groupTitle": "Dynamics365_Configurations"
9154   },
9155   {
9156     "type": "get",
9157     "url": "/api/integrations/dynamics365/configurations/{id}/fields",
9158     "title": "Gets configurations fields",
9159     "examples": [
9160       {
9161         "title": "Example usage:",
9162         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
9163         "type": "json"
9164       }
9165     ],
9166     "name": "getFields",
9167     "group": "Dynamics365_Configurations",
9168     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9169     "version": "0.0.0",
9170     "filename": "server/api/intDynamics365Configuration/index.js",
9171     "groupTitle": "Dynamics365_Configurations"
9172   },
9173   {
9174     "type": "get",
9175     "url": "/api/integrations/zoho/configurations/{id}/subjects",
9176     "title": "Gets configurations subjects",
9177     "examples": [
9178       {
9179         "title": "Example usage:",
9180         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/subjects -v -u {name}:{password} -X GET",
9181         "type": "json"
9182       }
9183     ],
9184     "name": "getSubjects",
9185     "group": "Dynamics365_Configurations",
9186     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9187     "version": "0.0.0",
9188     "filename": "server/api/intDynamics365Configuration/index.js",
9189     "groupTitle": "Dynamics365_Configurations"
9190   },
9191   {
9192     "type": "put",
9193     "url": "/api/integrations/dynamics365/configurations/{id}",
9194     "title": "Update an existing Dynamics365 Configuration",
9195     "examples": [
9196       {
9197         "title": "Example usage:",
9198         "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",
9199         "type": "json"
9200       }
9201     ],
9202     "name": "updateDynamics365_Configurations",
9203     "group": "Dynamics365_Configurations",
9204     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9205     "version": "0.0.0",
9206     "filename": "server/api/intDynamics365Configuration/index.js",
9207     "groupTitle": "Dynamics365_Configurations"
9208   },
9209   {
9210     "type": "post",
9211     "url": "/api/integrations/dynamics365/fields",
9212     "title": "Creates a new Dynamics365 Field",
9213     "examples": [
9214       {
9215         "title": "Example usage:",
9216         "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",
9217         "type": "json"
9218       }
9219     ],
9220     "name": "CreateDynamics365_Fields",
9221     "group": "Dynamics365_Fields",
9222     "parameter": {
9223       "fields": {
9224         "Body": [
9225           {
9226             "group": "Body",
9227             "type": "String",
9228             "allowedValues": [
9229               "\"string\"",
9230               "\"variable\"",
9231               "\"customVariable\"",
9232               "\"keyValue\""
9233             ],
9234             "optional": true,
9235             "field": "type",
9236             "description": ""
9237           },
9238           {
9239             "group": "Body",
9240             "type": "String",
9241             "optional": true,
9242             "field": "content",
9243             "description": ""
9244           },
9245           {
9246             "group": "Body",
9247             "type": "String",
9248             "optional": true,
9249             "field": "key",
9250             "description": ""
9251           },
9252           {
9253             "group": "Body",
9254             "type": "String",
9255             "allowedValues": [
9256               "\"string\"",
9257               "\"variable\"",
9258               "\"customVariable\""
9259             ],
9260             "optional": true,
9261             "field": "keyType",
9262             "description": ""
9263           },
9264           {
9265             "group": "Body",
9266             "type": "String",
9267             "optional": true,
9268             "field": "keyContent",
9269             "description": ""
9270           },
9271           {
9272             "group": "Body",
9273             "type": "String",
9274             "optional": true,
9275             "field": "idField",
9276             "description": ""
9277           },
9278           {
9279             "group": "Body",
9280             "type": "String",
9281             "optional": true,
9282             "field": "nameField",
9283             "description": ""
9284           },
9285           {
9286             "group": "Body",
9287             "type": "Boolean",
9288             "optional": true,
9289             "field": "customField",
9290             "description": ""
9291           },
9292           {
9293             "group": "Body",
9294             "type": "String",
9295             "optional": true,
9296             "field": "variableName",
9297             "description": ""
9298           }
9299         ]
9300       }
9301     },
9302     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9303     "version": "0.0.0",
9304     "filename": "server/api/intDynamics365Field/index.js",
9305     "groupTitle": "Dynamics365_Fields"
9306   },
9307   {
9308     "type": "delete",
9309     "url": "/api/integrations/dynamics365/fields/{id}",
9310     "title": "Deletes a Dynamics365 Field",
9311     "examples": [
9312       {
9313         "title": "Example usage:",
9314         "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password} -X DELETE",
9315         "type": "json"
9316       }
9317     ],
9318     "name": "DeleteDynamics365_Fields",
9319     "group": "Dynamics365_Fields",
9320     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9321     "version": "0.0.0",
9322     "filename": "server/api/intDynamics365Field/index.js",
9323     "groupTitle": "Dynamics365_Fields"
9324   },
9325   {
9326     "type": "get",
9327     "url": "/api/integrations/dynamics365/fields",
9328     "title": "Gets a list of Dynamics365 Fields",
9329     "examples": [
9330       {
9331         "title": "Example usage:",
9332         "content": "curl https://{domain}/api/integrations/dynamics365/fields -v -u {name}:{password}",
9333         "type": "json"
9334       }
9335     ],
9336     "name": "GetDynamics365_Fields",
9337     "group": "Dynamics365_Fields",
9338     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9339     "version": "0.0.0",
9340     "filename": "server/api/intDynamics365Field/index.js",
9341     "groupTitle": "Dynamics365_Fields"
9342   },
9343   {
9344     "type": "get",
9345     "url": "/api/integrations/dynamics365/fields/{id}",
9346     "title": "Gets a single Dynamics365 Field",
9347     "examples": [
9348       {
9349         "title": "Example usage:",
9350         "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password}",
9351         "type": "json"
9352       }
9353     ],
9354     "name": "ShowDynamics365_Fields",
9355     "group": "Dynamics365_Fields",
9356     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9357     "version": "0.0.0",
9358     "filename": "server/api/intDynamics365Field/index.js",
9359     "groupTitle": "Dynamics365_Fields"
9360   },
9361   {
9362     "type": "put",
9363     "url": "/api/integrations/dynamics365/fields/{id}",
9364     "title": "Update an existing Dynamics365 Field",
9365     "examples": [
9366       {
9367         "title": "Example usage:",
9368         "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",
9369         "type": "json"
9370       }
9371     ],
9372     "name": "updateDynamics365_Fields",
9373     "group": "Dynamics365_Fields",
9374     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9375     "version": "0.0.0",
9376     "filename": "server/api/intDynamics365Field/index.js",
9377     "groupTitle": "Dynamics365_Fields"
9378   },
9379   {
9380     "type": "post",
9381     "url": "/api/fax/accounts/{id}/users",
9382     "title": "Add agents to a fax account",
9383     "examples": [
9384       {
9385         "title": "Example usage:",
9386         "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",
9387         "type": "json"
9388       }
9389     ],
9390     "name": "AddAgents",
9391     "group": "Fax_Accounts",
9392     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9393     "version": "0.0.0",
9394     "filename": "server/api/faxAccount/index.js",
9395     "groupTitle": "Fax_Accounts"
9396   },
9397   {
9398     "type": "post",
9399     "url": "/api/fax/accounts",
9400     "title": "Creates a new Account",
9401     "examples": [
9402       {
9403         "title": "Example usage:",
9404         "content": "curl https://{domain}/api/fax/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
9405         "type": "json"
9406       }
9407     ],
9408     "name": "CreateAccounts",
9409     "group": "Fax_Accounts",
9410     "parameter": {
9411       "fields": {
9412         "Body": [
9413           {
9414             "group": "Body",
9415             "type": "String",
9416             "optional": false,
9417             "field": "name",
9418             "description": ""
9419           },
9420           {
9421             "group": "Body",
9422             "type": "String",
9423             "optional": true,
9424             "field": "description",
9425             "description": ""
9426           },
9427           {
9428             "group": "Body",
9429             "type": "String",
9430             "allowedValues": [
9431               "\"yes\"",
9432               "\"no\""
9433             ],
9434             "optional": true,
9435             "field": "ecm",
9436             "description": ""
9437           },
9438           {
9439             "group": "Body",
9440             "type": "String",
9441             "optional": true,
9442             "field": "headerinfo",
9443             "description": ""
9444           },
9445           {
9446             "group": "Body",
9447             "type": "String",
9448             "optional": true,
9449             "field": "localstationid",
9450             "description": ""
9451           },
9452           {
9453             "group": "Body",
9454             "type": "String",
9455             "allowedValues": [
9456               "\"2400\"",
9457               "\"4800\"",
9458               "\"7200\"",
9459               "\"9600\"",
9460               "\"12000\"",
9461               "\"14400\""
9462             ],
9463             "optional": true,
9464             "field": "minrate",
9465             "description": ""
9466           },
9467           {
9468             "group": "Body",
9469             "type": "String",
9470             "allowedValues": [
9471               "\"2400\"",
9472               "\"4800\"",
9473               "\"7200\"",
9474               "\"9600\"",
9475               "\"12000\"",
9476               "\"14400\""
9477             ],
9478             "optional": true,
9479             "field": "maxrate",
9480             "description": ""
9481           },
9482           {
9483             "group": "Body",
9484             "type": "String",
9485             "optional": true,
9486             "field": "modem",
9487             "description": ""
9488           },
9489           {
9490             "group": "Body",
9491             "type": "String",
9492             "optional": true,
9493             "field": "gateway",
9494             "description": ""
9495           },
9496           {
9497             "group": "Body",
9498             "type": "String",
9499             "optional": true,
9500             "field": "faxdetect",
9501             "description": ""
9502           },
9503           {
9504             "group": "Body",
9505             "type": "Integer",
9506             "optional": true,
9507             "field": "t38timeout",
9508             "description": ""
9509           },
9510           {
9511             "group": "Body",
9512             "type": "String",
9513             "allowedValues": [
9514               "\"SIP\"",
9515               "\"IAX\"",
9516               "\"DADHI\"",
9517               "\"KHOMP\""
9518             ],
9519             "optional": true,
9520             "field": "tech",
9521             "description": ""
9522           },
9523           {
9524             "group": "Body",
9525             "type": "String",
9526             "optional": false,
9527             "field": "key",
9528             "description": ""
9529           },
9530           {
9531             "group": "Body",
9532             "type": "Text",
9533             "optional": true,
9534             "field": "notificationTemplate",
9535             "description": ""
9536           },
9537           {
9538             "group": "Body",
9539             "type": "Boolean",
9540             "optional": true,
9541             "field": "notificationSound",
9542             "description": ""
9543           },
9544           {
9545             "group": "Body",
9546             "type": "Boolean",
9547             "optional": true,
9548             "field": "notificationShake",
9549             "description": ""
9550           },
9551           {
9552             "group": "Body",
9553             "type": "Integer",
9554             "optional": true,
9555             "field": "waitForTheAssignedAgent",
9556             "description": ""
9557           },
9558           {
9559             "group": "Body",
9560             "type": "Boolean",
9561             "optional": true,
9562             "field": "queueTransfer",
9563             "description": ""
9564           },
9565           {
9566             "group": "Body",
9567             "type": "Integer",
9568             "optional": true,
9569             "field": "queueTransferTimeout",
9570             "description": ""
9571           },
9572           {
9573             "group": "Body",
9574             "type": "Boolean",
9575             "optional": true,
9576             "field": "agentTransfer",
9577             "description": ""
9578           },
9579           {
9580             "group": "Body",
9581             "type": "Integer",
9582             "optional": true,
9583             "field": "agentTransferTimeout",
9584             "description": ""
9585           },
9586           {
9587             "group": "Body",
9588             "type": "Integer",
9589             "optional": true,
9590             "field": "mandatoryDispositionPauseId",
9591             "description": "<p>Status to put when mandatory disposition is enabled</p>"
9592           },
9593           {
9594             "group": "Body",
9595             "type": "Boolean",
9596             "optional": true,
9597             "field": "mandatoryDisposition",
9598             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
9599           }
9600         ]
9601       }
9602     },
9603     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9604     "version": "0.0.0",
9605     "filename": "server/api/faxAccount/index.js",
9606     "groupTitle": "Fax_Accounts"
9607   },
9608   {
9609     "type": "delete",
9610     "url": "/api/fax/accounts/{id}",
9611     "title": "Deletes a Account",
9612     "examples": [
9613       {
9614         "title": "Example usage:",
9615         "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password} -X DELETE",
9616         "type": "json"
9617       }
9618     ],
9619     "name": "DeleteAccounts",
9620     "group": "Fax_Accounts",
9621     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9622     "version": "0.0.0",
9623     "filename": "server/api/faxAccount/index.js",
9624     "groupTitle": "Fax_Accounts"
9625   },
9626   {
9627     "type": "get",
9628     "url": "/api/fax/accounts/describe",
9629     "title": "Gets table info about Accounts",
9630     "examples": [
9631       {
9632         "title": "Example usage:",
9633         "content": "curl https://{domain}/api/fax/accounts/describe -v -u {name}:{password}",
9634         "type": "json"
9635       }
9636     ],
9637     "name": "DescribeAccounts",
9638     "group": "Fax_Accounts",
9639     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9640     "version": "0.0.0",
9641     "filename": "server/api/faxAccount/index.js",
9642     "groupTitle": "Fax_Accounts"
9643   },
9644   {
9645     "type": "get",
9646     "url": "/api/fax/accounts",
9647     "title": "Gets a list of Accounts",
9648     "examples": [
9649       {
9650         "title": "Example usage:",
9651         "content": "curl https://{domain}/api/fax/accounts -v -u {name}:{password}",
9652         "type": "json"
9653       }
9654     ],
9655     "name": "GetAccounts",
9656     "group": "Fax_Accounts",
9657     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9658     "version": "0.0.0",
9659     "filename": "server/api/faxAccount/index.js",
9660     "groupTitle": "Fax_Accounts"
9661   },
9662   {
9663     "type": "get",
9664     "url": "/api/fax/accounts/{id}/users",
9665     "title": "Gets agents from fax account",
9666     "examples": [
9667       {
9668         "title": "Example usage:",
9669         "content": "curl https://{domain}/api/fax/accounts/{id}/users -v -u {name}:{password} -X GET",
9670         "type": "json"
9671       }
9672     ],
9673     "name": "GetAgents",
9674     "group": "Fax_Accounts",
9675     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9676     "version": "0.0.0",
9677     "filename": "server/api/faxAccount/index.js",
9678     "groupTitle": "Fax_Accounts"
9679   },
9680   {
9681     "type": "delete",
9682     "url": "/api/fax/accounts/{id}/users",
9683     "title": "Removes agents from a fax account",
9684     "examples": [
9685       {
9686         "title": "Example usage:",
9687         "content": "curl https://{domain}/api/fax/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9688         "type": "json"
9689       }
9690     ],
9691     "name": "RemoveAgents",
9692     "group": "Fax_Accounts",
9693     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9694     "version": "0.0.0",
9695     "filename": "server/api/faxAccount/index.js",
9696     "groupTitle": "Fax_Accounts"
9697   },
9698   {
9699     "type": "delete",
9700     "url": "/api/fax/accounts/{id}/canned_answers",
9701     "title": "Removes canned answers from account",
9702     "examples": [
9703       {
9704         "title": "Example usage:",
9705         "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9706         "type": "json"
9707       }
9708     ],
9709     "name": "RemoveAnswers",
9710     "group": "Fax_Accounts",
9711     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9712     "version": "0.0.0",
9713     "filename": "server/api/faxAccount/index.js",
9714     "groupTitle": "Fax_Accounts"
9715   },
9716   {
9717     "type": "delete",
9718     "url": "/api/fax/accounts/{id}/dispositions",
9719     "title": "Removes dispositions from account",
9720     "examples": [
9721       {
9722         "title": "Example usage:",
9723         "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9724         "type": "json"
9725       }
9726     ],
9727     "name": "RemoveDispositions",
9728     "group": "Fax_Accounts",
9729     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9730     "version": "0.0.0",
9731     "filename": "server/api/faxAccount/index.js",
9732     "groupTitle": "Fax_Accounts"
9733   },
9734   {
9735     "type": "get",
9736     "url": "/api/fax/accounts/{id}",
9737     "title": "Gets a single Account",
9738     "examples": [
9739       {
9740         "title": "Example usage:",
9741         "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password}",
9742         "type": "json"
9743       }
9744     ],
9745     "name": "ShowAccounts",
9746     "group": "Fax_Accounts",
9747     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9748     "version": "0.0.0",
9749     "filename": "server/api/faxAccount/index.js",
9750     "groupTitle": "Fax_Accounts"
9751   },
9752   {
9753     "type": "post",
9754     "url": "/api/fax/accounts/{id}/canned_answers",
9755     "title": "Creates new canned answer",
9756     "examples": [
9757       {
9758         "title": "Example usage:",
9759         "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",
9760         "type": "json"
9761       }
9762     ],
9763     "name": "addAnswer",
9764     "group": "Fax_Accounts",
9765     "parameter": {
9766       "fields": {
9767         "Body": [
9768           {
9769             "group": "Body",
9770             "type": "String",
9771             "optional": false,
9772             "field": "key",
9773             "description": ""
9774           },
9775           {
9776             "group": "Body",
9777             "type": "Text",
9778             "optional": false,
9779             "field": "value",
9780             "description": ""
9781           },
9782           {
9783             "group": "Body",
9784             "type": "String",
9785             "optional": true,
9786             "field": "description",
9787             "description": ""
9788           },
9789           {
9790             "group": "Body",
9791             "type": "Virtual",
9792             "optional": true,
9793             "field": "name",
9794             "description": ""
9795           }
9796         ]
9797       }
9798     },
9799     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9800     "version": "0.0.0",
9801     "filename": "server/api/faxAccount/index.js",
9802     "groupTitle": "Fax_Accounts"
9803   },
9804   {
9805     "type": "post",
9806     "url": "/api/fax/accounts/{id}/applications",
9807     "title": "Creates new applications",
9808     "examples": [
9809       {
9810         "title": "Example usage:",
9811         "content": "curl https://{domain}/api/fax/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9812         "type": "json"
9813       }
9814     ],
9815     "name": "addApplications",
9816     "group": "Fax_Accounts",
9817     "parameter": {
9818       "fields": {
9819         "Body": [
9820           {
9821             "group": "Body",
9822             "type": "Integer",
9823             "optional": false,
9824             "field": "priority",
9825             "description": ""
9826           },
9827           {
9828             "group": "Body",
9829             "type": "String",
9830             "optional": false,
9831             "field": "app",
9832             "description": ""
9833           },
9834           {
9835             "group": "Body",
9836             "type": "Text",
9837             "optional": true,
9838             "field": "appdata",
9839             "description": ""
9840           },
9841           {
9842             "group": "Body",
9843             "type": "String",
9844             "optional": true,
9845             "field": "description",
9846             "description": ""
9847           },
9848           {
9849             "group": "Body",
9850             "type": "String",
9851             "optional": true,
9852             "field": "interval",
9853             "description": ""
9854           }
9855         ]
9856       }
9857     },
9858     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9859     "version": "0.0.0",
9860     "filename": "server/api/faxAccount/index.js",
9861     "groupTitle": "Fax_Accounts"
9862   },
9863   {
9864     "type": "post",
9865     "url": "/api/fax/accounts/addaccountapplications",
9866     "title": "Creates new account and applications",
9867     "examples": [
9868       {
9869         "title": "Example usage:",
9870         "content": "curl https://{domain}/api/fax/accounts/addaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9871         "type": "json"
9872       }
9873     ],
9874     "name": "addApplications",
9875     "group": "Fax_Accounts",
9876     "parameter": {
9877       "fields": {
9878         "Body": [
9879           {
9880             "group": "Body",
9881             "type": "Integer",
9882             "optional": false,
9883             "field": "priority",
9884             "description": ""
9885           },
9886           {
9887             "group": "Body",
9888             "type": "String",
9889             "optional": false,
9890             "field": "app",
9891             "description": ""
9892           },
9893           {
9894             "group": "Body",
9895             "type": "Text",
9896             "optional": true,
9897             "field": "appdata",
9898             "description": ""
9899           },
9900           {
9901             "group": "Body",
9902             "type": "String",
9903             "optional": true,
9904             "field": "description",
9905             "description": ""
9906           },
9907           {
9908             "group": "Body",
9909             "type": "String",
9910             "optional": true,
9911             "field": "interval",
9912             "description": ""
9913           }
9914         ]
9915       }
9916     },
9917     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9918     "version": "0.0.0",
9919     "filename": "server/api/faxAccount/index.js",
9920     "groupTitle": "Fax_Accounts"
9921   },
9922   {
9923     "type": "post",
9924     "url": "/api/fax/accounts/{id}/dispositions",
9925     "title": "Creates new disposition",
9926     "examples": [
9927       {
9928         "title": "Example usage:",
9929         "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9930         "type": "json"
9931       }
9932     ],
9933     "name": "addDisposition",
9934     "group": "Fax_Accounts",
9935     "parameter": {
9936       "fields": {
9937         "Body": [
9938           {
9939             "group": "Body",
9940             "type": "String",
9941             "optional": false,
9942             "field": "name",
9943             "description": ""
9944           },
9945           {
9946             "group": "Body",
9947             "type": "String",
9948             "allowedValues": [
9949               "\"first\"",
9950               "\"second\"",
9951               "\"third\""
9952             ],
9953             "optional": false,
9954             "field": "level",
9955             "description": ""
9956           },
9957           {
9958             "group": "Body",
9959             "type": "String",
9960             "optional": true,
9961             "field": "description",
9962             "description": ""
9963           }
9964         ]
9965       }
9966     },
9967     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9968     "version": "0.0.0",
9969     "filename": "server/api/faxAccount/index.js",
9970     "groupTitle": "Fax_Accounts"
9971   },
9972   {
9973     "type": "post",
9974     "url": "/api/fax/accounts/{id}/interactions",
9975     "title": "Creates new interactions",
9976     "examples": [
9977       {
9978         "title": "Example usage:",
9979         "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",
9980         "type": "json"
9981       }
9982     ],
9983     "name": "addInteraction",
9984     "group": "Fax_Accounts",
9985     "parameter": {
9986       "fields": {
9987         "Body": [
9988           {
9989             "group": "Body",
9990             "type": "Boolean",
9991             "optional": true,
9992             "field": "closed",
9993             "description": ""
9994           },
9995           {
9996             "group": "Body",
9997             "type": "String",
9998             "optional": true,
9999             "field": "closedAt",
10000             "description": ""
10001           },
10002           {
10003             "group": "Body",
10004             "type": "String",
10005             "optional": true,
10006             "field": "disposition",
10007             "description": ""
10008           },
10009           {
10010             "group": "Body",
10011             "type": "String",
10012             "optional": true,
10013             "field": "secondDisposition",
10014             "description": ""
10015           },
10016           {
10017             "group": "Body",
10018             "type": "String",
10019             "optional": true,
10020             "field": "thirdDisposition",
10021             "description": ""
10022           },
10023           {
10024             "group": "Body",
10025             "type": "String",
10026             "optional": true,
10027             "field": "note",
10028             "description": ""
10029           },
10030           {
10031             "group": "Body",
10032             "type": "String",
10033             "optional": true,
10034             "field": "read1stAt",
10035             "description": ""
10036           },
10037           {
10038             "group": "Body",
10039             "type": "String",
10040             "optional": true,
10041             "field": "fax",
10042             "description": ""
10043           },
10044           {
10045             "group": "Body",
10046             "type": "String",
10047             "allowedValues": [
10048               "\"in\"",
10049               "\"out\""
10050             ],
10051             "optional": false,
10052             "field": "firstMsgDirection",
10053             "description": ""
10054           },
10055           {
10056             "group": "Body",
10057             "type": "String",
10058             "optional": true,
10059             "field": "lastMsgAt",
10060             "description": ""
10061           },
10062           {
10063             "group": "Body",
10064             "type": "String",
10065             "allowedValues": [
10066               "\"in\"",
10067               "\"out\""
10068             ],
10069             "optional": false,
10070             "field": "lastMsgDirection",
10071             "description": ""
10072           }
10073         ]
10074       }
10075     },
10076     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10077     "version": "0.0.0",
10078     "filename": "server/api/faxAccount/index.js",
10079     "groupTitle": "Fax_Accounts"
10080   },
10081   {
10082     "type": "get",
10083     "url": "/api/fax/accounts/{id}/canned_answers",
10084     "title": "Gets account canned answers",
10085     "examples": [
10086       {
10087         "title": "Example usage:",
10088         "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
10089         "type": "json"
10090       }
10091     ],
10092     "name": "getAnswers",
10093     "group": "Fax_Accounts",
10094     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10095     "version": "0.0.0",
10096     "filename": "server/api/faxAccount/index.js",
10097     "groupTitle": "Fax_Accounts"
10098   },
10099   {
10100     "type": "get",
10101     "url": "/api/fax/accounts/{id}/applications",
10102     "title": "Gets account pplications",
10103     "examples": [
10104       {
10105         "title": "Example usage:",
10106         "content": "curl https://{domain}/api/fax/accounts/{id}/applications -v -u {name}:{password} -X GET",
10107         "type": "json"
10108       }
10109     ],
10110     "name": "getApplications",
10111     "group": "Fax_Accounts",
10112     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10113     "version": "0.0.0",
10114     "filename": "server/api/faxAccount/index.js",
10115     "groupTitle": "Fax_Accounts"
10116   },
10117   {
10118     "type": "get",
10119     "url": "/api/fax/accounts/{id}/dispositions",
10120     "title": "Gets account dispositions",
10121     "examples": [
10122       {
10123         "title": "Example usage:",
10124         "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
10125         "type": "json"
10126       }
10127     ],
10128     "name": "getDispositions",
10129     "group": "Fax_Accounts",
10130     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10131     "version": "0.0.0",
10132     "filename": "server/api/faxAccount/index.js",
10133     "groupTitle": "Fax_Accounts"
10134   },
10135   {
10136     "type": "get",
10137     "url": "/api/fax/accounts/{id}/interactions",
10138     "title": "Gets account interactions",
10139     "examples": [
10140       {
10141         "title": "Example usage:",
10142         "content": "curl https://{domain}/api/fax/accounts/{id}/interactions -v -u {name}:{password} -X GET",
10143         "type": "json"
10144       }
10145     ],
10146     "name": "getInteraction",
10147     "group": "Fax_Accounts",
10148     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10149     "version": "0.0.0",
10150     "filename": "server/api/faxAccount/index.js",
10151     "groupTitle": "Fax_Accounts"
10152   },
10153   {
10154     "type": "get",
10155     "url": "/api/fax/accounts/{id}/messages",
10156     "title": "Gets account messages",
10157     "examples": [
10158       {
10159         "title": "Example usage:",
10160         "content": "curl https://{domain}/api/fax/accounts/{id}/messages -v -u {name}:{password} -X GET",
10161         "type": "json"
10162       }
10163     ],
10164     "name": "getMessages",
10165     "group": "Fax_Accounts",
10166     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10167     "version": "0.0.0",
10168     "filename": "server/api/faxAccount/index.js",
10169     "groupTitle": "Fax_Accounts"
10170   },
10171   {
10172     "type": "post",
10173     "url": "/api/fax/accounts/{id}/send",
10174     "title": "Send new fax",
10175     "examples": [
10176       {
10177         "title": "Example usage:",
10178         "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",
10179         "type": "json"
10180       }
10181     ],
10182     "name": "sendFax",
10183     "group": "Fax_Accounts",
10184     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10185     "version": "0.0.0",
10186     "filename": "server/api/faxAccount/index.js",
10187     "groupTitle": "Fax_Accounts"
10188   },
10189   {
10190     "type": "put",
10191     "url": "/api/fax/accounts/{id}",
10192     "title": "Update an existing Account",
10193     "examples": [
10194       {
10195         "title": "Example usage:",
10196         "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",
10197         "type": "json"
10198       }
10199     ],
10200     "name": "updateAccounts",
10201     "group": "Fax_Accounts",
10202     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10203     "version": "0.0.0",
10204     "filename": "server/api/faxAccount/index.js",
10205     "groupTitle": "Fax_Accounts"
10206   },
10207   {
10208     "type": "post",
10209     "url": "/api/fax/accounts/updateaccountapplications",
10210     "title": "Update account and applications",
10211     "examples": [
10212       {
10213         "title": "Example usage:",
10214         "content": "curl https://{domain}/api/fax/accounts/updateaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10215         "type": "json"
10216       }
10217     ],
10218     "name": "updateApplications",
10219     "group": "Fax_Accounts",
10220     "parameter": {
10221       "fields": {
10222         "Body": [
10223           {
10224             "group": "Body",
10225             "type": "Integer",
10226             "optional": false,
10227             "field": "priority",
10228             "description": ""
10229           },
10230           {
10231             "group": "Body",
10232             "type": "String",
10233             "optional": false,
10234             "field": "app",
10235             "description": ""
10236           },
10237           {
10238             "group": "Body",
10239             "type": "Text",
10240             "optional": true,
10241             "field": "appdata",
10242             "description": ""
10243           },
10244           {
10245             "group": "Body",
10246             "type": "String",
10247             "optional": true,
10248             "field": "description",
10249             "description": ""
10250           },
10251           {
10252             "group": "Body",
10253             "type": "String",
10254             "optional": true,
10255             "field": "interval",
10256             "description": ""
10257           }
10258         ]
10259       }
10260     },
10261     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10262     "version": "0.0.0",
10263     "filename": "server/api/faxAccount/index.js",
10264     "groupTitle": "Fax_Accounts"
10265   },
10266   {
10267     "type": "post",
10268     "url": "/api/fax/applications",
10269     "title": "Creates a new Application",
10270     "examples": [
10271       {
10272         "title": "Example usage:",
10273         "content": "curl https://{domain}/api/fax/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
10274         "type": "json"
10275       }
10276     ],
10277     "name": "CreateApplications",
10278     "group": "Fax_Applications",
10279     "parameter": {
10280       "fields": {
10281         "Body": [
10282           {
10283             "group": "Body",
10284             "type": "Integer",
10285             "optional": false,
10286             "field": "priority",
10287             "description": ""
10288           },
10289           {
10290             "group": "Body",
10291             "type": "String",
10292             "optional": false,
10293             "field": "app",
10294             "description": ""
10295           },
10296           {
10297             "group": "Body",
10298             "type": "Text",
10299             "optional": true,
10300             "field": "appdata",
10301             "description": ""
10302           },
10303           {
10304             "group": "Body",
10305             "type": "String",
10306             "optional": true,
10307             "field": "description",
10308             "description": ""
10309           },
10310           {
10311             "group": "Body",
10312             "type": "String",
10313             "optional": true,
10314             "field": "interval",
10315             "description": ""
10316           }
10317         ]
10318       }
10319     },
10320     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10321     "version": "0.0.0",
10322     "filename": "server/api/faxApplication/index.js",
10323     "groupTitle": "Fax_Applications"
10324   },
10325   {
10326     "type": "delete",
10327     "url": "/api/fax/applications/{id}",
10328     "title": "Deletes a Application",
10329     "examples": [
10330       {
10331         "title": "Example usage:",
10332         "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password} -X DELETE",
10333         "type": "json"
10334       }
10335     ],
10336     "name": "DeleteApplications",
10337     "group": "Fax_Applications",
10338     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10339     "version": "0.0.0",
10340     "filename": "server/api/faxApplication/index.js",
10341     "groupTitle": "Fax_Applications"
10342   },
10343   {
10344     "type": "get",
10345     "url": "/api/fax/applications",
10346     "title": "Gets a list of Applications",
10347     "examples": [
10348       {
10349         "title": "Example usage:",
10350         "content": "curl https://{domain}/api/fax/applications -v -u {name}:{password}",
10351         "type": "json"
10352       }
10353     ],
10354     "name": "GetApplications",
10355     "group": "Fax_Applications",
10356     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10357     "version": "0.0.0",
10358     "filename": "server/api/faxApplication/index.js",
10359     "groupTitle": "Fax_Applications"
10360   },
10361   {
10362     "type": "get",
10363     "url": "/api/fax/applications/{id}",
10364     "title": "Gets a single Application",
10365     "examples": [
10366       {
10367         "title": "Example usage:",
10368         "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password}",
10369         "type": "json"
10370       }
10371     ],
10372     "name": "ShowApplications",
10373     "group": "Fax_Applications",
10374     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10375     "version": "0.0.0",
10376     "filename": "server/api/faxApplication/index.js",
10377     "groupTitle": "Fax_Applications"
10378   },
10379   {
10380     "type": "put",
10381     "url": "/api/fax/applications/{id}",
10382     "title": "Update an existing Application",
10383     "examples": [
10384       {
10385         "title": "Example usage:",
10386         "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",
10387         "type": "json"
10388       }
10389     ],
10390     "name": "updateApplications",
10391     "group": "Fax_Applications",
10392     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10393     "version": "0.0.0",
10394     "filename": "server/api/faxApplication/index.js",
10395     "groupTitle": "Fax_Applications"
10396   },
10397   {
10398     "type": "post",
10399     "url": "/api/fax/interactions/{id}/tags",
10400     "title": "Add tags to the interaction",
10401     "examples": [
10402       {
10403         "title": "Example usage:",
10404         "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",
10405         "type": "json"
10406       }
10407     ],
10408     "name": "AddTags",
10409     "group": "Fax_Interactions",
10410     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10411     "version": "0.0.0",
10412     "filename": "server/api/faxInteraction/index.js",
10413     "groupTitle": "Fax_Interactions"
10414   },
10415   {
10416     "type": "post",
10417     "url": "/api/fax/interactions",
10418     "title": "Creates a new Interaction",
10419     "examples": [
10420       {
10421         "title": "Example usage:",
10422         "content": "curl https://{domain}/api/fax/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
10423         "type": "json"
10424       }
10425     ],
10426     "name": "CreateInteractions",
10427     "group": "Fax_Interactions",
10428     "parameter": {
10429       "fields": {
10430         "Body": [
10431           {
10432             "group": "Body",
10433             "type": "Boolean",
10434             "optional": true,
10435             "field": "closed",
10436             "description": ""
10437           },
10438           {
10439             "group": "Body",
10440             "type": "String",
10441             "optional": true,
10442             "field": "closedAt",
10443             "description": ""
10444           },
10445           {
10446             "group": "Body",
10447             "type": "String",
10448             "optional": true,
10449             "field": "disposition",
10450             "description": ""
10451           },
10452           {
10453             "group": "Body",
10454             "type": "String",
10455             "optional": true,
10456             "field": "secondDisposition",
10457             "description": ""
10458           },
10459           {
10460             "group": "Body",
10461             "type": "String",
10462             "optional": true,
10463             "field": "thirdDisposition",
10464             "description": ""
10465           },
10466           {
10467             "group": "Body",
10468             "type": "String",
10469             "optional": true,
10470             "field": "note",
10471             "description": ""
10472           },
10473           {
10474             "group": "Body",
10475             "type": "String",
10476             "optional": true,
10477             "field": "read1stAt",
10478             "description": ""
10479           },
10480           {
10481             "group": "Body",
10482             "type": "String",
10483             "optional": true,
10484             "field": "fax",
10485             "description": ""
10486           },
10487           {
10488             "group": "Body",
10489             "type": "String",
10490             "allowedValues": [
10491               "\"in\"",
10492               "\"out\""
10493             ],
10494             "optional": false,
10495             "field": "firstMsgDirection",
10496             "description": ""
10497           },
10498           {
10499             "group": "Body",
10500             "type": "String",
10501             "optional": true,
10502             "field": "lastMsgAt",
10503             "description": ""
10504           },
10505           {
10506             "group": "Body",
10507             "type": "String",
10508             "allowedValues": [
10509               "\"in\"",
10510               "\"out\""
10511             ],
10512             "optional": false,
10513             "field": "lastMsgDirection",
10514             "description": ""
10515           }
10516         ]
10517       }
10518     },
10519     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10520     "version": "0.0.0",
10521     "filename": "server/api/faxInteraction/index.js",
10522     "groupTitle": "Fax_Interactions"
10523   },
10524   {
10525     "type": "delete",
10526     "url": "/api/fax/interactions/{id}",
10527     "title": "Deletes a Interaction",
10528     "examples": [
10529       {
10530         "title": "Example usage:",
10531         "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password} -X DELETE",
10532         "type": "json"
10533       }
10534     ],
10535     "name": "DeleteInteractions",
10536     "group": "Fax_Interactions",
10537     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10538     "version": "0.0.0",
10539     "filename": "server/api/faxInteraction/index.js",
10540     "groupTitle": "Fax_Interactions"
10541   },
10542   {
10543     "type": "get",
10544     "url": "/api/fax/interactions/describe",
10545     "title": "Gets table info about Interactions",
10546     "examples": [
10547       {
10548         "title": "Example usage:",
10549         "content": "curl https://{domain}/api/fax/interactions/describe -v -u {name}:{password}",
10550         "type": "json"
10551       }
10552     ],
10553     "name": "DescribeInteractions",
10554     "group": "Fax_Interactions",
10555     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10556     "version": "0.0.0",
10557     "filename": "server/api/faxInteraction/index.js",
10558     "groupTitle": "Fax_Interactions"
10559   },
10560   {
10561     "type": "get",
10562     "url": "/api/fax/interactions",
10563     "title": "Gets a list of Interactions",
10564     "examples": [
10565       {
10566         "title": "Example usage:",
10567         "content": "curl https://{domain}/api/fax/interactions -v -u {name}:{password}",
10568         "type": "json"
10569       }
10570     ],
10571     "name": "GetInteractions",
10572     "group": "Fax_Interactions",
10573     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10574     "version": "0.0.0",
10575     "filename": "server/api/faxInteraction/index.js",
10576     "groupTitle": "Fax_Interactions"
10577   },
10578   {
10579     "type": "delete",
10580     "url": "/api/fax/interactions/{id}/tags",
10581     "title": "Removes tags from interaction",
10582     "examples": [
10583       {
10584         "title": "Example usage:",
10585         "content": "curl https://{domain}/api/fax/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
10586         "type": "json"
10587       }
10588     ],
10589     "name": "RemoveTags",
10590     "group": "Fax_Interactions",
10591     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10592     "version": "0.0.0",
10593     "filename": "server/api/faxInteraction/index.js",
10594     "groupTitle": "Fax_Interactions"
10595   },
10596   {
10597     "type": "get",
10598     "url": "/api/fax/interactions/{id}",
10599     "title": "Gets a single Interaction",
10600     "examples": [
10601       {
10602         "title": "Example usage:",
10603         "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password}",
10604         "type": "json"
10605       }
10606     ],
10607     "name": "ShowInteractions",
10608     "group": "Fax_Interactions",
10609     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10610     "version": "0.0.0",
10611     "filename": "server/api/faxInteraction/index.js",
10612     "groupTitle": "Fax_Interactions"
10613   },
10614   {
10615     "type": "post",
10616     "url": "/api/fax/interactions/{id}/messages",
10617     "title": "Creates new messages",
10618     "examples": [
10619       {
10620         "title": "Example usage:",
10621         "content": "curl https://{domain}/api/fax/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10622         "type": "json"
10623       }
10624     ],
10625     "name": "addMessage",
10626     "group": "Fax_Interactions",
10627     "parameter": {
10628       "fields": {
10629         "Body": [
10630           {
10631             "group": "Body",
10632             "type": "Text",
10633             "optional": false,
10634             "field": "body",
10635             "description": ""
10636           },
10637           {
10638             "group": "Body",
10639             "type": "Boolean",
10640             "optional": true,
10641             "field": "read",
10642             "description": ""
10643           },
10644           {
10645             "group": "Body",
10646             "type": "String",
10647             "allowedValues": [
10648               "\"in\"",
10649               "\"out\""
10650             ],
10651             "optional": false,
10652             "field": "direction",
10653             "description": ""
10654           },
10655           {
10656             "group": "Body",
10657             "type": "Text",
10658             "optional": true,
10659             "field": "failMessage",
10660             "description": ""
10661           },
10662           {
10663             "group": "Body",
10664             "type": "String",
10665             "optional": true,
10666             "field": "readAt",
10667             "description": ""
10668           }
10669         ]
10670       }
10671     },
10672     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10673     "version": "0.0.0",
10674     "filename": "server/api/faxInteraction/index.js",
10675     "groupTitle": "Fax_Interactions"
10676   },
10677   {
10678     "type": "get",
10679     "url": "/api/fax/interactions/{id}/download",
10680     "title": "Get interactions",
10681     "examples": [
10682       {
10683         "title": "Example usage:",
10684         "content": "curl https://{domain}/api/fax/interactions/{id}/download -v -u {name}:{password} -X GET",
10685         "type": "json"
10686       }
10687     ],
10688     "name": "download",
10689     "group": "Fax_Interactions",
10690     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10691     "version": "0.0.0",
10692     "filename": "server/api/faxInteraction/index.js",
10693     "groupTitle": "Fax_Interactions"
10694   },
10695   {
10696     "type": "get",
10697     "url": "/api/fax/interactions/{id}/messages",
10698     "title": "Gets interaction messages",
10699     "examples": [
10700       {
10701         "title": "Example usage:",
10702         "content": "curl https://{domain}/api/fax/interactions/{id}/messages -v -u {name}:{password} -X GET",
10703         "type": "json"
10704       }
10705     ],
10706     "name": "getMessages",
10707     "group": "Fax_Interactions",
10708     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10709     "version": "0.0.0",
10710     "filename": "server/api/faxInteraction/index.js",
10711     "groupTitle": "Fax_Interactions"
10712   },
10713   {
10714     "type": "put",
10715     "url": "/api/fax/interactions/{id}",
10716     "title": "Update an existing Interaction",
10717     "examples": [
10718       {
10719         "title": "Example usage:",
10720         "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",
10721         "type": "json"
10722       }
10723     ],
10724     "name": "updateInteractions",
10725     "group": "Fax_Interactions",
10726     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10727     "version": "0.0.0",
10728     "filename": "server/api/faxInteraction/index.js",
10729     "groupTitle": "Fax_Interactions"
10730   },
10731   {
10732     "type": "get",
10733     "url": "/api/fax/messages/{id}/download",
10734     "title": "Get message",
10735     "examples": [
10736       {
10737         "title": "Example usage:",
10738         "content": "curl https://{domain}/api/fax/messages/{id}/download -v -u {name}:{password} -X GET",
10739         "type": "json"
10740       }
10741     ],
10742     "name": "download",
10743     "group": "Fax_Message",
10744     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10745     "version": "0.0.0",
10746     "filename": "server/api/faxMessage/index.js",
10747     "groupTitle": "Fax_Message"
10748   },
10749   {
10750     "type": "delete",
10751     "url": "/api/fax/messages/{id}",
10752     "title": "Deletes a Message",
10753     "examples": [
10754       {
10755         "title": "Example usage:",
10756         "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password} -X DELETE",
10757         "type": "json"
10758       }
10759     ],
10760     "name": "DeleteMessages",
10761     "group": "Fax_Messages",
10762     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10763     "version": "0.0.0",
10764     "filename": "server/api/faxMessage/index.js",
10765     "groupTitle": "Fax_Messages"
10766   },
10767   {
10768     "type": "get",
10769     "url": "/api/fax/messages/describe",
10770     "title": "Gets table info about Messages",
10771     "examples": [
10772       {
10773         "title": "Example usage:",
10774         "content": "curl https://{domain}/api/fax/messages/describe -v -u {name}:{password}",
10775         "type": "json"
10776       }
10777     ],
10778     "name": "DescribeMessages",
10779     "group": "Fax_Messages",
10780     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10781     "version": "0.0.0",
10782     "filename": "server/api/faxMessage/index.js",
10783     "groupTitle": "Fax_Messages"
10784   },
10785   {
10786     "type": "get",
10787     "url": "/api/fax/messages",
10788     "title": "Gets a list of Messages",
10789     "examples": [
10790       {
10791         "title": "Example usage:",
10792         "content": "curl https://{domain}/api/fax/messages -v -u {name}:{password}",
10793         "type": "json"
10794       }
10795     ],
10796     "name": "GetMessages",
10797     "group": "Fax_Messages",
10798     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10799     "version": "0.0.0",
10800     "filename": "server/api/faxMessage/index.js",
10801     "groupTitle": "Fax_Messages"
10802   },
10803   {
10804     "type": "get",
10805     "url": "/api/fax/messages/{id}",
10806     "title": "Gets a single Message",
10807     "examples": [
10808       {
10809         "title": "Example usage:",
10810         "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password}",
10811         "type": "json"
10812       }
10813     ],
10814     "name": "ShowMessages",
10815     "group": "Fax_Messages",
10816     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10817     "version": "0.0.0",
10818     "filename": "server/api/faxMessage/index.js",
10819     "groupTitle": "Fax_Messages"
10820   },
10821   {
10822     "type": "put",
10823     "url": "/api/fax/messages/{id}/accept",
10824     "title": "Accepts message",
10825     "examples": [
10826       {
10827         "title": "Example usage:",
10828         "content": "curl https://{domain}/api/fax/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
10829         "type": "json"
10830       }
10831     ],
10832     "name": "acceptMessage",
10833     "group": "Fax_Messages",
10834     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10835     "version": "0.0.0",
10836     "filename": "server/api/faxMessage/index.js",
10837     "groupTitle": "Fax_Messages"
10838   },
10839   {
10840     "type": "post",
10841     "url": "/api/fax/messages",
10842     "title": "Create message and send Fax",
10843     "examples": [
10844       {
10845         "title": "Example usage:",
10846         "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
10847         "type": "json"
10848       }
10849     ],
10850     "name": "rejectMessage",
10851     "group": "Fax_Messages",
10852     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10853     "version": "0.0.0",
10854     "filename": "server/api/faxMessage/index.js",
10855     "groupTitle": "Fax_Messages"
10856   },
10857   {
10858     "type": "put",
10859     "url": "/api/fax/messages/{id}/reject",
10860     "title": "Rejects message",
10861     "examples": [
10862       {
10863         "title": "Example usage:",
10864         "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
10865         "type": "json"
10866       }
10867     ],
10868     "name": "rejectMessage",
10869     "group": "Fax_Messages",
10870     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10871     "version": "0.0.0",
10872     "filename": "server/api/faxMessage/index.js",
10873     "groupTitle": "Fax_Messages"
10874   },
10875   {
10876     "type": "put",
10877     "url": "/api/fax/messages/{id}",
10878     "title": "Update an existing Message",
10879     "examples": [
10880       {
10881         "title": "Example usage:",
10882         "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",
10883         "type": "json"
10884       }
10885     ],
10886     "name": "updateMessages",
10887     "group": "Fax_Messages",
10888     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10889     "version": "0.0.0",
10890     "filename": "server/api/faxMessage/index.js",
10891     "groupTitle": "Fax_Messages"
10892   },
10893   {
10894     "type": "post",
10895     "url": "/api/fax/reports/queue",
10896     "title": "Creates a new Fax Queue Report",
10897     "examples": [
10898       {
10899         "title": "Example usage:",
10900         "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",
10901         "type": "json"
10902       }
10903     ],
10904     "name": "CreateFax_Queue_Reports",
10905     "group": "Fax_Queue_Reports",
10906     "parameter": {
10907       "fields": {
10908         "Body": [
10909           {
10910             "group": "Body",
10911             "type": "String",
10912             "optional": false,
10913             "field": "uniqueid",
10914             "description": ""
10915           },
10916           {
10917             "group": "Body",
10918             "type": "String",
10919             "optional": true,
10920             "field": "from",
10921             "description": ""
10922           },
10923           {
10924             "group": "Body",
10925             "type": "String",
10926             "optional": true,
10927             "field": "joinAt",
10928             "description": ""
10929           },
10930           {
10931             "group": "Body",
10932             "type": "String",
10933             "optional": true,
10934             "field": "leaveAt",
10935             "description": ""
10936           },
10937           {
10938             "group": "Body",
10939             "type": "String",
10940             "optional": true,
10941             "field": "acceptAt",
10942             "description": ""
10943           },
10944           {
10945             "group": "Body",
10946             "type": "String",
10947             "optional": true,
10948             "field": "exitAt",
10949             "description": ""
10950           },
10951           {
10952             "group": "Body",
10953             "type": "String",
10954             "optional": true,
10955             "field": "reason",
10956             "description": ""
10957           }
10958         ]
10959       }
10960     },
10961     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10962     "version": "0.0.0",
10963     "filename": "server/api/faxQueueReport/index.js",
10964     "groupTitle": "Fax_Queue_Reports"
10965   },
10966   {
10967     "type": "delete",
10968     "url": "/api/fax/reports/queue/{id}",
10969     "title": "Deletes a Fax Queue Report",
10970     "examples": [
10971       {
10972         "title": "Example usage:",
10973         "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password} -X DELETE",
10974         "type": "json"
10975       }
10976     ],
10977     "name": "DeleteFax_Queue_Reports",
10978     "group": "Fax_Queue_Reports",
10979     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10980     "version": "0.0.0",
10981     "filename": "server/api/faxQueueReport/index.js",
10982     "groupTitle": "Fax_Queue_Reports"
10983   },
10984   {
10985     "type": "get",
10986     "url": "/api/fax/reports/queue/describe",
10987     "title": "Gets table info about Fax Queue Reports",
10988     "examples": [
10989       {
10990         "title": "Example usage:",
10991         "content": "curl https://{domain}/api/fax/reports/queue/describe -v -u {name}:{password}",
10992         "type": "json"
10993       }
10994     ],
10995     "name": "DescribeFax_Queue_Reports",
10996     "group": "Fax_Queue_Reports",
10997     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10998     "version": "0.0.0",
10999     "filename": "server/api/faxQueueReport/index.js",
11000     "groupTitle": "Fax_Queue_Reports"
11001   },
11002   {
11003     "type": "get",
11004     "url": "/api/fax/reports/queue",
11005     "title": "Gets a list of Fax Queue Reports",
11006     "examples": [
11007       {
11008         "title": "Example usage:",
11009         "content": "curl https://{domain}/api/fax/reports/queue -v -u {name}:{password}",
11010         "type": "json"
11011       }
11012     ],
11013     "name": "GetFax_Queue_Reports",
11014     "group": "Fax_Queue_Reports",
11015     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11016     "version": "0.0.0",
11017     "filename": "server/api/faxQueueReport/index.js",
11018     "groupTitle": "Fax_Queue_Reports"
11019   },
11020   {
11021     "type": "get",
11022     "url": "/api/fax/reports/queue/{id}",
11023     "title": "Gets a single Fax Queue Report",
11024     "examples": [
11025       {
11026         "title": "Example usage:",
11027         "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password}",
11028         "type": "json"
11029       }
11030     ],
11031     "name": "ShowFax_Queue_Reports",
11032     "group": "Fax_Queue_Reports",
11033     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11034     "version": "0.0.0",
11035     "filename": "server/api/faxQueueReport/index.js",
11036     "groupTitle": "Fax_Queue_Reports"
11037   },
11038   {
11039     "type": "put",
11040     "url": "/api/fax/reports/queue/{id}",
11041     "title": "Update an existing Fax Queue Report",
11042     "examples": [
11043       {
11044         "title": "Example usage:",
11045         "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",
11046         "type": "json"
11047       }
11048     ],
11049     "name": "updateFax_Queue_Reports",
11050     "group": "Fax_Queue_Reports",
11051     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11052     "version": "0.0.0",
11053     "filename": "server/api/faxQueueReport/index.js",
11054     "groupTitle": "Fax_Queue_Reports"
11055   },
11056   {
11057     "type": "post",
11058     "url": "/api/fax/queues/{id}/users",
11059     "title": "Add agents to a queue",
11060     "examples": [
11061       {
11062         "title": "Example usage:",
11063         "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",
11064         "type": "json"
11065       }
11066     ],
11067     "name": "AddAgents",
11068     "group": "Fax_Queues",
11069     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11070     "version": "0.0.0",
11071     "filename": "server/api/faxQueue/index.js",
11072     "groupTitle": "Fax_Queues"
11073   },
11074   {
11075     "type": "post",
11076     "url": "/api/fax/queues/{id}/teams",
11077     "title": "Add teams to a queue",
11078     "examples": [
11079       {
11080         "title": "Example usage:",
11081         "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",
11082         "type": "json"
11083       }
11084     ],
11085     "name": "AddTeams",
11086     "group": "Fax_Queues",
11087     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11088     "version": "0.0.0",
11089     "filename": "server/api/faxQueue/index.js",
11090     "groupTitle": "Fax_Queues"
11091   },
11092   {
11093     "type": "post",
11094     "url": "/api/fax/queues",
11095     "title": "Creates a new Queue",
11096     "examples": [
11097       {
11098         "title": "Example usage:",
11099         "content": "curl https://{domain}/api/fax/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
11100         "type": "json"
11101       }
11102     ],
11103     "name": "CreateQueues",
11104     "group": "Fax_Queues",
11105     "parameter": {
11106       "fields": {
11107         "Body": [
11108           {
11109             "group": "Body",
11110             "type": "String",
11111             "optional": false,
11112             "field": "name",
11113             "description": ""
11114           },
11115           {
11116             "group": "Body",
11117             "type": "String",
11118             "optional": true,
11119             "field": "description",
11120             "description": ""
11121           },
11122           {
11123             "group": "Body",
11124             "type": "Integer",
11125             "optional": false,
11126             "field": "timeout",
11127             "description": ""
11128           },
11129           {
11130             "group": "Body",
11131             "type": "String",
11132             "allowedValues": [
11133               "\"rrmemory\"",
11134               "\"beepall\"",
11135               "\"roundrobin\""
11136             ],
11137             "optional": false,
11138             "field": "strategy",
11139             "description": ""
11140           },
11141           {
11142             "group": "Body",
11143             "type": "Integer",
11144             "optional": true,
11145             "field": "lastAgent",
11146             "description": ""
11147           }
11148         ]
11149       }
11150     },
11151     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11152     "version": "0.0.0",
11153     "filename": "server/api/faxQueue/index.js",
11154     "groupTitle": "Fax_Queues"
11155   },
11156   {
11157     "type": "delete",
11158     "url": "/api/fax/queues/{id}",
11159     "title": "Deletes a Queue",
11160     "examples": [
11161       {
11162         "title": "Example usage:",
11163         "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password} -X DELETE",
11164         "type": "json"
11165       }
11166     ],
11167     "name": "DeleteQueues",
11168     "group": "Fax_Queues",
11169     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11170     "version": "0.0.0",
11171     "filename": "server/api/faxQueue/index.js",
11172     "groupTitle": "Fax_Queues"
11173   },
11174   {
11175     "type": "get",
11176     "url": "/api/fax/queues/describe",
11177     "title": "Gets table info about Queues",
11178     "examples": [
11179       {
11180         "title": "Example usage:",
11181         "content": "curl https://{domain}/api/fax/queues/describe -v -u {name}:{password}",
11182         "type": "json"
11183       }
11184     ],
11185     "name": "DescribeQueues",
11186     "group": "Fax_Queues",
11187     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11188     "version": "0.0.0",
11189     "filename": "server/api/faxQueue/index.js",
11190     "groupTitle": "Fax_Queues"
11191   },
11192   {
11193     "type": "get",
11194     "url": "/api/fax/queues/{id}/users",
11195     "title": "Gets queue agents",
11196     "examples": [
11197       {
11198         "title": "Example usage:",
11199         "content": "curl https://{domain}/api/fax/queues/{id}/users -v -u {name}:{password} -X POST",
11200         "type": "json"
11201       }
11202     ],
11203     "name": "GetAgents",
11204     "group": "Fax_Queues",
11205     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11206     "version": "0.0.0",
11207     "filename": "server/api/faxQueue/index.js",
11208     "groupTitle": "Fax_Queues"
11209   },
11210   {
11211     "type": "get",
11212     "url": "/api/fax/queues/{id}/members",
11213     "title": "GetMembers",
11214     "examples": [
11215       {
11216         "title": "Example usage:",
11217         "content": "curl https://{domain}/api/fax/queues/{id}/members  -v -u {name}:{password}",
11218         "type": "json"
11219       }
11220     ],
11221     "name": "GetMembers",
11222     "group": "Fax_Queues",
11223     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11224     "version": "0.0.0",
11225     "filename": "server/api/faxQueue/index.js",
11226     "groupTitle": "Fax_Queues"
11227   },
11228   {
11229     "type": "get",
11230     "url": "/api/fax/queues",
11231     "title": "Gets a list of Queues",
11232     "examples": [
11233       {
11234         "title": "Example usage:",
11235         "content": "curl https://{domain}/api/fax/queues -v -u {name}:{password}",
11236         "type": "json"
11237       }
11238     ],
11239     "name": "GetQueues",
11240     "group": "Fax_Queues",
11241     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11242     "version": "0.0.0",
11243     "filename": "server/api/faxQueue/index.js",
11244     "groupTitle": "Fax_Queues"
11245   },
11246   {
11247     "type": "get",
11248     "url": "/api/fax/queues/{id}/teams",
11249     "title": "Gets queues list",
11250     "examples": [
11251       {
11252         "title": "Example usage:",
11253         "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password}",
11254         "type": "json"
11255       }
11256     ],
11257     "name": "GetTeams",
11258     "group": "Fax_Queues",
11259     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11260     "version": "0.0.0",
11261     "filename": "server/api/faxQueue/index.js",
11262     "groupTitle": "Fax_Queues"
11263   },
11264   {
11265     "type": "delete",
11266     "url": "/api/fax/queues/{id}/users",
11267     "title": "Removes agents from a queue",
11268     "examples": [
11269       {
11270         "title": "Example usage:",
11271         "content": "curl https://{domain}/api/fax/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
11272         "type": "json"
11273       }
11274     ],
11275     "name": "RemoveAgents",
11276     "group": "Fax_Queues",
11277     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11278     "version": "0.0.0",
11279     "filename": "server/api/faxQueue/index.js",
11280     "groupTitle": "Fax_Queues"
11281   },
11282   {
11283     "type": "get",
11284     "url": "/api/fax/queues/{id}",
11285     "title": "Gets a single Queue",
11286     "examples": [
11287       {
11288         "title": "Example usage:",
11289         "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password}",
11290         "type": "json"
11291       }
11292     ],
11293     "name": "ShowQueues",
11294     "group": "Fax_Queues",
11295     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11296     "version": "0.0.0",
11297     "filename": "server/api/faxQueue/index.js",
11298     "groupTitle": "Fax_Queues"
11299   },
11300   {
11301     "type": "put",
11302     "url": "/api/fax/queues/{id}",
11303     "title": "Update an existing Queue",
11304     "examples": [
11305       {
11306         "title": "Example usage:",
11307         "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",
11308         "type": "json"
11309       }
11310     ],
11311     "name": "updateQueues",
11312     "group": "Fax_Queues",
11313     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11314     "version": "0.0.0",
11315     "filename": "server/api/faxQueue/index.js",
11316     "groupTitle": "Fax_Queues"
11317   },
11318   {
11319     "type": "post",
11320     "url": "/api/fax/reports/transfer",
11321     "title": "Creates a new Fax Transfer Report",
11322     "examples": [
11323       {
11324         "title": "Example usage:",
11325         "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",
11326         "type": "json"
11327       }
11328     ],
11329     "name": "CreateFax_Transfer_Reports",
11330     "group": "Fax_Transfer_Reports",
11331     "parameter": {
11332       "fields": {
11333         "Body": [
11334           {
11335             "group": "Body",
11336             "type": "String",
11337             "optional": false,
11338             "field": "uniqueid",
11339             "description": ""
11340           },
11341           {
11342             "group": "Body",
11343             "type": "String",
11344             "allowedValues": [
11345               "\"account\"",
11346               "\"agent\"",
11347               "\"queue\""
11348             ],
11349             "optional": false,
11350             "field": "type",
11351             "description": ""
11352           },
11353           {
11354             "group": "Body",
11355             "type": "String",
11356             "optional": false,
11357             "field": "transferredAt",
11358             "description": ""
11359           }
11360         ]
11361       }
11362     },
11363     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11364     "version": "0.0.0",
11365     "filename": "server/api/faxTransferReport/index.js",
11366     "groupTitle": "Fax_Transfer_Reports"
11367   },
11368   {
11369     "type": "delete",
11370     "url": "/api/fax/reports/transfer/{id}",
11371     "title": "Deletes a Fax Transfer Report",
11372     "examples": [
11373       {
11374         "title": "Example usage:",
11375         "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
11376         "type": "json"
11377       }
11378     ],
11379     "name": "DeleteFax_Transfer_Reports",
11380     "group": "Fax_Transfer_Reports",
11381     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11382     "version": "0.0.0",
11383     "filename": "server/api/faxTransferReport/index.js",
11384     "groupTitle": "Fax_Transfer_Reports"
11385   },
11386   {
11387     "type": "get",
11388     "url": "/api/fax/reports/transfer/describe",
11389     "title": "Gets table info about Fax Transfer Reports",
11390     "examples": [
11391       {
11392         "title": "Example usage:",
11393         "content": "curl https://{domain}/api/fax/reports/transfer/describe -v -u {name}:{password}",
11394         "type": "json"
11395       }
11396     ],
11397     "name": "DescribeFax_Transfer_Reports",
11398     "group": "Fax_Transfer_Reports",
11399     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11400     "version": "0.0.0",
11401     "filename": "server/api/faxTransferReport/index.js",
11402     "groupTitle": "Fax_Transfer_Reports"
11403   },
11404   {
11405     "type": "get",
11406     "url": "/api/fax/reports/transfer",
11407     "title": "Gets a list of Fax Transfer Reports",
11408     "examples": [
11409       {
11410         "title": "Example usage:",
11411         "content": "curl https://{domain}/api/fax/reports/transfer -v -u {name}:{password}",
11412         "type": "json"
11413       }
11414     ],
11415     "name": "GetFax_Transfer_Reports",
11416     "group": "Fax_Transfer_Reports",
11417     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11418     "version": "0.0.0",
11419     "filename": "server/api/faxTransferReport/index.js",
11420     "groupTitle": "Fax_Transfer_Reports"
11421   },
11422   {
11423     "type": "get",
11424     "url": "/api/fax/reports/transfer/{id}",
11425     "title": "Gets a single Fax Transfer Report",
11426     "examples": [
11427       {
11428         "title": "Example usage:",
11429         "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password}",
11430         "type": "json"
11431       }
11432     ],
11433     "name": "ShowFax_Transfer_Reports",
11434     "group": "Fax_Transfer_Reports",
11435     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11436     "version": "0.0.0",
11437     "filename": "server/api/faxTransferReport/index.js",
11438     "groupTitle": "Fax_Transfer_Reports"
11439   },
11440   {
11441     "type": "put",
11442     "url": "/api/fax/reports/transfer/{id}",
11443     "title": "Update an existing Fax Transfer Report",
11444     "examples": [
11445       {
11446         "title": "Example usage:",
11447         "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",
11448         "type": "json"
11449       }
11450     ],
11451     "name": "updateFax_Transfer_Reports",
11452     "group": "Fax_Transfer_Reports",
11453     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11454     "version": "0.0.0",
11455     "filename": "server/api/faxTransferReport/index.js",
11456     "groupTitle": "Fax_Transfer_Reports"
11457   },
11458   {
11459     "type": "post",
11460     "url": "/api/integrations/freshdesk/accounts",
11461     "title": "Creates a new Freshdesk Account",
11462     "examples": [
11463       {
11464         "title": "Example usage:",
11465         "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",
11466         "type": "json"
11467       }
11468     ],
11469     "name": "CreateFreshdesk_Accounts",
11470     "group": "Freshdesk_Accounts",
11471     "parameter": {
11472       "fields": {
11473         "Body": [
11474           {
11475             "group": "Body",
11476             "type": "String",
11477             "optional": true,
11478             "field": "name",
11479             "description": ""
11480           },
11481           {
11482             "group": "Body",
11483             "type": "String",
11484             "optional": true,
11485             "field": "description",
11486             "description": ""
11487           },
11488           {
11489             "group": "Body",
11490             "type": "String",
11491             "optional": true,
11492             "field": "username",
11493             "description": ""
11494           },
11495           {
11496             "group": "Body",
11497             "type": "String",
11498             "optional": true,
11499             "field": "apiKey",
11500             "description": ""
11501           },
11502           {
11503             "group": "Body",
11504             "type": "String",
11505             "optional": true,
11506             "field": "remoteUri",
11507             "description": ""
11508           },
11509           {
11510             "group": "Body",
11511             "type": "String",
11512             "optional": false,
11513             "field": "serverUrl",
11514             "description": ""
11515           }
11516         ]
11517       }
11518     },
11519     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11520     "version": "0.0.0",
11521     "filename": "server/api/intFreshdeskAccount/index.js",
11522     "groupTitle": "Freshdesk_Accounts"
11523   },
11524   {
11525     "type": "delete",
11526     "url": "/api/integrations/freshdesk/accounts/{id}",
11527     "title": "Deletes a Freshdesk Account",
11528     "examples": [
11529       {
11530         "title": "Example usage:",
11531         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password} -X DELETE",
11532         "type": "json"
11533       }
11534     ],
11535     "name": "DeleteFreshdesk_Accounts",
11536     "group": "Freshdesk_Accounts",
11537     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11538     "version": "0.0.0",
11539     "filename": "server/api/intFreshdeskAccount/index.js",
11540     "groupTitle": "Freshdesk_Accounts"
11541   },
11542   {
11543     "type": "get",
11544     "url": "/api/integrations/freshdesk/accounts",
11545     "title": "Gets a list of Freshdesk Accounts",
11546     "examples": [
11547       {
11548         "title": "Example usage:",
11549         "content": "curl https://{domain}/api/integrations/freshdesk/accounts -v -u {name}:{password}",
11550         "type": "json"
11551       }
11552     ],
11553     "name": "GetFreshdesk_Accounts",
11554     "group": "Freshdesk_Accounts",
11555     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11556     "version": "0.0.0",
11557     "filename": "server/api/intFreshdeskAccount/index.js",
11558     "groupTitle": "Freshdesk_Accounts"
11559   },
11560   {
11561     "type": "get",
11562     "url": "/api/integrations/freshdesk/accounts/{id}",
11563     "title": "Gets a single Freshdesk Account",
11564     "examples": [
11565       {
11566         "title": "Example usage:",
11567         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password}",
11568         "type": "json"
11569       }
11570     ],
11571     "name": "ShowFreshdesk_Accounts",
11572     "group": "Freshdesk_Accounts",
11573     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11574     "version": "0.0.0",
11575     "filename": "server/api/intFreshdeskAccount/index.js",
11576     "groupTitle": "Freshdesk_Accounts"
11577   },
11578   {
11579     "type": "post",
11580     "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
11581     "title": "Creates new configuration",
11582     "examples": [
11583       {
11584         "title": "Example usage:",
11585         "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",
11586         "type": "json"
11587       }
11588     ],
11589     "name": "addConfiguration",
11590     "group": "Freshdesk_Accounts",
11591     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11592     "version": "0.0.0",
11593     "filename": "server/api/intFreshdeskAccount/index.js",
11594     "groupTitle": "Freshdesk_Accounts"
11595   },
11596   {
11597     "type": "get",
11598     "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
11599     "title": "Gets account configurations",
11600     "examples": [
11601       {
11602         "title": "Example usage:",
11603         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
11604         "type": "json"
11605       }
11606     ],
11607     "name": "getConfigurations",
11608     "group": "Freshdesk_Accounts",
11609     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11610     "version": "0.0.0",
11611     "filename": "server/api/intFreshdeskAccount/index.js",
11612     "groupTitle": "Freshdesk_Accounts"
11613   },
11614   {
11615     "type": "get",
11616     "url": "/api/integrations/freshdesk/accounts/{id}/fields",
11617     "title": "Gets account fields",
11618     "examples": [
11619       {
11620         "title": "Example usage:",
11621         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
11622         "type": "json"
11623       }
11624     ],
11625     "name": "getFields",
11626     "group": "Freshdesk_Accounts",
11627     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11628     "version": "0.0.0",
11629     "filename": "server/api/intFreshdeskAccount/index.js",
11630     "groupTitle": "Freshdesk_Accounts"
11631   },
11632   {
11633     "type": "put",
11634     "url": "/api/integrations/freshdesk/accounts/{id}",
11635     "title": "Update an existing Freshdesk Account",
11636     "examples": [
11637       {
11638         "title": "Example usage:",
11639         "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",
11640         "type": "json"
11641       }
11642     ],
11643     "name": "updateFreshdesk_Accounts",
11644     "group": "Freshdesk_Accounts",
11645     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11646     "version": "0.0.0",
11647     "filename": "server/api/intFreshdeskAccount/index.js",
11648     "groupTitle": "Freshdesk_Accounts"
11649   },
11650   {
11651     "type": "post",
11652     "url": "/api/integrations/freshdesk/configurations",
11653     "title": "Creates a new Freshdesk Configuration",
11654     "examples": [
11655       {
11656         "title": "Example usage:",
11657         "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",
11658         "type": "json"
11659       }
11660     ],
11661     "name": "CreateFreshdesk_Configurations",
11662     "group": "Freshdesk_Configurations",
11663     "parameter": {
11664       "fields": {
11665         "Body": [
11666           {
11667             "group": "Body",
11668             "type": "String",
11669             "optional": true,
11670             "field": "name",
11671             "description": ""
11672           },
11673           {
11674             "group": "Body",
11675             "type": "String",
11676             "optional": true,
11677             "field": "description",
11678             "description": ""
11679           }
11680         ]
11681       }
11682     },
11683     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11684     "version": "0.0.0",
11685     "filename": "server/api/intFreshdeskConfiguration/index.js",
11686     "groupTitle": "Freshdesk_Configurations"
11687   },
11688   {
11689     "type": "delete",
11690     "url": "/api/integrations/freshdesk/configurations/{id}",
11691     "title": "Deletes a Freshdesk Configuration",
11692     "examples": [
11693       {
11694         "title": "Example usage:",
11695         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password} -X DELETE",
11696         "type": "json"
11697       }
11698     ],
11699     "name": "DeleteFreshdesk_Configurations",
11700     "group": "Freshdesk_Configurations",
11701     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11702     "version": "0.0.0",
11703     "filename": "server/api/intFreshdeskConfiguration/index.js",
11704     "groupTitle": "Freshdesk_Configurations"
11705   },
11706   {
11707     "type": "get",
11708     "url": "/api/integrations/freshdesk/configurations",
11709     "title": "Gets a list of Freshdesk Configurations",
11710     "examples": [
11711       {
11712         "title": "Example usage:",
11713         "content": "curl https://{domain}/api/integrations/freshdesk/configurations -v -u {name}:{password}",
11714         "type": "json"
11715       }
11716     ],
11717     "name": "GetFreshdesk_Configurations",
11718     "group": "Freshdesk_Configurations",
11719     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11720     "version": "0.0.0",
11721     "filename": "server/api/intFreshdeskConfiguration/index.js",
11722     "groupTitle": "Freshdesk_Configurations"
11723   },
11724   {
11725     "type": "get",
11726     "url": "/api/integrations/freshdesk/configurations/{id}",
11727     "title": "Gets a single Freshdesk Configuration",
11728     "examples": [
11729       {
11730         "title": "Example usage:",
11731         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password}",
11732         "type": "json"
11733       }
11734     ],
11735     "name": "ShowFreshdesk_Configurations",
11736     "group": "Freshdesk_Configurations",
11737     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11738     "version": "0.0.0",
11739     "filename": "server/api/intFreshdeskConfiguration/index.js",
11740     "groupTitle": "Freshdesk_Configurations"
11741   },
11742   {
11743     "type": "get",
11744     "url": "/api/integrations/freshdesk/configurations/{id}/descriptions",
11745     "title": "Gets configurations descriptions",
11746     "examples": [
11747       {
11748         "title": "Example usage:",
11749         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
11750         "type": "json"
11751       }
11752     ],
11753     "name": "getDescriptions",
11754     "group": "Freshdesk_Configurations",
11755     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11756     "version": "0.0.0",
11757     "filename": "server/api/intFreshdeskConfiguration/index.js",
11758     "groupTitle": "Freshdesk_Configurations"
11759   },
11760   {
11761     "type": "get",
11762     "url": "/api/integrations/freshdesk/configurations/{id}/fields",
11763     "title": "Gets configurations fields",
11764     "examples": [
11765       {
11766         "title": "Example usage:",
11767         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
11768         "type": "json"
11769       }
11770     ],
11771     "name": "getFields",
11772     "group": "Freshdesk_Configurations",
11773     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11774     "version": "0.0.0",
11775     "filename": "server/api/intFreshdeskConfiguration/index.js",
11776     "groupTitle": "Freshdesk_Configurations"
11777   },
11778   {
11779     "type": "get",
11780     "url": "/api/integrations/freshdesk/configurations/{id}/subjects",
11781     "title": "Gets configurations subjects",
11782     "examples": [
11783       {
11784         "title": "Example usage:",
11785         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
11786         "type": "json"
11787       }
11788     ],
11789     "name": "getSubjects",
11790     "group": "Freshdesk_Configurations",
11791     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11792     "version": "0.0.0",
11793     "filename": "server/api/intFreshdeskConfiguration/index.js",
11794     "groupTitle": "Freshdesk_Configurations"
11795   },
11796   {
11797     "type": "get",
11798     "url": "/api/integrations/freshdesk/configurations/{id}/tags",
11799     "title": "Gets configurations tags",
11800     "examples": [
11801       {
11802         "title": "Example usage:",
11803         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
11804         "type": "json"
11805       }
11806     ],
11807     "name": "getTags",
11808     "group": "Freshdesk_Configurations",
11809     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11810     "version": "0.0.0",
11811     "filename": "server/api/intFreshdeskConfiguration/index.js",
11812     "groupTitle": "Freshdesk_Configurations"
11813   },
11814   {
11815     "type": "post",
11816     "url": "/api/integrations/freshdesk/configurations/{id}/tags",
11817     "title": "Sets new tags",
11818     "examples": [
11819       {
11820         "title": "Example usage:",
11821         "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",
11822         "type": "json"
11823       }
11824     ],
11825     "name": "setTags",
11826     "group": "Freshdesk_Configurations",
11827     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11828     "version": "0.0.0",
11829     "filename": "server/api/intFreshdeskConfiguration/index.js",
11830     "groupTitle": "Freshdesk_Configurations"
11831   },
11832   {
11833     "type": "put",
11834     "url": "/api/integrations/freshdesk/configurations/{id}",
11835     "title": "Update an existing Freshdesk Configuration",
11836     "examples": [
11837       {
11838         "title": "Example usage:",
11839         "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",
11840         "type": "json"
11841       }
11842     ],
11843     "name": "updateFreshdesk_Configurations",
11844     "group": "Freshdesk_Configurations",
11845     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11846     "version": "0.0.0",
11847     "filename": "server/api/intFreshdeskConfiguration/index.js",
11848     "groupTitle": "Freshdesk_Configurations"
11849   },
11850   {
11851     "type": "post",
11852     "url": "/api/integrations/freshdesk/fields",
11853     "title": "Creates a new Freshdesk Field",
11854     "examples": [
11855       {
11856         "title": "Example usage:",
11857         "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",
11858         "type": "json"
11859       }
11860     ],
11861     "name": "CreateFreshdesk_Fields",
11862     "group": "Freshdesk_Fields",
11863     "parameter": {
11864       "fields": {
11865         "Body": [
11866           {
11867             "group": "Body",
11868             "type": "String",
11869             "allowedValues": [
11870               "\"string\"",
11871               "\"variable\"",
11872               "\"customVariable\"",
11873               "\"keyValue\""
11874             ],
11875             "optional": true,
11876             "field": "type",
11877             "description": ""
11878           },
11879           {
11880             "group": "Body",
11881             "type": "String",
11882             "optional": true,
11883             "field": "content",
11884             "description": ""
11885           },
11886           {
11887             "group": "Body",
11888             "type": "String",
11889             "optional": true,
11890             "field": "key",
11891             "description": ""
11892           },
11893           {
11894             "group": "Body",
11895             "type": "String",
11896             "allowedValues": [
11897               "\"string\"",
11898               "\"variable\"",
11899               "\"customVariable\""
11900             ],
11901             "optional": true,
11902             "field": "keyType",
11903             "description": ""
11904           },
11905           {
11906             "group": "Body",
11907             "type": "String",
11908             "optional": true,
11909             "field": "keyContent",
11910             "description": ""
11911           },
11912           {
11913             "group": "Body",
11914             "type": "String",
11915             "optional": true,
11916             "field": "idField",
11917             "description": ""
11918           },
11919           {
11920             "group": "Body",
11921             "type": "String",
11922             "optional": true,
11923             "field": "nameField",
11924             "description": ""
11925           },
11926           {
11927             "group": "Body",
11928             "type": "Boolean",
11929             "optional": true,
11930             "field": "customField",
11931             "description": ""
11932           },
11933           {
11934             "group": "Body",
11935             "type": "String",
11936             "optional": true,
11937             "field": "variableName",
11938             "description": ""
11939           }
11940         ]
11941       }
11942     },
11943     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11944     "version": "0.0.0",
11945     "filename": "server/api/intFreshdeskField/index.js",
11946     "groupTitle": "Freshdesk_Fields"
11947   },
11948   {
11949     "type": "delete",
11950     "url": "/api/integrations/freshdesk/fields/{id}",
11951     "title": "Deletes a Freshdesk Field",
11952     "examples": [
11953       {
11954         "title": "Example usage:",
11955         "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password} -X DELETE",
11956         "type": "json"
11957       }
11958     ],
11959     "name": "DeleteFreshdesk_Fields",
11960     "group": "Freshdesk_Fields",
11961     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11962     "version": "0.0.0",
11963     "filename": "server/api/intFreshdeskField/index.js",
11964     "groupTitle": "Freshdesk_Fields"
11965   },
11966   {
11967     "type": "get",
11968     "url": "/api/integrations/freshdesk/fields",
11969     "title": "Gets a list of Freshdesk Fields",
11970     "examples": [
11971       {
11972         "title": "Example usage:",
11973         "content": "curl https://{domain}/api/integrations/freshdesk/fields -v -u {name}:{password}",
11974         "type": "json"
11975       }
11976     ],
11977     "name": "GetFreshdesk_Fields",
11978     "group": "Freshdesk_Fields",
11979     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11980     "version": "0.0.0",
11981     "filename": "server/api/intFreshdeskField/index.js",
11982     "groupTitle": "Freshdesk_Fields"
11983   },
11984   {
11985     "type": "get",
11986     "url": "/api/integrations/freshdesk/fields/{id}",
11987     "title": "Gets a single Freshdesk Field",
11988     "examples": [
11989       {
11990         "title": "Example usage:",
11991         "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password}",
11992         "type": "json"
11993       }
11994     ],
11995     "name": "ShowFreshdesk_Fields",
11996     "group": "Freshdesk_Fields",
11997     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11998     "version": "0.0.0",
11999     "filename": "server/api/intFreshdeskField/index.js",
12000     "groupTitle": "Freshdesk_Fields"
12001   },
12002   {
12003     "type": "put",
12004     "url": "/api/integrations/freshdesk/fields/{id}",
12005     "title": "Update an existing Freshdesk Field",
12006     "examples": [
12007       {
12008         "title": "Example usage:",
12009         "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",
12010         "type": "json"
12011       }
12012     ],
12013     "name": "updateFreshdesk_Fields",
12014     "group": "Freshdesk_Fields",
12015     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12016     "version": "0.0.0",
12017     "filename": "server/api/intFreshdeskField/index.js",
12018     "groupTitle": "Freshdesk_Fields"
12019   },
12020   {
12021     "type": "post",
12022     "url": "/api/integrations/freshsales/accounts",
12023     "title": "Creates a new Freshsales Account",
12024     "examples": [
12025       {
12026         "title": "Example usage:",
12027         "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",
12028         "type": "json"
12029       }
12030     ],
12031     "name": "CreateFreshsales_Accounts",
12032     "group": "Freshsales_Accounts",
12033     "parameter": {
12034       "fields": {
12035         "Body": [
12036           {
12037             "group": "Body",
12038             "type": "String",
12039             "optional": true,
12040             "field": "name",
12041             "description": ""
12042           },
12043           {
12044             "group": "Body",
12045             "type": "String",
12046             "optional": true,
12047             "field": "description",
12048             "description": ""
12049           },
12050           {
12051             "group": "Body",
12052             "type": "String",
12053             "optional": true,
12054             "field": "username",
12055             "description": ""
12056           },
12057           {
12058             "group": "Body",
12059             "type": "String",
12060             "optional": true,
12061             "field": "apiKey",
12062             "description": ""
12063           },
12064           {
12065             "group": "Body",
12066             "type": "String",
12067             "optional": true,
12068             "field": "remoteUri",
12069             "description": ""
12070           },
12071           {
12072             "group": "Body",
12073             "type": "String",
12074             "optional": false,
12075             "field": "serverUrl",
12076             "description": ""
12077           }
12078         ]
12079       }
12080     },
12081     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12082     "version": "0.0.0",
12083     "filename": "server/api/intFreshsalesAccount/index.js",
12084     "groupTitle": "Freshsales_Accounts"
12085   },
12086   {
12087     "type": "delete",
12088     "url": "/api/integrations/freshsales/accounts/{id}",
12089     "title": "Deletes a Freshsales Account",
12090     "examples": [
12091       {
12092         "title": "Example usage:",
12093         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password} -X DELETE",
12094         "type": "json"
12095       }
12096     ],
12097     "name": "DeleteFreshsales_Accounts",
12098     "group": "Freshsales_Accounts",
12099     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12100     "version": "0.0.0",
12101     "filename": "server/api/intFreshsalesAccount/index.js",
12102     "groupTitle": "Freshsales_Accounts"
12103   },
12104   {
12105     "type": "get",
12106     "url": "/api/integrations/freshsales/accounts",
12107     "title": "Gets a list of Freshsales Accounts",
12108     "examples": [
12109       {
12110         "title": "Example usage:",
12111         "content": "curl https://{domain}/api/integrations/freshsales/accounts -v -u {name}:{password}",
12112         "type": "json"
12113       }
12114     ],
12115     "name": "GetFreshsales_Accounts",
12116     "group": "Freshsales_Accounts",
12117     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12118     "version": "0.0.0",
12119     "filename": "server/api/intFreshsalesAccount/index.js",
12120     "groupTitle": "Freshsales_Accounts"
12121   },
12122   {
12123     "type": "get",
12124     "url": "/api/integrations/freshsales/accounts/{id}",
12125     "title": "Gets a single Freshsales Account",
12126     "examples": [
12127       {
12128         "title": "Example usage:",
12129         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password}",
12130         "type": "json"
12131       }
12132     ],
12133     "name": "ShowFreshsales_Accounts",
12134     "group": "Freshsales_Accounts",
12135     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12136     "version": "0.0.0",
12137     "filename": "server/api/intFreshsalesAccount/index.js",
12138     "groupTitle": "Freshsales_Accounts"
12139   },
12140   {
12141     "type": "post",
12142     "url": "/api/integrations/freshsales/accounts/{id}/configurations",
12143     "title": "Creates new configuration",
12144     "examples": [
12145       {
12146         "title": "Example usage:",
12147         "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",
12148         "type": "json"
12149       }
12150     ],
12151     "name": "addConfiguration",
12152     "group": "Freshsales_Accounts",
12153     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12154     "version": "0.0.0",
12155     "filename": "server/api/intFreshsalesAccount/index.js",
12156     "groupTitle": "Freshsales_Accounts"
12157   },
12158   {
12159     "type": "get",
12160     "url": "/api/integrations/freshsales/accounts/{id}/configurations",
12161     "title": "Gets account configurations",
12162     "examples": [
12163       {
12164         "title": "Example usage:",
12165         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/configurations -v -u {name}:{password} -X GET",
12166         "type": "json"
12167       }
12168     ],
12169     "name": "getConfigurations",
12170     "group": "Freshsales_Accounts",
12171     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12172     "version": "0.0.0",
12173     "filename": "server/api/intFreshsalesAccount/index.js",
12174     "groupTitle": "Freshsales_Accounts"
12175   },
12176   {
12177     "type": "get",
12178     "url": "/api/integrations/freshsales/accounts/{id}/fields",
12179     "title": "Gets account fields",
12180     "examples": [
12181       {
12182         "title": "Example usage:",
12183         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/fields -v -u {name}:{password} -X GET",
12184         "type": "json"
12185       }
12186     ],
12187     "name": "getFields",
12188     "group": "Freshsales_Accounts",
12189     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12190     "version": "0.0.0",
12191     "filename": "server/api/intFreshsalesAccount/index.js",
12192     "groupTitle": "Freshsales_Accounts"
12193   },
12194   {
12195     "type": "put",
12196     "url": "/api/integrations/freshsales/accounts/{id}",
12197     "title": "Update an existing Freshsales Account",
12198     "examples": [
12199       {
12200         "title": "Example usage:",
12201         "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",
12202         "type": "json"
12203       }
12204     ],
12205     "name": "updateFreshsales_Accounts",
12206     "group": "Freshsales_Accounts",
12207     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12208     "version": "0.0.0",
12209     "filename": "server/api/intFreshsalesAccount/index.js",
12210     "groupTitle": "Freshsales_Accounts"
12211   },
12212   {
12213     "type": "post",
12214     "url": "/api/integrations/freshsales/configurations",
12215     "title": "Creates a new Freshsales Configuration",
12216     "examples": [
12217       {
12218         "title": "Example usage:",
12219         "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",
12220         "type": "json"
12221       }
12222     ],
12223     "name": "CreateFreshsales_Configurations",
12224     "group": "Freshsales_Configurations",
12225     "parameter": {
12226       "fields": {
12227         "Body": [
12228           {
12229             "group": "Body",
12230             "type": "String",
12231             "optional": true,
12232             "field": "name",
12233             "description": ""
12234           },
12235           {
12236             "group": "Body",
12237             "type": "String",
12238             "optional": true,
12239             "field": "description",
12240             "description": ""
12241           }
12242         ]
12243       }
12244     },
12245     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12246     "version": "0.0.0",
12247     "filename": "server/api/intFreshsalesConfiguration/index.js",
12248     "groupTitle": "Freshsales_Configurations"
12249   },
12250   {
12251     "type": "delete",
12252     "url": "/api/integrations/freshsales/configurations/{id}",
12253     "title": "Deletes a Freshsales Configuration",
12254     "examples": [
12255       {
12256         "title": "Example usage:",
12257         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password} -X DELETE",
12258         "type": "json"
12259       }
12260     ],
12261     "name": "DeleteFreshsales_Configurations",
12262     "group": "Freshsales_Configurations",
12263     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12264     "version": "0.0.0",
12265     "filename": "server/api/intFreshsalesConfiguration/index.js",
12266     "groupTitle": "Freshsales_Configurations"
12267   },
12268   {
12269     "type": "get",
12270     "url": "/api/integrations/freshsales/configurations",
12271     "title": "Gets a list of Freshsales Configurations",
12272     "examples": [
12273       {
12274         "title": "Example usage:",
12275         "content": "curl https://{domain}/api/integrations/freshsales/configurations -v -u {name}:{password}",
12276         "type": "json"
12277       }
12278     ],
12279     "name": "GetFreshsales_Configurations",
12280     "group": "Freshsales_Configurations",
12281     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12282     "version": "0.0.0",
12283     "filename": "server/api/intFreshsalesConfiguration/index.js",
12284     "groupTitle": "Freshsales_Configurations"
12285   },
12286   {
12287     "type": "get",
12288     "url": "/api/integrations/freshsales/configurations/{id}",
12289     "title": "Gets a single Freshsales Configuration",
12290     "examples": [
12291       {
12292         "title": "Example usage:",
12293         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password}",
12294         "type": "json"
12295       }
12296     ],
12297     "name": "ShowFreshsales_Configurations",
12298     "group": "Freshsales_Configurations",
12299     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12300     "version": "0.0.0",
12301     "filename": "server/api/intFreshsalesConfiguration/index.js",
12302     "groupTitle": "Freshsales_Configurations"
12303   },
12304   {
12305     "type": "get",
12306     "url": "/api/integrations/freshsales/configurations/{id}/descriptions",
12307     "title": "Gets configurations descriptions",
12308     "examples": [
12309       {
12310         "title": "Example usage:",
12311         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
12312         "type": "json"
12313       }
12314     ],
12315     "name": "getDescriptions",
12316     "group": "Freshsales_Configurations",
12317     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12318     "version": "0.0.0",
12319     "filename": "server/api/intFreshsalesConfiguration/index.js",
12320     "groupTitle": "Freshsales_Configurations"
12321   },
12322   {
12323     "type": "get",
12324     "url": "/api/integrations/freshsales/configurations/{id}/fields",
12325     "title": "Gets configurations fields",
12326     "examples": [
12327       {
12328         "title": "Example usage:",
12329         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/fields -v -u {name}:{password} -X GET",
12330         "type": "json"
12331       }
12332     ],
12333     "name": "getFields",
12334     "group": "Freshsales_Configurations",
12335     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12336     "version": "0.0.0",
12337     "filename": "server/api/intFreshsalesConfiguration/index.js",
12338     "groupTitle": "Freshsales_Configurations"
12339   },
12340   {
12341     "type": "get",
12342     "url": "/api/integrations/freshsales/configurations/{id}/subjects",
12343     "title": "Gets configurations subjects",
12344     "examples": [
12345       {
12346         "title": "Example usage:",
12347         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/subjects -v -u {name}:{password} -X GET",
12348         "type": "json"
12349       }
12350     ],
12351     "name": "getSubjects",
12352     "group": "Freshsales_Configurations",
12353     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12354     "version": "0.0.0",
12355     "filename": "server/api/intFreshsalesConfiguration/index.js",
12356     "groupTitle": "Freshsales_Configurations"
12357   },
12358   {
12359     "type": "put",
12360     "url": "/api/integrations/freshsales/configurations/{id}",
12361     "title": "Update an existing Freshsales Configuration",
12362     "examples": [
12363       {
12364         "title": "Example usage:",
12365         "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",
12366         "type": "json"
12367       }
12368     ],
12369     "name": "updateFreshsales_Configurations",
12370     "group": "Freshsales_Configurations",
12371     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12372     "version": "0.0.0",
12373     "filename": "server/api/intFreshsalesConfiguration/index.js",
12374     "groupTitle": "Freshsales_Configurations"
12375   },
12376   {
12377     "type": "post",
12378     "url": "/api/integrations/freshsales/fields",
12379     "title": "Creates a new Freshsales Field",
12380     "examples": [
12381       {
12382         "title": "Example usage:",
12383         "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",
12384         "type": "json"
12385       }
12386     ],
12387     "name": "CreateFreshsales_Fields",
12388     "group": "Freshsales_Fields",
12389     "parameter": {
12390       "fields": {
12391         "Body": [
12392           {
12393             "group": "Body",
12394             "type": "String",
12395             "allowedValues": [
12396               "\"string\"",
12397               "\"variable\"",
12398               "\"customVariable\"",
12399               "\"keyValue\""
12400             ],
12401             "optional": true,
12402             "field": "type",
12403             "description": ""
12404           },
12405           {
12406             "group": "Body",
12407             "type": "String",
12408             "optional": true,
12409             "field": "content",
12410             "description": ""
12411           },
12412           {
12413             "group": "Body",
12414             "type": "String",
12415             "optional": true,
12416             "field": "key",
12417             "description": ""
12418           },
12419           {
12420             "group": "Body",
12421             "type": "String",
12422             "allowedValues": [
12423               "\"string\"",
12424               "\"variable\"",
12425               "\"customVariable\""
12426             ],
12427             "optional": true,
12428             "field": "keyType",
12429             "description": ""
12430           },
12431           {
12432             "group": "Body",
12433             "type": "String",
12434             "optional": true,
12435             "field": "keyContent",
12436             "description": ""
12437           },
12438           {
12439             "group": "Body",
12440             "type": "String",
12441             "optional": true,
12442             "field": "idField",
12443             "description": ""
12444           },
12445           {
12446             "group": "Body",
12447             "type": "String",
12448             "optional": true,
12449             "field": "nameField",
12450             "description": ""
12451           },
12452           {
12453             "group": "Body",
12454             "type": "Boolean",
12455             "optional": true,
12456             "field": "customField",
12457             "description": ""
12458           },
12459           {
12460             "group": "Body",
12461             "type": "String",
12462             "optional": true,
12463             "field": "variableName",
12464             "description": ""
12465           }
12466         ]
12467       }
12468     },
12469     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12470     "version": "0.0.0",
12471     "filename": "server/api/intFreshsalesField/index.js",
12472     "groupTitle": "Freshsales_Fields"
12473   },
12474   {
12475     "type": "delete",
12476     "url": "/api/integrations/freshsales/fields/{id}",
12477     "title": "Deletes a Freshsales Field",
12478     "examples": [
12479       {
12480         "title": "Example usage:",
12481         "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password} -X DELETE",
12482         "type": "json"
12483       }
12484     ],
12485     "name": "DeleteFreshsales_Fields",
12486     "group": "Freshsales_Fields",
12487     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12488     "version": "0.0.0",
12489     "filename": "server/api/intFreshsalesField/index.js",
12490     "groupTitle": "Freshsales_Fields"
12491   },
12492   {
12493     "type": "get",
12494     "url": "/api/integrations/freshsales/fields",
12495     "title": "Gets a list of Freshsales Fields",
12496     "examples": [
12497       {
12498         "title": "Example usage:",
12499         "content": "curl https://{domain}/api/integrations/freshsales/fields -v -u {name}:{password}",
12500         "type": "json"
12501       }
12502     ],
12503     "name": "GetFreshsales_Fields",
12504     "group": "Freshsales_Fields",
12505     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/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>",
12506     "version": "0.0.0",
12507     "filename": "server/api/intFreshsalesField/index.js",
12508     "groupTitle": "Freshsales_Fields"
12509   },
12510   {
12511     "type": "get",
12512     "url": "/api/integrations/freshsales/fields/{id}",
12513     "title": "Gets a single Freshsales Field",
12514     "examples": [
12515       {
12516         "title": "Example usage:",
12517         "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password}",
12518         "type": "json"
12519       }
12520     ],
12521     "name": "ShowFreshsales_Fields",
12522     "group": "Freshsales_Fields",
12523     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12524     "version": "0.0.0",
12525     "filename": "server/api/intFreshsalesField/index.js",
12526     "groupTitle": "Freshsales_Fields"
12527   },
12528   {
12529     "type": "put",
12530     "url": "/api/integrations/freshsales/fields/{id}",
12531     "title": "Update an existing Freshsales Field",
12532     "examples": [
12533       {
12534         "title": "Example usage:",
12535         "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",
12536         "type": "json"
12537       }
12538     ],
12539     "name": "updateFreshsales_Fields",
12540     "group": "Freshsales_Fields",
12541     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12542     "version": "0.0.0",
12543     "filename": "server/api/intFreshsalesField/index.js",
12544     "groupTitle": "Freshsales_Fields"
12545   },
12546   {
12547     "type": "post",
12548     "url": "/api/campaigns/{id}/blacklists",
12549     "title": "Add blacklists to an IVR campaign",
12550     "examples": [
12551       {
12552         "title": "Example usage:",
12553         "content": "curl https://{domain}/api/campaigns/{id}/blacklists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
12554         "type": "json"
12555       }
12556     ],
12557     "name": "AddBlackLists",
12558     "group": "IVR_Campaigns",
12559     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12560     "version": "0.0.0",
12561     "filename": "server/api/campaign/index.js",
12562     "groupTitle": "IVR_Campaigns"
12563   },
12564   {
12565     "type": "post",
12566     "url": "/api/campaigns/{id}/lists",
12567     "title": "Add lists to an IVR campaign",
12568     "examples": [
12569       {
12570         "title": "Example usage:",
12571         "content": "curl https://{domain}/api/campaigns/{id}/lists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
12572         "type": "json"
12573       }
12574     ],
12575     "name": "AddLists",
12576     "group": "IVR_Campaigns",
12577     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12578     "version": "0.0.0",
12579     "filename": "server/api/campaign/index.js",
12580     "groupTitle": "IVR_Campaigns"
12581   },
12582   {
12583     "type": "post",
12584     "url": "/api/campaigns/clone",
12585     "title": "Clone an existing IVR Campaign",
12586     "examples": [
12587       {
12588         "title": "Example usage:",
12589         "content": "curl https://{domain}/api/campaigns/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12590         "type": "json"
12591       }
12592     ],
12593     "name": "CloneIVR_Campaigns",
12594     "group": "IVR_Campaigns",
12595     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12596     "version": "0.0.0",
12597     "filename": "server/api/campaign/index.js",
12598     "groupTitle": "IVR_Campaigns"
12599   },
12600   {
12601     "type": "post",
12602     "url": "/api/campaigns",
12603     "title": "Creates a new IVR Campaign",
12604     "examples": [
12605       {
12606         "title": "Example usage:",
12607         "content": "curl https://{domain}/api/campaigns -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12608         "type": "json"
12609       }
12610     ],
12611     "name": "CreateIVR_Campaigns",
12612     "group": "IVR_Campaigns",
12613     "parameter": {
12614       "fields": {
12615         "Body": [
12616           {
12617             "group": "Body",
12618             "type": "String",
12619             "optional": false,
12620             "field": "name",
12621             "description": ""
12622           },
12623           {
12624             "group": "Body",
12625             "type": "String",
12626             "allowedValues": [
12627               "\"ivr\""
12628             ],
12629             "optional": false,
12630             "field": "type",
12631             "description": ""
12632           },
12633           {
12634             "group": "Body",
12635             "type": "String",
12636             "optional": true,
12637             "field": "description",
12638             "description": ""
12639           },
12640           {
12641             "group": "Body",
12642             "type": "Boolean",
12643             "optional": true,
12644             "field": "active",
12645             "description": "<p>Active/Disactive Campaign</p>"
12646           },
12647           {
12648             "group": "Body",
12649             "type": "Integer",
12650             "optional": true,
12651             "field": "limitCalls",
12652             "description": "<p>Max 200 calls.</p>"
12653           },
12654           {
12655             "group": "Body",
12656             "type": "String",
12657             "optional": true,
12658             "field": "dialOriginateCallerIdName",
12659             "description": ""
12660           },
12661           {
12662             "group": "Body",
12663             "type": "String",
12664             "optional": true,
12665             "field": "dialOriginateCallerIdNumber",
12666             "description": ""
12667           },
12668           {
12669             "group": "Body",
12670             "type": "Integer",
12671             "optional": true,
12672             "field": "dialOriginateTimeout",
12673             "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
12674           },
12675           {
12676             "group": "Body",
12677             "type": "Integer",
12678             "optional": true,
12679             "field": "dialCongestionMaxRetry",
12680             "description": "<p>#Congestion Retry (min:1, max:999)</p>"
12681           },
12682           {
12683             "group": "Body",
12684             "type": "Integer",
12685             "optional": true,
12686             "field": "dialCongestionRetryFrequency",
12687             "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
12688           },
12689           {
12690             "group": "Body",
12691             "type": "Integer",
12692             "optional": true,
12693             "field": "dialBusyMaxRetry",
12694             "description": "<p>#Busy Retry (min:1, max:999)</p>"
12695           },
12696           {
12697             "group": "Body",
12698             "type": "Integer",
12699             "optional": true,
12700             "field": "dialBusyRetryFrequency",
12701             "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
12702           },
12703           {
12704             "group": "Body",
12705             "type": "Integer",
12706             "optional": true,
12707             "field": "dialNoAnswerMaxRetry",
12708             "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
12709           },
12710           {
12711             "group": "Body",
12712             "type": "Integer",
12713             "optional": true,
12714             "field": "dialNoAnswerRetryFrequency",
12715             "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
12716           },
12717           {
12718             "group": "Body",
12719             "type": "Integer",
12720             "optional": true,
12721             "field": "dialGlobalMaxRetry",
12722             "description": "<p>#Global Max Retry (min:1, max:999)</p>"
12723           },
12724           {
12725             "group": "Body",
12726             "type": "String",
12727             "optional": true,
12728             "field": "dialTimezone",
12729             "description": ""
12730           },
12731           {
12732             "group": "Body",
12733             "type": "String",
12734             "optional": true,
12735             "field": "dialGlobalInterval",
12736             "description": ""
12737           },
12738           {
12739             "group": "Body",
12740             "type": "String",
12741             "allowedValues": [
12742               "\"always\"",
12743               "\"never\"",
12744               "\"onlyIfOpen\""
12745             ],
12746             "optional": true,
12747             "field": "dialCheckDuplicateType",
12748             "description": ""
12749           },
12750           {
12751             "group": "Body",
12752             "type": "Boolean",
12753             "optional": true,
12754             "field": "dialAMDActive",
12755             "description": "<p>Active/Disactive AMD</p>"
12756           },
12757           {
12758             "group": "Body",
12759             "type": "Integer",
12760             "optional": true,
12761             "field": "dialAMDInitialSilence",
12762             "description": "<p>#AMD Initial Silence</p>"
12763           },
12764           {
12765             "group": "Body",
12766             "type": "Integer",
12767             "optional": true,
12768             "field": "dialAMDGreeting",
12769             "description": "<p>#AMD Greeting</p>"
12770           },
12771           {
12772             "group": "Body",
12773             "type": "Integer",
12774             "optional": true,
12775             "field": "dialAMDAfterGreetingSilence",
12776             "description": "<p>#AMD After Greeting Silence</p>"
12777           },
12778           {
12779             "group": "Body",
12780             "type": "Integer",
12781             "optional": true,
12782             "field": "dialAMDTotalAnalysisTime",
12783             "description": "<p>#AMD Total Analysis Time</p>"
12784           },
12785           {
12786             "group": "Body",
12787             "type": "Integer",
12788             "optional": true,
12789             "field": "dialAMDMinWordLength",
12790             "description": "<p>#AMD Min Word Length</p>"
12791           },
12792           {
12793             "group": "Body",
12794             "type": "Integer",
12795             "optional": true,
12796             "field": "dialAMDBetweenWordsSilence",
12797             "description": "<p>#AMD Between Words Silence</p>"
12798           },
12799           {
12800             "group": "Body",
12801             "type": "Integer",
12802             "optional": true,
12803             "field": "dialAMDMaximumNumberOfWords",
12804             "description": "<p>#AMD Maximum Number Of Words</p>"
12805           },
12806           {
12807             "group": "Body",
12808             "type": "Integer",
12809             "optional": true,
12810             "field": "dialAMDSilenceThreshold",
12811             "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
12812           },
12813           {
12814             "group": "Body",
12815             "type": "Integer",
12816             "optional": true,
12817             "field": "dialAMDMaximumWordLength",
12818             "description": "<p>#AMD Maximum Word Length</p>"
12819           },
12820           {
12821             "group": "Body",
12822             "type": "String",
12823             "allowedValues": [
12824               "\"DESC\"",
12825               "\"ASC\""
12826             ],
12827             "optional": true,
12828             "field": "dialOrderByScheduledAt",
12829             "description": ""
12830           },
12831           {
12832             "group": "Body",
12833             "type": "String",
12834             "optional": true,
12835             "field": "dialPrefix",
12836             "description": ""
12837           },
12838           {
12839             "group": "Body",
12840             "type": "Integer",
12841             "optional": true,
12842             "field": "dialRandomLastDigitCallerIdNumber",
12843             "description": "<p>Random Last Digit (min:1, max:15)</p>"
12844           },
12845           {
12846             "group": "Body",
12847             "type": "Integer",
12848             "optional": true,
12849             "field": "dialCutDigit",
12850             "description": "<p>Cut Digit (min:1, max:15)</p>"
12851           },
12852           {
12853             "group": "Body",
12854             "type": "Integer",
12855             "optional": true,
12856             "field": "dialNoSuchNumberMaxRetry",
12857             "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
12858           },
12859           {
12860             "group": "Body",
12861             "type": "Integer",
12862             "optional": true,
12863             "field": "dialNoSuchNumberRetryFrequency",
12864             "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
12865           },
12866           {
12867             "group": "Body",
12868             "type": "Integer",
12869             "optional": true,
12870             "field": "dialDropMaxRetry",
12871             "description": "<p>#Drop Retry (min:1, max:999)</p>"
12872           },
12873           {
12874             "group": "Body",
12875             "type": "Integer",
12876             "optional": true,
12877             "field": "dialDropRetryFrequency",
12878             "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
12879           },
12880           {
12881             "group": "Body",
12882             "type": "Integer",
12883             "optional": true,
12884             "field": "dialAbandonedMaxRetry",
12885             "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
12886           },
12887           {
12888             "group": "Body",
12889             "type": "Integer",
12890             "optional": true,
12891             "field": "dialAbandonedRetryFrequency",
12892             "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
12893           },
12894           {
12895             "group": "Body",
12896             "type": "Integer",
12897             "optional": true,
12898             "field": "dialMachineMaxRetry",
12899             "description": "<p>#Machine Retry (min:1, max:999)</p>"
12900           },
12901           {
12902             "group": "Body",
12903             "type": "Integer",
12904             "optional": true,
12905             "field": "dialMachineRetryFrequency",
12906             "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
12907           },
12908           {
12909             "group": "Body",
12910             "type": "Integer",
12911             "optional": true,
12912             "field": "dialAgentRejectMaxRetry",
12913             "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
12914           },
12915           {
12916             "group": "Body",
12917             "type": "Integer",
12918             "optional": true,
12919             "field": "dialAgentRejectRetryFrequency",
12920             "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
12921           }
12922         ]
12923       }
12924     },
12925     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12926     "version": "0.0.0",
12927     "filename": "server/api/campaign/index.js",
12928     "groupTitle": "IVR_Campaigns"
12929   },
12930   {
12931     "type": "delete",
12932     "url": "/api/campaigns/{id}",
12933     "title": "Deletes a IVR Campaign",
12934     "examples": [
12935       {
12936         "title": "Example usage:",
12937         "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password} -X DELETE",
12938         "type": "json"
12939       }
12940     ],
12941     "name": "DeleteIVR_Campaigns",
12942     "group": "IVR_Campaigns",
12943     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12944     "version": "0.0.0",
12945     "filename": "server/api/campaign/index.js",
12946     "groupTitle": "IVR_Campaigns"
12947   },
12948   {
12949     "type": "get",
12950     "url": "/api/campaigns/{id}/blacklists",
12951     "title": "Get IVR campaign blacklists",
12952     "examples": [
12953       {
12954         "title": "Example usage:",
12955         "content": "curl https://{domain}/api/campaigns/{id}/blacklists -v -u {name}:{password} -X GET",
12956         "type": "json"
12957       }
12958     ],
12959     "name": "GetBlackLists",
12960     "group": "IVR_Campaigns",
12961     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12962     "version": "0.0.0",
12963     "filename": "server/api/campaign/index.js",
12964     "groupTitle": "IVR_Campaigns"
12965   },
12966   {
12967     "type": "get",
12968     "url": "/api/campaigns/{id}/finals",
12969     "title": "Gets IVR campaign hopper finals",
12970     "examples": [
12971       {
12972         "title": "Example usage:",
12973         "content": "curl https://{domain}/api/campaigns/{id}/hopper_finals -v -u {name}:{password}  -X GET",
12974         "type": "json"
12975       }
12976     ],
12977     "name": "GetHopperFinals",
12978     "group": "IVR_Campaigns",
12979     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12980     "version": "0.0.0",
12981     "filename": "server/api/campaign/index.js",
12982     "groupTitle": "IVR_Campaigns"
12983   },
12984   {
12985     "type": "get",
12986     "url": "/api/campaigns/{id}/hopper_histories",
12987     "title": "Gets IVR campaign hopper histories",
12988     "examples": [
12989       {
12990         "title": "Example usage:",
12991         "content": "curl https://{domain}/api/campaigns/{id}/hopper_histories -v -u {name}:{password} -X GET",
12992         "type": "json"
12993       }
12994     ],
12995     "name": "GetHopperHistories",
12996     "group": "IVR_Campaigns",
12997     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12998     "version": "0.0.0",
12999     "filename": "server/api/campaign/index.js",
13000     "groupTitle": "IVR_Campaigns"
13001   },
13002   {
13003     "type": "get",
13004     "url": "/api/campaigns/{id}/hoppers",
13005     "title": "Gets IVR campaign hoppers",
13006     "examples": [
13007       {
13008         "title": "Example usage:",
13009         "content": "curl https://{domain}/api/campaigns/{id}/hoppers -v -u {name}:{password} -X GET",
13010         "type": "json"
13011       }
13012     ],
13013     "name": "GetHoppers",
13014     "group": "IVR_Campaigns",
13015     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13016     "version": "0.0.0",
13017     "filename": "server/api/campaign/index.js",
13018     "groupTitle": "IVR_Campaigns"
13019   },
13020   {
13021     "type": "get",
13022     "url": "/api/campaigns",
13023     "title": "Gets a list of IVR Campaigns",
13024     "examples": [
13025       {
13026         "title": "Example usage:",
13027         "content": "curl https://{domain}/api/campaigns -v -u {name}:{password}",
13028         "type": "json"
13029       }
13030     ],
13031     "name": "GetIVR_Campaigns",
13032     "group": "IVR_Campaigns",
13033     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13034     "version": "0.0.0",
13035     "filename": "server/api/campaign/index.js",
13036     "groupTitle": "IVR_Campaigns"
13037   },
13038   {
13039     "type": "get",
13040     "url": "/api/campaigns/{id}/lists",
13041     "title": "Get IVR campaign lists",
13042     "examples": [
13043       {
13044         "title": "Example usage:",
13045         "content": "curl https://{domain}/api/campaigns/{id}/lists -v -u {name}:{password} -X GET",
13046         "type": "json"
13047       }
13048     ],
13049     "name": "GetLists",
13050     "group": "IVR_Campaigns",
13051     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13052     "version": "0.0.0",
13053     "filename": "server/api/campaign/index.js",
13054     "groupTitle": "IVR_Campaigns"
13055   },
13056   {
13057     "type": "delete",
13058     "url": "/api/campaigns/{id}/blacklists",
13059     "title": "Remove blacklists from an IVR Campaign",
13060     "examples": [
13061       {
13062         "title": "Example usage:",
13063         "content": "curl https://{domain}/api/campaigns/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
13064         "type": "json"
13065       }
13066     ],
13067     "name": "RemoveBlackLists",
13068     "group": "IVR_Campaigns",
13069     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13070     "version": "0.0.0",
13071     "filename": "server/api/campaign/index.js",
13072     "groupTitle": "IVR_Campaigns"
13073   },
13074   {
13075     "type": "delete",
13076     "url": "/api/campaigns/{id}/lists",
13077     "title": "Remove lists from an IVR Campaign",
13078     "examples": [
13079       {
13080         "title": "Example usage:",
13081         "content": "curl https://{domain}/api/campaigns/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
13082         "type": "json"
13083       }
13084     ],
13085     "name": "RemoveLists",
13086     "group": "IVR_Campaigns",
13087     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13088     "version": "0.0.0",
13089     "filename": "server/api/campaign/index.js",
13090     "groupTitle": "IVR_Campaigns"
13091   },
13092   {
13093     "type": "get",
13094     "url": "/api/campaigns/{id}",
13095     "title": "Gets a single IVR Campaign",
13096     "examples": [
13097       {
13098         "title": "Example usage:",
13099         "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password}",
13100         "type": "json"
13101       }
13102     ],
13103     "name": "ShowIVR_Campaigns",
13104     "group": "IVR_Campaigns",
13105     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13106     "version": "0.0.0",
13107     "filename": "server/api/campaign/index.js",
13108     "groupTitle": "IVR_Campaigns"
13109   },
13110   {
13111     "type": "get",
13112     "url": "/api/campaigns/{id}/blacks",
13113     "title": "Gets IVR campaign hopper blacks",
13114     "examples": [
13115       {
13116         "title": "Example usage:",
13117         "content": "curl https://{domain}/api/campaigns/{id}/hopper_black -v -u {name}:{password}  -X GET",
13118         "type": "json"
13119       }
13120     ],
13121     "name": "getHopperBlacks",
13122     "group": "IVR_Campaigns",
13123     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13124     "version": "0.0.0",
13125     "filename": "server/api/campaign/index.js",
13126     "groupTitle": "IVR_Campaigns"
13127   },
13128   {
13129     "type": "put",
13130     "url": "/api/campaigns/{id}",
13131     "title": "Update an existing IVR Campaign",
13132     "examples": [
13133       {
13134         "title": "Example usage:",
13135         "content": "curl https://{domain}/api/campaigns/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
13136         "type": "json"
13137       }
13138     ],
13139     "name": "updateIVR_Campaigns",
13140     "group": "IVR_Campaigns",
13141     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13142     "version": "0.0.0",
13143     "filename": "server/api/campaign/index.js",
13144     "groupTitle": "IVR_Campaigns"
13145   },
13146   {
13147     "type": "post",
13148     "url": "/api/integrations/reports",
13149     "title": "Creates a new Integration Report",
13150     "examples": [
13151       {
13152         "title": "Example usage:",
13153         "content": "curl https://{domain}/api/integrations/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13154         "type": "json"
13155       }
13156     ],
13157     "name": "CreateIntegration_Reports",
13158     "group": "Integration_Reports",
13159     "parameter": {
13160       "fields": {
13161         "Body": [
13162           {
13163             "group": "Body",
13164             "type": "String",
13165             "optional": true,
13166             "field": "integration",
13167             "description": ""
13168           },
13169           {
13170             "group": "Body",
13171             "type": "String",
13172             "optional": true,
13173             "field": "eventChannel",
13174             "description": ""
13175           },
13176           {
13177             "group": "Body",
13178             "type": "String",
13179             "optional": true,
13180             "field": "exitStatus",
13181             "description": ""
13182           },
13183           {
13184             "group": "Body",
13185             "type": "String",
13186             "optional": true,
13187             "field": "ticketId",
13188             "description": ""
13189           },
13190           {
13191             "group": "Body",
13192             "type": "Integer",
13193             "optional": true,
13194             "field": "integrationId",
13195             "description": ""
13196           },
13197           {
13198             "group": "Body",
13199             "type": "String",
13200             "optional": true,
13201             "field": "contacts",
13202             "description": ""
13203           },
13204           {
13205             "group": "Body",
13206             "type": "String",
13207             "optional": true,
13208             "field": "uniqueid",
13209             "description": ""
13210           },
13211           {
13212             "group": "Body",
13213             "type": "String",
13214             "optional": true,
13215             "field": "calleridnum",
13216             "description": ""
13217           },
13218           {
13219             "group": "Body",
13220             "type": "String",
13221             "optional": true,
13222             "field": "calleridname",
13223             "description": ""
13224           },
13225           {
13226             "group": "Body",
13227             "type": "String",
13228             "optional": true,
13229             "field": "queue",
13230             "description": ""
13231           },
13232           {
13233             "group": "Body",
13234             "type": "String",
13235             "optional": true,
13236             "field": "interface",
13237             "description": ""
13238           },
13239           {
13240             "group": "Body",
13241             "type": "String",
13242             "optional": true,
13243             "field": "membername",
13244             "description": ""
13245           },
13246           {
13247             "group": "Body",
13248             "type": "String",
13249             "optional": true,
13250             "field": "agentcalledAt",
13251             "description": ""
13252           },
13253           {
13254             "group": "Body",
13255             "type": "String",
13256             "optional": true,
13257             "field": "agentconnectAt",
13258             "description": ""
13259           },
13260           {
13261             "group": "Body",
13262             "type": "Integer",
13263             "optional": true,
13264             "field": "holdtime",
13265             "description": ""
13266           },
13267           {
13268             "group": "Body",
13269             "type": "Boolean",
13270             "optional": true,
13271             "field": "agentcomplete",
13272             "description": ""
13273           },
13274           {
13275             "group": "Body",
13276             "type": "String",
13277             "optional": true,
13278             "field": "agentcompleteAt",
13279             "description": ""
13280           },
13281           {
13282             "group": "Body",
13283             "type": "Integer",
13284             "optional": true,
13285             "field": "talktime",
13286             "description": ""
13287           },
13288           {
13289             "group": "Body",
13290             "type": "Boolean",
13291             "optional": true,
13292             "field": "agentacw",
13293             "description": ""
13294           },
13295           {
13296             "group": "Body",
13297             "type": "Integer",
13298             "optional": true,
13299             "field": "acwtime",
13300             "description": ""
13301           },
13302           {
13303             "group": "Body",
13304             "type": "String",
13305             "optional": true,
13306             "field": "reason",
13307             "description": ""
13308           },
13309           {
13310             "group": "Body",
13311             "type": "Boolean",
13312             "optional": true,
13313             "field": "agentringnoanswer",
13314             "description": ""
13315           },
13316           {
13317             "group": "Body",
13318             "type": "String",
13319             "optional": true,
13320             "field": "agentringnoanswerAt",
13321             "description": ""
13322           },
13323           {
13324             "group": "Body",
13325             "type": "Boolean",
13326             "optional": true,
13327             "field": "agentdump",
13328             "description": ""
13329           },
13330           {
13331             "group": "Body",
13332             "type": "String",
13333             "optional": true,
13334             "field": "agentdumpAt",
13335             "description": ""
13336           },
13337           {
13338             "group": "Body",
13339             "type": "String",
13340             "optional": true,
13341             "field": "lastevent",
13342             "description": ""
13343           },
13344           {
13345             "group": "Body",
13346             "type": "String",
13347             "optional": true,
13348             "field": "channel",
13349             "description": ""
13350           },
13351           {
13352             "group": "Body",
13353             "type": "Integer",
13354             "optional": true,
13355             "field": "channelstate",
13356             "description": ""
13357           },
13358           {
13359             "group": "Body",
13360             "type": "String",
13361             "optional": true,
13362             "field": "channelstatedesc",
13363             "description": ""
13364           },
13365           {
13366             "group": "Body",
13367             "type": "String",
13368             "optional": true,
13369             "field": "connectedlinenum",
13370             "description": ""
13371           },
13372           {
13373             "group": "Body",
13374             "type": "String",
13375             "optional": true,
13376             "field": "connectedlinename",
13377             "description": ""
13378           },
13379           {
13380             "group": "Body",
13381             "type": "String",
13382             "optional": true,
13383             "field": "language",
13384             "description": ""
13385           },
13386           {
13387             "group": "Body",
13388             "type": "String",
13389             "optional": true,
13390             "field": "accountcode",
13391             "description": ""
13392           },
13393           {
13394             "group": "Body",
13395             "type": "String",
13396             "optional": true,
13397             "field": "context",
13398             "description": ""
13399           },
13400           {
13401             "group": "Body",
13402             "type": "String",
13403             "optional": true,
13404             "field": "exten",
13405             "description": ""
13406           },
13407           {
13408             "group": "Body",
13409             "type": "String",
13410             "optional": true,
13411             "field": "priority",
13412             "description": ""
13413           },
13414           {
13415             "group": "Body",
13416             "type": "String",
13417             "optional": true,
13418             "field": "destchannel",
13419             "description": ""
13420           },
13421           {
13422             "group": "Body",
13423             "type": "Integer",
13424             "optional": true,
13425             "field": "destchannelstate",
13426             "description": ""
13427           },
13428           {
13429             "group": "Body",
13430             "type": "String",
13431             "optional": true,
13432             "field": "destchannelstatedesc",
13433             "description": ""
13434           },
13435           {
13436             "group": "Body",
13437             "type": "String",
13438             "optional": true,
13439             "field": "destcalleridnum",
13440             "description": ""
13441           },
13442           {
13443             "group": "Body",
13444             "type": "String",
13445             "optional": true,
13446             "field": "destcalleridname",
13447             "description": ""
13448           },
13449           {
13450             "group": "Body",
13451             "type": "String",
13452             "optional": true,
13453             "field": "destconnectedlinenum",
13454             "description": ""
13455           },
13456           {
13457             "group": "Body",
13458             "type": "String",
13459             "optional": true,
13460             "field": "destconnectedlinename",
13461             "description": ""
13462           },
13463           {
13464             "group": "Body",
13465             "type": "String",
13466             "optional": true,
13467             "field": "destlanguage",
13468             "description": ""
13469           },
13470           {
13471             "group": "Body",
13472             "type": "String",
13473             "optional": true,
13474             "field": "destaccountcode",
13475             "description": ""
13476           },
13477           {
13478             "group": "Body",
13479             "type": "String",
13480             "optional": true,
13481             "field": "destcontext",
13482             "description": ""
13483           },
13484           {
13485             "group": "Body",
13486             "type": "String",
13487             "optional": true,
13488             "field": "destexten",
13489             "description": ""
13490           },
13491           {
13492             "group": "Body",
13493             "type": "String",
13494             "optional": true,
13495             "field": "destpriority",
13496             "description": ""
13497           },
13498           {
13499             "group": "Body",
13500             "type": "String",
13501             "optional": true,
13502             "field": "destuniqueid",
13503             "description": ""
13504           },
13505           {
13506             "group": "Body",
13507             "type": "String",
13508             "optional": true,
13509             "field": "messageId",
13510             "description": ""
13511           },
13512           {
13513             "group": "Body",
13514             "type": "String",
13515             "optional": true,
13516             "field": "inReplyTo",
13517             "description": ""
13518           },
13519           {
13520             "group": "Body",
13521             "type": "String",
13522             "optional": true,
13523             "field": "subject",
13524             "description": ""
13525           },
13526           {
13527             "group": "Body",
13528             "type": "String",
13529             "optional": true,
13530             "field": "from",
13531             "description": ""
13532           },
13533           {
13534             "group": "Body",
13535             "type": "String",
13536             "optional": true,
13537             "field": "to",
13538             "description": ""
13539           },
13540           {
13541             "group": "Body",
13542             "type": "String",
13543             "optional": true,
13544             "field": "cc",
13545             "description": ""
13546           },
13547           {
13548             "group": "Body",
13549             "type": "Text",
13550             "optional": true,
13551             "field": "attachment",
13552             "description": ""
13553           },
13554           {
13555             "group": "Body",
13556             "type": "Text",
13557             "optional": true,
13558             "field": "html",
13559             "description": ""
13560           },
13561           {
13562             "group": "Body",
13563             "type": "Text",
13564             "optional": true,
13565             "field": "text",
13566             "description": ""
13567           },
13568           {
13569             "group": "Body",
13570             "type": "String",
13571             "allowedValues": [
13572               "\"SENT\"",
13573               "\"SENDING\"",
13574               "\"RECEIVED\"",
13575               "\"FAILED\""
13576             ],
13577             "optional": true,
13578             "field": "status",
13579             "description": ""
13580           },
13581           {
13582             "group": "Body",
13583             "type": "String",
13584             "optional": true,
13585             "field": "url",
13586             "description": ""
13587           },
13588           {
13589             "group": "Body",
13590             "type": "String",
13591             "optional": true,
13592             "field": "app",
13593             "description": ""
13594           },
13595           {
13596             "group": "Body",
13597             "type": "String",
13598             "optional": true,
13599             "field": "appdata",
13600             "description": ""
13601           },
13602           {
13603             "group": "Body",
13604             "type": "Integer",
13605             "optional": true,
13606             "field": "projectId",
13607             "description": ""
13608           }
13609         ]
13610       }
13611     },
13612     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13613     "version": "0.0.0",
13614     "filename": "server/api/integrationReport/index.js",
13615     "groupTitle": "Integration_Reports"
13616   },
13617   {
13618     "type": "delete",
13619     "url": "/api/integrations/reports/{id}",
13620     "title": "Deletes a Integration Report",
13621     "examples": [
13622       {
13623         "title": "Example usage:",
13624         "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password} -X DELETE",
13625         "type": "json"
13626       }
13627     ],
13628     "name": "DeleteIntegration_Reports",
13629     "group": "Integration_Reports",
13630     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13631     "version": "0.0.0",
13632     "filename": "server/api/integrationReport/index.js",
13633     "groupTitle": "Integration_Reports"
13634   },
13635   {
13636     "type": "get",
13637     "url": "/api/integrations/reports/describe",
13638     "title": "Gets table info about Integration Reports",
13639     "examples": [
13640       {
13641         "title": "Example usage:",
13642         "content": "curl https://{domain}/api/integrations/reports/describe -v -u {name}:{password}",
13643         "type": "json"
13644       }
13645     ],
13646     "name": "DescribeIntegration_Reports",
13647     "group": "Integration_Reports",
13648     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13649     "version": "0.0.0",
13650     "filename": "server/api/integrationReport/index.js",
13651     "groupTitle": "Integration_Reports"
13652   },
13653   {
13654     "type": "get",
13655     "url": "/api/integrations/reports",
13656     "title": "Gets a list of Integration Reports",
13657     "examples": [
13658       {
13659         "title": "Example usage:",
13660         "content": "curl https://{domain}/api/integrations/reports -v -u {name}:{password}",
13661         "type": "json"
13662       }
13663     ],
13664     "name": "GetIntegration_Reports",
13665     "group": "Integration_Reports",
13666     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13667     "version": "0.0.0",
13668     "filename": "server/api/integrationReport/index.js",
13669     "groupTitle": "Integration_Reports"
13670   },
13671   {
13672     "type": "get",
13673     "url": "/api/integrations/reports/{id}",
13674     "title": "Gets a single Integration Report",
13675     "examples": [
13676       {
13677         "title": "Example usage:",
13678         "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password}",
13679         "type": "json"
13680       }
13681     ],
13682     "name": "ShowIntegration_Reports",
13683     "group": "Integration_Reports",
13684     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13685     "version": "0.0.0",
13686     "filename": "server/api/integrationReport/index.js",
13687     "groupTitle": "Integration_Reports"
13688   },
13689   {
13690     "type": "put",
13691     "url": "/api/integrations/reports/{id}",
13692     "title": "Update an existing Integration Report",
13693     "examples": [
13694       {
13695         "title": "Example usage:",
13696         "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",
13697         "type": "json"
13698       }
13699     ],
13700     "name": "updateIntegration_Reports",
13701     "group": "Integration_Reports",
13702     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13703     "version": "0.0.0",
13704     "filename": "server/api/integrationReport/index.js",
13705     "groupTitle": "Integration_Reports"
13706   },
13707   {
13708     "type": "post",
13709     "url": "/api/intervals",
13710     "title": "Creates a new Interval",
13711     "examples": [
13712       {
13713         "title": "Example usage:",
13714         "content": "curl https://{domain}/api/intervals -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13715         "type": "json"
13716       }
13717     ],
13718     "name": "CreateIntervals",
13719     "group": "Intervals",
13720     "parameter": {
13721       "fields": {
13722         "Body": [
13723           {
13724             "group": "Body",
13725             "type": "String",
13726             "optional": true,
13727             "field": "name",
13728             "description": ""
13729           },
13730           {
13731             "group": "Body",
13732             "type": "String",
13733             "optional": true,
13734             "field": "description",
13735             "description": ""
13736           },
13737           {
13738             "group": "Body",
13739             "type": "String",
13740             "optional": true,
13741             "field": "interval",
13742             "description": ""
13743           }
13744         ]
13745       }
13746     },
13747     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13748     "version": "0.0.0",
13749     "filename": "server/api/interval/index.js",
13750     "groupTitle": "Intervals"
13751   },
13752   {
13753     "type": "delete",
13754     "url": "/api/intervals/{id}",
13755     "title": "Deletes a Interval",
13756     "examples": [
13757       {
13758         "title": "Example usage:",
13759         "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password} -X DELETE",
13760         "type": "json"
13761       }
13762     ],
13763     "name": "DeleteIntervals",
13764     "group": "Intervals",
13765     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13766     "version": "0.0.0",
13767     "filename": "server/api/interval/index.js",
13768     "groupTitle": "Intervals"
13769   },
13770   {
13771     "type": "get",
13772     "url": "/api/intervals",
13773     "title": "Gets a list of Intervals",
13774     "examples": [
13775       {
13776         "title": "Example usage:",
13777         "content": "curl https://{domain}/api/intervals -v -u {name}:{password}",
13778         "type": "json"
13779       }
13780     ],
13781     "name": "GetIntervals",
13782     "group": "Intervals",
13783     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13784     "version": "0.0.0",
13785     "filename": "server/api/interval/index.js",
13786     "groupTitle": "Intervals"
13787   },
13788   {
13789     "type": "get",
13790     "url": "/api/intervals/{id}",
13791     "title": "Gets a single Interval",
13792     "examples": [
13793       {
13794         "title": "Example usage:",
13795         "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password}",
13796         "type": "json"
13797       }
13798     ],
13799     "name": "ShowIntervals",
13800     "group": "Intervals",
13801     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13802     "version": "0.0.0",
13803     "filename": "server/api/interval/index.js",
13804     "groupTitle": "Intervals"
13805   },
13806   {
13807     "type": "post",
13808     "url": "/api/intervals/{id}/sub_intervals",
13809     "title": "Creates a new sub interval",
13810     "examples": [
13811       {
13812         "title": "Example usage:",
13813         "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",
13814         "type": "json"
13815       }
13816     ],
13817     "name": "addInterval",
13818     "group": "Intervals",
13819     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13820     "version": "0.0.0",
13821     "filename": "server/api/interval/index.js",
13822     "groupTitle": "Intervals"
13823   },
13824   {
13825     "type": "post",
13826     "url": "/api/intervals/{id}/sub_intervals/create_many",
13827     "title": "Create new sub intervals set",
13828     "examples": [
13829       {
13830         "title": "Example usage:",
13831         "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
13832         "type": "json"
13833       }
13834     ],
13835     "name": "addIntervals",
13836     "group": "Intervals",
13837     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13838     "version": "0.0.0",
13839     "filename": "server/api/interval/index.js",
13840     "groupTitle": "Intervals"
13841   },
13842   {
13843     "type": "get",
13844     "url": "/api/intervals/{id}/sub_intervals",
13845     "title": "Get sub intervals set",
13846     "examples": [
13847       {
13848         "title": "Example usage:",
13849         "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -v -u {name}:{password} -X GET",
13850         "type": "json"
13851       }
13852     ],
13853     "name": "getIntervals",
13854     "group": "Intervals",
13855     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13856     "version": "0.0.0",
13857     "filename": "server/api/interval/index.js",
13858     "groupTitle": "Intervals"
13859   },
13860   {
13861     "type": "put",
13862     "url": "/api/intervals/{id}",
13863     "title": "Update an existing Interval",
13864     "examples": [
13865       {
13866         "title": "Example usage:",
13867         "content": "curl https://{domain}/api/intervals/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
13868         "type": "json"
13869       }
13870     ],
13871     "name": "updateIntervals",
13872     "group": "Intervals",
13873     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13874     "version": "0.0.0",
13875     "filename": "server/api/interval/index.js",
13876     "groupTitle": "Intervals"
13877   },
13878   {
13879     "type": "post",
13880     "url": "/api/jira",
13881     "title": "Creates a new issue",
13882     "examples": [
13883       {
13884         "title": "Example usage:",
13885         "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}",
13886         "type": "json"
13887       }
13888     ],
13889     "name": "Creates_Issue",
13890     "group": "Issue",
13891     "parameter": {
13892       "fields": {
13893         "Body": [
13894           {
13895             "group": "Body",
13896             "type": "String",
13897             "allowedValues": [
13898               "\"Bug\""
13899             ],
13900             "optional": true,
13901             "field": "issuetype",
13902             "description": ""
13903           },
13904           {
13905             "group": "Body",
13906             "type": "String",
13907             "optional": false,
13908             "field": "summary",
13909             "description": ""
13910           },
13911           {
13912             "group": "Body",
13913             "type": "String",
13914             "optional": false,
13915             "field": "description",
13916             "description": ""
13917           }
13918         ]
13919       }
13920     },
13921     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13922     "version": "0.0.0",
13923     "filename": "server/api/jira/index.js",
13924     "groupTitle": "Issue"
13925   },
13926   {
13927     "type": "post",
13928     "url": "/api/jscripty/answers/reports",
13929     "title": "Creates a new Report",
13930     "examples": [
13931       {
13932         "title": "Example usage:",
13933         "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",
13934         "type": "json"
13935       }
13936     ],
13937     "name": "CreateReports",
13938     "group": "JscriptyAnswerReport",
13939     "parameter": {
13940       "fields": {
13941         "Body": [
13942           {
13943             "group": "Body",
13944             "type": "Text",
13945             "optional": true,
13946             "field": "question",
13947             "description": ""
13948           },
13949           {
13950             "group": "Body",
13951             "type": "Text",
13952             "optional": true,
13953             "field": "answer",
13954             "description": ""
13955           },
13956           {
13957             "group": "Body",
13958             "type": "String",
13959             "optional": true,
13960             "field": "membername",
13961             "description": ""
13962           },
13963           {
13964             "group": "Body",
13965             "type": "String",
13966             "optional": true,
13967             "field": "projectname",
13968             "description": ""
13969           },
13970           {
13971             "group": "Body",
13972             "type": "String",
13973             "optional": true,
13974             "field": "queue",
13975             "description": ""
13976           },
13977           {
13978             "group": "Body",
13979             "type": "String",
13980             "optional": true,
13981             "field": "uniqueid",
13982             "description": ""
13983           },
13984           {
13985             "group": "Body",
13986             "type": "String",
13987             "optional": true,
13988             "field": "calleridname",
13989             "description": ""
13990           },
13991           {
13992             "group": "Body",
13993             "type": "String",
13994             "optional": true,
13995             "field": "calleridnum",
13996             "description": ""
13997           },
13998           {
13999             "group": "Body",
14000             "type": "String",
14001             "optional": true,
14002             "field": "questionId",
14003             "description": ""
14004           }
14005         ]
14006       }
14007     },
14008     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14009     "version": "0.0.0",
14010     "filename": "server/api/jscriptyAnswerReport/index.js",
14011     "groupTitle": "JscriptyAnswerReport"
14012   },
14013   {
14014     "type": "delete",
14015     "url": "/api/jscripty/answers/reports/{id}",
14016     "title": "Deletes a Report",
14017     "examples": [
14018       {
14019         "title": "Example usage:",
14020         "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password} -X DELETE",
14021         "type": "json"
14022       }
14023     ],
14024     "name": "DeleteReports",
14025     "group": "JscriptyAnswerReport",
14026     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14027     "version": "0.0.0",
14028     "filename": "server/api/jscriptyAnswerReport/index.js",
14029     "groupTitle": "JscriptyAnswerReport"
14030   },
14031   {
14032     "type": "get",
14033     "url": "/api/jscripty/answers/reports/describe",
14034     "title": "Gets table info about Reports",
14035     "examples": [
14036       {
14037         "title": "Example usage:",
14038         "content": "curl https://{domain}/api/jscripty/answers/reports/describe -v -u {name}:{password}",
14039         "type": "json"
14040       }
14041     ],
14042     "name": "DescribeReports",
14043     "group": "JscriptyAnswerReport",
14044     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14045     "version": "0.0.0",
14046     "filename": "server/api/jscriptyAnswerReport/index.js",
14047     "groupTitle": "JscriptyAnswerReport"
14048   },
14049   {
14050     "type": "get",
14051     "url": "/api/jscripty/answers/reports",
14052     "title": "Gets a list of Reports",
14053     "examples": [
14054       {
14055         "title": "Example usage:",
14056         "content": "curl https://{domain}/api/jscripty/answers/reports -v -u {name}:{password}",
14057         "type": "json"
14058       }
14059     ],
14060     "name": "GetReports",
14061     "group": "JscriptyAnswerReport",
14062     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14063     "version": "0.0.0",
14064     "filename": "server/api/jscriptyAnswerReport/index.js",
14065     "groupTitle": "JscriptyAnswerReport"
14066   },
14067   {
14068     "type": "get",
14069     "url": "/api/jscripty/answers/reports/{id}",
14070     "title": "Gets a single Report",
14071     "examples": [
14072       {
14073         "title": "Example usage:",
14074         "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password}",
14075         "type": "json"
14076       }
14077     ],
14078     "name": "ShowReports",
14079     "group": "JscriptyAnswerReport",
14080     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14081     "version": "0.0.0",
14082     "filename": "server/api/jscriptyAnswerReport/index.js",
14083     "groupTitle": "JscriptyAnswerReport"
14084   },
14085   {
14086     "type": "put",
14087     "url": "/api/jscripty/answers/reports/{id}",
14088     "title": "Update an existing Report",
14089     "examples": [
14090       {
14091         "title": "Example usage:",
14092         "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",
14093         "type": "json"
14094       }
14095     ],
14096     "name": "updateReports",
14097     "group": "JscriptyAnswerReport",
14098     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14099     "version": "0.0.0",
14100     "filename": "server/api/jscriptyAnswerReport/index.js",
14101     "groupTitle": "JscriptyAnswerReport"
14102   },
14103   {
14104     "type": "post",
14105     "url": "/api/jscripty/questions/reports",
14106     "title": "Creates a new Report",
14107     "examples": [
14108       {
14109         "title": "Example usage:",
14110         "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",
14111         "type": "json"
14112       }
14113     ],
14114     "name": "CreateReports",
14115     "group": "JscriptyQuestionReport",
14116     "parameter": {
14117       "fields": {
14118         "Body": [
14119           {
14120             "group": "Body",
14121             "type": "Text",
14122             "optional": true,
14123             "field": "question",
14124             "description": ""
14125           },
14126           {
14127             "group": "Body",
14128             "type": "Text",
14129             "optional": true,
14130             "field": "answer",
14131             "description": ""
14132           },
14133           {
14134             "group": "Body",
14135             "type": "String",
14136             "optional": true,
14137             "field": "membername",
14138             "description": ""
14139           },
14140           {
14141             "group": "Body",
14142             "type": "String",
14143             "optional": true,
14144             "field": "projectname",
14145             "description": ""
14146           },
14147           {
14148             "group": "Body",
14149             "type": "String",
14150             "optional": true,
14151             "field": "queue",
14152             "description": ""
14153           },
14154           {
14155             "group": "Body",
14156             "type": "String",
14157             "optional": true,
14158             "field": "uniqueid",
14159             "description": ""
14160           },
14161           {
14162             "group": "Body",
14163             "type": "String",
14164             "optional": true,
14165             "field": "calleridname",
14166             "description": ""
14167           },
14168           {
14169             "group": "Body",
14170             "type": "String",
14171             "optional": true,
14172             "field": "calleridnum",
14173             "description": ""
14174           },
14175           {
14176             "group": "Body",
14177             "type": "String",
14178             "optional": true,
14179             "field": "questionId",
14180             "description": ""
14181           }
14182         ]
14183       }
14184     },
14185     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14186     "version": "0.0.0",
14187     "filename": "server/api/jscriptyQuestionReport/index.js",
14188     "groupTitle": "JscriptyQuestionReport"
14189   },
14190   {
14191     "type": "delete",
14192     "url": "/api/jscripty/questions/reports/{id}",
14193     "title": "Deletes a Report",
14194     "examples": [
14195       {
14196         "title": "Example usage:",
14197         "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password} -X DELETE",
14198         "type": "json"
14199       }
14200     ],
14201     "name": "DeleteReports",
14202     "group": "JscriptyQuestionReport",
14203     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14204     "version": "0.0.0",
14205     "filename": "server/api/jscriptyQuestionReport/index.js",
14206     "groupTitle": "JscriptyQuestionReport"
14207   },
14208   {
14209     "type": "get",
14210     "url": "/api/jscripty/questions/reports/describe",
14211     "title": "Gets table info about Reports",
14212     "examples": [
14213       {
14214         "title": "Example usage:",
14215         "content": "curl https://{domain}/api/jscripty/questions/reports/describe -v -u {name}:{password}",
14216         "type": "json"
14217       }
14218     ],
14219     "name": "DescribeReports",
14220     "group": "JscriptyQuestionReport",
14221     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14222     "version": "0.0.0",
14223     "filename": "server/api/jscriptyQuestionReport/index.js",
14224     "groupTitle": "JscriptyQuestionReport"
14225   },
14226   {
14227     "type": "get",
14228     "url": "/api/jscripty/questions/reports",
14229     "title": "Gets a list of Reports",
14230     "examples": [
14231       {
14232         "title": "Example usage:",
14233         "content": "curl https://{domain}/api/jscripty/questions/reports -v -u {name}:{password}",
14234         "type": "json"
14235       }
14236     ],
14237     "name": "GetReports",
14238     "group": "JscriptyQuestionReport",
14239     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14240     "version": "0.0.0",
14241     "filename": "server/api/jscriptyQuestionReport/index.js",
14242     "groupTitle": "JscriptyQuestionReport"
14243   },
14244   {
14245     "type": "get",
14246     "url": "/api/jscripty/questions/reports/{id}",
14247     "title": "Gets a single Report",
14248     "examples": [
14249       {
14250         "title": "Example usage:",
14251         "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password}",
14252         "type": "json"
14253       }
14254     ],
14255     "name": "ShowReports",
14256     "group": "JscriptyQuestionReport",
14257     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14258     "version": "0.0.0",
14259     "filename": "server/api/jscriptyQuestionReport/index.js",
14260     "groupTitle": "JscriptyQuestionReport"
14261   },
14262   {
14263     "type": "put",
14264     "url": "/api/jscripty/questions/reports/{id}",
14265     "title": "Update an existing Report",
14266     "examples": [
14267       {
14268         "title": "Example usage:",
14269         "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",
14270         "type": "json"
14271       }
14272     ],
14273     "name": "updateReports",
14274     "group": "JscriptyQuestionReport",
14275     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14276     "version": "0.0.0",
14277     "filename": "server/api/jscriptyQuestionReport/index.js",
14278     "groupTitle": "JscriptyQuestionReport"
14279   },
14280   {
14281     "type": "post",
14282     "url": "/api/jscripty/sessions/reports",
14283     "title": "Creates a new Report",
14284     "examples": [
14285       {
14286         "title": "Example usage:",
14287         "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",
14288         "type": "json"
14289       }
14290     ],
14291     "name": "CreateReports",
14292     "group": "JscriptySessionReport",
14293     "parameter": {
14294       "fields": {
14295         "Body": [
14296           {
14297             "group": "Body",
14298             "type": "String",
14299             "optional": true,
14300             "field": "starttime",
14301             "description": ""
14302           },
14303           {
14304             "group": "Body",
14305             "type": "String",
14306             "optional": true,
14307             "field": "endtime",
14308             "description": ""
14309           },
14310           {
14311             "group": "Body",
14312             "type": "String",
14313             "optional": true,
14314             "field": "membername",
14315             "description": ""
14316           },
14317           {
14318             "group": "Body",
14319             "type": "String",
14320             "optional": true,
14321             "field": "projectname",
14322             "description": ""
14323           },
14324           {
14325             "group": "Body",
14326             "type": "String",
14327             "optional": true,
14328             "field": "queue",
14329             "description": ""
14330           },
14331           {
14332             "group": "Body",
14333             "type": "String",
14334             "optional": true,
14335             "field": "uniqueid",
14336             "description": ""
14337           },
14338           {
14339             "group": "Body",
14340             "type": "String",
14341             "optional": true,
14342             "field": "calleridname",
14343             "description": ""
14344           },
14345           {
14346             "group": "Body",
14347             "type": "String",
14348             "optional": true,
14349             "field": "calleridnum",
14350             "description": ""
14351           },
14352           {
14353             "group": "Body",
14354             "type": "Boolean",
14355             "optional": true,
14356             "field": "completed",
14357             "description": ""
14358           }
14359         ]
14360       }
14361     },
14362     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14363     "version": "0.0.0",
14364     "filename": "server/api/jscriptySessionReport/index.js",
14365     "groupTitle": "JscriptySessionReport"
14366   },
14367   {
14368     "type": "delete",
14369     "url": "/api/jscripty/sessions/reports/{id}",
14370     "title": "Deletes a Report",
14371     "examples": [
14372       {
14373         "title": "Example usage:",
14374         "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password} -X DELETE",
14375         "type": "json"
14376       }
14377     ],
14378     "name": "DeleteReports",
14379     "group": "JscriptySessionReport",
14380     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14381     "version": "0.0.0",
14382     "filename": "server/api/jscriptySessionReport/index.js",
14383     "groupTitle": "JscriptySessionReport"
14384   },
14385   {
14386     "type": "get",
14387     "url": "/api/jscripty/sessions/reports/describe",
14388     "title": "Gets table info about Reports",
14389     "examples": [
14390       {
14391         "title": "Example usage:",
14392         "content": "curl https://{domain}/api/jscripty/sessions/reports/describe -v -u {name}:{password}",
14393         "type": "json"
14394       }
14395     ],
14396     "name": "DescribeReports",
14397     "group": "JscriptySessionReport",
14398     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14399     "version": "0.0.0",
14400     "filename": "server/api/jscriptySessionReport/index.js",
14401     "groupTitle": "JscriptySessionReport"
14402   },
14403   {
14404     "type": "get",
14405     "url": "/api/jscripty/sessions/reports",
14406     "title": "Gets a list of Reports",
14407     "examples": [
14408       {
14409         "title": "Example usage:",
14410         "content": "curl https://{domain}/api/jscripty/sessions/reports -v -u {name}:{password}",
14411         "type": "json"
14412       }
14413     ],
14414     "name": "GetReports",
14415     "group": "JscriptySessionReport",
14416     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14417     "version": "0.0.0",
14418     "filename": "server/api/jscriptySessionReport/index.js",
14419     "groupTitle": "JscriptySessionReport"
14420   },
14421   {
14422     "type": "get",
14423     "url": "/api/jscripty/sessions/reports/{id}",
14424     "title": "Gets a single Report",
14425     "examples": [
14426       {
14427         "title": "Example usage:",
14428         "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password}",
14429         "type": "json"
14430       }
14431     ],
14432     "name": "ShowReports",
14433     "group": "JscriptySessionReport",
14434     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14435     "version": "0.0.0",
14436     "filename": "server/api/jscriptySessionReport/index.js",
14437     "groupTitle": "JscriptySessionReport"
14438   },
14439   {
14440     "type": "get",
14441     "url": "/api/jscripty/sessions/reports/{id}/questions",
14442     "title": "Gets Jscripty Session questions",
14443     "examples": [
14444       {
14445         "title": "Example usage:",
14446         "content": "curl https://{domain}/api/jscripty/sessions/reports/{id}/questions -v -u {name}:{password}  -X GET",
14447         "type": "json"
14448       }
14449     ],
14450     "name": "getQuestions",
14451     "group": "JscriptySessionReport",
14452     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14453     "version": "0.0.0",
14454     "filename": "server/api/jscriptySessionReport/index.js",
14455     "groupTitle": "JscriptySessionReport"
14456   },
14457   {
14458     "type": "put",
14459     "url": "/api/jscripty/sessions/reports/{id}",
14460     "title": "Update an existing Report",
14461     "examples": [
14462       {
14463         "title": "Example usage:",
14464         "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",
14465         "type": "json"
14466       }
14467     ],
14468     "name": "updateReports",
14469     "group": "JscriptySessionReport",
14470     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14471     "version": "0.0.0",
14472     "filename": "server/api/jscriptySessionReport/index.js",
14473     "groupTitle": "JscriptySessionReport"
14474   },
14475   {
14476     "type": "post",
14477     "url": "/api/jscripty/projects/clone",
14478     "title": "Clone an existing Project",
14479     "examples": [
14480       {
14481         "title": "Example usage:",
14482         "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",
14483         "type": "json"
14484       }
14485     ],
14486     "name": "CloneProjects",
14487     "group": "Jscripty_Projects",
14488     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14489     "version": "0.0.0",
14490     "filename": "server/api/jscriptyProject/index.js",
14491     "groupTitle": "Jscripty_Projects"
14492   },
14493   {
14494     "type": "post",
14495     "url": "/api/jscripty/projects",
14496     "title": "Creates a new Project",
14497     "examples": [
14498       {
14499         "title": "Example usage:",
14500         "content": "curl https://{domain}/api/jscripty/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
14501         "type": "json"
14502       }
14503     ],
14504     "name": "CreateProjects",
14505     "group": "Jscripty_Projects",
14506     "parameter": {
14507       "fields": {
14508         "Body": [
14509           {
14510             "group": "Body",
14511             "type": "String",
14512             "optional": true,
14513             "field": "name",
14514             "description": ""
14515           },
14516           {
14517             "group": "Body",
14518             "type": "String",
14519             "optional": true,
14520             "field": "description",
14521             "description": ""
14522           },
14523           {
14524             "group": "Body",
14525             "type": "Text",
14526             "optional": true,
14527             "field": "formData",
14528             "description": ""
14529           },
14530           {
14531             "group": "Body",
14532             "type": "Boolean",
14533             "optional": true,
14534             "field": "enableUncompleteSave",
14535             "description": ""
14536           },
14537           {
14538             "group": "Body",
14539             "type": "Boolean",
14540             "optional": true,
14541             "field": "sendUnpauseOnSubmit",
14542             "description": ""
14543           }
14544         ]
14545       }
14546     },
14547     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14548     "version": "0.0.0",
14549     "filename": "server/api/jscriptyProject/index.js",
14550     "groupTitle": "Jscripty_Projects"
14551   },
14552   {
14553     "type": "delete",
14554     "url": "/api/jscripty/projects/{id}",
14555     "title": "Deletes a Project",
14556     "examples": [
14557       {
14558         "title": "Example usage:",
14559         "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password} -X DELETE",
14560         "type": "json"
14561       }
14562     ],
14563     "name": "DeleteProjects",
14564     "group": "Jscripty_Projects",
14565     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14566     "version": "0.0.0",
14567     "filename": "server/api/jscriptyProject/index.js",
14568     "groupTitle": "Jscripty_Projects"
14569   },
14570   {
14571     "type": "get",
14572     "url": "/api/jscripty/projects",
14573     "title": "Gets a list of Projects",
14574     "examples": [
14575       {
14576         "title": "Example usage:",
14577         "content": "curl https://{domain}/api/jscripty/projects -v -u {name}:{password}",
14578         "type": "json"
14579       }
14580     ],
14581     "name": "GetProjects",
14582     "group": "Jscripty_Projects",
14583     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14584     "version": "0.0.0",
14585     "filename": "server/api/jscriptyProject/index.js",
14586     "groupTitle": "Jscripty_Projects"
14587   },
14588   {
14589     "type": "get",
14590     "url": "/api/jscripty/projects/{id}",
14591     "title": "Gets a single Project",
14592     "examples": [
14593       {
14594         "title": "Example usage:",
14595         "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password}",
14596         "type": "json"
14597       }
14598     ],
14599     "name": "ShowProjects",
14600     "group": "Jscripty_Projects",
14601     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14602     "version": "0.0.0",
14603     "filename": "server/api/jscriptyProject/index.js",
14604     "groupTitle": "Jscripty_Projects"
14605   },
14606   {
14607     "type": "get",
14608     "url": "/api/jscripty/projects/{id}/answers",
14609     "title": "Gets jscripty project answers",
14610     "examples": [
14611       {
14612         "title": "Example usage:",
14613         "content": "curl https://{domain}/api/jscripty/projects/{id}/answers -v -u {name}:{password}  -X GET",
14614         "type": "json"
14615       }
14616     ],
14617     "name": "getAnswers",
14618     "group": "Jscripty_Projects",
14619     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14620     "version": "0.0.0",
14621     "filename": "server/api/jscriptyProject/index.js",
14622     "groupTitle": "Jscripty_Projects"
14623   },
14624   {
14625     "type": "get",
14626     "url": "/api/jscripty/projects/{id}/sessions",
14627     "title": "Gets jscripty project sessions",
14628     "examples": [
14629       {
14630         "title": "Example usage:",
14631         "content": "curl https://{domain}/api/jscripty/projects/{id}/sessions -v -u {name}:{password}  -X GET",
14632         "type": "json"
14633       }
14634     ],
14635     "name": "getSessions",
14636     "group": "Jscripty_Projects",
14637     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14638     "version": "0.0.0",
14639     "filename": "server/api/jscriptyProject/index.js",
14640     "groupTitle": "Jscripty_Projects"
14641   },
14642   {
14643     "type": "get",
14644     "url": "/api/jscripty/projects/{id}/summary",
14645     "title": "Gets jscripty project summary",
14646     "examples": [
14647       {
14648         "title": "Example usage:",
14649         "content": "curl https://{domain}/api/jscripty/projects/{id}/summary -v -u {name}:{password}  -X GET",
14650         "type": "json"
14651       }
14652     ],
14653     "name": "getSummary",
14654     "group": "Jscripty_Projects",
14655     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14656     "version": "0.0.0",
14657     "filename": "server/api/jscriptyProject/index.js",
14658     "groupTitle": "Jscripty_Projects"
14659   },
14660   {
14661     "type": "put",
14662     "url": "/api/jscripty/projects/{id}",
14663     "title": "Update an existing Project",
14664     "examples": [
14665       {
14666         "title": "Example usage:",
14667         "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",
14668         "type": "json"
14669       }
14670     ],
14671     "name": "updateProjects",
14672     "group": "Jscripty_Projects",
14673     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14674     "version": "0.0.0",
14675     "filename": "server/api/jscriptyProject/index.js",
14676     "groupTitle": "Jscripty_Projects"
14677   },
14678   {
14679     "type": "get",
14680     "url": "/api/license",
14681     "title": "Gets License Info",
14682     "examples": [
14683       {
14684         "title": "Example usage:",
14685         "content": "curl https://{domain}/api/license -v -u {name}:{password} -X GET",
14686         "type": "json"
14687       }
14688     ],
14689     "name": "index",
14690     "group": "License",
14691     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14692     "version": "0.0.0",
14693     "filename": "server/api/license/index.js",
14694     "groupTitle": "License"
14695   },
14696   {
14697     "type": "put",
14698     "url": "/api/license/{id}",
14699     "title": "Update License Info",
14700     "examples": [
14701       {
14702         "title": "Example usage:",
14703         "content": "curl https://{domain}/api/license/{id} -v -u {name}:{password} -X PUT",
14704         "type": "json"
14705       }
14706     ],
14707     "name": "update",
14708     "group": "License",
14709     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14710     "version": "0.0.0",
14711     "filename": "server/api/license/index.js",
14712     "groupTitle": "License"
14713   },
14714   {
14715     "type": "post",
14716     "url": "/api/mail/accounts/{id}/users",
14717     "title": "Add agents to a mail account",
14718     "examples": [
14719       {
14720         "title": "Example usage:",
14721         "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",
14722         "type": "json"
14723       }
14724     ],
14725     "name": "AddAgents",
14726     "group": "Mail_Accounts",
14727     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14728     "version": "0.0.0",
14729     "filename": "server/api/mailAccount/index.js",
14730     "groupTitle": "Mail_Accounts"
14731   },
14732   {
14733     "type": "post",
14734     "url": "/api/mail/accounts/{id}/in_servers",
14735     "title": "Creates a new IMAP server",
14736     "examples": [
14737       {
14738         "title": "Example usage:",
14739         "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",
14740         "type": "json"
14741       }
14742     ],
14743     "name": "AddImap",
14744     "group": "Mail_Accounts",
14745     "parameter": {
14746       "fields": {
14747         "Body": [
14748           {
14749             "group": "Body",
14750             "type": "String",
14751             "optional": true,
14752             "field": "description",
14753             "description": ""
14754           },
14755           {
14756             "group": "Body",
14757             "type": "String",
14758             "optional": true,
14759             "field": "host",
14760             "description": ""
14761           },
14762           {
14763             "group": "Body",
14764             "type": "Boolean",
14765             "optional": true,
14766             "field": "authentication",
14767             "description": ""
14768           },
14769           {
14770             "group": "Body",
14771             "type": "String",
14772             "optional": true,
14773             "field": "user",
14774             "description": ""
14775           },
14776           {
14777             "group": "Body",
14778             "type": "String",
14779             "optional": true,
14780             "field": "password",
14781             "description": ""
14782           },
14783           {
14784             "group": "Body",
14785             "type": "Integer",
14786             "optional": true,
14787             "field": "port",
14788             "description": ""
14789           },
14790           {
14791             "group": "Body",
14792             "type": "Boolean",
14793             "optional": true,
14794             "field": "tls",
14795             "description": ""
14796           },
14797           {
14798             "group": "Body",
14799             "type": "String",
14800             "optional": true,
14801             "field": "mailbox",
14802             "description": ""
14803           },
14804           {
14805             "group": "Body",
14806             "type": "Integer",
14807             "optional": true,
14808             "field": "connTimeout",
14809             "description": ""
14810           },
14811           {
14812             "group": "Body",
14813             "type": "Integer",
14814             "optional": true,
14815             "field": "authTimeout",
14816             "description": ""
14817           },
14818           {
14819             "group": "Body",
14820             "type": "String",
14821             "optional": true,
14822             "field": "service",
14823             "description": ""
14824           }
14825         ]
14826       }
14827     },
14828     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14829     "version": "0.0.0",
14830     "filename": "server/api/mailAccount/index.js",
14831     "groupTitle": "Mail_Accounts"
14832   },
14833   {
14834     "type": "post",
14835     "url": "/api/mail/accounts/{id}/out_servers",
14836     "title": "Creates a new SMTP server",
14837     "examples": [
14838       {
14839         "title": "Example usage:",
14840         "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",
14841         "type": "json"
14842       }
14843     ],
14844     "name": "AddSmtp",
14845     "group": "Mail_Accounts",
14846     "parameter": {
14847       "fields": {
14848         "Body": [
14849           {
14850             "group": "Body",
14851             "type": "String",
14852             "optional": true,
14853             "field": "description",
14854             "description": ""
14855           },
14856           {
14857             "group": "Body",
14858             "type": "String",
14859             "optional": true,
14860             "field": "host",
14861             "description": ""
14862           },
14863           {
14864             "group": "Body",
14865             "type": "String",
14866             "optional": true,
14867             "field": "user",
14868             "description": ""
14869           },
14870           {
14871             "group": "Body",
14872             "type": "String",
14873             "optional": true,
14874             "field": "pass",
14875             "description": ""
14876           },
14877           {
14878             "group": "Body",
14879             "type": "Integer",
14880             "optional": true,
14881             "field": "port",
14882             "description": ""
14883           },
14884           {
14885             "group": "Body",
14886             "type": "Boolean",
14887             "optional": true,
14888             "field": "secure",
14889             "description": ""
14890           },
14891           {
14892             "group": "Body",
14893             "type": "String",
14894             "optional": true,
14895             "field": "service",
14896             "description": ""
14897           },
14898           {
14899             "group": "Body",
14900             "type": "Boolean",
14901             "optional": true,
14902             "field": "authentication",
14903             "description": ""
14904           }
14905         ]
14906       }
14907     },
14908     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14909     "version": "0.0.0",
14910     "filename": "server/api/mailAccount/index.js",
14911     "groupTitle": "Mail_Accounts"
14912   },
14913   {
14914     "type": "delete",
14915     "url": "/api/mail/accounts/{id}",
14916     "title": "Deletes a mail account",
14917     "examples": [
14918       {
14919         "title": "Example usage:",
14920         "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password} -X DELETE",
14921         "type": "json"
14922       }
14923     ],
14924     "name": "DeleteMailAccounts",
14925     "group": "Mail_Accounts",
14926     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14927     "version": "0.0.0",
14928     "filename": "server/api/mailAccount/index.js",
14929     "groupTitle": "Mail_Accounts"
14930   },
14931   {
14932     "type": "get",
14933     "url": "/api/mail/accounts/describe",
14934     "title": "Gets table info about Accounts",
14935     "examples": [
14936       {
14937         "title": "Example usage:",
14938         "content": "curl https://{domain}/api/mail/accounts/describe -v -u {name}:{password}",
14939         "type": "json"
14940       }
14941     ],
14942     "name": "DescribeAccounts",
14943     "group": "Mail_Accounts",
14944     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14945     "version": "0.0.0",
14946     "filename": "server/api/mailAccount/index.js",
14947     "groupTitle": "Mail_Accounts"
14948   },
14949   {
14950     "type": "get",
14951     "url": "/api/mail/accounts",
14952     "title": "Gets a list of Accounts",
14953     "examples": [
14954       {
14955         "title": "Example usage:",
14956         "content": "curl https://{domain}/api/mail/accounts -v -u {name}:{password}",
14957         "type": "json"
14958       }
14959     ],
14960     "name": "GetAccounts",
14961     "group": "Mail_Accounts",
14962     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14963     "version": "0.0.0",
14964     "filename": "server/api/mailAccount/index.js",
14965     "groupTitle": "Mail_Accounts"
14966   },
14967   {
14968     "type": "get",
14969     "url": "/api/mail/accounts/{id}/users",
14970     "title": "Gets agents from mail account",
14971     "examples": [
14972       {
14973         "title": "Example usage:",
14974         "content": "curl https://{domain}/api/mail/accounts/{id}/users -v -u {name}:{password} -X GET",
14975         "type": "json"
14976       }
14977     ],
14978     "name": "GetAgents",
14979     "group": "Mail_Accounts",
14980     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14981     "version": "0.0.0",
14982     "filename": "server/api/mailAccount/index.js",
14983     "groupTitle": "Mail_Accounts"
14984   },
14985   {
14986     "type": "get",
14987     "url": "/api/mail/accounts/{id}/in_servers",
14988     "title": "Gets account IMAP server",
14989     "examples": [
14990       {
14991         "title": "Example usage:",
14992         "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X GET",
14993         "type": "json"
14994       }
14995     ],
14996     "name": "GetImap",
14997     "group": "Mail_Accounts",
14998     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "get",
15005     "url": "/api/mail/accounts/{id}/out_servers",
15006     "title": "Gets account SMTP server",
15007     "examples": [
15008       {
15009         "title": "Example usage:",
15010         "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X GET",
15011         "type": "json"
15012       }
15013     ],
15014     "name": "GetSmtp",
15015     "group": "Mail_Accounts",
15016     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15017     "version": "0.0.0",
15018     "filename": "server/api/mailAccount/index.js",
15019     "groupTitle": "Mail_Accounts"
15020   },
15021   {
15022     "type": "delete",
15023     "url": "/api/mail/accounts/{id}/users",
15024     "title": "Removes agents from a mail account",
15025     "examples": [
15026       {
15027         "title": "Example usage:",
15028         "content": "curl https://{domain}/api/mail/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15029         "type": "json"
15030       }
15031     ],
15032     "name": "RemoveAgents",
15033     "group": "Mail_Accounts",
15034     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15035     "version": "0.0.0",
15036     "filename": "server/api/mailAccount/index.js",
15037     "groupTitle": "Mail_Accounts"
15038   },
15039   {
15040     "type": "delete",
15041     "url": "/api/mail/accounts/{id}/canned_answers",
15042     "title": "Removes canned answers from account",
15043     "examples": [
15044       {
15045         "title": "Example usage:",
15046         "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15047         "type": "json"
15048       }
15049     ],
15050     "name": "RemoveAnswers",
15051     "group": "Mail_Accounts",
15052     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15053     "version": "0.0.0",
15054     "filename": "server/api/mailAccount/index.js",
15055     "groupTitle": "Mail_Accounts"
15056   },
15057   {
15058     "type": "delete",
15059     "url": "/api/mail/accounts/{id}/dispositions",
15060     "title": "Removes dispositions from account",
15061     "examples": [
15062       {
15063         "title": "Example usage:",
15064         "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15065         "type": "json"
15066       }
15067     ],
15068     "name": "RemoveDispositions",
15069     "group": "Mail_Accounts",
15070     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15071     "version": "0.0.0",
15072     "filename": "server/api/mailAccount/index.js",
15073     "groupTitle": "Mail_Accounts"
15074   },
15075   {
15076     "type": "delete",
15077     "url": "/api/mail/accounts/{id}/in_servers",
15078     "title": "Removes IMAP server from an account",
15079     "examples": [
15080       {
15081         "title": "Example usage:",
15082         "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X DELETE",
15083         "type": "json"
15084       }
15085     ],
15086     "name": "RemoveImmap",
15087     "group": "Mail_Accounts",
15088     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "delete",
15095     "url": "/api/mail/accounts/{id}/out_servers",
15096     "title": "Removes SMTP server from an account",
15097     "examples": [
15098       {
15099         "title": "Example usage:",
15100         "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X DELETE",
15101         "type": "json"
15102       }
15103     ],
15104     "name": "RemoveSmtp",
15105     "group": "Mail_Accounts",
15106     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15107     "version": "0.0.0",
15108     "filename": "server/api/mailAccount/index.js",
15109     "groupTitle": "Mail_Accounts"
15110   },
15111   {
15112     "type": "get",
15113     "url": "/api/mail/accounts/{id}",
15114     "title": "Gets a single Account",
15115     "examples": [
15116       {
15117         "title": "Example usage:",
15118         "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password}",
15119         "type": "json"
15120       }
15121     ],
15122     "name": "ShowAccounts",
15123     "group": "Mail_Accounts",
15124     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15125     "version": "0.0.0",
15126     "filename": "server/api/mailAccount/index.js",
15127     "groupTitle": "Mail_Accounts"
15128   },
15129   {
15130     "type": "post",
15131     "url": "/api/mail/accounts/{id}/canned_answers",
15132     "title": "Creates new canned answer",
15133     "examples": [
15134       {
15135         "title": "Example usage:",
15136         "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",
15137         "type": "json"
15138       }
15139     ],
15140     "name": "addAnswer",
15141     "group": "Mail_Accounts",
15142     "parameter": {
15143       "fields": {
15144         "Body": [
15145           {
15146             "group": "Body",
15147             "type": "String",
15148             "optional": false,
15149             "field": "key",
15150             "description": ""
15151           },
15152           {
15153             "group": "Body",
15154             "type": "Text",
15155             "optional": false,
15156             "field": "value",
15157             "description": ""
15158           },
15159           {
15160             "group": "Body",
15161             "type": "String",
15162             "optional": true,
15163             "field": "description",
15164             "description": ""
15165           },
15166           {
15167             "group": "Body",
15168             "type": "Virtual",
15169             "optional": true,
15170             "field": "name",
15171             "description": ""
15172           }
15173         ]
15174       }
15175     },
15176     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15177     "version": "0.0.0",
15178     "filename": "server/api/mailAccount/index.js",
15179     "groupTitle": "Mail_Accounts"
15180   },
15181   {
15182     "type": "post",
15183     "url": "/api/mail/accounts/{id}/applications",
15184     "title": "Creates new applications",
15185     "examples": [
15186       {
15187         "title": "Example usage:",
15188         "content": "curl https://{domain}/api/mail/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15189         "type": "json"
15190       }
15191     ],
15192     "name": "addApplications",
15193     "group": "Mail_Accounts",
15194     "parameter": {
15195       "fields": {
15196         "Body": [
15197           {
15198             "group": "Body",
15199             "type": "Integer",
15200             "optional": false,
15201             "field": "priority",
15202             "description": ""
15203           },
15204           {
15205             "group": "Body",
15206             "type": "String",
15207             "optional": false,
15208             "field": "app",
15209             "description": ""
15210           },
15211           {
15212             "group": "Body",
15213             "type": "Text",
15214             "optional": true,
15215             "field": "appdata",
15216             "description": ""
15217           },
15218           {
15219             "group": "Body",
15220             "type": "String",
15221             "optional": true,
15222             "field": "description",
15223             "description": ""
15224           },
15225           {
15226             "group": "Body",
15227             "type": "String",
15228             "optional": true,
15229             "field": "interval",
15230             "description": ""
15231           }
15232         ]
15233       }
15234     },
15235     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15236     "version": "0.0.0",
15237     "filename": "server/api/mailAccount/index.js",
15238     "groupTitle": "Mail_Accounts"
15239   },
15240   {
15241     "type": "post",
15242     "url": "/api/mail/accounts/{id}/dispositions",
15243     "title": "Creates new disposition",
15244     "examples": [
15245       {
15246         "title": "Example usage:",
15247         "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15248         "type": "json"
15249       }
15250     ],
15251     "name": "addDisposition",
15252     "group": "Mail_Accounts",
15253     "parameter": {
15254       "fields": {
15255         "Body": [
15256           {
15257             "group": "Body",
15258             "type": "String",
15259             "optional": false,
15260             "field": "name",
15261             "description": ""
15262           },
15263           {
15264             "group": "Body",
15265             "type": "String",
15266             "allowedValues": [
15267               "\"first\"",
15268               "\"second\"",
15269               "\"third\""
15270             ],
15271             "optional": false,
15272             "field": "level",
15273             "description": ""
15274           },
15275           {
15276             "group": "Body",
15277             "type": "String",
15278             "optional": true,
15279             "field": "description",
15280             "description": ""
15281           }
15282         ]
15283       }
15284     },
15285     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15286     "version": "0.0.0",
15287     "filename": "server/api/mailAccount/index.js",
15288     "groupTitle": "Mail_Accounts"
15289   },
15290   {
15291     "type": "post",
15292     "url": "/api/mail/accounts/{id}/interactions",
15293     "title": "Creates new interactions",
15294     "examples": [
15295       {
15296         "title": "Example usage:",
15297         "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",
15298         "type": "json"
15299       }
15300     ],
15301     "name": "addInteraction",
15302     "group": "Mail_Accounts",
15303     "parameter": {
15304       "fields": {
15305         "Body": [
15306           {
15307             "group": "Body",
15308             "type": "Boolean",
15309             "optional": true,
15310             "field": "closed",
15311             "description": ""
15312           },
15313           {
15314             "group": "Body",
15315             "type": "String",
15316             "optional": true,
15317             "field": "closedAt",
15318             "description": ""
15319           },
15320           {
15321             "group": "Body",
15322             "type": "String",
15323             "optional": true,
15324             "field": "disposition",
15325             "description": ""
15326           },
15327           {
15328             "group": "Body",
15329             "type": "String",
15330             "optional": true,
15331             "field": "secondDisposition",
15332             "description": ""
15333           },
15334           {
15335             "group": "Body",
15336             "type": "String",
15337             "optional": true,
15338             "field": "thirdDisposition",
15339             "description": ""
15340           },
15341           {
15342             "group": "Body",
15343             "type": "String",
15344             "optional": true,
15345             "field": "note",
15346             "description": ""
15347           },
15348           {
15349             "group": "Body",
15350             "type": "String",
15351             "optional": true,
15352             "field": "inReplyTo",
15353             "description": ""
15354           },
15355           {
15356             "group": "Body",
15357             "type": "String",
15358             "optional": true,
15359             "field": "to",
15360             "description": ""
15361           },
15362           {
15363             "group": "Body",
15364             "type": "Text",
15365             "optional": true,
15366             "field": "cc",
15367             "description": ""
15368           },
15369           {
15370             "group": "Body",
15371             "type": "Text",
15372             "optional": true,
15373             "field": "subject",
15374             "description": ""
15375           },
15376           {
15377             "group": "Body",
15378             "type": "Boolean",
15379             "optional": true,
15380             "field": "attach",
15381             "description": ""
15382           },
15383           {
15384             "group": "Body",
15385             "type": "String",
15386             "optional": true,
15387             "field": "read1stAt",
15388             "description": ""
15389           },
15390           {
15391             "group": "Body",
15392             "type": "String",
15393             "optional": true,
15394             "field": "substatus",
15395             "description": ""
15396           },
15397           {
15398             "group": "Body",
15399             "type": "String",
15400             "optional": true,
15401             "field": "substatusAt",
15402             "description": ""
15403           },
15404           {
15405             "group": "Body",
15406             "type": "String",
15407             "allowedValues": [
15408               "\"in\"",
15409               "\"out\""
15410             ],
15411             "optional": false,
15412             "field": "firstMsgDirection",
15413             "description": ""
15414           },
15415           {
15416             "group": "Body",
15417             "type": "String",
15418             "optional": true,
15419             "field": "lastMsgAt",
15420             "description": ""
15421           },
15422           {
15423             "group": "Body",
15424             "type": "String",
15425             "allowedValues": [
15426               "\"in\"",
15427               "\"out\""
15428             ],
15429             "optional": false,
15430             "field": "lastMsgDirection",
15431             "description": ""
15432           },
15433           {
15434             "group": "Body",
15435             "type": "Text",
15436             "optional": true,
15437             "field": "lastMsgBody",
15438             "description": ""
15439           },
15440           {
15441             "group": "Body",
15442             "type": "Text",
15443             "optional": true,
15444             "field": "lastMsgText",
15445             "description": ""
15446           }
15447         ]
15448       }
15449     },
15450     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15451     "version": "0.0.0",
15452     "filename": "server/api/mailAccount/index.js",
15453     "groupTitle": "Mail_Accounts"
15454   },
15455   {
15456     "type": "post",
15457     "url": "/api/mail/accounts",
15458     "title": "Create a mail account",
15459     "examples": [
15460       {
15461         "title": "Example usage:",
15462         "content": "curl https://{domain}/api/mail/accounts \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15463         "type": "json"
15464       }
15465     ],
15466     "name": "create",
15467     "group": "Mail_Accounts",
15468     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15469     "version": "0.0.0",
15470     "filename": "server/api/mailAccount/index.js",
15471     "groupTitle": "Mail_Accounts"
15472   },
15473   {
15474     "type": "get",
15475     "url": "/api/mail/accounts/{id}/canned_answers",
15476     "title": "Gets account canned answers",
15477     "examples": [
15478       {
15479         "title": "Example usage:",
15480         "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
15481         "type": "json"
15482       }
15483     ],
15484     "name": "getAnswers",
15485     "group": "Mail_Accounts",
15486     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15487     "version": "0.0.0",
15488     "filename": "server/api/mailAccount/index.js",
15489     "groupTitle": "Mail_Accounts"
15490   },
15491   {
15492     "type": "get",
15493     "url": "/api/mail/accounts/{id}/applications",
15494     "title": "Gets account applications",
15495     "examples": [
15496       {
15497         "title": "Example usage:",
15498         "content": "curl https://{domain}/api/mail/accounts/{id}/applications -v -u {name}:{password} -X GET",
15499         "type": "json"
15500       }
15501     ],
15502     "name": "getApplications",
15503     "group": "Mail_Accounts",
15504     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15505     "version": "0.0.0",
15506     "filename": "server/api/mailAccount/index.js",
15507     "groupTitle": "Mail_Accounts"
15508   },
15509   {
15510     "type": "get",
15511     "url": "/api/mail/accounts/{id}/dispositions",
15512     "title": "Gets account dispositions",
15513     "examples": [
15514       {
15515         "title": "Example usage:",
15516         "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
15517         "type": "json"
15518       }
15519     ],
15520     "name": "getDispositions",
15521     "group": "Mail_Accounts",
15522     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15523     "version": "0.0.0",
15524     "filename": "server/api/mailAccount/index.js",
15525     "groupTitle": "Mail_Accounts"
15526   },
15527   {
15528     "type": "get",
15529     "url": "/api/mail/accounts/{id}/interactions",
15530     "title": "Gets account interactions",
15531     "examples": [
15532       {
15533         "title": "Example usage:",
15534         "content": "curl https://{domain}/api/mail/accounts/{id}/interactions -v -u {name}:{password} -X GET",
15535         "type": "json"
15536       }
15537     ],
15538     "name": "getInteraction",
15539     "group": "Mail_Accounts",
15540     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15541     "version": "0.0.0",
15542     "filename": "server/api/mailAccount/index.js",
15543     "groupTitle": "Mail_Accounts"
15544   },
15545   {
15546     "type": "get",
15547     "url": "/api/mail/accounts/{id}/messages",
15548     "title": "Gets account messages",
15549     "examples": [
15550       {
15551         "title": "Example usage:",
15552         "content": "curl https://{domain}/api/mail/accounts/{id}/messages -v -u {name}:{password} -X GET",
15553         "type": "json"
15554       }
15555     ],
15556     "name": "getMessages",
15557     "group": "Mail_Accounts",
15558     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15559     "version": "0.0.0",
15560     "filename": "server/api/mailAccount/index.js",
15561     "groupTitle": "Mail_Accounts"
15562   },
15563   {
15564     "type": "post",
15565     "url": "/api/mail/accounts/{id}/send",
15566     "title": "Send new mail",
15567     "examples": [
15568       {
15569         "title": "Example usage:",
15570         "content": "curl https://{domain}/api/mail/accounts/{id}/send -d '{from: '\"John Doe\" <john.doe@xcally.com>'}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15571         "type": "json"
15572       }
15573     ],
15574     "name": "sendMail",
15575     "group": "Mail_Accounts",
15576     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15577     "version": "0.0.0",
15578     "filename": "server/api/mailAccount/index.js",
15579     "groupTitle": "Mail_Accounts"
15580   },
15581   {
15582     "type": "put",
15583     "url": "/api/mail/accounts/{id}",
15584     "title": "Update an existing Account",
15585     "examples": [
15586       {
15587         "title": "Example usage:",
15588         "content": "curl https://{domain}/api/mail/accounts/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
15589         "type": "json"
15590       }
15591     ],
15592     "name": "updateAccounts",
15593     "group": "Mail_Accounts",
15594     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15595     "version": "0.0.0",
15596     "filename": "server/api/mailAccount/index.js",
15597     "groupTitle": "Mail_Accounts"
15598   },
15599   {
15600     "type": "get",
15601     "url": "/api/mail/accounts/{id}/verify",
15602     "title": "Verify mail account",
15603     "examples": [
15604       {
15605         "title": "Example usage:",
15606         "content": "curl https://{domain}/api/mail/accounts/{id}/verify -v -u {name}:{password} -X GET",
15607         "type": "json"
15608       }
15609     ],
15610     "name": "verifySmtp",
15611     "group": "Mail_Accounts",
15612     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15613     "version": "0.0.0",
15614     "filename": "server/api/mailAccount/index.js",
15615     "groupTitle": "Mail_Accounts"
15616   },
15617   {
15618     "type": "delete",
15619     "url": "/api/mail/applications/{id}",
15620     "title": "Deletes a Application",
15621     "examples": [
15622       {
15623         "title": "Example usage:",
15624         "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password} -X DELETE",
15625         "type": "json"
15626       }
15627     ],
15628     "name": "DeleteApplications",
15629     "group": "Mail_Applications",
15630     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15631     "version": "0.0.0",
15632     "filename": "server/api/mailApplication/index.js",
15633     "groupTitle": "Mail_Applications"
15634   },
15635   {
15636     "type": "get",
15637     "url": "/api/mail/applications/{id}",
15638     "title": "Gets a single Application",
15639     "examples": [
15640       {
15641         "title": "Example usage:",
15642         "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password}",
15643         "type": "json"
15644       }
15645     ],
15646     "name": "ShowApplications",
15647     "group": "Mail_Applications",
15648     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15649     "version": "0.0.0",
15650     "filename": "server/api/mailApplication/index.js",
15651     "groupTitle": "Mail_Applications"
15652   },
15653   {
15654     "type": "put",
15655     "url": "/api/mail/applications/{id}",
15656     "title": "Update an existing Application",
15657     "examples": [
15658       {
15659         "title": "Example usage:",
15660         "content": "curl https://{domain}/api/mail/applications/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
15661         "type": "json"
15662       }
15663     ],
15664     "name": "updateApplications",
15665     "group": "Mail_Applications",
15666     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15667     "version": "0.0.0",
15668     "filename": "server/api/mailApplication/index.js",
15669     "groupTitle": "Mail_Applications"
15670   },
15671   {
15672     "type": "post",
15673     "url": "/api/mail/interactions/{id}/tags",
15674     "title": "Add tags to the interaction",
15675     "examples": [
15676       {
15677         "title": "Example usage:",
15678         "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",
15679         "type": "json"
15680       }
15681     ],
15682     "name": "AddTags",
15683     "group": "Mail_Interactions",
15684     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15685     "version": "0.0.0",
15686     "filename": "server/api/mailInteraction/index.js",
15687     "groupTitle": "Mail_Interactions"
15688   },
15689   {
15690     "type": "post",
15691     "url": "/api/mail/interactions",
15692     "title": "Creates a new Interaction",
15693     "examples": [
15694       {
15695         "title": "Example usage:",
15696         "content": "curl https://{domain}/api/mail/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
15697         "type": "json"
15698       }
15699     ],
15700     "name": "CreateInteractions",
15701     "group": "Mail_Interactions",
15702     "parameter": {
15703       "fields": {
15704         "Body": [
15705           {
15706             "group": "Body",
15707             "type": "Boolean",
15708             "optional": true,
15709             "field": "closed",
15710             "description": ""
15711           },
15712           {
15713             "group": "Body",
15714             "type": "String",
15715             "optional": true,
15716             "field": "closedAt",
15717             "description": ""
15718           },
15719           {
15720             "group": "Body",
15721             "type": "String",
15722             "optional": true,
15723             "field": "disposition",
15724             "description": ""
15725           },
15726           {
15727             "group": "Body",
15728             "type": "String",
15729             "optional": true,
15730             "field": "secondDisposition",
15731             "description": ""
15732           },
15733           {
15734             "group": "Body",
15735             "type": "String",
15736             "optional": true,
15737             "field": "thirdDisposition",
15738             "description": ""
15739           },
15740           {
15741             "group": "Body",
15742             "type": "String",
15743             "optional": true,
15744             "field": "note",
15745             "description": ""
15746           },
15747           {
15748             "group": "Body",
15749             "type": "String",
15750             "optional": true,
15751             "field": "inReplyTo",
15752             "description": ""
15753           },
15754           {
15755             "group": "Body",
15756             "type": "String",
15757             "optional": true,
15758             "field": "to",
15759             "description": ""
15760           },
15761           {
15762             "group": "Body",
15763             "type": "Text",
15764             "optional": true,
15765             "field": "cc",
15766             "description": ""
15767           },
15768           {
15769             "group": "Body",
15770             "type": "Text",
15771             "optional": true,
15772             "field": "subject",
15773             "description": ""
15774           },
15775           {
15776             "group": "Body",
15777             "type": "Boolean",
15778             "optional": true,
15779             "field": "attach",
15780             "description": ""
15781           },
15782           {
15783             "group": "Body",
15784             "type": "String",
15785             "optional": true,
15786             "field": "read1stAt",
15787             "description": ""
15788           },
15789           {
15790             "group": "Body",
15791             "type": "String",
15792             "optional": true,
15793             "field": "substatus",
15794             "description": ""
15795           },
15796           {
15797             "group": "Body",
15798             "type": "String",
15799             "optional": true,
15800             "field": "substatusAt",
15801             "description": ""
15802           },
15803           {
15804             "group": "Body",
15805             "type": "String",
15806             "allowedValues": [
15807               "\"in\"",
15808               "\"out\""
15809             ],
15810             "optional": false,
15811             "field": "firstMsgDirection",
15812             "description": ""
15813           },
15814           {
15815             "group": "Body",
15816             "type": "String",
15817             "optional": true,
15818             "field": "lastMsgAt",
15819             "description": ""
15820           },
15821           {
15822             "group": "Body",
15823             "type": "String",
15824             "allowedValues": [
15825               "\"in\"",
15826               "\"out\""
15827             ],
15828             "optional": false,
15829             "field": "lastMsgDirection",
15830             "description": ""
15831           },
15832           {
15833             "group": "Body",
15834             "type": "Text",
15835             "optional": true,
15836             "field": "lastMsgBody",
15837             "description": ""
15838           },
15839           {
15840             "group": "Body",
15841             "type": "Text",
15842             "optional": true,
15843             "field": "lastMsgText",
15844             "description": ""
15845           }
15846         ]
15847       }
15848     },
15849     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15850     "version": "0.0.0",
15851     "filename": "server/api/mailInteraction/index.js",
15852     "groupTitle": "Mail_Interactions"
15853   },
15854   {
15855     "type": "delete",
15856     "url": "/api/mail/interactions/{id}",
15857     "title": "Deletes a Interaction",
15858     "examples": [
15859       {
15860         "title": "Example usage:",
15861         "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password} -X DELETE",
15862         "type": "json"
15863       }
15864     ],
15865     "name": "DeleteInteractions",
15866     "group": "Mail_Interactions",
15867     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15868     "version": "0.0.0",
15869     "filename": "server/api/mailInteraction/index.js",
15870     "groupTitle": "Mail_Interactions"
15871   },
15872   {
15873     "type": "get",
15874     "url": "/api/mail/interactions/describe",
15875     "title": "Gets table info about Interactions",
15876     "examples": [
15877       {
15878         "title": "Example usage:",
15879         "content": "curl https://{domain}/api/mail/interactions/describe -v -u {name}:{password}",
15880         "type": "json"
15881       }
15882     ],
15883     "name": "DescribeInteractions",
15884     "group": "Mail_Interactions",
15885     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15886     "version": "0.0.0",
15887     "filename": "server/api/mailInteraction/index.js",
15888     "groupTitle": "Mail_Interactions"
15889   },
15890   {
15891     "type": "get",
15892     "url": "/api/mail/interactions",
15893     "title": "Gets a list of Interactions",
15894     "examples": [
15895       {
15896         "title": "Example usage:",
15897         "content": "curl https://{domain}/api/mail/interactions -v -u {name}:{password}",
15898         "type": "json"
15899       }
15900     ],
15901     "name": "GetInteractions",
15902     "group": "Mail_Interactions",
15903     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
15904     "version": "0.0.0",
15905     "filename": "server/api/mailInteraction/index.js",
15906     "groupTitle": "Mail_Interactions"
15907   },
15908   {
15909     "type": "delete",
15910     "url": "/api/mail/interactions/{id}/tags",
15911     "title": "Removes tags from interaction",
15912     "examples": [
15913       {
15914         "title": "Example usage:",
15915         "content": "curl https://{domain}/api/mail/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15916         "type": "json"
15917       }
15918     ],
15919     "name": "RemoveTags",
15920     "group": "Mail_Interactions",
15921     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15922     "version": "0.0.0",
15923     "filename": "server/api/mailInteraction/index.js",
15924     "groupTitle": "Mail_Interactions"
15925   },
15926   {
15927     "type": "get",
15928     "url": "/api/mail/interactions/{id}",
15929     "title": "Gets a single Interaction",
15930     "examples": [
15931       {
15932         "title": "Example usage:",
15933         "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password}",
15934         "type": "json"
15935       }
15936     ],
15937     "name": "ShowInteractions",
15938     "group": "Mail_Interactions",
15939     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15940     "version": "0.0.0",
15941     "filename": "server/api/mailInteraction/index.js",
15942     "groupTitle": "Mail_Interactions"
15943   },
15944   {
15945     "type": "post",
15946     "url": "/api/mail/interactions/{id}/messages",
15947     "title": "Creates new message",
15948     "examples": [
15949       {
15950         "title": "Example usage:",
15951         "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",
15952         "type": "json"
15953       }
15954     ],
15955     "name": "addMessage",
15956     "group": "Mail_Interactions",
15957     "parameter": {
15958       "fields": {
15959         "Body": [
15960           {
15961             "group": "Body",
15962             "type": "Text",
15963             "optional": false,
15964             "field": "body",
15965             "description": ""
15966           },
15967           {
15968             "group": "Body",
15969             "type": "Text",
15970             "optional": true,
15971             "field": "plainBody",
15972             "description": ""
15973           },
15974           {
15975             "group": "Body",
15976             "type": "Boolean",
15977             "optional": true,
15978             "field": "read",
15979             "description": ""
15980           },
15981           {
15982             "group": "Body",
15983             "type": "String",
15984             "allowedValues": [
15985               "\"in\"",
15986               "\"out\""
15987             ],
15988             "optional": false,
15989             "field": "direction",
15990             "description": ""
15991           },
15992           {
15993             "group": "Body",
15994             "type": "String",
15995             "optional": true,
15996             "field": "messageId",
15997             "description": ""
15998           },
15999           {
16000             "group": "Body",
16001             "type": "String",
16002             "optional": true,
16003             "field": "from",
16004             "description": ""
16005           },
16006           {
16007             "group": "Body",
16008             "type": "Text",
16009             "optional": true,
16010             "field": "to",
16011             "description": ""
16012           },
16013           {
16014             "group": "Body",
16015             "type": "Text",
16016             "optional": true,
16017             "field": "cc",
16018             "description": ""
16019           },
16020           {
16021             "group": "Body",
16022             "type": "Text",
16023             "optional": true,
16024             "field": "bcc",
16025             "description": ""
16026           },
16027           {
16028             "group": "Body",
16029             "type": "Text",
16030             "optional": true,
16031             "field": "subject",
16032             "description": ""
16033           },
16034           {
16035             "group": "Body",
16036             "type": "String",
16037             "optional": true,
16038             "field": "sentAt",
16039             "description": ""
16040           },
16041           {
16042             "group": "Body",
16043             "type": "Integer",
16044             "optional": true,
16045             "field": "attach",
16046             "description": ""
16047           },
16048           {
16049             "group": "Body",
16050             "type": "Boolean",
16051             "optional": true,
16052             "field": "secret",
16053             "description": ""
16054           },
16055           {
16056             "group": "Body",
16057             "type": "String",
16058             "optional": true,
16059             "field": "readAt",
16060             "description": ""
16061           },
16062           {
16063             "group": "Body",
16064             "type": "Text",
16065             "optional": true,
16066             "field": "originTo",
16067             "description": ""
16068           },
16069           {
16070             "group": "Body",
16071             "type": "Text",
16072             "optional": true,
16073             "field": "originCc",
16074             "description": ""
16075           }
16076         ]
16077       }
16078     },
16079     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16080     "version": "0.0.0",
16081     "filename": "server/api/mailInteraction/index.js",
16082     "groupTitle": "Mail_Interactions"
16083   },
16084   {
16085     "type": "get",
16086     "url": "/api/mail/interactions/{id}/download",
16087     "title": "Gets interaction",
16088     "examples": [
16089       {
16090         "title": "Example usage:",
16091         "content": "curl https://{domain}/api/mail/interactions/{id}/download -v -u {name}:{password} -X GET",
16092         "type": "json"
16093       }
16094     ],
16095     "name": "download",
16096     "group": "Mail_Interactions",
16097     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16098     "version": "0.0.0",
16099     "filename": "server/api/mailInteraction/index.js",
16100     "groupTitle": "Mail_Interactions"
16101   },
16102   {
16103     "type": "get",
16104     "url": "/api/mail/interactions/{id}/messages",
16105     "title": "Gets interaction messages",
16106     "examples": [
16107       {
16108         "title": "Example usage:",
16109         "content": "curl https://{domain}/api/mail/interactions/{id}/messages -v -u {name}:{password} -X GET",
16110         "type": "json"
16111       }
16112     ],
16113     "name": "getMessages",
16114     "group": "Mail_Interactions",
16115     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16116     "version": "0.0.0",
16117     "filename": "server/api/mailInteraction/index.js",
16118     "groupTitle": "Mail_Interactions"
16119   },
16120   {
16121     "type": "put",
16122     "url": "/api/mail/interactions/{id}",
16123     "title": "Update an existing Interaction",
16124     "examples": [
16125       {
16126         "title": "Example usage:",
16127         "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",
16128         "type": "json"
16129       }
16130     ],
16131     "name": "updateInteractions",
16132     "group": "Mail_Interactions",
16133     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16134     "version": "0.0.0",
16135     "filename": "server/api/mailInteraction/index.js",
16136     "groupTitle": "Mail_Interactions"
16137   },
16138   {
16139     "type": "delete",
16140     "url": "/api/mail/messages/{id}",
16141     "title": "Deletes a Message",
16142     "examples": [
16143       {
16144         "title": "Example usage:",
16145         "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password} -X DELETE",
16146         "type": "json"
16147       }
16148     ],
16149     "name": "DeleteMessages",
16150     "group": "Mail_Messages",
16151     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16152     "version": "0.0.0",
16153     "filename": "server/api/mailMessage/index.js",
16154     "groupTitle": "Mail_Messages"
16155   },
16156   {
16157     "type": "get",
16158     "url": "/api/mail/messages/describe",
16159     "title": "Gets table info about Messages",
16160     "examples": [
16161       {
16162         "title": "Example usage:",
16163         "content": "curl https://{domain}/api/mail/messages/describe -v -u {name}:{password}",
16164         "type": "json"
16165       }
16166     ],
16167     "name": "DescribeMessages",
16168     "group": "Mail_Messages",
16169     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16170     "version": "0.0.0",
16171     "filename": "server/api/mailMessage/index.js",
16172     "groupTitle": "Mail_Messages"
16173   },
16174   {
16175     "type": "get",
16176     "url": "/api/mail/messages",
16177     "title": "Gets a list of Messages",
16178     "examples": [
16179       {
16180         "title": "Example usage:",
16181         "content": "curl https://{domain}/api/mail/messages -v -u {name}:{password}",
16182         "type": "json"
16183       }
16184     ],
16185     "name": "GetMessages",
16186     "group": "Mail_Messages",
16187     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16188     "version": "0.0.0",
16189     "filename": "server/api/mailMessage/index.js",
16190     "groupTitle": "Mail_Messages"
16191   },
16192   {
16193     "type": "get",
16194     "url": "/api/mail/messages/{id}",
16195     "title": "Gets a single Message",
16196     "examples": [
16197       {
16198         "title": "Example usage:",
16199         "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password}",
16200         "type": "json"
16201       }
16202     ],
16203     "name": "ShowMessages",
16204     "group": "Mail_Messages",
16205     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16206     "version": "0.0.0",
16207     "filename": "server/api/mailMessage/index.js",
16208     "groupTitle": "Mail_Messages"
16209   },
16210   {
16211     "type": "put",
16212     "url": "/api/mail/messages/{id}/accept",
16213     "title": "Accepts message",
16214     "examples": [
16215       {
16216         "title": "Example usage:",
16217         "content": "curl https://{domain}/api/mail/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
16218         "type": "json"
16219       }
16220     ],
16221     "name": "acceptMessage",
16222     "group": "Mail_Messages",
16223     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16224     "version": "0.0.0",
16225     "filename": "server/api/mailMessage/index.js",
16226     "groupTitle": "Mail_Messages"
16227   },
16228   {
16229     "type": "post",
16230     "url": "/api/mail/messages",
16231     "title": "Create a message",
16232     "examples": [
16233       {
16234         "title": "Example usage:",
16235         "content": "curl https://{domain}/api/mail/messages \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
16236         "type": "json"
16237       }
16238     ],
16239     "name": "createMessage",
16240     "group": "Mail_Messages",
16241     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16242     "version": "0.0.0",
16243     "filename": "server/api/mailMessage/index.js",
16244     "groupTitle": "Mail_Messages"
16245   },
16246   {
16247     "type": "get",
16248     "url": "/api/mail/messages/{id}/download",
16249     "title": "Gets message",
16250     "examples": [
16251       {
16252         "title": "Example usage:",
16253         "content": "curl https://{domain}/api/mail/messages/{id}/download -v -u {name}:{password} -X GET",
16254         "type": "json"
16255       }
16256     ],
16257     "name": "download",
16258     "group": "Mail_Messages",
16259     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16260     "version": "0.0.0",
16261     "filename": "server/api/mailMessage/index.js",
16262     "groupTitle": "Mail_Messages"
16263   },
16264   {
16265     "type": "put",
16266     "url": "/api/mail/messages/{id}/reject",
16267     "title": "Rejects message",
16268     "examples": [
16269       {
16270         "title": "Example usage:",
16271         "content": "curl https://{domain}/api/mail/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
16272         "type": "json"
16273       }
16274     ],
16275     "name": "rejectMessage",
16276     "group": "Mail_Messages",
16277     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16278     "version": "0.0.0",
16279     "filename": "server/api/mailMessage/index.js",
16280     "groupTitle": "Mail_Messages"
16281   },
16282   {
16283     "type": "put",
16284     "url": "/api/mail/messages/{id}",
16285     "title": "Update an existing Message",
16286     "examples": [
16287       {
16288         "title": "Example usage:",
16289         "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",
16290         "type": "json"
16291       }
16292     ],
16293     "name": "updateMessages",
16294     "group": "Mail_Messages",
16295     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16296     "version": "0.0.0",
16297     "filename": "server/api/mailMessage/index.js",
16298     "groupTitle": "Mail_Messages"
16299   },
16300   {
16301     "type": "post",
16302     "url": "/api/mail/reports/queue",
16303     "title": "Creates a new Mail Queue Report",
16304     "examples": [
16305       {
16306         "title": "Example usage:",
16307         "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",
16308         "type": "json"
16309       }
16310     ],
16311     "name": "CreateMail_Queue_Reports",
16312     "group": "Mail_Queue_Reports",
16313     "parameter": {
16314       "fields": {
16315         "Body": [
16316           {
16317             "group": "Body",
16318             "type": "String",
16319             "optional": false,
16320             "field": "uniqueid",
16321             "description": ""
16322           },
16323           {
16324             "group": "Body",
16325             "type": "String",
16326             "optional": true,
16327             "field": "from",
16328             "description": ""
16329           },
16330           {
16331             "group": "Body",
16332             "type": "String",
16333             "optional": true,
16334             "field": "joinAt",
16335             "description": ""
16336           },
16337           {
16338             "group": "Body",
16339             "type": "String",
16340             "optional": true,
16341             "field": "leaveAt",
16342             "description": ""
16343           },
16344           {
16345             "group": "Body",
16346             "type": "String",
16347             "optional": true,
16348             "field": "acceptAt",
16349             "description": ""
16350           },
16351           {
16352             "group": "Body",
16353             "type": "String",
16354             "optional": true,
16355             "field": "exitAt",
16356             "description": ""
16357           },
16358           {
16359             "group": "Body",
16360             "type": "String",
16361             "optional": true,
16362             "field": "reason",
16363             "description": ""
16364           }
16365         ]
16366       }
16367     },
16368     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16369     "version": "0.0.0",
16370     "filename": "server/api/mailQueueReport/index.js",
16371     "groupTitle": "Mail_Queue_Reports"
16372   },
16373   {
16374     "type": "delete",
16375     "url": "/api/mail/reports/queue/{id}",
16376     "title": "Deletes a Mail Queue Report",
16377     "examples": [
16378       {
16379         "title": "Example usage:",
16380         "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password} -X DELETE",
16381         "type": "json"
16382       }
16383     ],
16384     "name": "DeleteMail_Queue_Reports",
16385     "group": "Mail_Queue_Reports",
16386     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16387     "version": "0.0.0",
16388     "filename": "server/api/mailQueueReport/index.js",
16389     "groupTitle": "Mail_Queue_Reports"
16390   },
16391   {
16392     "type": "get",
16393     "url": "/api/mail/reports/queue/describe",
16394     "title": "Gets table info about Mail Queue Reports",
16395     "examples": [
16396       {
16397         "title": "Example usage:",
16398         "content": "curl https://{domain}/api/mail/reports/queue/describe -v -u {name}:{password}",
16399         "type": "json"
16400       }
16401     ],
16402     "name": "DescribeMail_Queue_Reports",
16403     "group": "Mail_Queue_Reports",
16404     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16405     "version": "0.0.0",
16406     "filename": "server/api/mailQueueReport/index.js",
16407     "groupTitle": "Mail_Queue_Reports"
16408   },
16409   {
16410     "type": "get",
16411     "url": "/api/mail/reports/queue",
16412     "title": "Gets a list of Mail Queue Reports",
16413     "examples": [
16414       {
16415         "title": "Example usage:",
16416         "content": "curl https://{domain}/api/mail/reports/queue -v -u {name}:{password}",
16417         "type": "json"
16418       }
16419     ],
16420     "name": "GetMail_Queue_Reports",
16421     "group": "Mail_Queue_Reports",
16422     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16423     "version": "0.0.0",
16424     "filename": "server/api/mailQueueReport/index.js",
16425     "groupTitle": "Mail_Queue_Reports"
16426   },
16427   {
16428     "type": "get",
16429     "url": "/api/mail/reports/queue/{id}",
16430     "title": "Gets a single Mail Queue Report",
16431     "examples": [
16432       {
16433         "title": "Example usage:",
16434         "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password}",
16435         "type": "json"
16436       }
16437     ],
16438     "name": "ShowMail_Queue_Reports",
16439     "group": "Mail_Queue_Reports",
16440     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16441     "version": "0.0.0",
16442     "filename": "server/api/mailQueueReport/index.js",
16443     "groupTitle": "Mail_Queue_Reports"
16444   },
16445   {
16446     "type": "put",
16447     "url": "/api/mail/reports/queue/{id}",
16448     "title": "Update an existing Mail Queue Report",
16449     "examples": [
16450       {
16451         "title": "Example usage:",
16452         "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",
16453         "type": "json"
16454       }
16455     ],
16456     "name": "updateMail_Queue_Reports",
16457     "group": "Mail_Queue_Reports",
16458     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16459     "version": "0.0.0",
16460     "filename": "server/api/mailQueueReport/index.js",
16461     "groupTitle": "Mail_Queue_Reports"
16462   },
16463   {
16464     "type": "post",
16465     "url": "/api/mail/queues/{id}/users",
16466     "title": "Add agents to a queue",
16467     "examples": [
16468       {
16469         "title": "Example usage:",
16470         "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",
16471         "type": "json"
16472       }
16473     ],
16474     "name": "AddAgents",
16475     "group": "Mail_Queues",
16476     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16477     "version": "0.0.0",
16478     "filename": "server/api/mailQueue/index.js",
16479     "groupTitle": "Mail_Queues"
16480   },
16481   {
16482     "type": "post",
16483     "url": "/api/mail/queues/{id}/teams",
16484     "title": "Add teams to a queue",
16485     "examples": [
16486       {
16487         "title": "Example usage:",
16488         "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",
16489         "type": "json"
16490       }
16491     ],
16492     "name": "AddTeams",
16493     "group": "Mail_Queues",
16494     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16495     "version": "0.0.0",
16496     "filename": "server/api/mailQueue/index.js",
16497     "groupTitle": "Mail_Queues"
16498   },
16499   {
16500     "type": "post",
16501     "url": "/api/mail/queues",
16502     "title": "Creates a new Queue",
16503     "examples": [
16504       {
16505         "title": "Example usage:",
16506         "content": "curl https://{domain}/api/mail/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
16507         "type": "json"
16508       }
16509     ],
16510     "name": "CreateQueues",
16511     "group": "Mail_Queues",
16512     "parameter": {
16513       "fields": {
16514         "Body": [
16515           {
16516             "group": "Body",
16517             "type": "String",
16518             "optional": true,
16519             "field": "name",
16520             "description": ""
16521           },
16522           {
16523             "group": "Body",
16524             "type": "String",
16525             "optional": true,
16526             "field": "description",
16527             "description": ""
16528           },
16529           {
16530             "group": "Body",
16531             "type": "Integer",
16532             "optional": true,
16533             "field": "timeout",
16534             "description": ""
16535           },
16536           {
16537             "group": "Body",
16538             "type": "String",
16539             "allowedValues": [
16540               "\"rrmemory\"",
16541               "\"beepall\"",
16542               "\"roundrobin\""
16543             ],
16544             "optional": true,
16545             "field": "strategy",
16546             "description": ""
16547           }
16548         ]
16549       }
16550     },
16551     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16552     "version": "0.0.0",
16553     "filename": "server/api/mailQueue/index.js",
16554     "groupTitle": "Mail_Queues"
16555   },
16556   {
16557     "type": "delete",
16558     "url": "/api/mail/queues/{id}",
16559     "title": "Deletes a Queue",
16560     "examples": [
16561       {
16562         "title": "Example usage:",
16563         "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password} -X DELETE",
16564         "type": "json"
16565       }
16566     ],
16567     "name": "DeleteQueues",
16568     "group": "Mail_Queues",
16569     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16570     "version": "0.0.0",
16571     "filename": "server/api/mailQueue/index.js",
16572     "groupTitle": "Mail_Queues"
16573   },
16574   {
16575     "type": "get",
16576     "url": "/api/mail/queues/describe",
16577     "title": "Gets table info about Queues",
16578     "examples": [
16579       {
16580         "title": "Example usage:",
16581         "content": "curl https://{domain}/api/mail/queues/describe -v -u {name}:{password}",
16582         "type": "json"
16583       }
16584     ],
16585     "name": "DescribeQueues",
16586     "group": "Mail_Queues",
16587     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16588     "version": "0.0.0",
16589     "filename": "server/api/mailQueue/index.js",
16590     "groupTitle": "Mail_Queues"
16591   },
16592   {
16593     "type": "get",
16594     "url": "/api/mail/queues/{id}/users",
16595     "title": "Gets queue agents",
16596     "examples": [
16597       {
16598         "title": "Example usage:",
16599         "content": "curl https://{domain}/api/mail/queues/{id}/users -v -u {name}:{password} -X POST",
16600         "type": "json"
16601       }
16602     ],
16603     "name": "GetAgents",
16604     "group": "Mail_Queues",
16605     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16606     "version": "0.0.0",
16607     "filename": "server/api/mailQueue/index.js",
16608     "groupTitle": "Mail_Queues"
16609   },
16610   {
16611     "type": "get",
16612     "url": "/api/mail/queues/{id}/members",
16613     "title": "GetMembers",
16614     "examples": [
16615       {
16616         "title": "Example usage:",
16617         "content": "curl https://{domain}/api/mail/queues/{id}/members  -v -u {name}:{password}",
16618         "type": "json"
16619       }
16620     ],
16621     "name": "GetMembers",
16622     "group": "Mail_Queues",
16623     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16624     "version": "0.0.0",
16625     "filename": "server/api/mailQueue/index.js",
16626     "groupTitle": "Mail_Queues"
16627   },
16628   {
16629     "type": "get",
16630     "url": "/api/mail/queues",
16631     "title": "Gets a list of Queues",
16632     "examples": [
16633       {
16634         "title": "Example usage:",
16635         "content": "curl https://{domain}/api/mail/queues -v -u {name}:{password}",
16636         "type": "json"
16637       }
16638     ],
16639     "name": "GetQueues",
16640     "group": "Mail_Queues",
16641     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16642     "version": "0.0.0",
16643     "filename": "server/api/mailQueue/index.js",
16644     "groupTitle": "Mail_Queues"
16645   },
16646   {
16647     "type": "get",
16648     "url": "/api/mail/queues/{id}/teams",
16649     "title": "Gets queues list",
16650     "examples": [
16651       {
16652         "title": "Example usage:",
16653         "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password}",
16654         "type": "json"
16655       }
16656     ],
16657     "name": "GetTeams",
16658     "group": "Mail_Queues",
16659     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16660     "version": "0.0.0",
16661     "filename": "server/api/mailQueue/index.js",
16662     "groupTitle": "Mail_Queues"
16663   },
16664   {
16665     "type": "delete",
16666     "url": "/api/mail/queues/{id}/users",
16667     "title": "Removes agents from a queue",
16668     "examples": [
16669       {
16670         "title": "Example usage:",
16671         "content": "curl https://{domain}/api/mail/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
16672         "type": "json"
16673       }
16674     ],
16675     "name": "RemoveAgents",
16676     "group": "Mail_Queues",
16677     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16678     "version": "0.0.0",
16679     "filename": "server/api/mailQueue/index.js",
16680     "groupTitle": "Mail_Queues"
16681   },
16682   {
16683     "type": "get",
16684     "url": "/api/mail/queues/{id}",
16685     "title": "Gets a single Queue",
16686     "examples": [
16687       {
16688         "title": "Example usage:",
16689         "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password}",
16690         "type": "json"
16691       }
16692     ],
16693     "name": "ShowQueues",
16694     "group": "Mail_Queues",
16695     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16696     "version": "0.0.0",
16697     "filename": "server/api/mailQueue/index.js",
16698     "groupTitle": "Mail_Queues"
16699   },
16700   {
16701     "type": "put",
16702     "url": "/api/mail/queues/{id}",
16703     "title": "Update an existing Queue",
16704     "examples": [
16705       {
16706         "title": "Example usage:",
16707         "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",
16708         "type": "json"
16709       }
16710     ],
16711     "name": "updateQueues",
16712     "group": "Mail_Queues",
16713     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16714     "version": "0.0.0",
16715     "filename": "server/api/mailQueue/index.js",
16716     "groupTitle": "Mail_Queues"
16717   },
16718   {
16719     "type": "post",
16720     "url": "/api/mail/out_servers",
16721     "title": "Creates a new SMTP",
16722     "examples": [
16723       {
16724         "title": "Example usage:",
16725         "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",
16726         "type": "json"
16727       }
16728     ],
16729     "name": "CreateSMTPs",
16730     "group": "Mail_SMTP",
16731     "parameter": {
16732       "fields": {
16733         "Body": [
16734           {
16735             "group": "Body",
16736             "type": "String",
16737             "optional": true,
16738             "field": "description",
16739             "description": ""
16740           },
16741           {
16742             "group": "Body",
16743             "type": "String",
16744             "optional": true,
16745             "field": "host",
16746             "description": ""
16747           },
16748           {
16749             "group": "Body",
16750             "type": "String",
16751             "optional": true,
16752             "field": "user",
16753             "description": ""
16754           },
16755           {
16756             "group": "Body",
16757             "type": "String",
16758             "optional": true,
16759             "field": "pass",
16760             "description": ""
16761           },
16762           {
16763             "group": "Body",
16764             "type": "Integer",
16765             "optional": true,
16766             "field": "port",
16767             "description": ""
16768           },
16769           {
16770             "group": "Body",
16771             "type": "Boolean",
16772             "optional": true,
16773             "field": "secure",
16774             "description": ""
16775           },
16776           {
16777             "group": "Body",
16778             "type": "String",
16779             "optional": true,
16780             "field": "service",
16781             "description": ""
16782           },
16783           {
16784             "group": "Body",
16785             "type": "Boolean",
16786             "optional": true,
16787             "field": "authentication",
16788             "description": ""
16789           }
16790         ]
16791       }
16792     },
16793     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16794     "version": "0.0.0",
16795     "filename": "server/api/mailServerOut/index.js",
16796     "groupTitle": "Mail_SMTP"
16797   },
16798   {
16799     "type": "delete",
16800     "url": "/api/mail/out_servers/{id}",
16801     "title": "Deletes a SMTP",
16802     "examples": [
16803       {
16804         "title": "Example usage:",
16805         "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password} -X DELETE",
16806         "type": "json"
16807       }
16808     ],
16809     "name": "DeleteSMTPs",
16810     "group": "Mail_SMTP",
16811     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16812     "version": "0.0.0",
16813     "filename": "server/api/mailServerOut/index.js",
16814     "groupTitle": "Mail_SMTP"
16815   },
16816   {
16817     "type": "get",
16818     "url": "/api/mail/out_servers",
16819     "title": "Gets a list of SMTPs",
16820     "examples": [
16821       {
16822         "title": "Example usage:",
16823         "content": "curl https://{domain}/api/mail/out_servers -v -u {name}:{password}",
16824         "type": "json"
16825       }
16826     ],
16827     "name": "GetSMTPs",
16828     "group": "Mail_SMTP",
16829     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16830     "version": "0.0.0",
16831     "filename": "server/api/mailServerOut/index.js",
16832     "groupTitle": "Mail_SMTP"
16833   },
16834   {
16835     "type": "get",
16836     "url": "/api/mail/out_servers/{id}",
16837     "title": "Gets a single SMTP",
16838     "examples": [
16839       {
16840         "title": "Example usage:",
16841         "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password}",
16842         "type": "json"
16843       }
16844     ],
16845     "name": "ShowSMTPs",
16846     "group": "Mail_SMTP",
16847     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16848     "version": "0.0.0",
16849     "filename": "server/api/mailServerOut/index.js",
16850     "groupTitle": "Mail_SMTP"
16851   },
16852   {
16853     "type": "put",
16854     "url": "/api/mail/out_servers/{id}",
16855     "title": "Update an existing SMTP",
16856     "examples": [
16857       {
16858         "title": "Example usage:",
16859         "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",
16860         "type": "json"
16861       }
16862     ],
16863     "name": "updateSMTPs",
16864     "group": "Mail_SMTP",
16865     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16866     "version": "0.0.0",
16867     "filename": "server/api/mailServerOut/index.js",
16868     "groupTitle": "Mail_SMTP"
16869   },
16870   {
16871     "type": "post",
16872     "url": "/api/mail/substatuses",
16873     "title": "Creates a new Queue",
16874     "examples": [
16875       {
16876         "title": "Example usage:",
16877         "content": "curl https://{domain}/api/mail/substatuses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
16878         "type": "json"
16879       }
16880     ],
16881     "name": "CreateSubstatuses",
16882     "group": "Mail_Substatuses",
16883     "parameter": {
16884       "fields": {
16885         "Body": [
16886           {
16887             "group": "Body",
16888             "type": "String",
16889             "optional": false,
16890             "field": "name",
16891             "description": ""
16892           },
16893           {
16894             "group": "Body",
16895             "type": "String",
16896             "optional": true,
16897             "field": "description",
16898             "description": ""
16899           }
16900         ]
16901       }
16902     },
16903     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16904     "version": "0.0.0",
16905     "filename": "server/api/mailSubstatus/index.js",
16906     "groupTitle": "Mail_Substatuses"
16907   },
16908   {
16909     "type": "delete",
16910     "url": "/api/mail/substatuses/{id}",
16911     "title": "Deletes a Queue",
16912     "examples": [
16913       {
16914         "title": "Example usage:",
16915         "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password} -X DELETE",
16916         "type": "json"
16917       }
16918     ],
16919     "name": "DeleteSubstatuses",
16920     "group": "Mail_Substatuses",
16921     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16922     "version": "0.0.0",
16923     "filename": "server/api/mailSubstatus/index.js",
16924     "groupTitle": "Mail_Substatuses"
16925   },
16926   {
16927     "type": "get",
16928     "url": "/api/mail/substatuses/describe",
16929     "title": "Gets table info about Substatuses",
16930     "examples": [
16931       {
16932         "title": "Example usage:",
16933         "content": "curl https://{domain}/api/mail/substatuses/describe -v -u {name}:{password}",
16934         "type": "json"
16935       }
16936     ],
16937     "name": "DescribeSubstatuses",
16938     "group": "Mail_Substatuses",
16939     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16940     "version": "0.0.0",
16941     "filename": "server/api/mailSubstatus/index.js",
16942     "groupTitle": "Mail_Substatuses"
16943   },
16944   {
16945     "type": "get",
16946     "url": "/api/mail/substatuses",
16947     "title": "Gets a list of Substatuses",
16948     "examples": [
16949       {
16950         "title": "Example usage:",
16951         "content": "curl https://{domain}/api/mail/substatuses -v -u {name}:{password}",
16952         "type": "json"
16953       }
16954     ],
16955     "name": "GetSubstatuses",
16956     "group": "Mail_Substatuses",
16957     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16958     "version": "0.0.0",
16959     "filename": "server/api/mailSubstatus/index.js",
16960     "groupTitle": "Mail_Substatuses"
16961   },
16962   {
16963     "type": "get",
16964     "url": "/api/mail/substatuses/{id}",
16965     "title": "Gets a single Queue",
16966     "examples": [
16967       {
16968         "title": "Example usage:",
16969         "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password}",
16970         "type": "json"
16971       }
16972     ],
16973     "name": "ShowSubstatuses",
16974     "group": "Mail_Substatuses",
16975     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16976     "version": "0.0.0",
16977     "filename": "server/api/mailSubstatus/index.js",
16978     "groupTitle": "Mail_Substatuses"
16979   },
16980   {
16981     "type": "put",
16982     "url": "/api/mail/substatuses/{id}",
16983     "title": "Update an existing Queue",
16984     "examples": [
16985       {
16986         "title": "Example usage:",
16987         "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",
16988         "type": "json"
16989       }
16990     ],
16991     "name": "updateSubstatuses",
16992     "group": "Mail_Substatuses",
16993     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16994     "version": "0.0.0",
16995     "filename": "server/api/mailSubstatus/index.js",
16996     "groupTitle": "Mail_Substatuses"
16997   },
16998   {
16999     "type": "post",
17000     "url": "/api/mail/reports/transfer",
17001     "title": "Creates a new Mail Transfer Report",
17002     "examples": [
17003       {
17004         "title": "Example usage:",
17005         "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",
17006         "type": "json"
17007       }
17008     ],
17009     "name": "CreateMail_Transfer_Reports",
17010     "group": "Mail_Transfer_Reports",
17011     "parameter": {
17012       "fields": {
17013         "Body": [
17014           {
17015             "group": "Body",
17016             "type": "String",
17017             "optional": false,
17018             "field": "uniqueid",
17019             "description": ""
17020           },
17021           {
17022             "group": "Body",
17023             "type": "String",
17024             "allowedValues": [
17025               "\"account\"",
17026               "\"agent\"",
17027               "\"queue\""
17028             ],
17029             "optional": false,
17030             "field": "type",
17031             "description": ""
17032           },
17033           {
17034             "group": "Body",
17035             "type": "String",
17036             "optional": false,
17037             "field": "transferredAt",
17038             "description": ""
17039           }
17040         ]
17041       }
17042     },
17043     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17044     "version": "0.0.0",
17045     "filename": "server/api/mailTransferReport/index.js",
17046     "groupTitle": "Mail_Transfer_Reports"
17047   },
17048   {
17049     "type": "delete",
17050     "url": "/api/mail/reports/transfer/{id}",
17051     "title": "Deletes a Mail Transfer Report",
17052     "examples": [
17053       {
17054         "title": "Example usage:",
17055         "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
17056         "type": "json"
17057       }
17058     ],
17059     "name": "DeleteMail_Transfer_Reports",
17060     "group": "Mail_Transfer_Reports",
17061     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17062     "version": "0.0.0",
17063     "filename": "server/api/mailTransferReport/index.js",
17064     "groupTitle": "Mail_Transfer_Reports"
17065   },
17066   {
17067     "type": "get",
17068     "url": "/api/mail/reports/transfer/describe",
17069     "title": "Gets table info about Mail Transfer Reports",
17070     "examples": [
17071       {
17072         "title": "Example usage:",
17073         "content": "curl https://{domain}/api/mail/reports/transfer/describe -v -u {name}:{password}",
17074         "type": "json"
17075       }
17076     ],
17077     "name": "DescribeMail_Transfer_Reports",
17078     "group": "Mail_Transfer_Reports",
17079     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17080     "version": "0.0.0",
17081     "filename": "server/api/mailTransferReport/index.js",
17082     "groupTitle": "Mail_Transfer_Reports"
17083   },
17084   {
17085     "type": "get",
17086     "url": "/api/mail/reports/transfer",
17087     "title": "Gets a list of Mail Transfer Reports",
17088     "examples": [
17089       {
17090         "title": "Example usage:",
17091         "content": "curl https://{domain}/api/mail/reports/transfer -v -u {name}:{password}",
17092         "type": "json"
17093       }
17094     ],
17095     "name": "GetMail_Transfer_Reports",
17096     "group": "Mail_Transfer_Reports",
17097     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17098     "version": "0.0.0",
17099     "filename": "server/api/mailTransferReport/index.js",
17100     "groupTitle": "Mail_Transfer_Reports"
17101   },
17102   {
17103     "type": "get",
17104     "url": "/api/mail/reports/transfer/{id}",
17105     "title": "Gets a single Mail Transfer Report",
17106     "examples": [
17107       {
17108         "title": "Example usage:",
17109         "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password}",
17110         "type": "json"
17111       }
17112     ],
17113     "name": "ShowMail_Transfer_Reports",
17114     "group": "Mail_Transfer_Reports",
17115     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17116     "version": "0.0.0",
17117     "filename": "server/api/mailTransferReport/index.js",
17118     "groupTitle": "Mail_Transfer_Reports"
17119   },
17120   {
17121     "type": "put",
17122     "url": "/api/mail/reports/transfer/{id}",
17123     "title": "Update an existing Mail Transfer Report",
17124     "examples": [
17125       {
17126         "title": "Example usage:",
17127         "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",
17128         "type": "json"
17129       }
17130     ],
17131     "name": "updateMail_Transfer_Reports",
17132     "group": "Mail_Transfer_Reports",
17133     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17134     "version": "0.0.0",
17135     "filename": "server/api/mailTransferReport/index.js",
17136     "groupTitle": "Mail_Transfer_Reports"
17137   },
17138   {
17139     "type": "get",
17140     "url": "/api/members/reports/describe",
17141     "title": "Gets table info about Member Reports",
17142     "examples": [
17143       {
17144         "title": "Example usage:",
17145         "content": "curl https://{domain}/api/members/reports/describe -v -u {name}:{password}",
17146         "type": "json"
17147       }
17148     ],
17149     "name": "DescribeMember_Reports",
17150     "group": "Member_Reports",
17151     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17152     "version": "0.0.0",
17153     "filename": "server/api/memberReport/index.js",
17154     "groupTitle": "Member_Reports"
17155   },
17156   {
17157     "type": "get",
17158     "url": "/api/members/reports",
17159     "title": "Gets a list of Member Reports",
17160     "examples": [
17161       {
17162         "title": "Example usage:",
17163         "content": "curl https://{domain}/api/members/reports -v -u {name}:{password}",
17164         "type": "json"
17165       }
17166     ],
17167     "name": "GetMember_Reports",
17168     "group": "Member_Reports",
17169     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17170     "version": "0.0.0",
17171     "filename": "server/api/memberReport/index.js",
17172     "groupTitle": "Member_Reports"
17173   },
17174   {
17175     "type": "get",
17176     "url": "/api/members/reports/{id}",
17177     "title": "Gets a single Member Report",
17178     "examples": [
17179       {
17180         "title": "Example usage:",
17181         "content": "curl https://{domain}/api/members/reports/{id} -v -u {name}:{password}",
17182         "type": "json"
17183       }
17184     ],
17185     "name": "ShowMember_Reports",
17186     "group": "Member_Reports",
17187     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17188     "version": "0.0.0",
17189     "filename": "server/api/memberReport/index.js",
17190     "groupTitle": "Member_Reports"
17191   },
17192   {
17193     "type": "get",
17194     "url": "/api/migrations",
17195     "title": "Gets a list of Migrations",
17196     "examples": [
17197       {
17198         "title": "Example usage:",
17199         "content": "curl https://{domain}/api/migrations -v -u {name}:{password}",
17200         "type": "json"
17201       }
17202     ],
17203     "name": "GetMigrations",
17204     "group": "Migrations",
17205     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17206     "version": "0.0.0",
17207     "filename": "server/api/migration/index.js",
17208     "groupTitle": "Migrations"
17209   },
17210   {
17211     "type": "post",
17212     "url": "/api/voice/networks",
17213     "title": "Create a new network",
17214     "examples": [
17215       {
17216         "title": "Example usage:",
17217         "content": "curl https://{domain}/api/voice/networks -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17218         "type": "json"
17219       }
17220     ],
17221     "name": "Create",
17222     "group": "Networks",
17223     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17224     "version": "0.0.0",
17225     "filename": "server/api/network/index.js",
17226     "groupTitle": "Networks"
17227   },
17228   {
17229     "type": "delete",
17230     "url": "/api/voice/networks/{id}",
17231     "title": "Deletes a network",
17232     "examples": [
17233       {
17234         "title": "Example usage:",
17235         "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X DELETE",
17236         "type": "json"
17237       }
17238     ],
17239     "name": "Delete",
17240     "group": "Networks",
17241     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17242     "version": "0.0.0",
17243     "filename": "server/api/network/index.js",
17244     "groupTitle": "Networks"
17245   },
17246   {
17247     "type": "get",
17248     "url": "/api/networks",
17249     "title": "Gets a list of Networks",
17250     "examples": [
17251       {
17252         "title": "Example usage:",
17253         "content": "curl https://{domain}/api/networks -v -u {name}:{password}",
17254         "type": "json"
17255       }
17256     ],
17257     "name": "GetNetworks",
17258     "group": "Networks",
17259     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17260     "version": "0.0.0",
17261     "filename": "server/api/network/index.js",
17262     "groupTitle": "Networks"
17263   },
17264   {
17265     "type": "get",
17266     "url": "/api/networks/{id}",
17267     "title": "Gets a single Network",
17268     "examples": [
17269       {
17270         "title": "Example usage:",
17271         "content": "curl https://{domain}/api/networks/{id} -v -u {name}:{password}",
17272         "type": "json"
17273       }
17274     ],
17275     "name": "ShowNetworks",
17276     "group": "Networks",
17277     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17278     "version": "0.0.0",
17279     "filename": "server/api/network/index.js",
17280     "groupTitle": "Networks"
17281   },
17282   {
17283     "type": "put",
17284     "url": "/api/voice/networks/{id}",
17285     "title": "Update an existing network",
17286     "examples": [
17287       {
17288         "title": "Example usage:",
17289         "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X PUT",
17290         "type": "json"
17291       }
17292     ],
17293     "name": "Update",
17294     "group": "Networks",
17295     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17296     "version": "0.0.0",
17297     "filename": "server/api/network/index.js",
17298     "groupTitle": "Networks"
17299   },
17300   {
17301     "type": "post",
17302     "url": "/api/notifications",
17303     "title": "Send notification to user",
17304     "examples": [
17305       {
17306         "title": "Example usage:",
17307         "content": "curl https://{domain}/api/notifications -d '{\"text\": \"Hello!\", \"TemplateId\": 1}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17308         "type": "json"
17309       }
17310     ],
17311     "name": "Send",
17312     "group": "Notifications",
17313     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17314     "version": "0.0.0",
17315     "filename": "server/api/notification/index.js",
17316     "groupTitle": "Notifications"
17317   },
17318   {
17319     "type": "post",
17320     "url": "/api/openchannel/accounts/{id}/users",
17321     "title": "Add agents to a openchannel account",
17322     "examples": [
17323       {
17324         "title": "Example usage:",
17325         "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",
17326         "type": "json"
17327       }
17328     ],
17329     "name": "AddAgents",
17330     "group": "Openchannel_Accounts",
17331     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17332     "version": "0.0.0",
17333     "filename": "server/api/openchannelAccount/index.js",
17334     "groupTitle": "Openchannel_Accounts"
17335   },
17336   {
17337     "type": "post",
17338     "url": "/api/openchannel/accounts",
17339     "title": "Creates a new Account",
17340     "examples": [
17341       {
17342         "title": "Example usage:",
17343         "content": "curl https://{domain}/api/openchannel/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17344         "type": "json"
17345       }
17346     ],
17347     "name": "CreateAccounts",
17348     "group": "Openchannel_Accounts",
17349     "parameter": {
17350       "fields": {
17351         "Body": [
17352           {
17353             "group": "Body",
17354             "type": "String",
17355             "optional": false,
17356             "field": "name",
17357             "description": ""
17358           },
17359           {
17360             "group": "Body",
17361             "type": "String",
17362             "optional": true,
17363             "field": "description",
17364             "description": ""
17365           },
17366           {
17367             "group": "Body",
17368             "type": "String",
17369             "optional": true,
17370             "field": "token",
17371             "description": ""
17372           },
17373           {
17374             "group": "Body",
17375             "type": "String",
17376             "optional": true,
17377             "field": "replyUri",
17378             "description": ""
17379           },
17380           {
17381             "group": "Body",
17382             "type": "String",
17383             "optional": false,
17384             "field": "key",
17385             "description": ""
17386           },
17387           {
17388             "group": "Body",
17389             "type": "Text",
17390             "optional": true,
17391             "field": "notificationTemplate",
17392             "description": ""
17393           },
17394           {
17395             "group": "Body",
17396             "type": "Boolean",
17397             "optional": true,
17398             "field": "notificationSound",
17399             "description": ""
17400           },
17401           {
17402             "group": "Body",
17403             "type": "Boolean",
17404             "optional": true,
17405             "field": "notificationShake",
17406             "description": ""
17407           },
17408           {
17409             "group": "Body",
17410             "type": "Integer",
17411             "optional": true,
17412             "field": "waitForTheAssignedAgent",
17413             "description": ""
17414           },
17415           {
17416             "group": "Body",
17417             "type": "String",
17418             "optional": true,
17419             "field": "mapKey",
17420             "description": ""
17421           },
17422           {
17423             "group": "Body",
17424             "type": "Boolean",
17425             "optional": true,
17426             "field": "queueTransfer",
17427             "description": ""
17428           },
17429           {
17430             "group": "Body",
17431             "type": "Integer",
17432             "optional": true,
17433             "field": "queueTransferTimeout",
17434             "description": ""
17435           },
17436           {
17437             "group": "Body",
17438             "type": "Boolean",
17439             "optional": true,
17440             "field": "agentTransfer",
17441             "description": ""
17442           },
17443           {
17444             "group": "Body",
17445             "type": "Integer",
17446             "optional": true,
17447             "field": "agentTransferTimeout",
17448             "description": ""
17449           },
17450           {
17451             "group": "Body",
17452             "type": "Integer",
17453             "optional": true,
17454             "field": "mandatoryDispositionPauseId",
17455             "description": "<p>Status to put when mandatory disposition is enabled</p>"
17456           },
17457           {
17458             "group": "Body",
17459             "type": "Boolean",
17460             "optional": true,
17461             "field": "mandatoryDisposition",
17462             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
17463           }
17464         ]
17465       }
17466     },
17467     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17468     "version": "0.0.0",
17469     "filename": "server/api/openchannelAccount/index.js",
17470     "groupTitle": "Openchannel_Accounts"
17471   },
17472   {
17473     "type": "delete",
17474     "url": "/api/openchannel/accounts/{id}",
17475     "title": "Deletes a Account",
17476     "examples": [
17477       {
17478         "title": "Example usage:",
17479         "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password} -X DELETE",
17480         "type": "json"
17481       }
17482     ],
17483     "name": "DeleteAccounts",
17484     "group": "Openchannel_Accounts",
17485     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17486     "version": "0.0.0",
17487     "filename": "server/api/openchannelAccount/index.js",
17488     "groupTitle": "Openchannel_Accounts"
17489   },
17490   {
17491     "type": "get",
17492     "url": "/api/openchannel/accounts/describe",
17493     "title": "Gets table info about Accounts",
17494     "examples": [
17495       {
17496         "title": "Example usage:",
17497         "content": "curl https://{domain}/api/openchannel/accounts/describe -v -u {name}:{password}",
17498         "type": "json"
17499       }
17500     ],
17501     "name": "DescribeAccounts",
17502     "group": "Openchannel_Accounts",
17503     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17504     "version": "0.0.0",
17505     "filename": "server/api/openchannelAccount/index.js",
17506     "groupTitle": "Openchannel_Accounts"
17507   },
17508   {
17509     "type": "get",
17510     "url": "/api/openchannel/accounts",
17511     "title": "Gets a list of Accounts",
17512     "examples": [
17513       {
17514         "title": "Example usage:",
17515         "content": "curl https://{domain}/api/openchannel/accounts -v -u {name}:{password}",
17516         "type": "json"
17517       }
17518     ],
17519     "name": "GetAccounts",
17520     "group": "Openchannel_Accounts",
17521     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17522     "version": "0.0.0",
17523     "filename": "server/api/openchannelAccount/index.js",
17524     "groupTitle": "Openchannel_Accounts"
17525   },
17526   {
17527     "type": "get",
17528     "url": "/api/openchannel/accounts/{id}/users",
17529     "title": "Gets agents from openchannel account",
17530     "examples": [
17531       {
17532         "title": "Example usage:",
17533         "content": "curl https://{domain}/api/openchannel/accounts/{id}/users -v -u {name}:{password} -X GET",
17534         "type": "json"
17535       }
17536     ],
17537     "name": "GetAgents",
17538     "group": "Openchannel_Accounts",
17539     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17540     "version": "0.0.0",
17541     "filename": "server/api/openchannelAccount/index.js",
17542     "groupTitle": "Openchannel_Accounts"
17543   },
17544   {
17545     "type": "delete",
17546     "url": "/api/openchannel/accounts/{id}/users",
17547     "title": "Removes agents from a openchannel account",
17548     "examples": [
17549       {
17550         "title": "Example usage:",
17551         "content": "curl https://{domain}/api/openchannel/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17552         "type": "json"
17553       }
17554     ],
17555     "name": "RemoveAgents",
17556     "group": "Openchannel_Accounts",
17557     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17558     "version": "0.0.0",
17559     "filename": "server/api/openchannelAccount/index.js",
17560     "groupTitle": "Openchannel_Accounts"
17561   },
17562   {
17563     "type": "delete",
17564     "url": "/api/openchannel/accounts/{id}/canned_answers",
17565     "title": "Removes canned answers from account",
17566     "examples": [
17567       {
17568         "title": "Example usage:",
17569         "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17570         "type": "json"
17571       }
17572     ],
17573     "name": "RemoveAnswers",
17574     "group": "Openchannel_Accounts",
17575     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17576     "version": "0.0.0",
17577     "filename": "server/api/openchannelAccount/index.js",
17578     "groupTitle": "Openchannel_Accounts"
17579   },
17580   {
17581     "type": "delete",
17582     "url": "/api/openchannel/accounts/{id}/dispositions",
17583     "title": "Removes dispositions from account",
17584     "examples": [
17585       {
17586         "title": "Example usage:",
17587         "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17588         "type": "json"
17589       }
17590     ],
17591     "name": "RemoveDispositions",
17592     "group": "Openchannel_Accounts",
17593     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17594     "version": "0.0.0",
17595     "filename": "server/api/openchannelAccount/index.js",
17596     "groupTitle": "Openchannel_Accounts"
17597   },
17598   {
17599     "type": "get",
17600     "url": "/api/openchannel/accounts/{id}",
17601     "title": "Gets a single Account",
17602     "examples": [
17603       {
17604         "title": "Example usage:",
17605         "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password}",
17606         "type": "json"
17607       }
17608     ],
17609     "name": "ShowAccounts",
17610     "group": "Openchannel_Accounts",
17611     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17612     "version": "0.0.0",
17613     "filename": "server/api/openchannelAccount/index.js",
17614     "groupTitle": "Openchannel_Accounts"
17615   },
17616   {
17617     "type": "post",
17618     "url": "/api/openchannel/accounts/{id}/canned_answers",
17619     "title": "Creates new canned answer",
17620     "examples": [
17621       {
17622         "title": "Example usage:",
17623         "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",
17624         "type": "json"
17625       }
17626     ],
17627     "name": "addAnswer",
17628     "group": "Openchannel_Accounts",
17629     "parameter": {
17630       "fields": {
17631         "Body": [
17632           {
17633             "group": "Body",
17634             "type": "String",
17635             "optional": false,
17636             "field": "key",
17637             "description": ""
17638           },
17639           {
17640             "group": "Body",
17641             "type": "Text",
17642             "optional": false,
17643             "field": "value",
17644             "description": ""
17645           },
17646           {
17647             "group": "Body",
17648             "type": "String",
17649             "optional": true,
17650             "field": "description",
17651             "description": ""
17652           },
17653           {
17654             "group": "Body",
17655             "type": "Virtual",
17656             "optional": true,
17657             "field": "name",
17658             "description": ""
17659           }
17660         ]
17661       }
17662     },
17663     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17664     "version": "0.0.0",
17665     "filename": "server/api/openchannelAccount/index.js",
17666     "groupTitle": "Openchannel_Accounts"
17667   },
17668   {
17669     "type": "post",
17670     "url": "/api/openchannel/accounts/{id}/applications",
17671     "title": "Creates new applications",
17672     "examples": [
17673       {
17674         "title": "Example usage:",
17675         "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17676         "type": "json"
17677       }
17678     ],
17679     "name": "addApplications",
17680     "group": "Openchannel_Accounts",
17681     "parameter": {
17682       "fields": {
17683         "Body": [
17684           {
17685             "group": "Body",
17686             "type": "Integer",
17687             "optional": false,
17688             "field": "priority",
17689             "description": ""
17690           },
17691           {
17692             "group": "Body",
17693             "type": "String",
17694             "optional": false,
17695             "field": "app",
17696             "description": ""
17697           },
17698           {
17699             "group": "Body",
17700             "type": "Text",
17701             "optional": true,
17702             "field": "appdata",
17703             "description": ""
17704           },
17705           {
17706             "group": "Body",
17707             "type": "String",
17708             "optional": true,
17709             "field": "description",
17710             "description": ""
17711           },
17712           {
17713             "group": "Body",
17714             "type": "String",
17715             "optional": true,
17716             "field": "interval",
17717             "description": ""
17718           }
17719         ]
17720       }
17721     },
17722     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17723     "version": "0.0.0",
17724     "filename": "server/api/openchannelAccount/index.js",
17725     "groupTitle": "Openchannel_Accounts"
17726   },
17727   {
17728     "type": "post",
17729     "url": "/api/openchannel/accounts/{id}/dispositions",
17730     "title": "Creates new disposition",
17731     "examples": [
17732       {
17733         "title": "Example usage:",
17734         "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17735         "type": "json"
17736       }
17737     ],
17738     "name": "addDisposition",
17739     "group": "Openchannel_Accounts",
17740     "parameter": {
17741       "fields": {
17742         "Body": [
17743           {
17744             "group": "Body",
17745             "type": "String",
17746             "optional": false,
17747             "field": "name",
17748             "description": ""
17749           },
17750           {
17751             "group": "Body",
17752             "type": "String",
17753             "allowedValues": [
17754               "\"first\"",
17755               "\"second\"",
17756               "\"third\""
17757             ],
17758             "optional": false,
17759             "field": "level",
17760             "description": ""
17761           },
17762           {
17763             "group": "Body",
17764             "type": "String",
17765             "optional": true,
17766             "field": "description",
17767             "description": ""
17768           }
17769         ]
17770       }
17771     },
17772     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17773     "version": "0.0.0",
17774     "filename": "server/api/openchannelAccount/index.js",
17775     "groupTitle": "Openchannel_Accounts"
17776   },
17777   {
17778     "type": "get",
17779     "url": "/api/openchannel/accounts/{id}/canned_answers",
17780     "title": "Gets account canned answers",
17781     "examples": [
17782       {
17783         "title": "Example usage:",
17784         "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
17785         "type": "json"
17786       }
17787     ],
17788     "name": "getAnswers",
17789     "group": "Openchannel_Accounts",
17790     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17791     "version": "0.0.0",
17792     "filename": "server/api/openchannelAccount/index.js",
17793     "groupTitle": "Openchannel_Accounts"
17794   },
17795   {
17796     "type": "get",
17797     "url": "/api/openchannel/accounts/{id}/applications",
17798     "title": "Gets account applications",
17799     "examples": [
17800       {
17801         "title": "Example usage:",
17802         "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -v -u {name}:{password} -X GET",
17803         "type": "json"
17804       }
17805     ],
17806     "name": "getApplications",
17807     "group": "Openchannel_Accounts",
17808     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17809     "version": "0.0.0",
17810     "filename": "server/api/openchannelAccount/index.js",
17811     "groupTitle": "Openchannel_Accounts"
17812   },
17813   {
17814     "type": "get",
17815     "url": "/api/openchannel/accounts/{id}/dispositions",
17816     "title": "Gets account dispositions",
17817     "examples": [
17818       {
17819         "title": "Example usage:",
17820         "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
17821         "type": "json"
17822       }
17823     ],
17824     "name": "getDispositions",
17825     "group": "Openchannel_Accounts",
17826     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17827     "version": "0.0.0",
17828     "filename": "server/api/openchannelAccount/index.js",
17829     "groupTitle": "Openchannel_Accounts"
17830   },
17831   {
17832     "type": "get",
17833     "url": "/api/openchannel/accounts/{id}/interactions",
17834     "title": "Gets Openchannel Account Interactions",
17835     "examples": [
17836       {
17837         "title": "Example usage:",
17838         "content": "curl https://{domain}/api/openchannel/accounts/{id}/interactions -v -u {name}:{password} -X GET",
17839         "type": "json"
17840       }
17841     ],
17842     "name": "getInteractions",
17843     "group": "Openchannel_Accounts",
17844     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17845     "version": "0.0.0",
17846     "filename": "server/api/openchannelAccount/index.js",
17847     "groupTitle": "Openchannel_Accounts"
17848   },
17849   {
17850     "type": "post",
17851     "url": "/api/openchannel/accounts/{id}/notify",
17852     "title": "Notify new message",
17853     "examples": [
17854       {
17855         "title": "Example usage:",
17856         "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",
17857         "type": "json"
17858       }
17859     ],
17860     "name": "notify",
17861     "group": "Openchannel_Accounts",
17862     "description": "<p>Motion 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>",
17863     "version": "0.0.0",
17864     "filename": "server/api/openchannelAccount/index.js",
17865     "groupTitle": "Openchannel_Accounts"
17866   },
17867   {
17868     "type": "post",
17869     "url": "/api/openchannel/accounts/{id}/send",
17870     "title": "Send new openchannel message",
17871     "examples": [
17872       {
17873         "title": "Example usage:",
17874         "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",
17875         "type": "json"
17876       }
17877     ],
17878     "name": "sendOpenchannel",
17879     "group": "Openchannel_Accounts",
17880     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17881     "version": "0.0.0",
17882     "filename": "server/api/openchannelAccount/index.js",
17883     "groupTitle": "Openchannel_Accounts"
17884   },
17885   {
17886     "type": "put",
17887     "url": "/api/openchannel/accounts/{id}",
17888     "title": "Update an existing Account",
17889     "examples": [
17890       {
17891         "title": "Example usage:",
17892         "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",
17893         "type": "json"
17894       }
17895     ],
17896     "name": "updateAccounts",
17897     "group": "Openchannel_Accounts",
17898     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17899     "version": "0.0.0",
17900     "filename": "server/api/openchannelAccount/index.js",
17901     "groupTitle": "Openchannel_Accounts"
17902   },
17903   {
17904     "type": "post",
17905     "url": "/api/openchannel/applications",
17906     "title": "Creates a new Application",
17907     "examples": [
17908       {
17909         "title": "Example usage:",
17910         "content": "curl https://{domain}/api/openchannel/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17911         "type": "json"
17912       }
17913     ],
17914     "name": "CreateApplications",
17915     "group": "Openchannel_Applications",
17916     "parameter": {
17917       "fields": {
17918         "Body": [
17919           {
17920             "group": "Body",
17921             "type": "Integer",
17922             "optional": false,
17923             "field": "priority",
17924             "description": ""
17925           },
17926           {
17927             "group": "Body",
17928             "type": "String",
17929             "optional": false,
17930             "field": "app",
17931             "description": ""
17932           },
17933           {
17934             "group": "Body",
17935             "type": "Text",
17936             "optional": true,
17937             "field": "appdata",
17938             "description": ""
17939           },
17940           {
17941             "group": "Body",
17942             "type": "String",
17943             "optional": true,
17944             "field": "description",
17945             "description": ""
17946           },
17947           {
17948             "group": "Body",
17949             "type": "String",
17950             "optional": true,
17951             "field": "interval",
17952             "description": ""
17953           }
17954         ]
17955       }
17956     },
17957     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17958     "version": "0.0.0",
17959     "filename": "server/api/openchannelApplication/index.js",
17960     "groupTitle": "Openchannel_Applications"
17961   },
17962   {
17963     "type": "delete",
17964     "url": "/api/openchannel/applications/{id}",
17965     "title": "Deletes a Application",
17966     "examples": [
17967       {
17968         "title": "Example usage:",
17969         "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password} -X DELETE",
17970         "type": "json"
17971       }
17972     ],
17973     "name": "DeleteApplications",
17974     "group": "Openchannel_Applications",
17975     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17976     "version": "0.0.0",
17977     "filename": "server/api/openchannelApplication/index.js",
17978     "groupTitle": "Openchannel_Applications"
17979   },
17980   {
17981     "type": "get",
17982     "url": "/api/openchannel/applications",
17983     "title": "Gets a list of Applications",
17984     "examples": [
17985       {
17986         "title": "Example usage:",
17987         "content": "curl https://{domain}/api/openchannel/applications -v -u {name}:{password}",
17988         "type": "json"
17989       }
17990     ],
17991     "name": "GetApplications",
17992     "group": "Openchannel_Applications",
17993     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17994     "version": "0.0.0",
17995     "filename": "server/api/openchannelApplication/index.js",
17996     "groupTitle": "Openchannel_Applications"
17997   },
17998   {
17999     "type": "get",
18000     "url": "/api/openchannel/applications/{id}",
18001     "title": "Gets a single Application",
18002     "examples": [
18003       {
18004         "title": "Example usage:",
18005         "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password}",
18006         "type": "json"
18007       }
18008     ],
18009     "name": "ShowApplications",
18010     "group": "Openchannel_Applications",
18011     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18012     "version": "0.0.0",
18013     "filename": "server/api/openchannelApplication/index.js",
18014     "groupTitle": "Openchannel_Applications"
18015   },
18016   {
18017     "type": "put",
18018     "url": "/api/openchannel/applications/{id}",
18019     "title": "Update an existing Application",
18020     "examples": [
18021       {
18022         "title": "Example usage:",
18023         "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",
18024         "type": "json"
18025       }
18026     ],
18027     "name": "updateApplications",
18028     "group": "Openchannel_Applications",
18029     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18030     "version": "0.0.0",
18031     "filename": "server/api/openchannelApplication/index.js",
18032     "groupTitle": "Openchannel_Applications"
18033   },
18034   {
18035     "type": "post",
18036     "url": "/api/openchannel/interactions/{id}/tags",
18037     "title": "Add tags to the interaction",
18038     "examples": [
18039       {
18040         "title": "Example usage:",
18041         "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",
18042         "type": "json"
18043       }
18044     ],
18045     "name": "AddTags",
18046     "group": "Openchannel_Interactions",
18047     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18048     "version": "0.0.0",
18049     "filename": "server/api/openchannelInteraction/index.js",
18050     "groupTitle": "Openchannel_Interactions"
18051   },
18052   {
18053     "type": "post",
18054     "url": "/api/openchannel/interactions",
18055     "title": "Creates a new Interaction",
18056     "examples": [
18057       {
18058         "title": "Example usage:",
18059         "content": "curl https://{domain}/api/openchannel/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18060         "type": "json"
18061       }
18062     ],
18063     "name": "CreateInteractions",
18064     "group": "Openchannel_Interactions",
18065     "parameter": {
18066       "fields": {
18067         "Body": [
18068           {
18069             "group": "Body",
18070             "type": "Boolean",
18071             "optional": true,
18072             "field": "closed",
18073             "description": ""
18074           },
18075           {
18076             "group": "Body",
18077             "type": "String",
18078             "optional": true,
18079             "field": "closedAt",
18080             "description": ""
18081           },
18082           {
18083             "group": "Body",
18084             "type": "String",
18085             "optional": true,
18086             "field": "disposition",
18087             "description": ""
18088           },
18089           {
18090             "group": "Body",
18091             "type": "String",
18092             "optional": true,
18093             "field": "secondDisposition",
18094             "description": ""
18095           },
18096           {
18097             "group": "Body",
18098             "type": "String",
18099             "optional": true,
18100             "field": "thirdDisposition",
18101             "description": ""
18102           },
18103           {
18104             "group": "Body",
18105             "type": "String",
18106             "optional": true,
18107             "field": "note",
18108             "description": ""
18109           },
18110           {
18111             "group": "Body",
18112             "type": "String",
18113             "optional": true,
18114             "field": "read1stAt",
18115             "description": ""
18116           },
18117           {
18118             "group": "Body",
18119             "type": "String",
18120             "optional": true,
18121             "field": "threadId",
18122             "description": ""
18123           },
18124           {
18125             "group": "Body",
18126             "type": "String",
18127             "optional": true,
18128             "field": "externalUrl",
18129             "description": ""
18130           },
18131           {
18132             "group": "Body",
18133             "type": "String",
18134             "optional": true,
18135             "field": "lastMsgAt",
18136             "description": ""
18137           },
18138           {
18139             "group": "Body",
18140             "type": "String",
18141             "allowedValues": [
18142               "\"in\"",
18143               "\"out\""
18144             ],
18145             "optional": false,
18146             "field": "lastMsgDirection",
18147             "description": ""
18148           },
18149           {
18150             "group": "Body",
18151             "type": "String",
18152             "optional": true,
18153             "field": "from",
18154             "description": ""
18155           }
18156         ]
18157       }
18158     },
18159     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18160     "version": "0.0.0",
18161     "filename": "server/api/openchannelInteraction/index.js",
18162     "groupTitle": "Openchannel_Interactions"
18163   },
18164   {
18165     "type": "delete",
18166     "url": "/api/openchannel/interactions/{id}",
18167     "title": "Deletes a Interaction",
18168     "examples": [
18169       {
18170         "title": "Example usage:",
18171         "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password} -X DELETE",
18172         "type": "json"
18173       }
18174     ],
18175     "name": "DeleteInteractions",
18176     "group": "Openchannel_Interactions",
18177     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18178     "version": "0.0.0",
18179     "filename": "server/api/openchannelInteraction/index.js",
18180     "groupTitle": "Openchannel_Interactions"
18181   },
18182   {
18183     "type": "get",
18184     "url": "/api/openchannel/interactions/describe",
18185     "title": "Gets table info about Interactions",
18186     "examples": [
18187       {
18188         "title": "Example usage:",
18189         "content": "curl https://{domain}/api/openchannel/interactions/describe -v -u {name}:{password}",
18190         "type": "json"
18191       }
18192     ],
18193     "name": "DescribeInteractions",
18194     "group": "Openchannel_Interactions",
18195     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18196     "version": "0.0.0",
18197     "filename": "server/api/openchannelInteraction/index.js",
18198     "groupTitle": "Openchannel_Interactions"
18199   },
18200   {
18201     "type": "get",
18202     "url": "/api/openchannel/interactions",
18203     "title": "Gets a list of Interactions",
18204     "examples": [
18205       {
18206         "title": "Example usage:",
18207         "content": "curl https://{domain}/api/openchannel/interactions -v -u {name}:{password}",
18208         "type": "json"
18209       }
18210     ],
18211     "name": "GetInteractions",
18212     "group": "Openchannel_Interactions",
18213     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18214     "version": "0.0.0",
18215     "filename": "server/api/openchannelInteraction/index.js",
18216     "groupTitle": "Openchannel_Interactions"
18217   },
18218   {
18219     "type": "delete",
18220     "url": "/api/openchannel/interactions/{id}/tags",
18221     "title": "Removes tags from interaction",
18222     "examples": [
18223       {
18224         "title": "Example usage:",
18225         "content": "curl https://{domain}/api/openchannel/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
18226         "type": "json"
18227       }
18228     ],
18229     "name": "RemoveTags",
18230     "group": "Openchannel_Interactions",
18231     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18232     "version": "0.0.0",
18233     "filename": "server/api/openchannelInteraction/index.js",
18234     "groupTitle": "Openchannel_Interactions"
18235   },
18236   {
18237     "type": "get",
18238     "url": "/api/openchannel/interactions/{id}",
18239     "title": "Gets a single Interaction",
18240     "examples": [
18241       {
18242         "title": "Example usage:",
18243         "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password}",
18244         "type": "json"
18245       }
18246     ],
18247     "name": "ShowInteractions",
18248     "group": "Openchannel_Interactions",
18249     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18250     "version": "0.0.0",
18251     "filename": "server/api/openchannelInteraction/index.js",
18252     "groupTitle": "Openchannel_Interactions"
18253   },
18254   {
18255     "type": "post",
18256     "url": "/api/openchannel/interactions/{id}/messages",
18257     "title": "Creates new messages",
18258     "examples": [
18259       {
18260         "title": "Example usage:",
18261         "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
18262         "type": "json"
18263       }
18264     ],
18265     "name": "addMessage",
18266     "group": "Openchannel_Interactions",
18267     "parameter": {
18268       "fields": {
18269         "Body": [
18270           {
18271             "group": "Body",
18272             "type": "Text",
18273             "optional": false,
18274             "field": "body",
18275             "description": ""
18276           },
18277           {
18278             "group": "Body",
18279             "type": "Boolean",
18280             "optional": true,
18281             "field": "read",
18282             "description": ""
18283           },
18284           {
18285             "group": "Body",
18286             "type": "Boolean",
18287             "optional": true,
18288             "field": "secret",
18289             "description": ""
18290           },
18291           {
18292             "group": "Body",
18293             "type": "String",
18294             "allowedValues": [
18295               "\"in\"",
18296               "\"out\""
18297             ],
18298             "optional": false,
18299             "field": "direction",
18300             "description": ""
18301           },
18302           {
18303             "group": "Body",
18304             "type": "String",
18305             "optional": true,
18306             "field": "readAt",
18307             "description": ""
18308           },
18309           {
18310             "group": "Body",
18311             "type": "String",
18312             "optional": true,
18313             "field": "providerName",
18314             "description": ""
18315           },
18316           {
18317             "group": "Body",
18318             "type": "Text",
18319             "optional": true,
18320             "field": "providerResponse",
18321             "description": ""
18322           }
18323         ]
18324       }
18325     },
18326     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18327     "version": "0.0.0",
18328     "filename": "server/api/openchannelInteraction/index.js",
18329     "groupTitle": "Openchannel_Interactions"
18330   },
18331   {
18332     "type": "get",
18333     "url": "/api/openchannel/interactions/{id}/download",
18334     "title": "Gets interaction",
18335     "examples": [
18336       {
18337         "title": "Example usage:",
18338         "content": "curl https://{domain}/api/openchannel/interactions/{id}/download -v -u {name}:{password} -X GET",
18339         "type": "json"
18340       }
18341     ],
18342     "name": "download",
18343     "group": "Openchannel_Interactions",
18344     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18345     "version": "0.0.0",
18346     "filename": "server/api/openchannelInteraction/index.js",
18347     "groupTitle": "Openchannel_Interactions"
18348   },
18349   {
18350     "type": "get",
18351     "url": "/api/openchannel/interactions/{id}/messages",
18352     "title": "Gets interaction messages",
18353     "examples": [
18354       {
18355         "title": "Example usage:",
18356         "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -v -u {name}:{password} -X GET",
18357         "type": "json"
18358       }
18359     ],
18360     "name": "getMessages",
18361     "group": "Openchannel_Interactions",
18362     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18363     "version": "0.0.0",
18364     "filename": "server/api/openchannelInteraction/index.js",
18365     "groupTitle": "Openchannel_Interactions"
18366   },
18367   {
18368     "type": "put",
18369     "url": "/api/openchannel/interactions/{id}",
18370     "title": "Update an existing Interaction",
18371     "examples": [
18372       {
18373         "title": "Example usage:",
18374         "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",
18375         "type": "json"
18376       }
18377     ],
18378     "name": "updateInteractions",
18379     "group": "Openchannel_Interactions",
18380     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18381     "version": "0.0.0",
18382     "filename": "server/api/openchannelInteraction/index.js",
18383     "groupTitle": "Openchannel_Interactions"
18384   },
18385   {
18386     "type": "post",
18387     "url": "/api/openchannel/messages",
18388     "title": "Creates a new Message",
18389     "examples": [
18390       {
18391         "title": "Example usage:",
18392         "content": "curl https://{domain}/api/openchannel/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18393         "type": "json"
18394       }
18395     ],
18396     "name": "CreateMessages",
18397     "group": "Openchannel_Messages",
18398     "parameter": {
18399       "fields": {
18400         "Body": [
18401           {
18402             "group": "Body",
18403             "type": "Text",
18404             "optional": false,
18405             "field": "body",
18406             "description": ""
18407           },
18408           {
18409             "group": "Body",
18410             "type": "Boolean",
18411             "optional": true,
18412             "field": "read",
18413             "description": ""
18414           },
18415           {
18416             "group": "Body",
18417             "type": "Boolean",
18418             "optional": true,
18419             "field": "secret",
18420             "description": ""
18421           },
18422           {
18423             "group": "Body",
18424             "type": "String",
18425             "allowedValues": [
18426               "\"in\"",
18427               "\"out\""
18428             ],
18429             "optional": false,
18430             "field": "direction",
18431             "description": ""
18432           },
18433           {
18434             "group": "Body",
18435             "type": "String",
18436             "optional": true,
18437             "field": "readAt",
18438             "description": ""
18439           },
18440           {
18441             "group": "Body",
18442             "type": "String",
18443             "optional": true,
18444             "field": "providerName",
18445             "description": ""
18446           },
18447           {
18448             "group": "Body",
18449             "type": "Text",
18450             "optional": true,
18451             "field": "providerResponse",
18452             "description": ""
18453           }
18454         ]
18455       }
18456     },
18457     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18458     "version": "0.0.0",
18459     "filename": "server/api/openchannelMessage/index.js",
18460     "groupTitle": "Openchannel_Messages"
18461   },
18462   {
18463     "type": "delete",
18464     "url": "/api/openchannel/messages/{id}",
18465     "title": "Deletes a Message",
18466     "examples": [
18467       {
18468         "title": "Example usage:",
18469         "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password} -X DELETE",
18470         "type": "json"
18471       }
18472     ],
18473     "name": "DeleteMessages",
18474     "group": "Openchannel_Messages",
18475     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18476     "version": "0.0.0",
18477     "filename": "server/api/openchannelMessage/index.js",
18478     "groupTitle": "Openchannel_Messages"
18479   },
18480   {
18481     "type": "get",
18482     "url": "/api/openchannel/messages/describe",
18483     "title": "Gets table info about Messages",
18484     "examples": [
18485       {
18486         "title": "Example usage:",
18487         "content": "curl https://{domain}/api/openchannel/messages/describe -v -u {name}:{password}",
18488         "type": "json"
18489       }
18490     ],
18491     "name": "DescribeMessages",
18492     "group": "Openchannel_Messages",
18493     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18494     "version": "0.0.0",
18495     "filename": "server/api/openchannelMessage/index.js",
18496     "groupTitle": "Openchannel_Messages"
18497   },
18498   {
18499     "type": "get",
18500     "url": "/api/openchannel/messages",
18501     "title": "Gets a list of Messages",
18502     "examples": [
18503       {
18504         "title": "Example usage:",
18505         "content": "curl https://{domain}/api/openchannel/messages -v -u {name}:{password}",
18506         "type": "json"
18507       }
18508     ],
18509     "name": "GetMessages",
18510     "group": "Openchannel_Messages",
18511     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18512     "version": "0.0.0",
18513     "filename": "server/api/openchannelMessage/index.js",
18514     "groupTitle": "Openchannel_Messages"
18515   },
18516   {
18517     "type": "get",
18518     "url": "/api/openchannel/messages/{id}",
18519     "title": "Gets a single Message",
18520     "examples": [
18521       {
18522         "title": "Example usage:",
18523         "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password}",
18524         "type": "json"
18525       }
18526     ],
18527     "name": "ShowMessages",
18528     "group": "Openchannel_Messages",
18529     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18530     "version": "0.0.0",
18531     "filename": "server/api/openchannelMessage/index.js",
18532     "groupTitle": "Openchannel_Messages"
18533   },
18534   {
18535     "type": "put",
18536     "url": "/api/openchannel/messages/{id}/accept",
18537     "title": "Accepts message",
18538     "examples": [
18539       {
18540         "title": "Example usage:",
18541         "content": "curl https://{domain}/api/openchannel/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
18542         "type": "json"
18543       }
18544     ],
18545     "name": "acceptMessage",
18546     "group": "Openchannel_Messages",
18547     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18548     "version": "0.0.0",
18549     "filename": "server/api/openchannelMessage/index.js",
18550     "groupTitle": "Openchannel_Messages"
18551   },
18552   {
18553     "type": "put",
18554     "url": "/api/openchannel/messages/{id}/reject",
18555     "title": "Rejects message",
18556     "examples": [
18557       {
18558         "title": "Example usage:",
18559         "content": "curl https://{domain}/api/openchannel/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
18560         "type": "json"
18561       }
18562     ],
18563     "name": "rejectMessage",
18564     "group": "Openchannel_Messages",
18565     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18566     "version": "0.0.0",
18567     "filename": "server/api/openchannelMessage/index.js",
18568     "groupTitle": "Openchannel_Messages"
18569   },
18570   {
18571     "type": "put",
18572     "url": "/api/openchannel/messages/{id}",
18573     "title": "Update an existing Message",
18574     "examples": [
18575       {
18576         "title": "Example usage:",
18577         "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",
18578         "type": "json"
18579       }
18580     ],
18581     "name": "updateMessages",
18582     "group": "Openchannel_Messages",
18583     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18584     "version": "0.0.0",
18585     "filename": "server/api/openchannelMessage/index.js",
18586     "groupTitle": "Openchannel_Messages"
18587   },
18588   {
18589     "type": "post",
18590     "url": "/api/openchannel/reports/queue",
18591     "title": "Creates a new Openchannel Queue Report",
18592     "examples": [
18593       {
18594         "title": "Example usage:",
18595         "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",
18596         "type": "json"
18597       }
18598     ],
18599     "name": "CreateOpenchannel_Queue_Reports",
18600     "group": "Openchannel_Queue_Reports",
18601     "parameter": {
18602       "fields": {
18603         "Body": [
18604           {
18605             "group": "Body",
18606             "type": "String",
18607             "optional": false,
18608             "field": "uniqueid",
18609             "description": ""
18610           },
18611           {
18612             "group": "Body",
18613             "type": "String",
18614             "optional": true,
18615             "field": "from",
18616             "description": ""
18617           },
18618           {
18619             "group": "Body",
18620             "type": "String",
18621             "optional": true,
18622             "field": "joinAt",
18623             "description": ""
18624           },
18625           {
18626             "group": "Body",
18627             "type": "String",
18628             "optional": true,
18629             "field": "leaveAt",
18630             "description": ""
18631           },
18632           {
18633             "group": "Body",
18634             "type": "String",
18635             "optional": true,
18636             "field": "acceptAt",
18637             "description": ""
18638           },
18639           {
18640             "group": "Body",
18641             "type": "String",
18642             "optional": true,
18643             "field": "exitAt",
18644             "description": ""
18645           },
18646           {
18647             "group": "Body",
18648             "type": "String",
18649             "optional": true,
18650             "field": "reason",
18651             "description": ""
18652           }
18653         ]
18654       }
18655     },
18656     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18657     "version": "0.0.0",
18658     "filename": "server/api/openchannelQueueReport/index.js",
18659     "groupTitle": "Openchannel_Queue_Reports"
18660   },
18661   {
18662     "type": "delete",
18663     "url": "/api/openchannel/reports/queue/{id}",
18664     "title": "Deletes a Openchannel Queue Report",
18665     "examples": [
18666       {
18667         "title": "Example usage:",
18668         "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password} -X DELETE",
18669         "type": "json"
18670       }
18671     ],
18672     "name": "DeleteOpenchannel_Queue_Reports",
18673     "group": "Openchannel_Queue_Reports",
18674     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18675     "version": "0.0.0",
18676     "filename": "server/api/openchannelQueueReport/index.js",
18677     "groupTitle": "Openchannel_Queue_Reports"
18678   },
18679   {
18680     "type": "get",
18681     "url": "/api/openchannel/reports/queue/describe",
18682     "title": "Gets table info about Openchannel Queue Reports",
18683     "examples": [
18684       {
18685         "title": "Example usage:",
18686         "content": "curl https://{domain}/api/openchannel/reports/queue/describe -v -u {name}:{password}",
18687         "type": "json"
18688       }
18689     ],
18690     "name": "DescribeOpenchannel_Queue_Reports",
18691     "group": "Openchannel_Queue_Reports",
18692     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18693     "version": "0.0.0",
18694     "filename": "server/api/openchannelQueueReport/index.js",
18695     "groupTitle": "Openchannel_Queue_Reports"
18696   },
18697   {
18698     "type": "get",
18699     "url": "/api/openchannel/reports/queue",
18700     "title": "Gets a list of Openchannel Queue Reports",
18701     "examples": [
18702       {
18703         "title": "Example usage:",
18704         "content": "curl https://{domain}/api/openchannel/reports/queue -v -u {name}:{password}",
18705         "type": "json"
18706       }
18707     ],
18708     "name": "GetOpenchannel_Queue_Reports",
18709     "group": "Openchannel_Queue_Reports",
18710     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18711     "version": "0.0.0",
18712     "filename": "server/api/openchannelQueueReport/index.js",
18713     "groupTitle": "Openchannel_Queue_Reports"
18714   },
18715   {
18716     "type": "get",
18717     "url": "/api/openchannel/reports/queue/{id}",
18718     "title": "Gets a single Openchannel Queue Report",
18719     "examples": [
18720       {
18721         "title": "Example usage:",
18722         "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password}",
18723         "type": "json"
18724       }
18725     ],
18726     "name": "ShowOpenchannel_Queue_Reports",
18727     "group": "Openchannel_Queue_Reports",
18728     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18729     "version": "0.0.0",
18730     "filename": "server/api/openchannelQueueReport/index.js",
18731     "groupTitle": "Openchannel_Queue_Reports"
18732   },
18733   {
18734     "type": "put",
18735     "url": "/api/openchannel/reports/queue/{id}",
18736     "title": "Update an existing Openchannel Queue Report",
18737     "examples": [
18738       {
18739         "title": "Example usage:",
18740         "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",
18741         "type": "json"
18742       }
18743     ],
18744     "name": "updateOpenchannel_Queue_Reports",
18745     "group": "Openchannel_Queue_Reports",
18746     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18747     "version": "0.0.0",
18748     "filename": "server/api/openchannelQueueReport/index.js",
18749     "groupTitle": "Openchannel_Queue_Reports"
18750   },
18751   {
18752     "type": "post",
18753     "url": "/api/openchannel/queues/{id}/users",
18754     "title": "Add agents to a queue",
18755     "examples": [
18756       {
18757         "title": "Example usage:",
18758         "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",
18759         "type": "json"
18760       }
18761     ],
18762     "name": "AddAgents",
18763     "group": "Openchannel_Queues",
18764     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18765     "version": "0.0.0",
18766     "filename": "server/api/openchannelQueue/index.js",
18767     "groupTitle": "Openchannel_Queues"
18768   },
18769   {
18770     "type": "post",
18771     "url": "/api/openchannel/queues/{id}/teams",
18772     "title": "Add teams to a queue",
18773     "examples": [
18774       {
18775         "title": "Example usage:",
18776         "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",
18777         "type": "json"
18778       }
18779     ],
18780     "name": "AddTeams",
18781     "group": "Openchannel_Queues",
18782     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18783     "version": "0.0.0",
18784     "filename": "server/api/openchannelQueue/index.js",
18785     "groupTitle": "Openchannel_Queues"
18786   },
18787   {
18788     "type": "post",
18789     "url": "/api/openchannel/queues",
18790     "title": "Creates a new Queue",
18791     "examples": [
18792       {
18793         "title": "Example usage:",
18794         "content": "curl https://{domain}/api/openchannel/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18795         "type": "json"
18796       }
18797     ],
18798     "name": "CreateQueues",
18799     "group": "Openchannel_Queues",
18800     "parameter": {
18801       "fields": {
18802         "Body": [
18803           {
18804             "group": "Body",
18805             "type": "String",
18806             "optional": true,
18807             "field": "name",
18808             "description": ""
18809           },
18810           {
18811             "group": "Body",
18812             "type": "String",
18813             "optional": true,
18814             "field": "description",
18815             "description": ""
18816           },
18817           {
18818             "group": "Body",
18819             "type": "Integer",
18820             "optional": true,
18821             "field": "timeout",
18822             "description": ""
18823           },
18824           {
18825             "group": "Body",
18826             "type": "String",
18827             "allowedValues": [
18828               "\"rrmemory\"",
18829               "\"beepall\"",
18830               "\"roundrobin\""
18831             ],
18832             "optional": true,
18833             "field": "strategy",
18834             "description": ""
18835           }
18836         ]
18837       }
18838     },
18839     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18840     "version": "0.0.0",
18841     "filename": "server/api/openchannelQueue/index.js",
18842     "groupTitle": "Openchannel_Queues"
18843   },
18844   {
18845     "type": "delete",
18846     "url": "/api/openchannel/queues/{id}",
18847     "title": "Deletes a Queue",
18848     "examples": [
18849       {
18850         "title": "Example usage:",
18851         "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password} -X DELETE",
18852         "type": "json"
18853       }
18854     ],
18855     "name": "DeleteQueues",
18856     "group": "Openchannel_Queues",
18857     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18858     "version": "0.0.0",
18859     "filename": "server/api/openchannelQueue/index.js",
18860     "groupTitle": "Openchannel_Queues"
18861   },
18862   {
18863     "type": "get",
18864     "url": "/api/openchannel/queues/describe",
18865     "title": "Gets table info about Queues",
18866     "examples": [
18867       {
18868         "title": "Example usage:",
18869         "content": "curl https://{domain}/api/openchannel/queues/describe -v -u {name}:{password}",
18870         "type": "json"
18871       }
18872     ],
18873     "name": "DescribeQueues",
18874     "group": "Openchannel_Queues",
18875     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18876     "version": "0.0.0",
18877     "filename": "server/api/openchannelQueue/index.js",
18878     "groupTitle": "Openchannel_Queues"
18879   },
18880   {
18881     "type": "get",
18882     "url": "/api/openchannel/queues/{id}/users",
18883     "title": "Gets queue agents",
18884     "examples": [
18885       {
18886         "title": "Example usage:",
18887         "content": "curl https://{domain}/api/openchannel/queues/{id}/users -v -u {name}:{password} -X POST",
18888         "type": "json"
18889       }
18890     ],
18891     "name": "GetAgents",
18892     "group": "Openchannel_Queues",
18893     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18894     "version": "0.0.0",
18895     "filename": "server/api/openchannelQueue/index.js",
18896     "groupTitle": "Openchannel_Queues"
18897   },
18898   {
18899     "type": "get",
18900     "url": "/api/openchannel/queues/{id}/members",
18901     "title": "GetMembers",
18902     "examples": [
18903       {
18904         "title": "Example usage:",
18905         "content": "curl https://{domain}/api/openchannel/queues/{id}/members  -v -u {name}:{password}",
18906         "type": "json"
18907       }
18908     ],
18909     "name": "GetMembers",
18910     "group": "Openchannel_Queues",
18911     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18912     "version": "0.0.0",
18913     "filename": "server/api/openchannelQueue/index.js",
18914     "groupTitle": "Openchannel_Queues"
18915   },
18916   {
18917     "type": "get",
18918     "url": "/api/openchannel/queues",
18919     "title": "Gets a list of Queues",
18920     "examples": [
18921       {
18922         "title": "Example usage:",
18923         "content": "curl https://{domain}/api/openchannel/queues -v -u {name}:{password}",
18924         "type": "json"
18925       }
18926     ],
18927     "name": "GetQueues",
18928     "group": "Openchannel_Queues",
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/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>",
18930     "version": "0.0.0",
18931     "filename": "server/api/openchannelQueue/index.js",
18932     "groupTitle": "Openchannel_Queues"
18933   },
18934   {
18935     "type": "get",
18936     "url": "/api/openchannel/queues/{id}/teams",
18937     "title": "Gets queues list",
18938     "examples": [
18939       {
18940         "title": "Example usage:",
18941         "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password}",
18942         "type": "json"
18943       }
18944     ],
18945     "name": "GetTeams",
18946     "group": "Openchannel_Queues",
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/openchannelQueue/index.js",
18950     "groupTitle": "Openchannel_Queues"
18951   },
18952   {
18953     "type": "delete",
18954     "url": "/api/openchannel/queues/{id}/users",
18955     "title": "Removes agents from a queue",
18956     "examples": [
18957       {
18958         "title": "Example usage:",
18959         "content": "curl https://{domain}/api/openchannel/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
18960         "type": "json"
18961       }
18962     ],
18963     "name": "RemoveAgents",
18964     "group": "Openchannel_Queues",
18965     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/openchannelQueue/index.js",
18968     "groupTitle": "Openchannel_Queues"
18969   },
18970   {
18971     "type": "get",
18972     "url": "/api/openchannel/queues/{id}",
18973     "title": "Gets a single Queue",
18974     "examples": [
18975       {
18976         "title": "Example usage:",
18977         "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password}",
18978         "type": "json"
18979       }
18980     ],
18981     "name": "ShowQueues",
18982     "group": "Openchannel_Queues",
18983     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18984     "version": "0.0.0",
18985     "filename": "server/api/openchannelQueue/index.js",
18986     "groupTitle": "Openchannel_Queues"
18987   },
18988   {
18989     "type": "put",
18990     "url": "/api/openchannel/queues/{id}",
18991     "title": "Update an existing Queue",
18992     "examples": [
18993       {
18994         "title": "Example usage:",
18995         "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",
18996         "type": "json"
18997       }
18998     ],
18999     "name": "updateQueues",
19000     "group": "Openchannel_Queues",
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/openchannelQueue/index.js",
19004     "groupTitle": "Openchannel_Queues"
19005   },
19006   {
19007     "type": "post",
19008     "url": "/api/openchannel/reports/transfer",
19009     "title": "Creates a new Openchannel Transfer Report",
19010     "examples": [
19011       {
19012         "title": "Example usage:",
19013         "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",
19014         "type": "json"
19015       }
19016     ],
19017     "name": "CreateOpenchannel_Transfer_Reports",
19018     "group": "Openchannel_Transfer_Reports",
19019     "parameter": {
19020       "fields": {
19021         "Body": [
19022           {
19023             "group": "Body",
19024             "type": "String",
19025             "optional": false,
19026             "field": "uniqueid",
19027             "description": ""
19028           },
19029           {
19030             "group": "Body",
19031             "type": "String",
19032             "allowedValues": [
19033               "\"account\"",
19034               "\"agent\"",
19035               "\"queue\""
19036             ],
19037             "optional": false,
19038             "field": "type",
19039             "description": ""
19040           },
19041           {
19042             "group": "Body",
19043             "type": "String",
19044             "optional": false,
19045             "field": "transferredAt",
19046             "description": ""
19047           }
19048         ]
19049       }
19050     },
19051     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19052     "version": "0.0.0",
19053     "filename": "server/api/openchannelTransferReport/index.js",
19054     "groupTitle": "Openchannel_Transfer_Reports"
19055   },
19056   {
19057     "type": "delete",
19058     "url": "/api/openchannel/reports/transfer/{id}",
19059     "title": "Deletes a Openchannel Transfer Report",
19060     "examples": [
19061       {
19062         "title": "Example usage:",
19063         "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
19064         "type": "json"
19065       }
19066     ],
19067     "name": "DeleteOpenchannel_Transfer_Reports",
19068     "group": "Openchannel_Transfer_Reports",
19069     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19070     "version": "0.0.0",
19071     "filename": "server/api/openchannelTransferReport/index.js",
19072     "groupTitle": "Openchannel_Transfer_Reports"
19073   },
19074   {
19075     "type": "get",
19076     "url": "/api/openchannel/reports/transfer/describe",
19077     "title": "Gets table info about Openchannel Transfer Reports",
19078     "examples": [
19079       {
19080         "title": "Example usage:",
19081         "content": "curl https://{domain}/api/openchannel/reports/transfer/describe -v -u {name}:{password}",
19082         "type": "json"
19083       }
19084     ],
19085     "name": "DescribeOpenchannel_Transfer_Reports",
19086     "group": "Openchannel_Transfer_Reports",
19087     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19088     "version": "0.0.0",
19089     "filename": "server/api/openchannelTransferReport/index.js",
19090     "groupTitle": "Openchannel_Transfer_Reports"
19091   },
19092   {
19093     "type": "get",
19094     "url": "/api/openchannel/reports/transfer",
19095     "title": "Gets a list of Openchannel Transfer Reports",
19096     "examples": [
19097       {
19098         "title": "Example usage:",
19099         "content": "curl https://{domain}/api/openchannel/reports/transfer -v -u {name}:{password}",
19100         "type": "json"
19101       }
19102     ],
19103     "name": "GetOpenchannel_Transfer_Reports",
19104     "group": "Openchannel_Transfer_Reports",
19105     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19106     "version": "0.0.0",
19107     "filename": "server/api/openchannelTransferReport/index.js",
19108     "groupTitle": "Openchannel_Transfer_Reports"
19109   },
19110   {
19111     "type": "get",
19112     "url": "/api/openchannel/reports/transfer/{id}",
19113     "title": "Gets a single Openchannel Transfer Report",
19114     "examples": [
19115       {
19116         "title": "Example usage:",
19117         "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password}",
19118         "type": "json"
19119       }
19120     ],
19121     "name": "ShowOpenchannel_Transfer_Reports",
19122     "group": "Openchannel_Transfer_Reports",
19123     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19124     "version": "0.0.0",
19125     "filename": "server/api/openchannelTransferReport/index.js",
19126     "groupTitle": "Openchannel_Transfer_Reports"
19127   },
19128   {
19129     "type": "put",
19130     "url": "/api/openchannel/reports/transfer/{id}",
19131     "title": "Update an existing Openchannel Transfer Report",
19132     "examples": [
19133       {
19134         "title": "Example usage:",
19135         "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",
19136         "type": "json"
19137       }
19138     ],
19139     "name": "updateOpenchannel_Transfer_Reports",
19140     "group": "Openchannel_Transfer_Reports",
19141     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19142     "version": "0.0.0",
19143     "filename": "server/api/openchannelTransferReport/index.js",
19144     "groupTitle": "Openchannel_Transfer_Reports"
19145   },
19146   {
19147     "type": "post",
19148     "url": "/api/pauses",
19149     "title": "Creates a new Pause",
19150     "examples": [
19151       {
19152         "title": "Example usage:",
19153         "content": "curl https://{domain}/api/pauses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
19154         "type": "json"
19155       }
19156     ],
19157     "name": "CreatePauses",
19158     "group": "Pauses",
19159     "parameter": {
19160       "fields": {
19161         "Body": [
19162           {
19163             "group": "Body",
19164             "type": "String",
19165             "optional": false,
19166             "field": "name",
19167             "description": ""
19168           },
19169           {
19170             "group": "Body",
19171             "type": "String",
19172             "optional": true,
19173             "field": "description",
19174             "description": ""
19175           }
19176         ]
19177       }
19178     },
19179     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19180     "version": "0.0.0",
19181     "filename": "server/api/pause/index.js",
19182     "groupTitle": "Pauses"
19183   },
19184   {
19185     "type": "delete",
19186     "url": "/api/pauses/{id}",
19187     "title": "Deletes a Pause",
19188     "examples": [
19189       {
19190         "title": "Example usage:",
19191         "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password} -X DELETE",
19192         "type": "json"
19193       }
19194     ],
19195     "name": "DeletePauses",
19196     "group": "Pauses",
19197     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19198     "version": "0.0.0",
19199     "filename": "server/api/pause/index.js",
19200     "groupTitle": "Pauses"
19201   },
19202   {
19203     "type": "get",
19204     "url": "/api/pauses",
19205     "title": "Gets a list of Pauses",
19206     "examples": [
19207       {
19208         "title": "Example usage:",
19209         "content": "curl https://{domain}/api/pauses -v -u {name}:{password}",
19210         "type": "json"
19211       }
19212     ],
19213     "name": "GetPauses",
19214     "group": "Pauses",
19215     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19216     "version": "0.0.0",
19217     "filename": "server/api/pause/index.js",
19218     "groupTitle": "Pauses"
19219   },
19220   {
19221     "type": "get",
19222     "url": "/api/pauses/{id}",
19223     "title": "Gets a single Pause",
19224     "examples": [
19225       {
19226         "title": "Example usage:",
19227         "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password}",
19228         "type": "json"
19229       }
19230     ],
19231     "name": "ShowPauses",
19232     "group": "Pauses",
19233     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19234     "version": "0.0.0",
19235     "filename": "server/api/pause/index.js",
19236     "groupTitle": "Pauses"
19237   },
19238   {
19239     "type": "put",
19240     "url": "/api/pauses/{id}",
19241     "title": "Update an existing Pause",
19242     "examples": [
19243       {
19244         "title": "Example usage:",
19245         "content": "curl https://{domain}/api/pauses/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
19246         "type": "json"
19247       }
19248     ],
19249     "name": "updatePauses",
19250     "group": "Pauses",
19251     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19252     "version": "0.0.0",
19253     "filename": "server/api/pause/index.js",
19254     "groupTitle": "Pauses"
19255   },
19256   {
19257     "type": "get",
19258     "url": "/api/plugins",
19259     "title": "Gets a list of Plugins",
19260     "examples": [
19261       {
19262         "title": "Example usage:",
19263         "content": "curl https://{domain}/api/plugins -v -u {name}:{password}",
19264         "type": "json"
19265       }
19266     ],
19267     "name": "GetPlugins",
19268     "group": "Plugins",
19269     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19270     "version": "0.0.0",
19271     "filename": "server/api/plugin/index.js",
19272     "groupTitle": "Plugins"
19273   },
19274   {
19275     "type": "get",
19276     "url": "/api/plugins/{id}",
19277     "title": "Gets a single Plugin",
19278     "examples": [
19279       {
19280         "title": "Example usage:",
19281         "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password}",
19282         "type": "json"
19283       }
19284     ],
19285     "name": "ShowPlugins",
19286     "group": "Plugins",
19287     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19288     "version": "0.0.0",
19289     "filename": "server/api/plugin/index.js",
19290     "groupTitle": "Plugins"
19291   },
19292   {
19293     "type": "delete",
19294     "url": "/api/plugins/{id}",
19295     "title": "Delete a plugin",
19296     "examples": [
19297       {
19298         "title": "Example usage:",
19299         "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X DELETE",
19300         "type": "json"
19301       }
19302     ],
19303     "name": "destroyPlugin",
19304     "group": "Plugins",
19305     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19306     "version": "0.0.0",
19307     "filename": "server/api/plugin/index.js",
19308     "groupTitle": "Plugins"
19309   },
19310   {
19311     "type": "get",
19312     "url": "/api/plugins/{id}/download",
19313     "title": "Download plugin source code",
19314     "examples": [
19315       {
19316         "title": "Example usage:",
19317         "content": "curl https://{domain}/api/plugins/{id}/download -v -u {name}:{password} -X GET",
19318         "type": "json"
19319       }
19320     ],
19321     "name": "download",
19322     "group": "Plugins",
19323     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19324     "version": "0.0.0",
19325     "filename": "server/api/plugin/index.js",
19326     "groupTitle": "Plugins"
19327   },
19328   {
19329     "type": "put",
19330     "url": "/api/plugins/{id}",
19331     "title": "Update an existing plugin",
19332     "examples": [
19333       {
19334         "title": "Example usage:",
19335         "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X PUT",
19336         "type": "json"
19337       }
19338     ],
19339     "name": "updatePlugin",
19340     "group": "Plugins",
19341     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19342     "version": "0.0.0",
19343     "filename": "server/api/plugin/index.js",
19344     "groupTitle": "Plugins"
19345   },
19346   {
19347     "type": "post",
19348     "url": "/api/plugins",
19349     "title": "Upload new plugin",
19350     "examples": [
19351       {
19352         "title": "Example usage:",
19353         "content": "curl https://{domain}/api/plugins -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
19354         "type": "json"
19355       }
19356     ],
19357     "name": "uploadPlugin",
19358     "group": "Plugins",
19359     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19360     "version": "0.0.0",
19361     "filename": "server/api/plugin/index.js",
19362     "groupTitle": "Plugins"
19363   },
19364   {
19365     "type": "get",
19366     "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
19367     "title": "Redirect a plugin request to the specified path",
19368     "examples": [
19369       {
19370         "title": "Example usage:",
19371         "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -v -u {name}:{password} -X GET",
19372         "type": "json"
19373       }
19374     ],
19375     "name": "webhookPlugin",
19376     "group": "Plugins",
19377     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19378     "version": "0.0.0",
19379     "filename": "server/api/plugin/index.js",
19380     "groupTitle": "Plugins"
19381   },
19382   {
19383     "type": "post",
19384     "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
19385     "title": "Redirect a plugin request to the specified path",
19386     "examples": [
19387       {
19388         "title": "Example usage:",
19389         "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -H 'Content-Type: application/json' -X POST",
19390         "type": "json"
19391       }
19392     ],
19393     "name": "webhookPlugin",
19394     "group": "Plugins",
19395     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19396     "version": "0.0.0",
19397     "filename": "server/api/plugin/index.js",
19398     "groupTitle": "Plugins"
19399   },
19400   {
19401     "type": "delete",
19402     "url": "/api/pm2/{id}",
19403     "title": "Deletes an existing process",
19404     "examples": [
19405       {
19406         "title": "Example usage:",
19407         "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password} -X DELETE",
19408         "type": "json"
19409       }
19410     ],
19411     "name": "DeletePm2Process",
19412     "group": "Pm2",
19413     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19414     "version": "0.0.0",
19415     "filename": "server/api/pm2/index.js",
19416     "groupTitle": "Pm2"
19417   },
19418   {
19419     "type": "get",
19420     "url": "/api/pm2/{id}",
19421     "title": "Gets a single pm2 process",
19422     "examples": [
19423       {
19424         "title": "Example usage:",
19425         "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password}",
19426         "type": "json"
19427       }
19428     ],
19429     "name": "GetPm2Process",
19430     "group": "Pm2",
19431     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19432     "version": "0.0.0",
19433     "filename": "server/api/pm2/index.js",
19434     "groupTitle": "Pm2"
19435   },
19436   {
19437     "type": "get",
19438     "url": "/api/pm2",
19439     "title": "Gets pm2 processes",
19440     "examples": [
19441       {
19442         "title": "Example usage:",
19443         "content": "curl https://{domain}/api/pm2 -v -u {name}:{password}",
19444         "type": "json"
19445       }
19446     ],
19447     "name": "GetPm2Processes",
19448     "group": "Pm2",
19449     "description": "<p>Motion returns the pm2 processes list.</p>",
19450     "version": "0.0.0",
19451     "filename": "server/api/pm2/index.js",
19452     "groupTitle": "Pm2"
19453   },
19454   {
19455     "type": "post",
19456     "url": "/api/pm2",
19457     "title": "Start a single pm2 process",
19458     "examples": [
19459       {
19460         "title": "Example usage:",
19461         "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",
19462         "type": "json"
19463       }
19464     ],
19465     "name": "StartPm2Process",
19466     "group": "Pm2",
19467     "parameter": {
19468       "fields": {
19469         "Body": [
19470           {
19471             "group": "Body",
19472             "type": "String",
19473             "optional": false,
19474             "field": "name",
19475             "description": ""
19476           },
19477           {
19478             "group": "Body",
19479             "type": "String",
19480             "optional": false,
19481             "field": "script",
19482             "description": ""
19483           }
19484         ]
19485       }
19486     },
19487     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19488     "version": "0.0.0",
19489     "filename": "server/api/pm2/index.js",
19490     "groupTitle": "Pm2"
19491   },
19492   {
19493     "type": "put",
19494     "url": "/api/pm2/{id}",
19495     "title": "Update an existing process",
19496     "examples": [
19497       {
19498         "title": "Example usage:",
19499         "content": "curl https://{domain}/api/pm2/{id} -d '{\"status\": \"online\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
19500         "type": "json"
19501       }
19502     ],
19503     "name": "UpdatePm2Process",
19504     "group": "Pm2",
19505     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19506     "version": "0.0.0",
19507     "filename": "server/api/pm2/index.js",
19508     "groupTitle": "Pm2"
19509   },
19510   {
19511     "type": "get",
19512     "url": "/api/rpc/campaigns/",
19513     "title": "Gets a list of campaigns",
19514     "examples": [
19515       {
19516         "title": "Example usage:",
19517         "content": "curl https://{domain}/api/rpc/campaigns -v -u {name}:{password}",
19518         "type": "json"
19519       }
19520     ],
19521     "name": "Campaigns",
19522     "group": "RPC_Realtime",
19523     "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>",
19524     "version": "0.0.0",
19525     "filename": "server/api/rpc/index.js",
19526     "groupTitle": "RPC_Realtime"
19527   },
19528   {
19529     "type": "get",
19530     "url": "/api/rpc/fax/accounts",
19531     "title": "Gets a list of FaxAccounts",
19532     "examples": [
19533       {
19534         "title": "Example usage:",
19535         "content": "curl https://{domain}/api/rpc/fax/accounts -v -u {name}:{password}",
19536         "type": "json"
19537       }
19538     ],
19539     "name": "FaxAccounts",
19540     "group": "RPC_Realtime",
19541     "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>",
19542     "version": "0.0.0",
19543     "filename": "server/api/rpc/index.js",
19544     "groupTitle": "RPC_Realtime"
19545   },
19546   {
19547     "type": "put",
19548     "url": "/api/rpc/agents/:id/capacity",
19549     "title": "Sets agent capacity",
19550     "examples": [
19551       {
19552         "title": "Example usage:",
19553         "content": "curl https://{domain}/api/rpc/agents/:id/capacity -v -u {name}:{password}",
19554         "type": "json"
19555       }
19556     ],
19557     "name": "RTAgentCapacity",
19558     "group": "RPC_Realtime",
19559     "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>",
19560     "version": "0.0.0",
19561     "filename": "server/api/rpc/index.js",
19562     "groupTitle": "RPC_Realtime"
19563   },
19564   {
19565     "type": "get",
19566     "url": "/api/rpc/agents",
19567     "title": "Gets a list of RTAgents",
19568     "examples": [
19569       {
19570         "title": "Example usage:",
19571         "content": "curl https://{domain}/api/rpc/agents -v -u {name}:{password}",
19572         "type": "json"
19573       }
19574     ],
19575     "name": "RTAgents",
19576     "group": "RPC_Realtime",
19577     "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>",
19578     "version": "0.0.0",
19579     "filename": "server/api/rpc/index.js",
19580     "groupTitle": "RPC_Realtime"
19581   },
19582   {
19583     "type": "get",
19584     "url": "/api/rpc/chat/queues",
19585     "title": "Gets a list of RTChatQueues",
19586     "examples": [
19587       {
19588         "title": "Example usage:",
19589         "content": "curl https://{domain}/api/rpc/chat/queues -v -u {name}:{password}",
19590         "type": "json"
19591       }
19592     ],
19593     "name": "RTChatQueues",
19594     "group": "RPC_Realtime",
19595     "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>",
19596     "version": "0.0.0",
19597     "filename": "server/api/rpc/index.js",
19598     "groupTitle": "RPC_Realtime"
19599   },
19600   {
19601     "type": "get",
19602     "url": "/api/rpc/fax/queues",
19603     "title": "Gets a list of RTFaxQueues",
19604     "examples": [
19605       {
19606         "title": "Example usage:",
19607         "content": "curl https://{domain}/api/rpc/fax/queues -v -u {name}:{password}",
19608         "type": "json"
19609       }
19610     ],
19611     "name": "RTFaxQueues",
19612     "group": "RPC_Realtime",
19613     "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>",
19614     "version": "0.0.0",
19615     "filename": "server/api/rpc/index.js",
19616     "groupTitle": "RPC_Realtime"
19617   },
19618   {
19619     "type": "get",
19620     "url": "/api/rpc/mail/accounts",
19621     "title": "Gets a list of RTMailAccounts",
19622     "examples": [
19623       {
19624         "title": "Example usage:",
19625         "content": "curl https://{domain}/api/rpc/mail/accounts -v -u {name}:{password}",
19626         "type": "json"
19627       }
19628     ],
19629     "name": "RTMailAccounts",
19630     "group": "RPC_Realtime",
19631     "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>",
19632     "version": "0.0.0",
19633     "filename": "server/api/rpc/index.js",
19634     "groupTitle": "RPC_Realtime"
19635   },
19636   {
19637     "type": "get",
19638     "url": "/api/rpc/mail/queues",
19639     "title": "Gets a list of RTMailQueues",
19640     "examples": [
19641       {
19642         "title": "Example usage:",
19643         "content": "curl https://{domain}/api/rpc/mail/queues -v -u {name}:{password}",
19644         "type": "json"
19645       }
19646     ],
19647     "name": "RTMailQueues",
19648     "group": "RPC_Realtime",
19649     "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>",
19650     "version": "0.0.0",
19651     "filename": "server/api/rpc/index.js",
19652     "groupTitle": "RPC_Realtime"
19653   },
19654   {
19655     "type": "get",
19656     "url": "/api/rpc/openchannel/queues",
19657     "title": "Gets a list of RTOpenchannelQueues",
19658     "examples": [
19659       {
19660         "title": "Example usage:",
19661         "content": "curl https://{domain}/api/rpc/openchannel/queues -v -u {name}:{password}",
19662         "type": "json"
19663       }
19664     ],
19665     "name": "RTOpenchannelQueues",
19666     "group": "RPC_Realtime",
19667     "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>",
19668     "version": "0.0.0",
19669     "filename": "server/api/rpc/index.js",
19670     "groupTitle": "RPC_Realtime"
19671   },
19672   {
19673     "type": "get",
19674     "url": "/api/rpc/outbound/channels",
19675     "title": "Gets a list of RTOutboundChannels",
19676     "examples": [
19677       {
19678         "title": "Example usage:",
19679         "content": "curl https://{domain}/api/rpc/outbound/channels -v -u {name}:{password}",
19680         "type": "json"
19681       }
19682     ],
19683     "name": "RTOutboundChannels",
19684     "group": "RPC_Realtime",
19685     "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>",
19686     "version": "0.0.0",
19687     "filename": "server/api/rpc/index.js",
19688     "groupTitle": "RPC_Realtime"
19689   },
19690   {
19691     "type": "get",
19692     "url": "/api/rpc/sms/queues",
19693     "title": "Gets a list of RTSmsQueues",
19694     "examples": [
19695       {
19696         "title": "Example usage:",
19697         "content": "curl https://{domain}/api/rpc/sms/queues -v -u {name}:{password}",
19698         "type": "json"
19699       }
19700     ],
19701     "name": "RTSmsQueues",
19702     "group": "RPC_Realtime",
19703     "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>",
19704     "version": "0.0.0",
19705     "filename": "server/api/rpc/index.js",
19706     "groupTitle": "RPC_Realtime"
19707   },
19708   {
19709     "type": "get",
19710     "url": "/api/rpc/telephones",
19711     "title": "Gets a list of RTTelephones",
19712     "examples": [
19713       {
19714         "title": "Example usage:",
19715         "content": "curl https://{domain}/api/rpc/telephones -v -u {name}:{password}",
19716         "type": "json"
19717       }
19718     ],
19719     "name": "RTTelephones",
19720     "group": "RPC_Realtime",
19721     "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>",
19722     "version": "0.0.0",
19723     "filename": "server/api/rpc/index.js",
19724     "groupTitle": "RPC_Realtime"
19725   },
19726   {
19727     "type": "get",
19728     "url": "/api/rpc/trunks",
19729     "title": "Gets a list of RTTrunks",
19730     "examples": [
19731       {
19732         "title": "Example usage:",
19733         "content": "curl https://{domain}/api/rpc/trunks -v -u {name}:{password}",
19734         "type": "json"
19735       }
19736     ],
19737     "name": "RTTrunks",
19738     "group": "RPC_Realtime",
19739     "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>",
19740     "version": "0.0.0",
19741     "filename": "server/api/rpc/index.js",
19742     "groupTitle": "RPC_Realtime"
19743   },
19744   {
19745     "type": "get",
19746     "url": "/api/rpc/voice/channels",
19747     "title": "Gets a list of RTVoiceChannelMixMonitor",
19748     "examples": [
19749       {
19750         "title": "Example usage:",
19751         "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/mixmonitor -v -u {name}:{password}",
19752         "type": "json"
19753       }
19754     ],
19755     "name": "RTVoiceChannelMixMonitor",
19756     "group": "RPC_Realtime",
19757     "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>",
19758     "version": "0.0.0",
19759     "filename": "server/api/rpc/index.js",
19760     "groupTitle": "RPC_Realtime"
19761   },
19762   {
19763     "type": "get",
19764     "url": "/api/rpc/voice/channels",
19765     "title": "Gets a list of RTVoiceChannelStopMixMonitor",
19766     "examples": [
19767       {
19768         "title": "Example usage:",
19769         "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/stopmixmonitor -v -u {name}:{password}",
19770         "type": "json"
19771       }
19772     ],
19773     "name": "RTVoiceChannelStopMixMonitor",
19774     "group": "RPC_Realtime",
19775     "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>",
19776     "version": "0.0.0",
19777     "filename": "server/api/rpc/index.js",
19778     "groupTitle": "RPC_Realtime"
19779   },
19780   {
19781     "type": "get",
19782     "url": "/api/rpc/voice/channels",
19783     "title": "Gets a list of RTVoiceChannels",
19784     "examples": [
19785       {
19786         "title": "Example usage:",
19787         "content": "curl https://{domain}/api/rpc/voice/channels -v -u {name}:{password}",
19788         "type": "json"
19789       }
19790     ],
19791     "name": "RTVoiceChannels",
19792     "group": "RPC_Realtime",
19793     "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>",
19794     "version": "0.0.0",
19795     "filename": "server/api/rpc/index.js",
19796     "groupTitle": "RPC_Realtime"
19797   },
19798   {
19799     "type": "get",
19800     "url": "/api/rpc/voice/queues/channels/{uniqueid}",
19801     "title": "Gets a single RTVoiceQueueChannel",
19802     "examples": [
19803       {
19804         "title": "Example usage:",
19805         "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid} -v -u {name}:{password}",
19806         "type": "json"
19807       }
19808     ],
19809     "name": "RTVoiceQueueChannel",
19810     "group": "RPC_Realtime",
19811     "description": "<p>Motion will return a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19812     "version": "0.0.0",
19813     "filename": "server/api/rpc/index.js",
19814     "groupTitle": "RPC_Realtime"
19815   },
19816   {
19817     "type": "get",
19818     "url": "/api/rpc/voice/queues/channels/{uniqueid}/hangup",
19819     "title": "Hangup a single RTVoiceQueueChannel",
19820     "examples": [
19821       {
19822         "title": "Example usage:",
19823         "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/hangup -v -u {name}:{password}",
19824         "type": "json"
19825       }
19826     ],
19827     "name": "RTVoiceQueueChannelHangup",
19828     "group": "RPC_Realtime",
19829     "description": "<p>Motion will hangup a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19830     "version": "0.0.0",
19831     "filename": "server/api/rpc/index.js",
19832     "groupTitle": "RPC_Realtime"
19833   },
19834   {
19835     "type": "get",
19836     "url": "/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten}",
19837     "title": "Hangup a single RTVoiceQueueChannel",
19838     "examples": [
19839       {
19840         "title": "Example usage:",
19841         "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten} -v -u {name}:{password}",
19842         "type": "json"
19843       }
19844     ],
19845     "name": "RTVoiceQueueChannelRedirect",
19846     "group": "RPC_Realtime",
19847     "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>",
19848     "version": "0.0.0",
19849     "filename": "server/api/rpc/index.js",
19850     "groupTitle": "RPC_Realtime"
19851   },
19852   {
19853     "type": "get",
19854     "url": "/api/rpc/voice/queues/preview/{id}",
19855     "title": "Gets a single preview contact",
19856     "examples": [
19857       {
19858         "title": "Example usage:",
19859         "content": "curl https://{domain}/api/rpc/voice/queues/preview/{id} -v -u {name}:{password}",
19860         "type": "json"
19861       }
19862     ],
19863     "name": "RTVoiceQueuePreview",
19864     "group": "RPC_Realtime",
19865     "description": "<p>Motion will return a specific preview contact.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19866     "version": "0.0.0",
19867     "filename": "server/api/rpc/index.js",
19868     "groupTitle": "RPC_Realtime"
19869   },
19870   {
19871     "type": "get",
19872     "url": "/api/rpc/outbound",
19873     "title": "Gets a list of RTOutbound",
19874     "examples": [
19875       {
19876         "title": "Example usage:",
19877         "content": "curl https://{domain}/api/rpc/outbound -v -u {name}:{password}",
19878         "type": "json"
19879       }
19880     ],
19881     "name": "RTVoiceQueues",
19882     "group": "RPC_Realtime",
19883     "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>",
19884     "version": "0.0.0",
19885     "filename": "server/api/rpc/index.js",
19886     "groupTitle": "RPC_Realtime"
19887   },
19888   {
19889     "type": "get",
19890     "url": "/api/rpc/voice/queues",
19891     "title": "Gets a list of RTVoiceQueues",
19892     "examples": [
19893       {
19894         "title": "Example usage:",
19895         "content": "curl https://{domain}/api/rpc/voice/queues -v -u {name}:{password}",
19896         "type": "json"
19897       }
19898     ],
19899     "name": "RTVoiceQueues",
19900     "group": "RPC_Realtime",
19901     "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>",
19902     "version": "0.0.0",
19903     "filename": "server/api/rpc/index.js",
19904     "groupTitle": "RPC_Realtime"
19905   },
19906   {
19907     "type": "get",
19908     "url": "/api/rpc/voice/queues/channels",
19909     "title": "Gets a list of RTVoiceQueuesChannels",
19910     "examples": [
19911       {
19912         "title": "Example usage:",
19913         "content": "curl https://{domain}/api/rpc/voice/queues/channels -v -u {name}:{password}",
19914         "type": "json"
19915       }
19916     ],
19917     "name": "RTVoiceQueuesChannels",
19918     "group": "RPC_Realtime",
19919     "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>",
19920     "version": "0.0.0",
19921     "filename": "server/api/rpc/index.js",
19922     "groupTitle": "RPC_Realtime"
19923   },
19924   {
19925     "type": "get",
19926     "url": "/api/rpc/chat/queues/{id}",
19927     "title": "Gets a single RTChatQueue",
19928     "examples": [
19929       {
19930         "title": "Example usage:",
19931         "content": "curl https://{domain}/api/rpc/chat/queues/{id} -v -u {name}:{password}",
19932         "type": "json"
19933       }
19934     ],
19935     "name": "ShowRTChatQueues",
19936     "group": "RPC_Realtime",
19937     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19938     "version": "0.0.0",
19939     "filename": "server/api/rpc/index.js",
19940     "groupTitle": "RPC_Realtime"
19941   },
19942   {
19943     "type": "get",
19944     "url": "/api/rpc/fax/queues/{id}",
19945     "title": "Gets a single RTFaxQueue",
19946     "examples": [
19947       {
19948         "title": "Example usage:",
19949         "content": "curl https://{domain}/api/rpc/fax/queues/{id} -v -u {name}:{password}",
19950         "type": "json"
19951       }
19952     ],
19953     "name": "ShowRTFaxQueues",
19954     "group": "RPC_Realtime",
19955     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19956     "version": "0.0.0",
19957     "filename": "server/api/rpc/index.js",
19958     "groupTitle": "RPC_Realtime"
19959   },
19960   {
19961     "type": "get",
19962     "url": "/api/rpc/mail/queues/{id}",
19963     "title": "Gets a single RTMailQueue",
19964     "examples": [
19965       {
19966         "title": "Example usage:",
19967         "content": "curl https://{domain}/api/rpc/mail/queues/{id} -v -u {name}:{password}",
19968         "type": "json"
19969       }
19970     ],
19971     "name": "ShowRTMailQueues",
19972     "group": "RPC_Realtime",
19973     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19974     "version": "0.0.0",
19975     "filename": "server/api/rpc/index.js",
19976     "groupTitle": "RPC_Realtime"
19977   },
19978   {
19979     "type": "get",
19980     "url": "/api/rpc/openchannel/queues/{id}",
19981     "title": "Gets a single RTOpenchannelQueue",
19982     "examples": [
19983       {
19984         "title": "Example usage:",
19985         "content": "curl https://{domain}/api/rpc/openchannel/queues/{id} -v -u {name}:{password}",
19986         "type": "json"
19987       }
19988     ],
19989     "name": "ShowRTOpenchannelQueues",
19990     "group": "RPC_Realtime",
19991     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19992     "version": "0.0.0",
19993     "filename": "server/api/rpc/index.js",
19994     "groupTitle": "RPC_Realtime"
19995   },
19996   {
19997     "type": "get",
19998     "url": "/api/rpc/sms/queues/{id}",
19999     "title": "Gets a single RTSmsQueue",
20000     "examples": [
20001       {
20002         "title": "Example usage:",
20003         "content": "curl https://{domain}/api/rpc/sms/queues/{id} -v -u {name}:{password}",
20004         "type": "json"
20005       }
20006     ],
20007     "name": "ShowRTSmsQueues",
20008     "group": "RPC_Realtime",
20009     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20010     "version": "0.0.0",
20011     "filename": "server/api/rpc/index.js",
20012     "groupTitle": "RPC_Realtime"
20013   },
20014   {
20015     "type": "get",
20016     "url": "/api/rpc/voice/queues/{id}",
20017     "title": "Gets a single RTVoiceQueue",
20018     "examples": [
20019       {
20020         "title": "Example usage:",
20021         "content": "curl https://{domain}/api/rpc/voice/queues/{id} -v -u {name}:{password}",
20022         "type": "json"
20023       }
20024     ],
20025     "name": "ShowRTVoiceQueues",
20026     "group": "RPC_Realtime",
20027     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20028     "version": "0.0.0",
20029     "filename": "server/api/rpc/index.js",
20030     "groupTitle": "RPC_Realtime"
20031   },
20032   {
20033     "type": "post",
20034     "url": "/api/rpc/agents/:id/notify",
20035     "title": "Notify message to a specific agent",
20036     "examples": [
20037       {
20038         "title": "Example usage:",
20039         "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",
20040         "type": "json"
20041       }
20042     ],
20043     "name": "agentNotify",
20044     "group": "RPC_Realtime",
20045     "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>",
20046     "version": "0.0.0",
20047     "filename": "server/api/rpc/index.js",
20048     "groupTitle": "RPC_Realtime"
20049   },
20050   {
20051     "type": "post",
20052     "url": "/api/rpc/chat/queues/:id/notify",
20053     "title": "Notify message to a specific queue",
20054     "examples": [
20055       {
20056         "title": "Example usage:",
20057         "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",
20058         "type": "json"
20059       }
20060     ],
20061     "name": "chatQueueNotify",
20062     "group": "RPC_Realtime",
20063     "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>",
20064     "version": "0.0.0",
20065     "filename": "server/api/rpc/index.js",
20066     "groupTitle": "RPC_Realtime"
20067   },
20068   {
20069     "type": "get",
20070     "url": "/api/rpc/chat/queues/waitinginteractions",
20071     "title": "Gets a list of chatQueuesWaitingInteractions",
20072     "examples": [
20073       {
20074         "title": "Example usage:",
20075         "content": "curl https://{domain}/api/rpc/chat/queues/waitinginteractions -v -u {name}:{password}",
20076         "type": "json"
20077       }
20078     ],
20079     "name": "chatQueuesWaitingInteractions",
20080     "group": "RPC_Realtime",
20081     "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>",
20082     "version": "0.0.0",
20083     "filename": "server/api/rpc/index.js",
20084     "groupTitle": "RPC_Realtime"
20085   },
20086   {
20087     "type": "post",
20088     "url": "/api/rpc/fax/queues/:id/notify",
20089     "title": "Notify message to a specific queue",
20090     "examples": [
20091       {
20092         "title": "Example usage:",
20093         "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",
20094         "type": "json"
20095       }
20096     ],
20097     "name": "faxQueueNotify",
20098     "group": "RPC_Realtime",
20099     "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>",
20100     "version": "0.0.0",
20101     "filename": "server/api/rpc/index.js",
20102     "groupTitle": "RPC_Realtime"
20103   },
20104   {
20105     "type": "get",
20106     "url": "/api/rpc/fax/queues/waitinginteractions",
20107     "title": "Gets a list of faxQueuesWaitingInteractions",
20108     "examples": [
20109       {
20110         "title": "Example usage:",
20111         "content": "curl https://{domain}/api/rpc/fax/queues/waitinginteractions -v -u {name}:{password}",
20112         "type": "json"
20113       }
20114     ],
20115     "name": "faxQueuesWaitingInteractions",
20116     "group": "RPC_Realtime",
20117     "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>",
20118     "version": "0.0.0",
20119     "filename": "server/api/rpc/index.js",
20120     "groupTitle": "RPC_Realtime"
20121   },
20122   {
20123     "type": "post",
20124     "url": "/api/rpc/mail/queues/:id/notify",
20125     "title": "Notify message to a specific queue",
20126     "examples": [
20127       {
20128         "title": "Example usage:",
20129         "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",
20130         "type": "json"
20131       }
20132     ],
20133     "name": "mailQueueNotify",
20134     "group": "RPC_Realtime",
20135     "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>",
20136     "version": "0.0.0",
20137     "filename": "server/api/rpc/index.js",
20138     "groupTitle": "RPC_Realtime"
20139   },
20140   {
20141     "type": "get",
20142     "url": "/api/rpc/mail/queues/waitinginteractions",
20143     "title": "Gets a list of mailQueuesWaitingInteractions",
20144     "examples": [
20145       {
20146         "title": "Example usage:",
20147         "content": "curl https://{domain}/api/rpc/mail/queues/waitinginteractions -v -u {name}:{password}",
20148         "type": "json"
20149       }
20150     ],
20151     "name": "mailQueuesWaitingInteractions",
20152     "group": "RPC_Realtime",
20153     "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>",
20154     "version": "0.0.0",
20155     "filename": "server/api/rpc/index.js",
20156     "groupTitle": "RPC_Realtime"
20157   },
20158   {
20159     "type": "post",
20160     "url": "/api/rpc/openchannel/queues/:id/notify",
20161     "title": "Notify message to a specific queue",
20162     "examples": [
20163       {
20164         "title": "Example usage:",
20165         "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",
20166         "type": "json"
20167       }
20168     ],
20169     "name": "openchannelQueueNotify",
20170     "group": "RPC_Realtime",
20171     "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>",
20172     "version": "0.0.0",
20173     "filename": "server/api/rpc/index.js",
20174     "groupTitle": "RPC_Realtime"
20175   },
20176   {
20177     "type": "get",
20178     "url": "/api/rpc/openchannel/queues/:id/waitinginteractions",
20179     "title": "Gets a list of openchannelQueuesIdWaitingInteractions",
20180     "examples": [
20181       {
20182         "title": "Example usage:",
20183         "content": "curl https://{domain}/api/rpc/openchannel/queues/:id/waitinginteractions -v -u {name}:{password}",
20184         "type": "json"
20185       }
20186     ],
20187     "name": "openchannelQueuesIdWaitingInteractions",
20188     "group": "RPC_Realtime",
20189     "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>",
20190     "version": "0.0.0",
20191     "filename": "server/api/rpc/index.js",
20192     "groupTitle": "RPC_Realtime"
20193   },
20194   {
20195     "type": "get",
20196     "url": "/api/rpc/openchannel/queues/waitinginteractions",
20197     "title": "Gets a list of openchannelQueuesWaitingInteractions",
20198     "examples": [
20199       {
20200         "title": "Example usage:",
20201         "content": "curl https://{domain}/api/rpc/openchannel/queues/waitinginteractions -v -u {name}:{password}",
20202         "type": "json"
20203       }
20204     ],
20205     "name": "openchannelQueuesWaitingInteractions",
20206     "group": "RPC_Realtime",
20207     "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>",
20208     "version": "0.0.0",
20209     "filename": "server/api/rpc/index.js",
20210     "groupTitle": "RPC_Realtime"
20211   },
20212   {
20213     "type": "post",
20214     "url": "/api/rpc/sms/queues/:id/notify",
20215     "title": "Notify message to a specific queue",
20216     "examples": [
20217       {
20218         "title": "Example usage:",
20219         "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",
20220         "type": "json"
20221       }
20222     ],
20223     "name": "smsQueueNotify",
20224     "group": "RPC_Realtime",
20225     "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>",
20226     "version": "0.0.0",
20227     "filename": "server/api/rpc/index.js",
20228     "groupTitle": "RPC_Realtime"
20229   },
20230   {
20231     "type": "get",
20232     "url": "/api/rpc/sms/queues/waitinginteractions",
20233     "title": "Gets a list of smsQueuesWaitingInteractions",
20234     "examples": [
20235       {
20236         "title": "Example usage:",
20237         "content": "curl https://{domain}/api/rpc/sms/queues/waitinginteractions -v -u {name}:{password}",
20238         "type": "json"
20239       }
20240     ],
20241     "name": "smsQueuesWaitingInteractions",
20242     "group": "RPC_Realtime",
20243     "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>",
20244     "version": "0.0.0",
20245     "filename": "server/api/rpc/index.js",
20246     "groupTitle": "RPC_Realtime"
20247   },
20248   {
20249     "type": "post",
20250     "url": "/api/integrations/salesforce/accounts",
20251     "title": "Creates a new Salesforce Account",
20252     "examples": [
20253       {
20254         "title": "Example usage:",
20255         "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",
20256         "type": "json"
20257       }
20258     ],
20259     "name": "CreateSalesforce_Accounts",
20260     "group": "Salesforce_Accounts",
20261     "parameter": {
20262       "fields": {
20263         "Body": [
20264           {
20265             "group": "Body",
20266             "type": "String",
20267             "optional": true,
20268             "field": "name",
20269             "description": ""
20270           },
20271           {
20272             "group": "Body",
20273             "type": "String",
20274             "optional": true,
20275             "field": "description",
20276             "description": ""
20277           },
20278           {
20279             "group": "Body",
20280             "type": "String",
20281             "optional": true,
20282             "field": "username",
20283             "description": ""
20284           },
20285           {
20286             "group": "Body",
20287             "type": "String",
20288             "optional": true,
20289             "field": "remoteUri",
20290             "description": ""
20291           },
20292           {
20293             "group": "Body",
20294             "type": "String",
20295             "optional": true,
20296             "field": "password",
20297             "description": ""
20298           },
20299           {
20300             "group": "Body",
20301             "type": "String",
20302             "optional": true,
20303             "field": "clientId",
20304             "description": ""
20305           },
20306           {
20307             "group": "Body",
20308             "type": "String",
20309             "optional": true,
20310             "field": "clientSecret",
20311             "description": ""
20312           },
20313           {
20314             "group": "Body",
20315             "type": "String",
20316             "optional": true,
20317             "field": "securityToken",
20318             "description": ""
20319           },
20320           {
20321             "group": "Body",
20322             "type": "String",
20323             "optional": false,
20324             "field": "serverUrl",
20325             "description": ""
20326           },
20327           {
20328             "group": "Body",
20329             "type": "String",
20330             "allowedValues": [
20331               "\"integrationTab\"",
20332               "\"newTab\""
20333             ],
20334             "optional": true,
20335             "field": "type",
20336             "description": ""
20337           }
20338         ]
20339       }
20340     },
20341     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20342     "version": "0.0.0",
20343     "filename": "server/api/intSalesforceAccount/index.js",
20344     "groupTitle": "Salesforce_Accounts"
20345   },
20346   {
20347     "type": "delete",
20348     "url": "/api/integrations/salesforce/accounts/{id}",
20349     "title": "Deletes a Salesforce Account",
20350     "examples": [
20351       {
20352         "title": "Example usage:",
20353         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password} -X DELETE",
20354         "type": "json"
20355       }
20356     ],
20357     "name": "DeleteSalesforce_Accounts",
20358     "group": "Salesforce_Accounts",
20359     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20360     "version": "0.0.0",
20361     "filename": "server/api/intSalesforceAccount/index.js",
20362     "groupTitle": "Salesforce_Accounts"
20363   },
20364   {
20365     "type": "get",
20366     "url": "/api/integrations/salesforce/accounts",
20367     "title": "Gets a list of Salesforce Accounts",
20368     "examples": [
20369       {
20370         "title": "Example usage:",
20371         "content": "curl https://{domain}/api/integrations/salesforce/accounts -v -u {name}:{password}",
20372         "type": "json"
20373       }
20374     ],
20375     "name": "GetSalesforce_Accounts",
20376     "group": "Salesforce_Accounts",
20377     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20378     "version": "0.0.0",
20379     "filename": "server/api/intSalesforceAccount/index.js",
20380     "groupTitle": "Salesforce_Accounts"
20381   },
20382   {
20383     "type": "get",
20384     "url": "/api/integrations/salesforce/accounts/{id}",
20385     "title": "Gets a single Salesforce Account",
20386     "examples": [
20387       {
20388         "title": "Example usage:",
20389         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password}",
20390         "type": "json"
20391       }
20392     ],
20393     "name": "ShowSalesforce_Accounts",
20394     "group": "Salesforce_Accounts",
20395     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20396     "version": "0.0.0",
20397     "filename": "server/api/intSalesforceAccount/index.js",
20398     "groupTitle": "Salesforce_Accounts"
20399   },
20400   {
20401     "type": "post",
20402     "url": "/api/integrations/salesforce/accounts/{id}/configurations",
20403     "title": "Creates new configuration",
20404     "examples": [
20405       {
20406         "title": "Example usage:",
20407         "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",
20408         "type": "json"
20409       }
20410     ],
20411     "name": "addConfiguration",
20412     "group": "Salesforce_Accounts",
20413     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20414     "version": "0.0.0",
20415     "filename": "server/api/intSalesforceAccount/index.js",
20416     "groupTitle": "Salesforce_Accounts"
20417   },
20418   {
20419     "type": "get",
20420     "url": "/api/integrations/salesforce/accounts/{id}/configurations",
20421     "title": "Gets account configurations",
20422     "examples": [
20423       {
20424         "title": "Example usage:",
20425         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/configurations -v -u {name}:{password} -X GET",
20426         "type": "json"
20427       }
20428     ],
20429     "name": "getConfigurations",
20430     "group": "Salesforce_Accounts",
20431     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20432     "version": "0.0.0",
20433     "filename": "server/api/intSalesforceAccount/index.js",
20434     "groupTitle": "Salesforce_Accounts"
20435   },
20436   {
20437     "type": "get",
20438     "url": "/api/integrations/salesforce/accounts/{id}/fields",
20439     "title": "Gets account fields",
20440     "examples": [
20441       {
20442         "title": "Example usage:",
20443         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/fields -v -u {name}:{password} -X GET",
20444         "type": "json"
20445       }
20446     ],
20447     "name": "getFields",
20448     "group": "Salesforce_Accounts",
20449     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20450     "version": "0.0.0",
20451     "filename": "server/api/intSalesforceAccount/index.js",
20452     "groupTitle": "Salesforce_Accounts"
20453   },
20454   {
20455     "type": "put",
20456     "url": "/api/integrations/salesforce/accounts/{id}",
20457     "title": "Update an existing Salesforce Account",
20458     "examples": [
20459       {
20460         "title": "Example usage:",
20461         "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",
20462         "type": "json"
20463       }
20464     ],
20465     "name": "updateSalesforce_Accounts",
20466     "group": "Salesforce_Accounts",
20467     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20468     "version": "0.0.0",
20469     "filename": "server/api/intSalesforceAccount/index.js",
20470     "groupTitle": "Salesforce_Accounts"
20471   },
20472   {
20473     "type": "post",
20474     "url": "/api/integrations/salesforce/configurations",
20475     "title": "Creates a new Salesforce Configuration",
20476     "examples": [
20477       {
20478         "title": "Example usage:",
20479         "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",
20480         "type": "json"
20481       }
20482     ],
20483     "name": "CreateSalesforce_Configurations",
20484     "group": "Salesforce_Configurations",
20485     "parameter": {
20486       "fields": {
20487         "Body": [
20488           {
20489             "group": "Body",
20490             "type": "String",
20491             "optional": true,
20492             "field": "name",
20493             "description": ""
20494           },
20495           {
20496             "group": "Body",
20497             "type": "String",
20498             "optional": true,
20499             "field": "description",
20500             "description": ""
20501           },
20502           {
20503             "group": "Body",
20504             "type": "String",
20505             "allowedValues": [
20506               "\"Task\"",
20507               "\"Case\""
20508             ],
20509             "optional": true,
20510             "field": "ticketType",
20511             "description": ""
20512           },
20513           {
20514             "group": "Body",
20515             "type": "String",
20516             "allowedValues": [
20517               "\"contact_lead\"",
20518               "\"contact\"",
20519               "\"lead\""
20520             ],
20521             "optional": true,
20522             "field": "moduleSearch",
20523             "description": ""
20524           },
20525           {
20526             "group": "Body",
20527             "type": "String",
20528             "allowedValues": [
20529               "\"nothing\"",
20530               "\"contact\"",
20531               "\"lead\""
20532             ],
20533             "optional": true,
20534             "field": "moduleCreate",
20535             "description": ""
20536           }
20537         ]
20538       }
20539     },
20540     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20541     "version": "0.0.0",
20542     "filename": "server/api/intSalesforceConfiguration/index.js",
20543     "groupTitle": "Salesforce_Configurations"
20544   },
20545   {
20546     "type": "delete",
20547     "url": "/api/integrations/salesforce/configurations/{id}",
20548     "title": "Deletes a Salesforce Configuration",
20549     "examples": [
20550       {
20551         "title": "Example usage:",
20552         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password} -X DELETE",
20553         "type": "json"
20554       }
20555     ],
20556     "name": "DeleteSalesforce_Configurations",
20557     "group": "Salesforce_Configurations",
20558     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20559     "version": "0.0.0",
20560     "filename": "server/api/intSalesforceConfiguration/index.js",
20561     "groupTitle": "Salesforce_Configurations"
20562   },
20563   {
20564     "type": "get",
20565     "url": "/api/integrations/salesforce/configurations",
20566     "title": "Gets a list of Salesforce Configurations",
20567     "examples": [
20568       {
20569         "title": "Example usage:",
20570         "content": "curl https://{domain}/api/integrations/salesforce/configurations -v -u {name}:{password}",
20571         "type": "json"
20572       }
20573     ],
20574     "name": "GetSalesforce_Configurations",
20575     "group": "Salesforce_Configurations",
20576     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20577     "version": "0.0.0",
20578     "filename": "server/api/intSalesforceConfiguration/index.js",
20579     "groupTitle": "Salesforce_Configurations"
20580   },
20581   {
20582     "type": "get",
20583     "url": "/api/integrations/salesforce/configurations/{id}",
20584     "title": "Gets a single Salesforce Configuration",
20585     "examples": [
20586       {
20587         "title": "Example usage:",
20588         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password}",
20589         "type": "json"
20590       }
20591     ],
20592     "name": "ShowSalesforce_Configurations",
20593     "group": "Salesforce_Configurations",
20594     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20595     "version": "0.0.0",
20596     "filename": "server/api/intSalesforceConfiguration/index.js",
20597     "groupTitle": "Salesforce_Configurations"
20598   },
20599   {
20600     "type": "get",
20601     "url": "/api/integrations/salesforce/configurations/{id}/descriptions",
20602     "title": "Gets configurations descriptions",
20603     "examples": [
20604       {
20605         "title": "Example usage:",
20606         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
20607         "type": "json"
20608       }
20609     ],
20610     "name": "getDescriptions",
20611     "group": "Salesforce_Configurations",
20612     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20613     "version": "0.0.0",
20614     "filename": "server/api/intSalesforceConfiguration/index.js",
20615     "groupTitle": "Salesforce_Configurations"
20616   },
20617   {
20618     "type": "get",
20619     "url": "/api/integrations/salesforce/configurations/{id}/fields",
20620     "title": "Gets configurations fields",
20621     "examples": [
20622       {
20623         "title": "Example usage:",
20624         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/fields -v -u {name}:{password} -X GET",
20625         "type": "json"
20626       }
20627     ],
20628     "name": "getFields",
20629     "group": "Salesforce_Configurations",
20630     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20631     "version": "0.0.0",
20632     "filename": "server/api/intSalesforceConfiguration/index.js",
20633     "groupTitle": "Salesforce_Configurations"
20634   },
20635   {
20636     "type": "get",
20637     "url": "/api/integrations/salesforce/configurations/{id}/subjects",
20638     "title": "Gets configurations subjects",
20639     "examples": [
20640       {
20641         "title": "Example usage:",
20642         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/subjects -v -u {name}:{password} -X GET",
20643         "type": "json"
20644       }
20645     ],
20646     "name": "getSubjects",
20647     "group": "Salesforce_Configurations",
20648     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20649     "version": "0.0.0",
20650     "filename": "server/api/intSalesforceConfiguration/index.js",
20651     "groupTitle": "Salesforce_Configurations"
20652   },
20653   {
20654     "type": "put",
20655     "url": "/api/integrations/salesforce/configurations/{id}",
20656     "title": "Update an existing Salesforce Configuration",
20657     "examples": [
20658       {
20659         "title": "Example usage:",
20660         "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",
20661         "type": "json"
20662       }
20663     ],
20664     "name": "updateSalesforce_Configurations",
20665     "group": "Salesforce_Configurations",
20666     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20667     "version": "0.0.0",
20668     "filename": "server/api/intSalesforceConfiguration/index.js",
20669     "groupTitle": "Salesforce_Configurations"
20670   },
20671   {
20672     "type": "post",
20673     "url": "/api/integrations/salesforce/fields",
20674     "title": "Creates a new Salesforce Field",
20675     "examples": [
20676       {
20677         "title": "Example usage:",
20678         "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",
20679         "type": "json"
20680       }
20681     ],
20682     "name": "CreateSalesforce_Fields",
20683     "group": "Salesforce_Fields",
20684     "parameter": {
20685       "fields": {
20686         "Body": [
20687           {
20688             "group": "Body",
20689             "type": "String",
20690             "allowedValues": [
20691               "\"string\"",
20692               "\"variable\"",
20693               "\"customVariable\"",
20694               "\"keyValue\""
20695             ],
20696             "optional": true,
20697             "field": "type",
20698             "description": ""
20699           },
20700           {
20701             "group": "Body",
20702             "type": "String",
20703             "optional": true,
20704             "field": "content",
20705             "description": ""
20706           },
20707           {
20708             "group": "Body",
20709             "type": "String",
20710             "optional": true,
20711             "field": "key",
20712             "description": ""
20713           },
20714           {
20715             "group": "Body",
20716             "type": "String",
20717             "allowedValues": [
20718               "\"string\"",
20719               "\"variable\"",
20720               "\"customVariable\""
20721             ],
20722             "optional": true,
20723             "field": "keyType",
20724             "description": ""
20725           },
20726           {
20727             "group": "Body",
20728             "type": "String",
20729             "optional": true,
20730             "field": "keyContent",
20731             "description": ""
20732           },
20733           {
20734             "group": "Body",
20735             "type": "String",
20736             "optional": true,
20737             "field": "idField",
20738             "description": ""
20739           },
20740           {
20741             "group": "Body",
20742             "type": "String",
20743             "optional": true,
20744             "field": "variableName",
20745             "description": ""
20746           }
20747         ]
20748       }
20749     },
20750     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20751     "version": "0.0.0",
20752     "filename": "server/api/intSalesforceField/index.js",
20753     "groupTitle": "Salesforce_Fields"
20754   },
20755   {
20756     "type": "delete",
20757     "url": "/api/integrations/salesforce/fields/{id}",
20758     "title": "Deletes a Salesforce Field",
20759     "examples": [
20760       {
20761         "title": "Example usage:",
20762         "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password} -X DELETE",
20763         "type": "json"
20764       }
20765     ],
20766     "name": "DeleteSalesforce_Fields",
20767     "group": "Salesforce_Fields",
20768     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20769     "version": "0.0.0",
20770     "filename": "server/api/intSalesforceField/index.js",
20771     "groupTitle": "Salesforce_Fields"
20772   },
20773   {
20774     "type": "get",
20775     "url": "/api/integrations/salesforce/fields",
20776     "title": "Gets a list of Salesforce Fields",
20777     "examples": [
20778       {
20779         "title": "Example usage:",
20780         "content": "curl https://{domain}/api/integrations/salesforce/fields -v -u {name}:{password}",
20781         "type": "json"
20782       }
20783     ],
20784     "name": "GetSalesforce_Fields",
20785     "group": "Salesforce_Fields",
20786     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20787     "version": "0.0.0",
20788     "filename": "server/api/intSalesforceField/index.js",
20789     "groupTitle": "Salesforce_Fields"
20790   },
20791   {
20792     "type": "get",
20793     "url": "/api/integrations/salesforce/fields/{id}",
20794     "title": "Gets a single Salesforce Field",
20795     "examples": [
20796       {
20797         "title": "Example usage:",
20798         "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password}",
20799         "type": "json"
20800       }
20801     ],
20802     "name": "ShowSalesforce_Fields",
20803     "group": "Salesforce_Fields",
20804     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20805     "version": "0.0.0",
20806     "filename": "server/api/intSalesforceField/index.js",
20807     "groupTitle": "Salesforce_Fields"
20808   },
20809   {
20810     "type": "put",
20811     "url": "/api/integrations/salesforce/fields/{id}",
20812     "title": "Update an existing Salesforce Field",
20813     "examples": [
20814       {
20815         "title": "Example usage:",
20816         "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",
20817         "type": "json"
20818       }
20819     ],
20820     "name": "updateSalesforce_Fields",
20821     "group": "Salesforce_Fields",
20822     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20823     "version": "0.0.0",
20824     "filename": "server/api/intSalesforceField/index.js",
20825     "groupTitle": "Salesforce_Fields"
20826   },
20827   {
20828     "type": "post",
20829     "url": "/api/schedules",
20830     "title": "Creates a new Schedule",
20831     "examples": [
20832       {
20833         "title": "Example usage:",
20834         "content": "curl https://{domain}/api/schedules -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
20835         "type": "json"
20836       }
20837     ],
20838     "name": "CreateSchedules",
20839     "group": "Schedules",
20840     "parameter": {
20841       "fields": {
20842         "Body": [
20843           {
20844             "group": "Body",
20845             "type": "String",
20846             "optional": false,
20847             "field": "name",
20848             "description": ""
20849           },
20850           {
20851             "group": "Body",
20852             "type": "String",
20853             "optional": true,
20854             "field": "description",
20855             "description": ""
20856           },
20857           {
20858             "group": "Body",
20859             "type": "Boolean",
20860             "optional": false,
20861             "field": "active",
20862             "description": ""
20863           },
20864           {
20865             "group": "Body",
20866             "type": "String",
20867             "optional": false,
20868             "field": "cron",
20869             "description": ""
20870           },
20871           {
20872             "group": "Body",
20873             "type": "String",
20874             "optional": false,
20875             "field": "startAt",
20876             "description": ""
20877           },
20878           {
20879             "group": "Body",
20880             "type": "String",
20881             "optional": false,
20882             "field": "endAt",
20883             "description": ""
20884           },
20885           {
20886             "group": "Body",
20887             "type": "Integer",
20888             "optional": false,
20889             "field": "subtractNumber",
20890             "description": ""
20891           },
20892           {
20893             "group": "Body",
20894             "type": "String",
20895             "allowedValues": [
20896               "\"years\"",
20897               "\"quarters\"",
20898               "\"months\"",
20899               "\"weeks\"",
20900               "\"days\"",
20901               "\"hours\"",
20902               "\"minutes\""
20903             ],
20904             "optional": false,
20905             "field": "subtractUnit",
20906             "description": ""
20907           },
20908           {
20909             "group": "Body",
20910             "type": "String",
20911             "allowedValues": [
20912               "\"csv\"",
20913               "\"pdf\"",
20914               "\"xlsx\""
20915             ],
20916             "optional": false,
20917             "field": "output",
20918             "description": ""
20919           },
20920           {
20921             "group": "Body",
20922             "type": "String",
20923             "allowedValues": [
20924               "\"custom\"",
20925               "\"default\""
20926             ],
20927             "optional": false,
20928             "field": "type",
20929             "description": ""
20930           },
20931           {
20932             "group": "Body",
20933             "type": "Boolean",
20934             "optional": true,
20935             "field": "sendMail",
20936             "description": ""
20937           },
20938           {
20939             "group": "Body",
20940             "type": "String",
20941             "optional": true,
20942             "field": "email",
20943             "description": ""
20944           },
20945           {
20946             "group": "Body",
20947             "type": "Text",
20948             "optional": true,
20949             "field": "cc",
20950             "description": ""
20951           },
20952           {
20953             "group": "Body",
20954             "type": "Text",
20955             "optional": true,
20956             "field": "bcc",
20957             "description": ""
20958           },
20959           {
20960             "group": "Body",
20961             "type": "Boolean",
20962             "optional": true,
20963             "field": "sendIfEmpty",
20964             "description": ""
20965           }
20966         ]
20967       }
20968     },
20969     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20970     "version": "0.0.0",
20971     "filename": "server/api/schedule/index.js",
20972     "groupTitle": "Schedules"
20973   },
20974   {
20975     "type": "delete",
20976     "url": "/api/schedules/{id}",
20977     "title": "Deletes a Schedule",
20978     "examples": [
20979       {
20980         "title": "Example usage:",
20981         "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password} -X DELETE",
20982         "type": "json"
20983       }
20984     ],
20985     "name": "DeleteSchedules",
20986     "group": "Schedules",
20987     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20988     "version": "0.0.0",
20989     "filename": "server/api/schedule/index.js",
20990     "groupTitle": "Schedules"
20991   },
20992   {
20993     "type": "get",
20994     "url": "/api/schedules",
20995     "title": "Gets a list of Schedules",
20996     "examples": [
20997       {
20998         "title": "Example usage:",
20999         "content": "curl https://{domain}/api/schedules -v -u {name}:{password}",
21000         "type": "json"
21001       }
21002     ],
21003     "name": "GetSchedules",
21004     "group": "Schedules",
21005     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21006     "version": "0.0.0",
21007     "filename": "server/api/schedule/index.js",
21008     "groupTitle": "Schedules"
21009   },
21010   {
21011     "type": "get",
21012     "url": "/api/schedules/{id}",
21013     "title": "Gets a single Schedule",
21014     "examples": [
21015       {
21016         "title": "Example usage:",
21017         "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password}",
21018         "type": "json"
21019       }
21020     ],
21021     "name": "ShowSchedules",
21022     "group": "Schedules",
21023     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21024     "version": "0.0.0",
21025     "filename": "server/api/schedule/index.js",
21026     "groupTitle": "Schedules"
21027   },
21028   {
21029     "type": "get",
21030     "url": "/api/schedules/{id}/run",
21031     "title": "Run Scheduler",
21032     "examples": [
21033       {
21034         "title": "Example usage:",
21035         "content": "curl https://{domain}/api/schedules/{id}/run -v -u {name}:{password} -X GET",
21036         "type": "json"
21037       }
21038     ],
21039     "name": "run",
21040     "group": "Schedules",
21041     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21042     "version": "0.0.0",
21043     "filename": "server/api/schedule/index.js",
21044     "groupTitle": "Schedules"
21045   },
21046   {
21047     "type": "put",
21048     "url": "/api/schedules/{id}",
21049     "title": "Update an existing Schedule",
21050     "examples": [
21051       {
21052         "title": "Example usage:",
21053         "content": "curl https://{domain}/api/schedules/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
21054         "type": "json"
21055       }
21056     ],
21057     "name": "updateSchedules",
21058     "group": "Schedules",
21059     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21060     "version": "0.0.0",
21061     "filename": "server/api/schedule/index.js",
21062     "groupTitle": "Schedules"
21063   },
21064   {
21065     "type": "post",
21066     "url": "/api/screen/recordings",
21067     "title": "Creates a new Recording",
21068     "examples": [
21069       {
21070         "title": "Example usage:",
21071         "content": "curl https://{domain}/api/screen/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
21072         "type": "json"
21073       }
21074     ],
21075     "name": "CreateRecordings",
21076     "group": "Screen_Recordings",
21077     "parameter": {
21078       "fields": {
21079         "Body": [
21080           {
21081             "group": "Body",
21082             "type": "Virtual",
21083             "optional": true,
21084             "field": "format",
21085             "description": ""
21086           },
21087           {
21088             "group": "Body",
21089             "type": "String",
21090             "optional": true,
21091             "field": "interactionid",
21092             "description": ""
21093           },
21094           {
21095             "group": "Body",
21096             "type": "String",
21097             "optional": true,
21098             "field": "channel",
21099             "description": ""
21100           },
21101           {
21102             "group": "Body",
21103             "type": "String",
21104             "optional": true,
21105             "field": "value",
21106             "description": ""
21107           },
21108           {
21109             "group": "Body",
21110             "type": "Integer",
21111             "optional": true,
21112             "field": "rating",
21113             "description": ""
21114           },
21115           {
21116             "group": "Body",
21117             "type": "Integer",
21118             "optional": true,
21119             "field": "duration",
21120             "description": ""
21121           },
21122           {
21123             "group": "Body",
21124             "type": "String",
21125             "optional": true,
21126             "field": "startedAt",
21127             "description": ""
21128           },
21129           {
21130             "group": "Body",
21131             "type": "String",
21132             "optional": true,
21133             "field": "closedAt",
21134             "description": ""
21135           },
21136           {
21137             "group": "Body",
21138             "type": "String",
21139             "optional": true,
21140             "field": "createdAt",
21141             "description": ""
21142           },
21143           {
21144             "group": "Body",
21145             "type": "String",
21146             "optional": true,
21147             "field": "updatedAt",
21148             "description": ""
21149           }
21150         ]
21151       }
21152     },
21153     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21154     "version": "0.0.0",
21155     "filename": "server/api/screenRecording/index.js",
21156     "groupTitle": "Screen_Recordings"
21157   },
21158   {
21159     "type": "get",
21160     "url": "/api/screen/recordings/describe",
21161     "title": "Gets table info about Recordings",
21162     "examples": [
21163       {
21164         "title": "Example usage:",
21165         "content": "curl https://{domain}/api/screen/recordings/describe -v -u {name}:{password}",
21166         "type": "json"
21167       }
21168     ],
21169     "name": "DescribeRecordings",
21170     "group": "Screen_Recordings",
21171     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21172     "version": "0.0.0",
21173     "filename": "server/api/screenRecording/index.js",
21174     "groupTitle": "Screen_Recordings"
21175   },
21176   {
21177     "type": "get",
21178     "url": "/api/screen/recordings",
21179     "title": "Gets a list of Recordings",
21180     "examples": [
21181       {
21182         "title": "Example usage:",
21183         "content": "curl https://{domain}/api/screen/recordings -v -u {name}:{password}",
21184         "type": "json"
21185       }
21186     ],
21187     "name": "GetRecordings",
21188     "group": "Screen_Recordings",
21189     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21190     "version": "0.0.0",
21191     "filename": "server/api/screenRecording/index.js",
21192     "groupTitle": "Screen_Recordings"
21193   },
21194   {
21195     "type": "get",
21196     "url": "/api/screen/recordings/{id}",
21197     "title": "Gets a single Recording",
21198     "examples": [
21199       {
21200         "title": "Example usage:",
21201         "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password}",
21202         "type": "json"
21203       }
21204     ],
21205     "name": "ShowRecordings",
21206     "group": "Screen_Recordings",
21207     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21208     "version": "0.0.0",
21209     "filename": "server/api/screenRecording/index.js",
21210     "groupTitle": "Screen_Recordings"
21211   },
21212   {
21213     "type": "delete",
21214     "url": "/api/screen/recordings/{id}",
21215     "title": "Delete screen recording",
21216     "examples": [
21217       {
21218         "title": "Example usage:",
21219         "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password} -X DELETE",
21220         "type": "json"
21221       }
21222     ],
21223     "name": "destroy",
21224     "group": "Screen_Recordings",
21225     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21226     "version": "0.0.0",
21227     "filename": "server/api/screenRecording/index.js",
21228     "groupTitle": "Screen_Recordings"
21229   },
21230   {
21231     "type": "get",
21232     "url": "/api/screen/recordings/{id}/download",
21233     "title": "Download Recording",
21234     "examples": [
21235       {
21236         "title": "Example usage:",
21237         "content": "curl https://{domain}/api/screen/recordings/{id}/download -v -u {name}:{password} -X GET",
21238         "type": "json"
21239       }
21240     ],
21241     "name": "download",
21242     "group": "Screen_Recordings",
21243     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21244     "version": "0.0.0",
21245     "filename": "server/api/screenRecording/index.js",
21246     "groupTitle": "Screen_Recordings"
21247   },
21248   {
21249     "type": "put",
21250     "url": "/api/screen/recordings/{id}",
21251     "title": "Update an existing Recording",
21252     "examples": [
21253       {
21254         "title": "Example usage:",
21255         "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",
21256         "type": "json"
21257       }
21258     ],
21259     "name": "updateRecordings",
21260     "group": "Screen_Recordings",
21261     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21262     "version": "0.0.0",
21263     "filename": "server/api/screenRecording/index.js",
21264     "groupTitle": "Screen_Recordings"
21265   },
21266   {
21267     "type": "post",
21268     "url": "/api/integrations/servicenow/accounts",
21269     "title": "Creates a new Servicenow Account",
21270     "examples": [
21271       {
21272         "title": "Example usage:",
21273         "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",
21274         "type": "json"
21275       }
21276     ],
21277     "name": "CreateServicenow_Accounts",
21278     "group": "Servicenow_Accounts",
21279     "parameter": {
21280       "fields": {
21281         "Body": [
21282           {
21283             "group": "Body",
21284             "type": "String",
21285             "optional": true,
21286             "field": "name",
21287             "description": ""
21288           },
21289           {
21290             "group": "Body",
21291             "type": "String",
21292             "optional": true,
21293             "field": "description",
21294             "description": ""
21295           },
21296           {
21297             "group": "Body",
21298             "type": "String",
21299             "optional": true,
21300             "field": "username",
21301             "description": ""
21302           },
21303           {
21304             "group": "Body",
21305             "type": "String",
21306             "optional": true,
21307             "field": "password",
21308             "description": ""
21309           },
21310           {
21311             "group": "Body",
21312             "type": "String",
21313             "optional": true,
21314             "field": "email",
21315             "description": ""
21316           },
21317           {
21318             "group": "Body",
21319             "type": "String",
21320             "optional": true,
21321             "field": "remoteUri",
21322             "description": ""
21323           },
21324           {
21325             "group": "Body",
21326             "type": "String",
21327             "optional": false,
21328             "field": "serverUrl",
21329             "description": ""
21330           }
21331         ]
21332       }
21333     },
21334     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21335     "version": "0.0.0",
21336     "filename": "server/api/intServicenowAccount/index.js",
21337     "groupTitle": "Servicenow_Accounts"
21338   },
21339   {
21340     "type": "delete",
21341     "url": "/api/integrations/servicenow/accounts/{id}",
21342     "title": "Deletes a Servicenow Account",
21343     "examples": [
21344       {
21345         "title": "Example usage:",
21346         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password} -X DELETE",
21347         "type": "json"
21348       }
21349     ],
21350     "name": "DeleteServicenow_Accounts",
21351     "group": "Servicenow_Accounts",
21352     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21353     "version": "0.0.0",
21354     "filename": "server/api/intServicenowAccount/index.js",
21355     "groupTitle": "Servicenow_Accounts"
21356   },
21357   {
21358     "type": "get",
21359     "url": "/api/integrations/servicenow/accounts",
21360     "title": "Gets a list of Servicenow Accounts",
21361     "examples": [
21362       {
21363         "title": "Example usage:",
21364         "content": "curl https://{domain}/api/integrations/servicenow/accounts -v -u {name}:{password}",
21365         "type": "json"
21366       }
21367     ],
21368     "name": "GetServicenow_Accounts",
21369     "group": "Servicenow_Accounts",
21370     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21371     "version": "0.0.0",
21372     "filename": "server/api/intServicenowAccount/index.js",
21373     "groupTitle": "Servicenow_Accounts"
21374   },
21375   {
21376     "type": "get",
21377     "url": "/api/integrations/servicenow/accounts/{id}",
21378     "title": "Gets a single Servicenow Account",
21379     "examples": [
21380       {
21381         "title": "Example usage:",
21382         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password}",
21383         "type": "json"
21384       }
21385     ],
21386     "name": "ShowServicenow_Accounts",
21387     "group": "Servicenow_Accounts",
21388     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21389     "version": "0.0.0",
21390     "filename": "server/api/intServicenowAccount/index.js",
21391     "groupTitle": "Servicenow_Accounts"
21392   },
21393   {
21394     "type": "post",
21395     "url": "/api/integrations/servicenow/accounts/{id}/configurations",
21396     "title": "Creates new configuration",
21397     "examples": [
21398       {
21399         "title": "Example usage:",
21400         "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",
21401         "type": "json"
21402       }
21403     ],
21404     "name": "addConfiguration",
21405     "group": "Servicenow_Accounts",
21406     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21407     "version": "0.0.0",
21408     "filename": "server/api/intServicenowAccount/index.js",
21409     "groupTitle": "Servicenow_Accounts"
21410   },
21411   {
21412     "type": "get",
21413     "url": "/api/integrations/servicenow/accounts/{id}/configurations",
21414     "title": "Gets account configurations",
21415     "examples": [
21416       {
21417         "title": "Example usage:",
21418         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/configurations -v -u {name}:{password} -X GET",
21419         "type": "json"
21420       }
21421     ],
21422     "name": "getConfigurations",
21423     "group": "Servicenow_Accounts",
21424     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21425     "version": "0.0.0",
21426     "filename": "server/api/intServicenowAccount/index.js",
21427     "groupTitle": "Servicenow_Accounts"
21428   },
21429   {
21430     "type": "get",
21431     "url": "/api/integrations/servicenow/accounts/{id}/fields",
21432     "title": "Gets account fields",
21433     "examples": [
21434       {
21435         "title": "Example usage:",
21436         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/fields -v -u {name}:{password} -X GET",
21437         "type": "json"
21438       }
21439     ],
21440     "name": "getFields",
21441     "group": "Servicenow_Accounts",
21442     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21443     "version": "0.0.0",
21444     "filename": "server/api/intServicenowAccount/index.js",
21445     "groupTitle": "Servicenow_Accounts"
21446   },
21447   {
21448     "type": "put",
21449     "url": "/api/integrations/servicenow/accounts/{id}",
21450     "title": "Update an existing Servicenow Account",
21451     "examples": [
21452       {
21453         "title": "Example usage:",
21454         "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",
21455         "type": "json"
21456       }
21457     ],
21458     "name": "updateServicenow_Accounts",
21459     "group": "Servicenow_Accounts",
21460     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21461     "version": "0.0.0",
21462     "filename": "server/api/intServicenowAccount/index.js",
21463     "groupTitle": "Servicenow_Accounts"
21464   },
21465   {
21466     "type": "post",
21467     "url": "/api/integrations/servicenow/configurations",
21468     "title": "Creates a new Servicenow Configuration",
21469     "examples": [
21470       {
21471         "title": "Example usage:",
21472         "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",
21473         "type": "json"
21474       }
21475     ],
21476     "name": "CreateServicenow_Configurations",
21477     "group": "Servicenow_Configurations",
21478     "parameter": {
21479       "fields": {
21480         "Body": [
21481           {
21482             "group": "Body",
21483             "type": "String",
21484             "optional": true,
21485             "field": "name",
21486             "description": ""
21487           },
21488           {
21489             "group": "Body",
21490             "type": "String",
21491             "optional": true,
21492             "field": "description",
21493             "description": ""
21494           }
21495         ]
21496       }
21497     },
21498     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21499     "version": "0.0.0",
21500     "filename": "server/api/intServicenowConfiguration/index.js",
21501     "groupTitle": "Servicenow_Configurations"
21502   },
21503   {
21504     "type": "delete",
21505     "url": "/api/integrations/servicenow/configurations/{id}",
21506     "title": "Deletes a Servicenow Configuration",
21507     "examples": [
21508       {
21509         "title": "Example usage:",
21510         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password} -X DELETE",
21511         "type": "json"
21512       }
21513     ],
21514     "name": "DeleteServicenow_Configurations",
21515     "group": "Servicenow_Configurations",
21516     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21517     "version": "0.0.0",
21518     "filename": "server/api/intServicenowConfiguration/index.js",
21519     "groupTitle": "Servicenow_Configurations"
21520   },
21521   {
21522     "type": "get",
21523     "url": "/api/integrations/servicenow/configurations",
21524     "title": "Gets a list of Servicenow Configurations",
21525     "examples": [
21526       {
21527         "title": "Example usage:",
21528         "content": "curl https://{domain}/api/integrations/servicenow/configurations -v -u {name}:{password}",
21529         "type": "json"
21530       }
21531     ],
21532     "name": "GetServicenow_Configurations",
21533     "group": "Servicenow_Configurations",
21534     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21535     "version": "0.0.0",
21536     "filename": "server/api/intServicenowConfiguration/index.js",
21537     "groupTitle": "Servicenow_Configurations"
21538   },
21539   {
21540     "type": "get",
21541     "url": "/api/integrations/servicenow/configurations/{id}",
21542     "title": "Gets a single Servicenow Configuration",
21543     "examples": [
21544       {
21545         "title": "Example usage:",
21546         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password}",
21547         "type": "json"
21548       }
21549     ],
21550     "name": "ShowServicenow_Configurations",
21551     "group": "Servicenow_Configurations",
21552     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21553     "version": "0.0.0",
21554     "filename": "server/api/intServicenowConfiguration/index.js",
21555     "groupTitle": "Servicenow_Configurations"
21556   },
21557   {
21558     "type": "get",
21559     "url": "/api/integrations/servicenow/configurations/{id}/descriptions",
21560     "title": "Gets configurations descriptions",
21561     "examples": [
21562       {
21563         "title": "Example usage:",
21564         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
21565         "type": "json"
21566       }
21567     ],
21568     "name": "getDescriptions",
21569     "group": "Servicenow_Configurations",
21570     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21571     "version": "0.0.0",
21572     "filename": "server/api/intServicenowConfiguration/index.js",
21573     "groupTitle": "Servicenow_Configurations"
21574   },
21575   {
21576     "type": "get",
21577     "url": "/api/integrations/servicenow/configurations/{id}/fields",
21578     "title": "Gets configurations fields",
21579     "examples": [
21580       {
21581         "title": "Example usage:",
21582         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/fields -v -u {name}:{password} -X GET",
21583         "type": "json"
21584       }
21585     ],
21586     "name": "getFields",
21587     "group": "Servicenow_Configurations",
21588     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21589     "version": "0.0.0",
21590     "filename": "server/api/intServicenowConfiguration/index.js",
21591     "groupTitle": "Servicenow_Configurations"
21592   },
21593   {
21594     "type": "get",
21595     "url": "/api/integrations/servicenow/configurations/{id}/subjects",
21596     "title": "Gets configurations subjects",
21597     "examples": [
21598       {
21599         "title": "Example usage:",
21600         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/subjects -v -u {name}:{password} -X GET",
21601         "type": "json"
21602       }
21603     ],
21604     "name": "getSubjects",
21605     "group": "Servicenow_Configurations",
21606     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21607     "version": "0.0.0",
21608     "filename": "server/api/intServicenowConfiguration/index.js",
21609     "groupTitle": "Servicenow_Configurations"
21610   },
21611   {
21612     "type": "put",
21613     "url": "/api/integrations/servicenow/configurations/{id}",
21614     "title": "Update an existing Servicenow Configuration",
21615     "examples": [
21616       {
21617         "title": "Example usage:",
21618         "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",
21619         "type": "json"
21620       }
21621     ],
21622     "name": "updateServicenow_Configurations",
21623     "group": "Servicenow_Configurations",
21624     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21625     "version": "0.0.0",
21626     "filename": "server/api/intServicenowConfiguration/index.js",
21627     "groupTitle": "Servicenow_Configurations"
21628   },
21629   {
21630     "type": "post",
21631     "url": "/api/integrations/servicenow/fields",
21632     "title": "Creates a new Servicenow Field",
21633     "examples": [
21634       {
21635         "title": "Example usage:",
21636         "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",
21637         "type": "json"
21638       }
21639     ],
21640     "name": "CreateServicenow_Fields",
21641     "group": "Servicenow_Fields",
21642     "parameter": {
21643       "fields": {
21644         "Body": [
21645           {
21646             "group": "Body",
21647             "type": "String",
21648             "allowedValues": [
21649               "\"string\"",
21650               "\"variable\"",
21651               "\"customVariable\"",
21652               "\"keyValue\""
21653             ],
21654             "optional": true,
21655             "field": "type",
21656             "description": ""
21657           },
21658           {
21659             "group": "Body",
21660             "type": "String",
21661             "optional": true,
21662             "field": "content",
21663             "description": ""
21664           },
21665           {
21666             "group": "Body",
21667             "type": "String",
21668             "optional": true,
21669             "field": "key",
21670             "description": ""
21671           },
21672           {
21673             "group": "Body",
21674             "type": "String",
21675             "allowedValues": [
21676               "\"string\"",
21677               "\"variable\"",
21678               "\"customVariable\""
21679             ],
21680             "optional": true,
21681             "field": "keyType",
21682             "description": ""
21683           },
21684           {
21685             "group": "Body",
21686             "type": "String",
21687             "optional": true,
21688             "field": "keyContent",
21689             "description": ""
21690           },
21691           {
21692             "group": "Body",
21693             "type": "String",
21694             "optional": true,
21695             "field": "idField",
21696             "description": ""
21697           },
21698           {
21699             "group": "Body",
21700             "type": "String",
21701             "optional": true,
21702             "field": "nameField",
21703             "description": ""
21704           },
21705           {
21706             "group": "Body",
21707             "type": "Boolean",
21708             "optional": true,
21709             "field": "customField",
21710             "description": ""
21711           },
21712           {
21713             "group": "Body",
21714             "type": "String",
21715             "optional": true,
21716             "field": "variableName",
21717             "description": ""
21718           }
21719         ]
21720       }
21721     },
21722     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21723     "version": "0.0.0",
21724     "filename": "server/api/intServicenowField/index.js",
21725     "groupTitle": "Servicenow_Fields"
21726   },
21727   {
21728     "type": "delete",
21729     "url": "/api/integrations/servicenow/fields/{id}",
21730     "title": "Deletes a Servicenow Field",
21731     "examples": [
21732       {
21733         "title": "Example usage:",
21734         "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password} -X DELETE",
21735         "type": "json"
21736       }
21737     ],
21738     "name": "DeleteServicenow_Fields",
21739     "group": "Servicenow_Fields",
21740     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21741     "version": "0.0.0",
21742     "filename": "server/api/intServicenowField/index.js",
21743     "groupTitle": "Servicenow_Fields"
21744   },
21745   {
21746     "type": "get",
21747     "url": "/api/integrations/servicenow/fields",
21748     "title": "Gets a list of Servicenow Fields",
21749     "examples": [
21750       {
21751         "title": "Example usage:",
21752         "content": "curl https://{domain}/api/integrations/servicenow/fields -v -u {name}:{password}",
21753         "type": "json"
21754       }
21755     ],
21756     "name": "GetServicenow_Fields",
21757     "group": "Servicenow_Fields",
21758     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21759     "version": "0.0.0",
21760     "filename": "server/api/intServicenowField/index.js",
21761     "groupTitle": "Servicenow_Fields"
21762   },
21763   {
21764     "type": "get",
21765     "url": "/api/integrations/servicenow/fields/{id}",
21766     "title": "Gets a single Servicenow Field",
21767     "examples": [
21768       {
21769         "title": "Example usage:",
21770         "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password}",
21771         "type": "json"
21772       }
21773     ],
21774     "name": "ShowServicenow_Fields",
21775     "group": "Servicenow_Fields",
21776     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21777     "version": "0.0.0",
21778     "filename": "server/api/intServicenowField/index.js",
21779     "groupTitle": "Servicenow_Fields"
21780   },
21781   {
21782     "type": "put",
21783     "url": "/api/integrations/servicenow/fields/{id}",
21784     "title": "Update an existing Servicenow Field",
21785     "examples": [
21786       {
21787         "title": "Example usage:",
21788         "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",
21789         "type": "json"
21790       }
21791     ],
21792     "name": "updateServicenow_Fields",
21793     "group": "Servicenow_Fields",
21794     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21795     "version": "0.0.0",
21796     "filename": "server/api/intServicenowField/index.js",
21797     "groupTitle": "Servicenow_Fields"
21798   },
21799   {
21800     "type": "get",
21801     "url": "/api/settings",
21802     "title": "Gets a list of Settings",
21803     "examples": [
21804       {
21805         "title": "Example usage:",
21806         "content": "curl https://{domain}/api/settings -v -u {name}:{password}",
21807         "type": "json"
21808       }
21809     ],
21810     "name": "GetSettings",
21811     "group": "Settings",
21812     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21813     "version": "0.0.0",
21814     "filename": "server/api/setting/index.js",
21815     "groupTitle": "Settings"
21816   },
21817   {
21818     "type": "get",
21819     "url": "/api/settings/{id}",
21820     "title": "Gets a single Setting",
21821     "examples": [
21822       {
21823         "title": "Example usage:",
21824         "content": "curl https://{domain}/api/settings/{id} -v -u {name}:{password}",
21825         "type": "json"
21826       }
21827     ],
21828     "name": "ShowSettings",
21829     "group": "Settings",
21830     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21831     "version": "0.0.0",
21832     "filename": "server/api/setting/index.js",
21833     "groupTitle": "Settings"
21834   },
21835   {
21836     "type": "post",
21837     "url": "/api/settings/{id}/favicon",
21838     "title": "Add Favicon",
21839     "examples": [
21840       {
21841         "title": "Example usage:",
21842         "content": "curl https://{domain}/api/settings/{id}/favicon -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21843         "type": "json"
21844       }
21845     ],
21846     "name": "addFavicon",
21847     "group": "Settings",
21848     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21849     "version": "0.0.0",
21850     "filename": "server/api/setting/index.js",
21851     "groupTitle": "Settings"
21852   },
21853   {
21854     "type": "post",
21855     "url": "/api/settings/{id}/logo",
21856     "title": "Add logo",
21857     "examples": [
21858       {
21859         "title": "Example usage:",
21860         "content": "curl https://{domain}/api/settings/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21861         "type": "json"
21862       }
21863     ],
21864     "name": "addLogo",
21865     "group": "Settings",
21866     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21867     "version": "0.0.0",
21868     "filename": "server/api/setting/index.js",
21869     "groupTitle": "Settings"
21870   },
21871   {
21872     "type": "post",
21873     "url": "/api/settings/{id}/logo_login",
21874     "title": "Add logo login",
21875     "examples": [
21876       {
21877         "title": "Example usage:",
21878         "content": "curl https://{domain}/api/settings/{id}/logo_login -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21879         "type": "json"
21880       }
21881     ],
21882     "name": "addLogoLogin",
21883     "group": "Settings",
21884     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21885     "version": "0.0.0",
21886     "filename": "server/api/setting/index.js",
21887     "groupTitle": "Settings"
21888   },
21889   {
21890     "type": "post",
21891     "url": "/api/settings/{id}/preferred",
21892     "title": "Add Preferred",
21893     "examples": [
21894       {
21895         "title": "Example usage:",
21896         "content": "curl https://{domain}/api/settings/{id}/preferred -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21897         "type": "json"
21898       }
21899     ],
21900     "name": "addPreferred",
21901     "group": "Settings",
21902     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21903     "version": "0.0.0",
21904     "filename": "server/api/setting/index.js",
21905     "groupTitle": "Settings"
21906   },
21907   {
21908     "type": "get",
21909     "url": "/api/settings/now",
21910     "title": "Get Server Current Date",
21911     "examples": [
21912       {
21913         "title": "Example usage:",
21914         "content": "curl https://{domain}/api/settings/now -v -X GET",
21915         "type": "json"
21916       }
21917     ],
21918     "name": "getDate",
21919     "group": "Settings",
21920     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21921     "version": "0.0.0",
21922     "filename": "server/api/setting/index.js",
21923     "groupTitle": "Settings"
21924   },
21925   {
21926     "type": "get",
21927     "url": "/api/settings/{id}/favicon",
21928     "title": "Get Favicon",
21929     "examples": [
21930       {
21931         "title": "Example usage:",
21932         "content": "curl https://{domain}/api/settings/{id}/favicon -v -X GET",
21933         "type": "json"
21934       }
21935     ],
21936     "name": "getFavicon",
21937     "group": "Settings",
21938     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21939     "version": "0.0.0",
21940     "filename": "server/api/setting/index.js",
21941     "groupTitle": "Settings"
21942   },
21943   {
21944     "type": "get",
21945     "url": "/api/settings/{id}/gdpr",
21946     "title": "Get gdpr settings",
21947     "examples": [
21948       {
21949         "title": "Example usage:",
21950         "content": "curl https://{domain}/api/settings/{id}/gdpr -v -u {name}:{password} -X GET",
21951         "type": "json"
21952       }
21953     ],
21954     "name": "getGdpr",
21955     "group": "Settings",
21956     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21957     "version": "0.0.0",
21958     "filename": "server/api/setting/index.js",
21959     "groupTitle": "Settings"
21960   },
21961   {
21962     "type": "get",
21963     "url": "/api/settings/{id}/logo",
21964     "title": "Get logo",
21965     "examples": [
21966       {
21967         "title": "Example usage:",
21968         "content": "curl https://{domain}/api/settings/{id}/logo -v -X GET",
21969         "type": "json"
21970       }
21971     ],
21972     "name": "getLogo",
21973     "group": "Settings",
21974     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21975     "version": "0.0.0",
21976     "filename": "server/api/setting/index.js",
21977     "groupTitle": "Settings"
21978   },
21979   {
21980     "type": "get",
21981     "url": "/api/settings/{id}/logo_login",
21982     "title": "Get logo login",
21983     "examples": [
21984       {
21985         "title": "Example usage:",
21986         "content": "curl https://{domain}/api/settings/{id}/logo_login -v -X GET",
21987         "type": "json"
21988       }
21989     ],
21990     "name": "getLogoLogin",
21991     "group": "Settings",
21992     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21993     "version": "0.0.0",
21994     "filename": "server/api/setting/index.js",
21995     "groupTitle": "Settings"
21996   },
21997   {
21998     "type": "get",
21999     "url": "/api/settings/{id}/preferred",
22000     "title": "Get Preferred",
22001     "examples": [
22002       {
22003         "title": "Example usage:",
22004         "content": "curl https://{domain}/api/settings/{id}/preferred -v -X GET",
22005         "type": "json"
22006       }
22007     ],
22008     "name": "getPreferred",
22009     "group": "Settings",
22010     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22011     "version": "0.0.0",
22012     "filename": "server/api/setting/index.js",
22013     "groupTitle": "Settings"
22014   },
22015   {
22016     "type": "put",
22017     "url": "/api/settings/{id}",
22018     "title": "Update an existing Setting",
22019     "examples": [
22020       {
22021         "title": "Example usage:",
22022         "content": "curl https://{domain}/api/settings/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
22023         "type": "json"
22024       }
22025     ],
22026     "name": "updateSettings",
22027     "group": "Settings",
22028     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22029     "version": "0.0.0",
22030     "filename": "server/api/setting/index.js",
22031     "groupTitle": "Settings"
22032   },
22033   {
22034     "type": "post",
22035     "url": "/api/sms/accounts/{id}/users",
22036     "title": "Add agents to a sms account",
22037     "examples": [
22038       {
22039         "title": "Example usage:",
22040         "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",
22041         "type": "json"
22042       }
22043     ],
22044     "name": "AddAgents",
22045     "group": "Sms_Accounts",
22046     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22047     "version": "0.0.0",
22048     "filename": "server/api/smsAccount/index.js",
22049     "groupTitle": "Sms_Accounts"
22050   },
22051   {
22052     "type": "post",
22053     "url": "/api/sms/accounts",
22054     "title": "Creates a new Account",
22055     "examples": [
22056       {
22057         "title": "Example usage:",
22058         "content": "curl https://{domain}/api/sms/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22059         "type": "json"
22060       }
22061     ],
22062     "name": "CreateAccounts",
22063     "group": "Sms_Accounts",
22064     "parameter": {
22065       "fields": {
22066         "Body": [
22067           {
22068             "group": "Body",
22069             "type": "String",
22070             "optional": false,
22071             "field": "name",
22072             "description": ""
22073           },
22074           {
22075             "group": "Body",
22076             "type": "String",
22077             "optional": false,
22078             "field": "key",
22079             "description": ""
22080           },
22081           {
22082             "group": "Body",
22083             "type": "String",
22084             "optional": false,
22085             "field": "remote",
22086             "description": ""
22087           },
22088           {
22089             "group": "Body",
22090             "type": "String",
22091             "optional": true,
22092             "field": "token",
22093             "description": ""
22094           },
22095           {
22096             "group": "Body",
22097             "type": "String",
22098             "optional": true,
22099             "field": "phone",
22100             "description": ""
22101           },
22102           {
22103             "group": "Body",
22104             "type": "String",
22105             "allowedValues": [
22106               "\"twilio\"",
22107               "\"skebby\"",
22108               "\"connectel\"",
22109               "\"clicksend\"",
22110               "\"plivo\"",
22111               "\"clickatell\"",
22112               "\"csc\"",
22113               "\"infobip\"",
22114               "\"intelepeer\""
22115             ],
22116             "optional": true,
22117             "field": "type",
22118             "description": ""
22119           },
22120           {
22121             "group": "Body",
22122             "type": "String",
22123             "optional": true,
22124             "field": "accountSid",
22125             "description": ""
22126           },
22127           {
22128             "group": "Body",
22129             "type": "String",
22130             "optional": true,
22131             "field": "authId",
22132             "description": ""
22133           },
22134           {
22135             "group": "Body",
22136             "type": "String",
22137             "optional": true,
22138             "field": "authToken",
22139             "description": ""
22140           },
22141           {
22142             "group": "Body",
22143             "type": "String",
22144             "allowedValues": [
22145               "\"SI\"",
22146               "\"TI\"",
22147               "\"GP\""
22148             ],
22149             "optional": true,
22150             "field": "smsMethod",
22151             "description": ""
22152           },
22153           {
22154             "group": "Body",
22155             "type": "String",
22156             "optional": true,
22157             "field": "username",
22158             "description": ""
22159           },
22160           {
22161             "group": "Body",
22162             "type": "String",
22163             "optional": true,
22164             "field": "password",
22165             "description": ""
22166           },
22167           {
22168             "group": "Body",
22169             "type": "String",
22170             "optional": true,
22171             "field": "apiKey",
22172             "description": ""
22173           },
22174           {
22175             "group": "Body",
22176             "type": "String",
22177             "optional": true,
22178             "field": "senderString",
22179             "description": ""
22180           },
22181           {
22182             "group": "Body",
22183             "type": "Boolean",
22184             "optional": true,
22185             "field": "deliveryReport",
22186             "description": ""
22187           },
22188           {
22189             "group": "Body",
22190             "type": "String",
22191             "optional": true,
22192             "field": "description",
22193             "description": ""
22194           },
22195           {
22196             "group": "Body",
22197             "type": "Text",
22198             "optional": true,
22199             "field": "notificationTemplate",
22200             "description": ""
22201           },
22202           {
22203             "group": "Body",
22204             "type": "Boolean",
22205             "optional": true,
22206             "field": "notificationSound",
22207             "description": ""
22208           },
22209           {
22210             "group": "Body",
22211             "type": "Boolean",
22212             "optional": true,
22213             "field": "notificationShake",
22214             "description": ""
22215           },
22216           {
22217             "group": "Body",
22218             "type": "Integer",
22219             "optional": true,
22220             "field": "waitForTheAssignedAgent",
22221             "description": ""
22222           },
22223           {
22224             "group": "Body",
22225             "type": "Boolean",
22226             "optional": true,
22227             "field": "queueTransfer",
22228             "description": ""
22229           },
22230           {
22231             "group": "Body",
22232             "type": "Integer",
22233             "optional": true,
22234             "field": "queueTransferTimeout",
22235             "description": ""
22236           },
22237           {
22238             "group": "Body",
22239             "type": "Boolean",
22240             "optional": true,
22241             "field": "agentTransfer",
22242             "description": ""
22243           },
22244           {
22245             "group": "Body",
22246             "type": "Integer",
22247             "optional": true,
22248             "field": "agentTransferTimeout",
22249             "description": ""
22250           },
22251           {
22252             "group": "Body",
22253             "type": "String",
22254             "optional": true,
22255             "field": "baseUrl",
22256             "description": ""
22257           },
22258           {
22259             "group": "Body",
22260             "type": "Integer",
22261             "optional": true,
22262             "field": "mandatoryDispositionPauseId",
22263             "description": "<p>Status to put when mandatory disposition is enabled</p>"
22264           },
22265           {
22266             "group": "Body",
22267             "type": "Boolean",
22268             "optional": true,
22269             "field": "mandatoryDisposition",
22270             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
22271           }
22272         ]
22273       }
22274     },
22275     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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": "delete",
22282     "url": "/api/sms/accounts/{id}",
22283     "title": "Deletes a Account",
22284     "examples": [
22285       {
22286         "title": "Example usage:",
22287         "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password} -X DELETE",
22288         "type": "json"
22289       }
22290     ],
22291     "name": "DeleteAccounts",
22292     "group": "Sms_Accounts",
22293     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/describe",
22301     "title": "Gets table info about Accounts",
22302     "examples": [
22303       {
22304         "title": "Example usage:",
22305         "content": "curl https://{domain}/api/sms/accounts/describe -v -u {name}:{password}",
22306         "type": "json"
22307       }
22308     ],
22309     "name": "DescribeAccounts",
22310     "group": "Sms_Accounts",
22311     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</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",
22319     "title": "Gets a list of Accounts",
22320     "examples": [
22321       {
22322         "title": "Example usage:",
22323         "content": "curl https://{domain}/api/sms/accounts -v -u {name}:{password}",
22324         "type": "json"
22325       }
22326     ],
22327     "name": "GetAccounts",
22328     "group": "Sms_Accounts",
22329     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22330     "version": "0.0.0",
22331     "filename": "server/api/smsAccount/index.js",
22332     "groupTitle": "Sms_Accounts"
22333   },
22334   {
22335     "type": "get",
22336     "url": "/api/sms/accounts/{id}/users",
22337     "title": "Gets agents from sms account",
22338     "examples": [
22339       {
22340         "title": "Example usage:",
22341         "content": "curl https://{domain}/api/sms/accounts/{id}/users -v -u {name}:{password} -X GET",
22342         "type": "json"
22343       }
22344     ],
22345     "name": "GetAgents",
22346     "group": "Sms_Accounts",
22347     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22348     "version": "0.0.0",
22349     "filename": "server/api/smsAccount/index.js",
22350     "groupTitle": "Sms_Accounts"
22351   },
22352   {
22353     "type": "delete",
22354     "url": "/api/sms/accounts/{id}/users",
22355     "title": "Removes agents from a sms account",
22356     "examples": [
22357       {
22358         "title": "Example usage:",
22359         "content": "curl https://{domain}/api/sms/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22360         "type": "json"
22361       }
22362     ],
22363     "name": "RemoveAgents",
22364     "group": "Sms_Accounts",
22365     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/smsAccount/index.js",
22368     "groupTitle": "Sms_Accounts"
22369   },
22370   {
22371     "type": "delete",
22372     "url": "/api/sms/accounts/{id}/canned_answers",
22373     "title": "Removes canned answers from account",
22374     "examples": [
22375       {
22376         "title": "Example usage:",
22377         "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22378         "type": "json"
22379       }
22380     ],
22381     "name": "RemoveAnswers",
22382     "group": "Sms_Accounts",
22383     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "delete",
22390     "url": "/api/sms/accounts/{id}/dispositions",
22391     "title": "Removes dispositions from account",
22392     "examples": [
22393       {
22394         "title": "Example usage:",
22395         "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22396         "type": "json"
22397       }
22398     ],
22399     "name": "RemoveDispositions",
22400     "group": "Sms_Accounts",
22401     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22402     "version": "0.0.0",
22403     "filename": "server/api/smsAccount/index.js",
22404     "groupTitle": "Sms_Accounts"
22405   },
22406   {
22407     "type": "get",
22408     "url": "/api/sms/accounts/{id}",
22409     "title": "Gets a single Account",
22410     "examples": [
22411       {
22412         "title": "Example usage:",
22413         "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password}",
22414         "type": "json"
22415       }
22416     ],
22417     "name": "ShowAccounts",
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": "put",
22426     "url": "/api/sms/messages/{id}/accept",
22427     "title": "Accepts message",
22428     "examples": [
22429       {
22430         "title": "Example usage:",
22431         "content": "curl https://{domain}/api/sms/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
22432         "type": "json"
22433       }
22434     ],
22435     "name": "acceptMessage",
22436     "group": "Sms_Accounts",
22437     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22438     "version": "0.0.0",
22439     "filename": "server/api/smsMessage/index.js",
22440     "groupTitle": "Sms_Accounts"
22441   },
22442   {
22443     "type": "post",
22444     "url": "/api/sms/accounts/{id}/canned_answers",
22445     "title": "Creates new canned answer",
22446     "examples": [
22447       {
22448         "title": "Example usage:",
22449         "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",
22450         "type": "json"
22451       }
22452     ],
22453     "name": "addAnswer",
22454     "group": "Sms_Accounts",
22455     "parameter": {
22456       "fields": {
22457         "Body": [
22458           {
22459             "group": "Body",
22460             "type": "String",
22461             "optional": false,
22462             "field": "key",
22463             "description": ""
22464           },
22465           {
22466             "group": "Body",
22467             "type": "Text",
22468             "optional": false,
22469             "field": "value",
22470             "description": ""
22471           },
22472           {
22473             "group": "Body",
22474             "type": "String",
22475             "optional": true,
22476             "field": "description",
22477             "description": ""
22478           },
22479           {
22480             "group": "Body",
22481             "type": "Virtual",
22482             "optional": true,
22483             "field": "name",
22484             "description": ""
22485           }
22486         ]
22487       }
22488     },
22489     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22490     "version": "0.0.0",
22491     "filename": "server/api/smsAccount/index.js",
22492     "groupTitle": "Sms_Accounts"
22493   },
22494   {
22495     "type": "post",
22496     "url": "/api/sms/accounts/{id}/applications",
22497     "title": "Creates new applications",
22498     "examples": [
22499       {
22500         "title": "Example usage:",
22501         "content": "curl https://{domain}/api/sms/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
22502         "type": "json"
22503       }
22504     ],
22505     "name": "addApplications",
22506     "group": "Sms_Accounts",
22507     "parameter": {
22508       "fields": {
22509         "Body": [
22510           {
22511             "group": "Body",
22512             "type": "Integer",
22513             "optional": false,
22514             "field": "priority",
22515             "description": ""
22516           },
22517           {
22518             "group": "Body",
22519             "type": "String",
22520             "optional": false,
22521             "field": "app",
22522             "description": ""
22523           },
22524           {
22525             "group": "Body",
22526             "type": "Text",
22527             "optional": true,
22528             "field": "appdata",
22529             "description": ""
22530           },
22531           {
22532             "group": "Body",
22533             "type": "String",
22534             "optional": true,
22535             "field": "description",
22536             "description": ""
22537           },
22538           {
22539             "group": "Body",
22540             "type": "String",
22541             "optional": true,
22542             "field": "interval",
22543             "description": ""
22544           }
22545         ]
22546       }
22547     },
22548     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22549     "version": "0.0.0",
22550     "filename": "server/api/smsAccount/index.js",
22551     "groupTitle": "Sms_Accounts"
22552   },
22553   {
22554     "type": "post",
22555     "url": "/api/sms/accounts/{id}/dispositions",
22556     "title": "Creates new disposition",
22557     "examples": [
22558       {
22559         "title": "Example usage:",
22560         "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
22561         "type": "json"
22562       }
22563     ],
22564     "name": "addDisposition",
22565     "group": "Sms_Accounts",
22566     "parameter": {
22567       "fields": {
22568         "Body": [
22569           {
22570             "group": "Body",
22571             "type": "String",
22572             "optional": false,
22573             "field": "name",
22574             "description": ""
22575           },
22576           {
22577             "group": "Body",
22578             "type": "String",
22579             "allowedValues": [
22580               "\"first\"",
22581               "\"second\"",
22582               "\"third\""
22583             ],
22584             "optional": false,
22585             "field": "level",
22586             "description": ""
22587           },
22588           {
22589             "group": "Body",
22590             "type": "String",
22591             "optional": true,
22592             "field": "description",
22593             "description": ""
22594           }
22595         ]
22596       }
22597     },
22598     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22599     "version": "0.0.0",
22600     "filename": "server/api/smsAccount/index.js",
22601     "groupTitle": "Sms_Accounts"
22602   },
22603   {
22604     "type": "get",
22605     "url": "/api/sms/accounts/{id}/canned_answers",
22606     "title": "Gets account canned answers",
22607     "examples": [
22608       {
22609         "title": "Example usage:",
22610         "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
22611         "type": "json"
22612       }
22613     ],
22614     "name": "getAnswers",
22615     "group": "Sms_Accounts",
22616     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22617     "version": "0.0.0",
22618     "filename": "server/api/smsAccount/index.js",
22619     "groupTitle": "Sms_Accounts"
22620   },
22621   {
22622     "type": "get",
22623     "url": "/api/sms/accounts/{id}/applications",
22624     "title": "Gets account applications",
22625     "examples": [
22626       {
22627         "title": "Example usage:",
22628         "content": "curl https://{domain}/api/sms/accounts/{id}/applications -v -u {name}:{password} -X GET",
22629         "type": "json"
22630       }
22631     ],
22632     "name": "getApplications",
22633     "group": "Sms_Accounts",
22634     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22635     "version": "0.0.0",
22636     "filename": "server/api/smsAccount/index.js",
22637     "groupTitle": "Sms_Accounts"
22638   },
22639   {
22640     "type": "get",
22641     "url": "/api/sms/accounts/{id}/dispositions",
22642     "title": "Gets account dispositions",
22643     "examples": [
22644       {
22645         "title": "Example usage:",
22646         "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
22647         "type": "json"
22648       }
22649     ],
22650     "name": "getDispositions",
22651     "group": "Sms_Accounts",
22652     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22653     "version": "0.0.0",
22654     "filename": "server/api/smsAccount/index.js",
22655     "groupTitle": "Sms_Accounts"
22656   },
22657   {
22658     "type": "get",
22659     "url": "/api/sms/accounts/{id}/interactions",
22660     "title": "Gets Sms Account interactions",
22661     "examples": [
22662       {
22663         "title": "Example usage:",
22664         "content": "curl https://{domain}/api/sms/accounts/{id}/interactions -v -u {name}:{password} -X GET",
22665         "type": "json"
22666       }
22667     ],
22668     "name": "getInteractions",
22669     "group": "Sms_Accounts",
22670     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22671     "version": "0.0.0",
22672     "filename": "server/api/smsAccount/index.js",
22673     "groupTitle": "Sms_Accounts"
22674   },
22675   {
22676     "type": "post",
22677     "url": "/api/sms/accounts/{id}/notify",
22678     "title": "Notify new message",
22679     "examples": [
22680       {
22681         "title": "Example usage:",
22682         "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",
22683         "type": "json"
22684       }
22685     ],
22686     "name": "notify",
22687     "group": "Sms_Accounts",
22688     "description": "<p>Motion 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>",
22689     "version": "0.0.0",
22690     "filename": "server/api/smsAccount/index.js",
22691     "groupTitle": "Sms_Accounts"
22692   },
22693   {
22694     "type": "put",
22695     "url": "/api/sms/messages/{id}/reject",
22696     "title": "Rejects message",
22697     "examples": [
22698       {
22699         "title": "Example usage:",
22700         "content": "curl https://{domain}/api/sms/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
22701         "type": "json"
22702       }
22703     ],
22704     "name": "rejectMessage",
22705     "group": "Sms_Accounts",
22706     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22707     "version": "0.0.0",
22708     "filename": "server/api/smsMessage/index.js",
22709     "groupTitle": "Sms_Accounts"
22710   },
22711   {
22712     "type": "post",
22713     "url": "/api/sms/accounts/{id}/send",
22714     "title": "Send new sms message",
22715     "examples": [
22716       {
22717         "title": "Example usage:",
22718         "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",
22719         "type": "json"
22720       }
22721     ],
22722     "name": "sendSms",
22723     "group": "Sms_Accounts",
22724     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22725     "version": "0.0.0",
22726     "filename": "server/api/smsAccount/index.js",
22727     "groupTitle": "Sms_Accounts"
22728   },
22729   {
22730     "type": "get",
22731     "url": "/api/sms/accounts/{id}/status",
22732     "title": "Receive message status as get request",
22733     "examples": [
22734       {
22735         "title": "Example usage:",
22736         "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X GET",
22737         "type": "json"
22738       }
22739     ],
22740     "name": "statusMessage",
22741     "group": "Sms_Accounts",
22742     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22743     "version": "0.0.0",
22744     "filename": "server/api/smsAccount/index.js",
22745     "groupTitle": "Sms_Accounts"
22746   },
22747   {
22748     "type": "post",
22749     "url": "/api/sms/messages/{id}/status",
22750     "title": "Receive message status",
22751     "examples": [
22752       {
22753         "title": "Example usage:",
22754         "content": "curl https://{domain}/api/sms/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
22755         "type": "json"
22756       }
22757     ],
22758     "name": "statusMessage",
22759     "group": "Sms_Accounts",
22760     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22761     "version": "0.0.0",
22762     "filename": "server/api/smsMessage/index.js",
22763     "groupTitle": "Sms_Accounts"
22764   },
22765   {
22766     "type": "post",
22767     "url": "/api/sms/accounts/{id}/status",
22768     "title": "Receive message status",
22769     "examples": [
22770       {
22771         "title": "Example usage:",
22772         "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X POST",
22773         "type": "json"
22774       }
22775     ],
22776     "name": "statusMessage",
22777     "group": "Sms_Accounts",
22778     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22779     "version": "0.0.0",
22780     "filename": "server/api/smsAccount/index.js",
22781     "groupTitle": "Sms_Accounts"
22782   },
22783   {
22784     "type": "put",
22785     "url": "/api/sms/accounts/{id}",
22786     "title": "Update an existing Account",
22787     "examples": [
22788       {
22789         "title": "Example usage:",
22790         "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",
22791         "type": "json"
22792       }
22793     ],
22794     "name": "updateAccounts",
22795     "group": "Sms_Accounts",
22796     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22797     "version": "0.0.0",
22798     "filename": "server/api/smsAccount/index.js",
22799     "groupTitle": "Sms_Accounts"
22800   },
22801   {
22802     "type": "post",
22803     "url": "/api/sms/applications",
22804     "title": "Creates a new Application",
22805     "examples": [
22806       {
22807         "title": "Example usage:",
22808         "content": "curl https://{domain}/api/sms/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22809         "type": "json"
22810       }
22811     ],
22812     "name": "CreateApplications",
22813     "group": "Sms_Applications",
22814     "parameter": {
22815       "fields": {
22816         "Body": [
22817           {
22818             "group": "Body",
22819             "type": "Integer",
22820             "optional": false,
22821             "field": "priority",
22822             "description": ""
22823           },
22824           {
22825             "group": "Body",
22826             "type": "String",
22827             "optional": false,
22828             "field": "app",
22829             "description": ""
22830           },
22831           {
22832             "group": "Body",
22833             "type": "Text",
22834             "optional": true,
22835             "field": "appdata",
22836             "description": ""
22837           },
22838           {
22839             "group": "Body",
22840             "type": "String",
22841             "optional": true,
22842             "field": "description",
22843             "description": ""
22844           },
22845           {
22846             "group": "Body",
22847             "type": "String",
22848             "optional": true,
22849             "field": "interval",
22850             "description": ""
22851           }
22852         ]
22853       }
22854     },
22855     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22856     "version": "0.0.0",
22857     "filename": "server/api/smsApplication/index.js",
22858     "groupTitle": "Sms_Applications"
22859   },
22860   {
22861     "type": "delete",
22862     "url": "/api/sms/applications/{id}",
22863     "title": "Deletes a Application",
22864     "examples": [
22865       {
22866         "title": "Example usage:",
22867         "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password} -X DELETE",
22868         "type": "json"
22869       }
22870     ],
22871     "name": "DeleteApplications",
22872     "group": "Sms_Applications",
22873     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22874     "version": "0.0.0",
22875     "filename": "server/api/smsApplication/index.js",
22876     "groupTitle": "Sms_Applications"
22877   },
22878   {
22879     "type": "get",
22880     "url": "/api/sms/applications",
22881     "title": "Gets a list of Applications",
22882     "examples": [
22883       {
22884         "title": "Example usage:",
22885         "content": "curl https://{domain}/api/sms/applications -v -u {name}:{password}",
22886         "type": "json"
22887       }
22888     ],
22889     "name": "GetApplications",
22890     "group": "Sms_Applications",
22891     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22892     "version": "0.0.0",
22893     "filename": "server/api/smsApplication/index.js",
22894     "groupTitle": "Sms_Applications"
22895   },
22896   {
22897     "type": "get",
22898     "url": "/api/sms/applications/{id}",
22899     "title": "Gets a single Application",
22900     "examples": [
22901       {
22902         "title": "Example usage:",
22903         "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password}",
22904         "type": "json"
22905       }
22906     ],
22907     "name": "ShowApplications",
22908     "group": "Sms_Applications",
22909     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22910     "version": "0.0.0",
22911     "filename": "server/api/smsApplication/index.js",
22912     "groupTitle": "Sms_Applications"
22913   },
22914   {
22915     "type": "put",
22916     "url": "/api/sms/applications/{id}",
22917     "title": "Update an existing Application",
22918     "examples": [
22919       {
22920         "title": "Example usage:",
22921         "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",
22922         "type": "json"
22923       }
22924     ],
22925     "name": "updateApplications",
22926     "group": "Sms_Applications",
22927     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22928     "version": "0.0.0",
22929     "filename": "server/api/smsApplication/index.js",
22930     "groupTitle": "Sms_Applications"
22931   },
22932   {
22933     "type": "post",
22934     "url": "/api/sms/interactions/{id}/tags",
22935     "title": "Add tags to the interaction",
22936     "examples": [
22937       {
22938         "title": "Example usage:",
22939         "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",
22940         "type": "json"
22941       }
22942     ],
22943     "name": "AddTags",
22944     "group": "Sms_Interactions",
22945     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22946     "version": "0.0.0",
22947     "filename": "server/api/smsInteraction/index.js",
22948     "groupTitle": "Sms_Interactions"
22949   },
22950   {
22951     "type": "post",
22952     "url": "/api/sms/interactions",
22953     "title": "Creates a new Interaction",
22954     "examples": [
22955       {
22956         "title": "Example usage:",
22957         "content": "curl https://{domain}/api/sms/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22958         "type": "json"
22959       }
22960     ],
22961     "name": "CreateInteractions",
22962     "group": "Sms_Interactions",
22963     "parameter": {
22964       "fields": {
22965         "Body": [
22966           {
22967             "group": "Body",
22968             "type": "Boolean",
22969             "optional": true,
22970             "field": "closed",
22971             "description": ""
22972           },
22973           {
22974             "group": "Body",
22975             "type": "String",
22976             "optional": true,
22977             "field": "closedAt",
22978             "description": ""
22979           },
22980           {
22981             "group": "Body",
22982             "type": "String",
22983             "optional": true,
22984             "field": "disposition",
22985             "description": ""
22986           },
22987           {
22988             "group": "Body",
22989             "type": "String",
22990             "optional": true,
22991             "field": "secondDisposition",
22992             "description": ""
22993           },
22994           {
22995             "group": "Body",
22996             "type": "String",
22997             "optional": true,
22998             "field": "thirdDisposition",
22999             "description": ""
23000           },
23001           {
23002             "group": "Body",
23003             "type": "String",
23004             "optional": true,
23005             "field": "note",
23006             "description": ""
23007           },
23008           {
23009             "group": "Body",
23010             "type": "String",
23011             "optional": true,
23012             "field": "phone",
23013             "description": ""
23014           },
23015           {
23016             "group": "Body",
23017             "type": "String",
23018             "optional": true,
23019             "field": "read1stAt",
23020             "description": ""
23021           },
23022           {
23023             "group": "Body",
23024             "type": "String",
23025             "allowedValues": [
23026               "\"in\"",
23027               "\"out\""
23028             ],
23029             "optional": false,
23030             "field": "firstMsgDirection",
23031             "description": ""
23032           },
23033           {
23034             "group": "Body",
23035             "type": "String",
23036             "optional": true,
23037             "field": "lastMsgAt",
23038             "description": ""
23039           },
23040           {
23041             "group": "Body",
23042             "type": "String",
23043             "allowedValues": [
23044               "\"in\"",
23045               "\"out\""
23046             ],
23047             "optional": false,
23048             "field": "lastMsgDirection",
23049             "description": ""
23050           }
23051         ]
23052       }
23053     },
23054     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23055     "version": "0.0.0",
23056     "filename": "server/api/smsInteraction/index.js",
23057     "groupTitle": "Sms_Interactions"
23058   },
23059   {
23060     "type": "delete",
23061     "url": "/api/sms/interactions/{id}",
23062     "title": "Deletes a Interaction",
23063     "examples": [
23064       {
23065         "title": "Example usage:",
23066         "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password} -X DELETE",
23067         "type": "json"
23068       }
23069     ],
23070     "name": "DeleteInteractions",
23071     "group": "Sms_Interactions",
23072     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23073     "version": "0.0.0",
23074     "filename": "server/api/smsInteraction/index.js",
23075     "groupTitle": "Sms_Interactions"
23076   },
23077   {
23078     "type": "get",
23079     "url": "/api/sms/interactions/describe",
23080     "title": "Gets table info about Interactions",
23081     "examples": [
23082       {
23083         "title": "Example usage:",
23084         "content": "curl https://{domain}/api/sms/interactions/describe -v -u {name}:{password}",
23085         "type": "json"
23086       }
23087     ],
23088     "name": "DescribeInteractions",
23089     "group": "Sms_Interactions",
23090     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23091     "version": "0.0.0",
23092     "filename": "server/api/smsInteraction/index.js",
23093     "groupTitle": "Sms_Interactions"
23094   },
23095   {
23096     "type": "get",
23097     "url": "/api/sms/interactions",
23098     "title": "Gets a list of Interactions",
23099     "examples": [
23100       {
23101         "title": "Example usage:",
23102         "content": "curl https://{domain}/api/sms/interactions -v -u {name}:{password}",
23103         "type": "json"
23104       }
23105     ],
23106     "name": "GetInteractions",
23107     "group": "Sms_Interactions",
23108     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23109     "version": "0.0.0",
23110     "filename": "server/api/smsInteraction/index.js",
23111     "groupTitle": "Sms_Interactions"
23112   },
23113   {
23114     "type": "delete",
23115     "url": "/api/sms/interactions/{id}/tags",
23116     "title": "Removes tags from interaction",
23117     "examples": [
23118       {
23119         "title": "Example usage:",
23120         "content": "curl https://{domain}/api/sms/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
23121         "type": "json"
23122       }
23123     ],
23124     "name": "RemoveTags",
23125     "group": "Sms_Interactions",
23126     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23127     "version": "0.0.0",
23128     "filename": "server/api/smsInteraction/index.js",
23129     "groupTitle": "Sms_Interactions"
23130   },
23131   {
23132     "type": "get",
23133     "url": "/api/sms/interactions/{id}",
23134     "title": "Gets a single Interaction",
23135     "examples": [
23136       {
23137         "title": "Example usage:",
23138         "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password}",
23139         "type": "json"
23140       }
23141     ],
23142     "name": "ShowInteractions",
23143     "group": "Sms_Interactions",
23144     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23145     "version": "0.0.0",
23146     "filename": "server/api/smsInteraction/index.js",
23147     "groupTitle": "Sms_Interactions"
23148   },
23149   {
23150     "type": "post",
23151     "url": "/api/sms/interactions/{id}/messages",
23152     "title": "Creates new messages",
23153     "examples": [
23154       {
23155         "title": "Example usage:",
23156         "content": "curl https://{domain}/api/sms/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
23157         "type": "json"
23158       }
23159     ],
23160     "name": "addMessage",
23161     "group": "Sms_Interactions",
23162     "parameter": {
23163       "fields": {
23164         "Body": [
23165           {
23166             "group": "Body",
23167             "type": "Text",
23168             "optional": false,
23169             "field": "body",
23170             "description": ""
23171           },
23172           {
23173             "group": "Body",
23174             "type": "Boolean",
23175             "optional": true,
23176             "field": "read",
23177             "description": ""
23178           },
23179           {
23180             "group": "Body",
23181             "type": "String",
23182             "allowedValues": [
23183               "\"in\"",
23184               "\"out\""
23185             ],
23186             "optional": false,
23187             "field": "direction",
23188             "description": ""
23189           },
23190           {
23191             "group": "Body",
23192             "type": "String",
23193             "optional": true,
23194             "field": "messageId",
23195             "description": ""
23196           },
23197           {
23198             "group": "Body",
23199             "type": "String",
23200             "optional": true,
23201             "field": "phone",
23202             "description": ""
23203           },
23204           {
23205             "group": "Body",
23206             "type": "String",
23207             "optional": true,
23208             "field": "readAt",
23209             "description": ""
23210           },
23211           {
23212             "group": "Body",
23213             "type": "Boolean",
23214             "optional": true,
23215             "field": "secret",
23216             "description": ""
23217           },
23218           {
23219             "group": "Body",
23220             "type": "String",
23221             "optional": true,
23222             "field": "providerName",
23223             "description": ""
23224           },
23225           {
23226             "group": "Body",
23227             "type": "Text",
23228             "optional": true,
23229             "field": "providerResponse",
23230             "description": ""
23231           }
23232         ]
23233       }
23234     },
23235     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23236     "version": "0.0.0",
23237     "filename": "server/api/smsInteraction/index.js",
23238     "groupTitle": "Sms_Interactions"
23239   },
23240   {
23241     "type": "get",
23242     "url": "/api/sms/interactions/{id}/download",
23243     "title": "Gets interaction",
23244     "examples": [
23245       {
23246         "title": "Example usage:",
23247         "content": "curl https://{domain}/api/sms/interactions/{id}/download -v -u {name}:{password} -X GET",
23248         "type": "json"
23249       }
23250     ],
23251     "name": "download",
23252     "group": "Sms_Interactions",
23253     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23254     "version": "0.0.0",
23255     "filename": "server/api/smsInteraction/index.js",
23256     "groupTitle": "Sms_Interactions"
23257   },
23258   {
23259     "type": "get",
23260     "url": "/api/sms/interactions/{id}/messages",
23261     "title": "Gets interaction messages",
23262     "examples": [
23263       {
23264         "title": "Example usage:",
23265         "content": "curl https://{domain}/api/sms/interactions/{id}/messages -v -u {name}:{password} -X GET",
23266         "type": "json"
23267       }
23268     ],
23269     "name": "getMessages",
23270     "group": "Sms_Interactions",
23271     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23272     "version": "0.0.0",
23273     "filename": "server/api/smsInteraction/index.js",
23274     "groupTitle": "Sms_Interactions"
23275   },
23276   {
23277     "type": "put",
23278     "url": "/api/sms/interactions/{id}",
23279     "title": "Update an existing Interaction",
23280     "examples": [
23281       {
23282         "title": "Example usage:",
23283         "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",
23284         "type": "json"
23285       }
23286     ],
23287     "name": "updateInteractions",
23288     "group": "Sms_Interactions",
23289     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23290     "version": "0.0.0",
23291     "filename": "server/api/smsInteraction/index.js",
23292     "groupTitle": "Sms_Interactions"
23293   },
23294   {
23295     "type": "post",
23296     "url": "/api/sms/messages",
23297     "title": "Creates a new Message",
23298     "examples": [
23299       {
23300         "title": "Example usage:",
23301         "content": "curl https://{domain}/api/sms/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23302         "type": "json"
23303       }
23304     ],
23305     "name": "CreateMessages",
23306     "group": "Sms_Messages",
23307     "parameter": {
23308       "fields": {
23309         "Body": [
23310           {
23311             "group": "Body",
23312             "type": "Text",
23313             "optional": false,
23314             "field": "body",
23315             "description": ""
23316           },
23317           {
23318             "group": "Body",
23319             "type": "Boolean",
23320             "optional": true,
23321             "field": "read",
23322             "description": ""
23323           },
23324           {
23325             "group": "Body",
23326             "type": "String",
23327             "allowedValues": [
23328               "\"in\"",
23329               "\"out\""
23330             ],
23331             "optional": false,
23332             "field": "direction",
23333             "description": ""
23334           },
23335           {
23336             "group": "Body",
23337             "type": "String",
23338             "optional": true,
23339             "field": "messageId",
23340             "description": ""
23341           },
23342           {
23343             "group": "Body",
23344             "type": "String",
23345             "optional": true,
23346             "field": "phone",
23347             "description": ""
23348           },
23349           {
23350             "group": "Body",
23351             "type": "String",
23352             "optional": true,
23353             "field": "readAt",
23354             "description": ""
23355           },
23356           {
23357             "group": "Body",
23358             "type": "Boolean",
23359             "optional": true,
23360             "field": "secret",
23361             "description": ""
23362           },
23363           {
23364             "group": "Body",
23365             "type": "String",
23366             "optional": true,
23367             "field": "providerName",
23368             "description": ""
23369           },
23370           {
23371             "group": "Body",
23372             "type": "Text",
23373             "optional": true,
23374             "field": "providerResponse",
23375             "description": ""
23376           }
23377         ]
23378       }
23379     },
23380     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23381     "version": "0.0.0",
23382     "filename": "server/api/smsMessage/index.js",
23383     "groupTitle": "Sms_Messages"
23384   },
23385   {
23386     "type": "delete",
23387     "url": "/api/sms/messages/{id}",
23388     "title": "Deletes a Message",
23389     "examples": [
23390       {
23391         "title": "Example usage:",
23392         "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password} -X DELETE",
23393         "type": "json"
23394       }
23395     ],
23396     "name": "DeleteMessages",
23397     "group": "Sms_Messages",
23398     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23399     "version": "0.0.0",
23400     "filename": "server/api/smsMessage/index.js",
23401     "groupTitle": "Sms_Messages"
23402   },
23403   {
23404     "type": "get",
23405     "url": "/api/sms/messages/describe",
23406     "title": "Gets table info about Messages",
23407     "examples": [
23408       {
23409         "title": "Example usage:",
23410         "content": "curl https://{domain}/api/sms/messages/describe -v -u {name}:{password}",
23411         "type": "json"
23412       }
23413     ],
23414     "name": "DescribeMessages",
23415     "group": "Sms_Messages",
23416     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23417     "version": "0.0.0",
23418     "filename": "server/api/smsMessage/index.js",
23419     "groupTitle": "Sms_Messages"
23420   },
23421   {
23422     "type": "get",
23423     "url": "/api/sms/messages",
23424     "title": "Gets a list of Messages",
23425     "examples": [
23426       {
23427         "title": "Example usage:",
23428         "content": "curl https://{domain}/api/sms/messages -v -u {name}:{password}",
23429         "type": "json"
23430       }
23431     ],
23432     "name": "GetMessages",
23433     "group": "Sms_Messages",
23434     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23435     "version": "0.0.0",
23436     "filename": "server/api/smsMessage/index.js",
23437     "groupTitle": "Sms_Messages"
23438   },
23439   {
23440     "type": "get",
23441     "url": "/api/sms/messages/{id}",
23442     "title": "Gets a single Message",
23443     "examples": [
23444       {
23445         "title": "Example usage:",
23446         "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password}",
23447         "type": "json"
23448       }
23449     ],
23450     "name": "ShowMessages",
23451     "group": "Sms_Messages",
23452     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23453     "version": "0.0.0",
23454     "filename": "server/api/smsMessage/index.js",
23455     "groupTitle": "Sms_Messages"
23456   },
23457   {
23458     "type": "put",
23459     "url": "/api/sms/messages/{id}",
23460     "title": "Update an existing Message",
23461     "examples": [
23462       {
23463         "title": "Example usage:",
23464         "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",
23465         "type": "json"
23466       }
23467     ],
23468     "name": "updateMessages",
23469     "group": "Sms_Messages",
23470     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23471     "version": "0.0.0",
23472     "filename": "server/api/smsMessage/index.js",
23473     "groupTitle": "Sms_Messages"
23474   },
23475   {
23476     "type": "post",
23477     "url": "/api/sms/reports/queue",
23478     "title": "Creates a new Sms Queue Report",
23479     "examples": [
23480       {
23481         "title": "Example usage:",
23482         "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",
23483         "type": "json"
23484       }
23485     ],
23486     "name": "CreateSms_Queue_Reports",
23487     "group": "Sms_Queue_Reports",
23488     "parameter": {
23489       "fields": {
23490         "Body": [
23491           {
23492             "group": "Body",
23493             "type": "String",
23494             "optional": false,
23495             "field": "uniqueid",
23496             "description": ""
23497           },
23498           {
23499             "group": "Body",
23500             "type": "String",
23501             "optional": true,
23502             "field": "from",
23503             "description": ""
23504           },
23505           {
23506             "group": "Body",
23507             "type": "String",
23508             "optional": true,
23509             "field": "joinAt",
23510             "description": ""
23511           },
23512           {
23513             "group": "Body",
23514             "type": "String",
23515             "optional": true,
23516             "field": "leaveAt",
23517             "description": ""
23518           },
23519           {
23520             "group": "Body",
23521             "type": "String",
23522             "optional": true,
23523             "field": "acceptAt",
23524             "description": ""
23525           },
23526           {
23527             "group": "Body",
23528             "type": "String",
23529             "optional": true,
23530             "field": "exitAt",
23531             "description": ""
23532           },
23533           {
23534             "group": "Body",
23535             "type": "String",
23536             "optional": true,
23537             "field": "reason",
23538             "description": ""
23539           }
23540         ]
23541       }
23542     },
23543     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23544     "version": "0.0.0",
23545     "filename": "server/api/smsQueueReport/index.js",
23546     "groupTitle": "Sms_Queue_Reports"
23547   },
23548   {
23549     "type": "delete",
23550     "url": "/api/sms/reports/queue/{id}",
23551     "title": "Deletes a Sms Queue Report",
23552     "examples": [
23553       {
23554         "title": "Example usage:",
23555         "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password} -X DELETE",
23556         "type": "json"
23557       }
23558     ],
23559     "name": "DeleteSms_Queue_Reports",
23560     "group": "Sms_Queue_Reports",
23561     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23562     "version": "0.0.0",
23563     "filename": "server/api/smsQueueReport/index.js",
23564     "groupTitle": "Sms_Queue_Reports"
23565   },
23566   {
23567     "type": "get",
23568     "url": "/api/sms/reports/queue/describe",
23569     "title": "Gets table info about Sms Queue Reports",
23570     "examples": [
23571       {
23572         "title": "Example usage:",
23573         "content": "curl https://{domain}/api/sms/reports/queue/describe -v -u {name}:{password}",
23574         "type": "json"
23575       }
23576     ],
23577     "name": "DescribeSms_Queue_Reports",
23578     "group": "Sms_Queue_Reports",
23579     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23580     "version": "0.0.0",
23581     "filename": "server/api/smsQueueReport/index.js",
23582     "groupTitle": "Sms_Queue_Reports"
23583   },
23584   {
23585     "type": "get",
23586     "url": "/api/sms/reports/queue",
23587     "title": "Gets a list of Sms Queue Reports",
23588     "examples": [
23589       {
23590         "title": "Example usage:",
23591         "content": "curl https://{domain}/api/sms/reports/queue -v -u {name}:{password}",
23592         "type": "json"
23593       }
23594     ],
23595     "name": "GetSms_Queue_Reports",
23596     "group": "Sms_Queue_Reports",
23597     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23598     "version": "0.0.0",
23599     "filename": "server/api/smsQueueReport/index.js",
23600     "groupTitle": "Sms_Queue_Reports"
23601   },
23602   {
23603     "type": "get",
23604     "url": "/api/sms/reports/queue/{id}",
23605     "title": "Gets a single Sms Queue Report",
23606     "examples": [
23607       {
23608         "title": "Example usage:",
23609         "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password}",
23610         "type": "json"
23611       }
23612     ],
23613     "name": "ShowSms_Queue_Reports",
23614     "group": "Sms_Queue_Reports",
23615     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23616     "version": "0.0.0",
23617     "filename": "server/api/smsQueueReport/index.js",
23618     "groupTitle": "Sms_Queue_Reports"
23619   },
23620   {
23621     "type": "put",
23622     "url": "/api/sms/reports/queue/{id}",
23623     "title": "Update an existing Sms Queue Report",
23624     "examples": [
23625       {
23626         "title": "Example usage:",
23627         "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",
23628         "type": "json"
23629       }
23630     ],
23631     "name": "updateSms_Queue_Reports",
23632     "group": "Sms_Queue_Reports",
23633     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23634     "version": "0.0.0",
23635     "filename": "server/api/smsQueueReport/index.js",
23636     "groupTitle": "Sms_Queue_Reports"
23637   },
23638   {
23639     "type": "post",
23640     "url": "/api/sms/queues/{id}/users",
23641     "title": "Add agents to a queue",
23642     "examples": [
23643       {
23644         "title": "Example usage:",
23645         "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",
23646         "type": "json"
23647       }
23648     ],
23649     "name": "AddAgents",
23650     "group": "Sms_Queues",
23651     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23652     "version": "0.0.0",
23653     "filename": "server/api/smsQueue/index.js",
23654     "groupTitle": "Sms_Queues"
23655   },
23656   {
23657     "type": "post",
23658     "url": "/api/sms/queues/{id}/teams",
23659     "title": "Add teams to a queue",
23660     "examples": [
23661       {
23662         "title": "Example usage:",
23663         "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",
23664         "type": "json"
23665       }
23666     ],
23667     "name": "AddTeams",
23668     "group": "Sms_Queues",
23669     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23670     "version": "0.0.0",
23671     "filename": "server/api/smsQueue/index.js",
23672     "groupTitle": "Sms_Queues"
23673   },
23674   {
23675     "type": "post",
23676     "url": "/api/sms/queues",
23677     "title": "Creates a new Queue",
23678     "examples": [
23679       {
23680         "title": "Example usage:",
23681         "content": "curl https://{domain}/api/sms/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23682         "type": "json"
23683       }
23684     ],
23685     "name": "CreateQueues",
23686     "group": "Sms_Queues",
23687     "parameter": {
23688       "fields": {
23689         "Body": [
23690           {
23691             "group": "Body",
23692             "type": "String",
23693             "optional": true,
23694             "field": "name",
23695             "description": ""
23696           },
23697           {
23698             "group": "Body",
23699             "type": "String",
23700             "optional": true,
23701             "field": "description",
23702             "description": ""
23703           },
23704           {
23705             "group": "Body",
23706             "type": "Integer",
23707             "optional": true,
23708             "field": "timeout",
23709             "description": ""
23710           },
23711           {
23712             "group": "Body",
23713             "type": "String",
23714             "allowedValues": [
23715               "\"rrmemory\"",
23716               "\"beepall\"",
23717               "\"roundrobin\""
23718             ],
23719             "optional": true,
23720             "field": "strategy",
23721             "description": ""
23722           }
23723         ]
23724       }
23725     },
23726     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23727     "version": "0.0.0",
23728     "filename": "server/api/smsQueue/index.js",
23729     "groupTitle": "Sms_Queues"
23730   },
23731   {
23732     "type": "delete",
23733     "url": "/api/sms/queues/{id}",
23734     "title": "Deletes a Queue",
23735     "examples": [
23736       {
23737         "title": "Example usage:",
23738         "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password} -X DELETE",
23739         "type": "json"
23740       }
23741     ],
23742     "name": "DeleteQueues",
23743     "group": "Sms_Queues",
23744     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23745     "version": "0.0.0",
23746     "filename": "server/api/smsQueue/index.js",
23747     "groupTitle": "Sms_Queues"
23748   },
23749   {
23750     "type": "get",
23751     "url": "/api/sms/queues/describe",
23752     "title": "Gets table info about Queues",
23753     "examples": [
23754       {
23755         "title": "Example usage:",
23756         "content": "curl https://{domain}/api/sms/queues/describe -v -u {name}:{password}",
23757         "type": "json"
23758       }
23759     ],
23760     "name": "DescribeQueues",
23761     "group": "Sms_Queues",
23762     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23763     "version": "0.0.0",
23764     "filename": "server/api/smsQueue/index.js",
23765     "groupTitle": "Sms_Queues"
23766   },
23767   {
23768     "type": "get",
23769     "url": "/api/sms/queues/{id}/users",
23770     "title": "Gets queue agents",
23771     "examples": [
23772       {
23773         "title": "Example usage:",
23774         "content": "curl https://{domain}/api/sms/queues/{id}/users -v -u {name}:{password} -X POST",
23775         "type": "json"
23776       }
23777     ],
23778     "name": "GetAgents",
23779     "group": "Sms_Queues",
23780     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23781     "version": "0.0.0",
23782     "filename": "server/api/smsQueue/index.js",
23783     "groupTitle": "Sms_Queues"
23784   },
23785   {
23786     "type": "get",
23787     "url": "/api/sms/queues/{id}/members",
23788     "title": "GetMembers",
23789     "examples": [
23790       {
23791         "title": "Example usage:",
23792         "content": "curl https://{domain}/api/sms/queues/{id}/members  -v -u {name}:{password}",
23793         "type": "json"
23794       }
23795     ],
23796     "name": "GetMembers",
23797     "group": "Sms_Queues",
23798     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23799     "version": "0.0.0",
23800     "filename": "server/api/smsQueue/index.js",
23801     "groupTitle": "Sms_Queues"
23802   },
23803   {
23804     "type": "get",
23805     "url": "/api/sms/queues",
23806     "title": "Gets a list of Queues",
23807     "examples": [
23808       {
23809         "title": "Example usage:",
23810         "content": "curl https://{domain}/api/sms/queues -v -u {name}:{password}",
23811         "type": "json"
23812       }
23813     ],
23814     "name": "GetQueues",
23815     "group": "Sms_Queues",
23816     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23817     "version": "0.0.0",
23818     "filename": "server/api/smsQueue/index.js",
23819     "groupTitle": "Sms_Queues"
23820   },
23821   {
23822     "type": "get",
23823     "url": "/api/sms/queues/{id}/teams",
23824     "title": "Gets queues list",
23825     "examples": [
23826       {
23827         "title": "Example usage:",
23828         "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password}",
23829         "type": "json"
23830       }
23831     ],
23832     "name": "GetTeams",
23833     "group": "Sms_Queues",
23834     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23835     "version": "0.0.0",
23836     "filename": "server/api/smsQueue/index.js",
23837     "groupTitle": "Sms_Queues"
23838   },
23839   {
23840     "type": "delete",
23841     "url": "/api/sms/queues/{id}/users",
23842     "title": "Removes agents from a queue",
23843     "examples": [
23844       {
23845         "title": "Example usage:",
23846         "content": "curl https://{domain}/api/sms/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
23847         "type": "json"
23848       }
23849     ],
23850     "name": "RemoveAgents",
23851     "group": "Sms_Queues",
23852     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23853     "version": "0.0.0",
23854     "filename": "server/api/smsQueue/index.js",
23855     "groupTitle": "Sms_Queues"
23856   },
23857   {
23858     "type": "get",
23859     "url": "/api/sms/queues/{id}",
23860     "title": "Gets a single Queue",
23861     "examples": [
23862       {
23863         "title": "Example usage:",
23864         "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password}",
23865         "type": "json"
23866       }
23867     ],
23868     "name": "ShowQueues",
23869     "group": "Sms_Queues",
23870     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23871     "version": "0.0.0",
23872     "filename": "server/api/smsQueue/index.js",
23873     "groupTitle": "Sms_Queues"
23874   },
23875   {
23876     "type": "put",
23877     "url": "/api/sms/queues/{id}",
23878     "title": "Update an existing Queue",
23879     "examples": [
23880       {
23881         "title": "Example usage:",
23882         "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",
23883         "type": "json"
23884       }
23885     ],
23886     "name": "updateQueues",
23887     "group": "Sms_Queues",
23888     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23889     "version": "0.0.0",
23890     "filename": "server/api/smsQueue/index.js",
23891     "groupTitle": "Sms_Queues"
23892   },
23893   {
23894     "type": "post",
23895     "url": "/api/sms/reports/transfer",
23896     "title": "Creates a new Sms Transfer Report",
23897     "examples": [
23898       {
23899         "title": "Example usage:",
23900         "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",
23901         "type": "json"
23902       }
23903     ],
23904     "name": "CreateSms_Transfer_Reports",
23905     "group": "Sms_Transfer_Reports",
23906     "parameter": {
23907       "fields": {
23908         "Body": [
23909           {
23910             "group": "Body",
23911             "type": "String",
23912             "optional": false,
23913             "field": "uniqueid",
23914             "description": ""
23915           },
23916           {
23917             "group": "Body",
23918             "type": "String",
23919             "allowedValues": [
23920               "\"account\"",
23921               "\"agent\"",
23922               "\"queue\""
23923             ],
23924             "optional": false,
23925             "field": "type",
23926             "description": ""
23927           },
23928           {
23929             "group": "Body",
23930             "type": "String",
23931             "optional": false,
23932             "field": "transferredAt",
23933             "description": ""
23934           }
23935         ]
23936       }
23937     },
23938     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23939     "version": "0.0.0",
23940     "filename": "server/api/smsTransferReport/index.js",
23941     "groupTitle": "Sms_Transfer_Reports"
23942   },
23943   {
23944     "type": "delete",
23945     "url": "/api/sms/reports/transfer/{id}",
23946     "title": "Deletes a Sms Transfer Report",
23947     "examples": [
23948       {
23949         "title": "Example usage:",
23950         "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
23951         "type": "json"
23952       }
23953     ],
23954     "name": "DeleteSms_Transfer_Reports",
23955     "group": "Sms_Transfer_Reports",
23956     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23957     "version": "0.0.0",
23958     "filename": "server/api/smsTransferReport/index.js",
23959     "groupTitle": "Sms_Transfer_Reports"
23960   },
23961   {
23962     "type": "get",
23963     "url": "/api/sms/reports/transfer/describe",
23964     "title": "Gets table info about Sms Transfer Reports",
23965     "examples": [
23966       {
23967         "title": "Example usage:",
23968         "content": "curl https://{domain}/api/sms/reports/transfer/describe -v -u {name}:{password}",
23969         "type": "json"
23970       }
23971     ],
23972     "name": "DescribeSms_Transfer_Reports",
23973     "group": "Sms_Transfer_Reports",
23974     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23975     "version": "0.0.0",
23976     "filename": "server/api/smsTransferReport/index.js",
23977     "groupTitle": "Sms_Transfer_Reports"
23978   },
23979   {
23980     "type": "get",
23981     "url": "/api/sms/reports/transfer",
23982     "title": "Gets a list of Sms Transfer Reports",
23983     "examples": [
23984       {
23985         "title": "Example usage:",
23986         "content": "curl https://{domain}/api/sms/reports/transfer -v -u {name}:{password}",
23987         "type": "json"
23988       }
23989     ],
23990     "name": "GetSms_Transfer_Reports",
23991     "group": "Sms_Transfer_Reports",
23992     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23993     "version": "0.0.0",
23994     "filename": "server/api/smsTransferReport/index.js",
23995     "groupTitle": "Sms_Transfer_Reports"
23996   },
23997   {
23998     "type": "get",
23999     "url": "/api/sms/reports/transfer/{id}",
24000     "title": "Gets a single Sms Transfer Report",
24001     "examples": [
24002       {
24003         "title": "Example usage:",
24004         "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password}",
24005         "type": "json"
24006       }
24007     ],
24008     "name": "ShowSms_Transfer_Reports",
24009     "group": "Sms_Transfer_Reports",
24010     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24011     "version": "0.0.0",
24012     "filename": "server/api/smsTransferReport/index.js",
24013     "groupTitle": "Sms_Transfer_Reports"
24014   },
24015   {
24016     "type": "put",
24017     "url": "/api/sms/reports/transfer/{id}",
24018     "title": "Update an existing Sms Transfer Report",
24019     "examples": [
24020       {
24021         "title": "Example usage:",
24022         "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",
24023         "type": "json"
24024       }
24025     ],
24026     "name": "updateSms_Transfer_Reports",
24027     "group": "Sms_Transfer_Reports",
24028     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24029     "version": "0.0.0",
24030     "filename": "server/api/smsTransferReport/index.js",
24031     "groupTitle": "Sms_Transfer_Reports"
24032   },
24033   {
24034     "type": "get",
24035     "url": "/api/sounds",
24036     "title": "Gets a list of Sounds",
24037     "examples": [
24038       {
24039         "title": "Example usage:",
24040         "content": "curl https://{domain}/api/sounds -v -u {name}:{password}",
24041         "type": "json"
24042       }
24043     ],
24044     "name": "GetSounds",
24045     "group": "Sounds",
24046     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24047     "version": "0.0.0",
24048     "filename": "server/api/sound/index.js",
24049     "groupTitle": "Sounds"
24050   },
24051   {
24052     "type": "get",
24053     "url": "/api/sounds/{id}",
24054     "title": "Gets a single Sound",
24055     "examples": [
24056       {
24057         "title": "Example usage:",
24058         "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password}",
24059         "type": "json"
24060       }
24061     ],
24062     "name": "ShowSounds",
24063     "group": "Sounds",
24064     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24065     "version": "0.0.0",
24066     "filename": "server/api/sound/index.js",
24067     "groupTitle": "Sounds"
24068   },
24069   {
24070     "type": "post",
24071     "url": "/api/sounds",
24072     "title": "Create a new sound",
24073     "examples": [
24074       {
24075         "title": "Example usage:",
24076         "content": "curl https://{domain}/api/sounds -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
24077         "type": "json"
24078       }
24079     ],
24080     "name": "addSound",
24081     "group": "Sounds",
24082     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24083     "version": "0.0.0",
24084     "filename": "server/api/sound/index.js",
24085     "groupTitle": "Sounds"
24086   },
24087   {
24088     "type": "delete",
24089     "url": "/api/sounds/{id}",
24090     "title": "Deletes a sound",
24091     "examples": [
24092       {
24093         "title": "Example usage:",
24094         "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password} -X DELETE",
24095         "type": "json"
24096       }
24097     ],
24098     "name": "destroySound",
24099     "group": "Sounds",
24100     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24101     "version": "0.0.0",
24102     "filename": "server/api/sound/index.js",
24103     "groupTitle": "Sounds"
24104   },
24105   {
24106     "type": "get",
24107     "url": "/api/sounds/{id}/download",
24108     "title": "Download Sound",
24109     "examples": [
24110       {
24111         "title": "Example usage:",
24112         "content": "curl https://{domain}/api/sounds/{id}/download -v -u {name}:{password} -X GET",
24113         "type": "json"
24114       }
24115     ],
24116     "name": "download",
24117     "group": "Sounds",
24118     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24119     "version": "0.0.0",
24120     "filename": "server/api/sound/index.js",
24121     "groupTitle": "Sounds"
24122   },
24123   {
24124     "type": "put",
24125     "url": "/api/sounds",
24126     "title": "Update an existing new sound",
24127     "examples": [
24128       {
24129         "title": "Example usage:",
24130         "content": "curl https://{domain}/api/sounds -d '[\"name\": \"sound_name\", \"description\": \"sound_desc\"]' -v -u {name}:{password} -X PUT",
24131         "type": "json"
24132       }
24133     ],
24134     "name": "updateSound",
24135     "group": "Sounds",
24136     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24137     "version": "0.0.0",
24138     "filename": "server/api/sound/index.js",
24139     "groupTitle": "Sounds"
24140   },
24141   {
24142     "type": "post",
24143     "url": "/api/square/details/reports",
24144     "title": "Creates a new Square Detail Report",
24145     "examples": [
24146       {
24147         "title": "Example usage:",
24148         "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",
24149         "type": "json"
24150       }
24151     ],
24152     "name": "CreateSquare_Detail_Reports",
24153     "group": "Square_Details_Reports",
24154     "parameter": {
24155       "fields": {
24156         "Body": [
24157           {
24158             "group": "Body",
24159             "type": "String",
24160             "optional": true,
24161             "field": "uniqueid",
24162             "description": ""
24163           },
24164           {
24165             "group": "Body",
24166             "type": "String",
24167             "optional": true,
24168             "field": "node",
24169             "description": ""
24170           },
24171           {
24172             "group": "Body",
24173             "type": "String",
24174             "optional": true,
24175             "field": "application",
24176             "description": ""
24177           },
24178           {
24179             "group": "Body",
24180             "type": "Text",
24181             "optional": true,
24182             "field": "data",
24183             "description": ""
24184           },
24185           {
24186             "group": "Body",
24187             "type": "String",
24188             "optional": true,
24189             "field": "project_name",
24190             "description": ""
24191           },
24192           {
24193             "group": "Body",
24194             "type": "String",
24195             "optional": true,
24196             "field": "callerid",
24197             "description": ""
24198           }
24199         ]
24200       }
24201     },
24202     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24203     "version": "0.0.0",
24204     "filename": "server/api/squareReportDetail/index.js",
24205     "groupTitle": "Square_Details_Reports"
24206   },
24207   {
24208     "type": "delete",
24209     "url": "/api/square/details/reports/{id}",
24210     "title": "Deletes a Square Detail Report",
24211     "examples": [
24212       {
24213         "title": "Example usage:",
24214         "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password} -X DELETE",
24215         "type": "json"
24216       }
24217     ],
24218     "name": "DeleteSquare_Detail_Reports",
24219     "group": "Square_Details_Reports",
24220     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24221     "version": "0.0.0",
24222     "filename": "server/api/squareReportDetail/index.js",
24223     "groupTitle": "Square_Details_Reports"
24224   },
24225   {
24226     "type": "get",
24227     "url": "/api/square/details/reports/describe",
24228     "title": "Gets table info about Square Detail Reports",
24229     "examples": [
24230       {
24231         "title": "Example usage:",
24232         "content": "curl https://{domain}/api/square/details/reports/describe -v -u {name}:{password}",
24233         "type": "json"
24234       }
24235     ],
24236     "name": "DescribeSquare_Detail_Reports",
24237     "group": "Square_Details_Reports",
24238     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24239     "version": "0.0.0",
24240     "filename": "server/api/squareReportDetail/index.js",
24241     "groupTitle": "Square_Details_Reports"
24242   },
24243   {
24244     "type": "get",
24245     "url": "/api/square/details/reports",
24246     "title": "Gets a list of Square Detail Reports",
24247     "examples": [
24248       {
24249         "title": "Example usage:",
24250         "content": "curl https://{domain}/api/square/details/reports -v -u {name}:{password}",
24251         "type": "json"
24252       }
24253     ],
24254     "name": "GetSquare_Detail_Reports",
24255     "group": "Square_Details_Reports",
24256     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24257     "version": "0.0.0",
24258     "filename": "server/api/squareReportDetail/index.js",
24259     "groupTitle": "Square_Details_Reports"
24260   },
24261   {
24262     "type": "get",
24263     "url": "/api/square/details/reports/{id}",
24264     "title": "Gets a single Square Detail Report",
24265     "examples": [
24266       {
24267         "title": "Example usage:",
24268         "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password}",
24269         "type": "json"
24270       }
24271     ],
24272     "name": "ShowSquare_Detail_Reports",
24273     "group": "Square_Details_Reports",
24274     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24275     "version": "0.0.0",
24276     "filename": "server/api/squareReportDetail/index.js",
24277     "groupTitle": "Square_Details_Reports"
24278   },
24279   {
24280     "type": "put",
24281     "url": "/api/square/details/reports/{id}",
24282     "title": "Update an existing Square Detail Report",
24283     "examples": [
24284       {
24285         "title": "Example usage:",
24286         "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",
24287         "type": "json"
24288       }
24289     ],
24290     "name": "updateSquare_Detail_Reports",
24291     "group": "Square_Details_Reports",
24292     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24293     "version": "0.0.0",
24294     "filename": "server/api/squareReportDetail/index.js",
24295     "groupTitle": "Square_Details_Reports"
24296   },
24297   {
24298     "type": "post",
24299     "url": "/api/square/messages",
24300     "title": "Creates a new Message",
24301     "examples": [
24302       {
24303         "title": "Example usage:",
24304         "content": "curl https://{domain}/api/square/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24305         "type": "json"
24306       }
24307     ],
24308     "name": "CreateMessages",
24309     "group": "Square_Messages",
24310     "parameter": {
24311       "fields": {
24312         "Body": [
24313           {
24314             "group": "Body",
24315             "type": "String",
24316             "optional": true,
24317             "field": "uniqueid",
24318             "description": ""
24319           },
24320           {
24321             "group": "Body",
24322             "type": "Text",
24323             "optional": false,
24324             "field": "body",
24325             "description": ""
24326           },
24327           {
24328             "group": "Body",
24329             "type": "String",
24330             "allowedValues": [
24331               "\"in\"",
24332               "\"out\""
24333             ],
24334             "optional": false,
24335             "field": "direction",
24336             "description": ""
24337           },
24338           {
24339             "group": "Body",
24340             "type": "String",
24341             "optional": true,
24342             "field": "providerName",
24343             "description": ""
24344           },
24345           {
24346             "group": "Body",
24347             "type": "Text",
24348             "optional": true,
24349             "field": "providerResponse",
24350             "description": ""
24351           }
24352         ]
24353       }
24354     },
24355     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24356     "version": "0.0.0",
24357     "filename": "server/api/squareMessage/index.js",
24358     "groupTitle": "Square_Messages"
24359   },
24360   {
24361     "type": "delete",
24362     "url": "/api/square/messages/{id}",
24363     "title": "Deletes a Message",
24364     "examples": [
24365       {
24366         "title": "Example usage:",
24367         "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password} -X DELETE",
24368         "type": "json"
24369       }
24370     ],
24371     "name": "DeleteMessages",
24372     "group": "Square_Messages",
24373     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24374     "version": "0.0.0",
24375     "filename": "server/api/squareMessage/index.js",
24376     "groupTitle": "Square_Messages"
24377   },
24378   {
24379     "type": "get",
24380     "url": "/api/square/messages",
24381     "title": "Gets a list of Messages",
24382     "examples": [
24383       {
24384         "title": "Example usage:",
24385         "content": "curl https://{domain}/api/square/messages -v -u {name}:{password}",
24386         "type": "json"
24387       }
24388     ],
24389     "name": "GetMessages",
24390     "group": "Square_Messages",
24391     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24392     "version": "0.0.0",
24393     "filename": "server/api/squareMessage/index.js",
24394     "groupTitle": "Square_Messages"
24395   },
24396   {
24397     "type": "get",
24398     "url": "/api/square/messages/{id}",
24399     "title": "Gets a single Message",
24400     "examples": [
24401       {
24402         "title": "Example usage:",
24403         "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password}",
24404         "type": "json"
24405       }
24406     ],
24407     "name": "ShowMessages",
24408     "group": "Square_Messages",
24409     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24410     "version": "0.0.0",
24411     "filename": "server/api/squareMessage/index.js",
24412     "groupTitle": "Square_Messages"
24413   },
24414   {
24415     "type": "put",
24416     "url": "/api/square/messages/{id}",
24417     "title": "Update an existing Message",
24418     "examples": [
24419       {
24420         "title": "Example usage:",
24421         "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",
24422         "type": "json"
24423       }
24424     ],
24425     "name": "updateMessages",
24426     "group": "Square_Messages",
24427     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24428     "version": "0.0.0",
24429     "filename": "server/api/squareMessage/index.js",
24430     "groupTitle": "Square_Messages"
24431   },
24432   {
24433     "type": "post",
24434     "url": "/api/square/odbc",
24435     "title": "Creates a new ODBC",
24436     "examples": [
24437       {
24438         "title": "Example usage:",
24439         "content": "curl https://{domain}/api/square/odbc -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24440         "type": "json"
24441       }
24442     ],
24443     "name": "CreateODBCs",
24444     "group": "Square_ODBC",
24445     "parameter": {
24446       "fields": {
24447         "Body": [
24448           {
24449             "group": "Body",
24450             "type": "String",
24451             "optional": false,
24452             "field": "name",
24453             "description": ""
24454           },
24455           {
24456             "group": "Body",
24457             "type": "String",
24458             "optional": true,
24459             "field": "dsn",
24460             "description": ""
24461           },
24462           {
24463             "group": "Body",
24464             "type": "String",
24465             "optional": true,
24466             "field": "description",
24467             "description": ""
24468           }
24469         ]
24470       }
24471     },
24472     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24473     "version": "0.0.0",
24474     "filename": "server/api/squareOdbc/index.js",
24475     "groupTitle": "Square_ODBC"
24476   },
24477   {
24478     "type": "delete",
24479     "url": "/api/square/odbc/{id}",
24480     "title": "Deletes a ODBC",
24481     "examples": [
24482       {
24483         "title": "Example usage:",
24484         "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password} -X DELETE",
24485         "type": "json"
24486       }
24487     ],
24488     "name": "DeleteODBCs",
24489     "group": "Square_ODBC",
24490     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24491     "version": "0.0.0",
24492     "filename": "server/api/squareOdbc/index.js",
24493     "groupTitle": "Square_ODBC"
24494   },
24495   {
24496     "type": "get",
24497     "url": "/api/square/odbc",
24498     "title": "Gets a list of ODBCs",
24499     "examples": [
24500       {
24501         "title": "Example usage:",
24502         "content": "curl https://{domain}/api/square/odbc -v -u {name}:{password}",
24503         "type": "json"
24504       }
24505     ],
24506     "name": "GetODBCs",
24507     "group": "Square_ODBC",
24508     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24509     "version": "0.0.0",
24510     "filename": "server/api/squareOdbc/index.js",
24511     "groupTitle": "Square_ODBC"
24512   },
24513   {
24514     "type": "get",
24515     "url": "/api/square/odbc/{id}",
24516     "title": "Gets a single ODBC",
24517     "examples": [
24518       {
24519         "title": "Example usage:",
24520         "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password}",
24521         "type": "json"
24522       }
24523     ],
24524     "name": "ShowODBCs",
24525     "group": "Square_ODBC",
24526     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24527     "version": "0.0.0",
24528     "filename": "server/api/squareOdbc/index.js",
24529     "groupTitle": "Square_ODBC"
24530   },
24531   {
24532     "type": "get",
24533     "url": "/api/square/odbc/{id}/test",
24534     "title": "Test Odbc",
24535     "examples": [
24536       {
24537         "title": "Example usage:",
24538         "content": "curl https://{domain}/api/square/odbc/{id}/test -v -u {name}:{password} -X GET",
24539         "type": "json"
24540       }
24541     ],
24542     "name": "test",
24543     "group": "Square_ODBC",
24544     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24545     "version": "0.0.0",
24546     "filename": "server/api/squareOdbc/index.js",
24547     "groupTitle": "Square_ODBC"
24548   },
24549   {
24550     "type": "put",
24551     "url": "/api/square/odbc/{id}",
24552     "title": "Update an existing ODBC",
24553     "examples": [
24554       {
24555         "title": "Example usage:",
24556         "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",
24557         "type": "json"
24558       }
24559     ],
24560     "name": "updateODBCs",
24561     "group": "Square_ODBC",
24562     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24563     "version": "0.0.0",
24564     "filename": "server/api/squareOdbc/index.js",
24565     "groupTitle": "Square_ODBC"
24566   },
24567   {
24568     "type": "post",
24569     "url": "/api/square/projects",
24570     "title": "Creates a new Project",
24571     "examples": [
24572       {
24573         "title": "Example usage:",
24574         "content": "curl https://{domain}/api/square/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24575         "type": "json"
24576       }
24577     ],
24578     "name": "CreateProjects",
24579     "group": "Square_Projects",
24580     "parameter": {
24581       "fields": {
24582         "Body": [
24583           {
24584             "group": "Body",
24585             "type": "String",
24586             "optional": false,
24587             "field": "name",
24588             "description": ""
24589           },
24590           {
24591             "group": "Body",
24592             "type": "String",
24593             "optional": true,
24594             "field": "description",
24595             "description": ""
24596           },
24597           {
24598             "group": "Body",
24599             "type": "Text",
24600             "optional": true,
24601             "field": "notes",
24602             "description": ""
24603           },
24604           {
24605             "group": "Body",
24606             "type": "Blob",
24607             "optional": true,
24608             "field": "preproduction",
24609             "description": ""
24610           },
24611           {
24612             "group": "Body",
24613             "type": "Blob",
24614             "optional": true,
24615             "field": "production",
24616             "description": ""
24617           },
24618           {
24619             "group": "Body",
24620             "type": "String",
24621             "optional": true,
24622             "field": "savedAt",
24623             "description": ""
24624           },
24625           {
24626             "group": "Body",
24627             "type": "String",
24628             "optional": true,
24629             "field": "publishedAt",
24630             "description": ""
24631           }
24632         ]
24633       }
24634     },
24635     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24636     "version": "0.0.0",
24637     "filename": "server/api/squareProject/index.js",
24638     "groupTitle": "Square_Projects"
24639   },
24640   {
24641     "type": "delete",
24642     "url": "/api/square/projects/{id}",
24643     "title": "Deletes a Project",
24644     "examples": [
24645       {
24646         "title": "Example usage:",
24647         "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password} -X DELETE",
24648         "type": "json"
24649       }
24650     ],
24651     "name": "DeleteProjects",
24652     "group": "Square_Projects",
24653     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24654     "version": "0.0.0",
24655     "filename": "server/api/squareProject/index.js",
24656     "groupTitle": "Square_Projects"
24657   },
24658   {
24659     "type": "get",
24660     "url": "/api/square/projects",
24661     "title": "Gets a list of Projects",
24662     "examples": [
24663       {
24664         "title": "Example usage:",
24665         "content": "curl https://{domain}/api/square/projects -v -u {name}:{password}",
24666         "type": "json"
24667       }
24668     ],
24669     "name": "GetProjects",
24670     "group": "Square_Projects",
24671     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24672     "version": "0.0.0",
24673     "filename": "server/api/squareProject/index.js",
24674     "groupTitle": "Square_Projects"
24675   },
24676   {
24677     "type": "get",
24678     "url": "/api/square/projects/{id}",
24679     "title": "Gets a single Project",
24680     "examples": [
24681       {
24682         "title": "Example usage:",
24683         "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password}",
24684         "type": "json"
24685       }
24686     ],
24687     "name": "ShowProjects",
24688     "group": "Square_Projects",
24689     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24690     "version": "0.0.0",
24691     "filename": "server/api/squareProject/index.js",
24692     "groupTitle": "Square_Projects"
24693   },
24694   {
24695     "type": "post",
24696     "url": "/api/square/projects/{id}/users",
24697     "title": "Adds user permissions to a Project",
24698     "examples": [
24699       {
24700         "title": "Example usage:",
24701         "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",
24702         "type": "json"
24703       }
24704     ],
24705     "name": "addUsers",
24706     "group": "Square_Projects",
24707     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24708     "version": "0.0.0",
24709     "filename": "server/api/squareProject/index.js",
24710     "groupTitle": "Square_Projects"
24711   },
24712   {
24713     "type": "get",
24714     "url": "/api/square/projects/{id}/users",
24715     "title": "Gets users permissions from Project",
24716     "examples": [
24717       {
24718         "title": "Example usage:",
24719         "content": "curl https://{domain}/api/square/projects/{id}/users -v -u {name}:{password} -X GET",
24720         "type": "json"
24721       }
24722     ],
24723     "name": "getUsers",
24724     "group": "Square_Projects",
24725     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24726     "version": "0.0.0",
24727     "filename": "server/api/squareProject/index.js",
24728     "groupTitle": "Square_Projects"
24729   },
24730   {
24731     "type": "delete",
24732     "url": "/api/square/projects/{id}/users",
24733     "title": "Removes user permissions from a Project",
24734     "examples": [
24735       {
24736         "title": "Example usage:",
24737         "content": "curl https://{domain}/api/square/projects/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
24738         "type": "json"
24739       }
24740     ],
24741     "name": "removeUsers",
24742     "group": "Square_Projects",
24743     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24744     "version": "0.0.0",
24745     "filename": "server/api/squareProject/index.js",
24746     "groupTitle": "Square_Projects"
24747   },
24748   {
24749     "type": "put",
24750     "url": "/api/square/projects/{id}",
24751     "title": "Update an existing Project",
24752     "examples": [
24753       {
24754         "title": "Example usage:",
24755         "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",
24756         "type": "json"
24757       }
24758     ],
24759     "name": "updateProjects",
24760     "group": "Square_Projects",
24761     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24762     "version": "0.0.0",
24763     "filename": "server/api/squareProject/index.js",
24764     "groupTitle": "Square_Projects"
24765   },
24766   {
24767     "type": "post",
24768     "url": "/api/square/recordings",
24769     "title": "Creates a new Recording",
24770     "examples": [
24771       {
24772         "title": "Example usage:",
24773         "content": "curl https://{domain}/api/square/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24774         "type": "json"
24775       }
24776     ],
24777     "name": "CreateRecordings",
24778     "group": "Square_Recordings",
24779     "parameter": {
24780       "fields": {
24781         "Body": [
24782           {
24783             "group": "Body",
24784             "type": "String",
24785             "optional": true,
24786             "field": "uniqueid",
24787             "description": ""
24788           },
24789           {
24790             "group": "Body",
24791             "type": "String",
24792             "optional": true,
24793             "field": "callerid",
24794             "description": ""
24795           },
24796           {
24797             "group": "Body",
24798             "type": "String",
24799             "optional": true,
24800             "field": "calleridname",
24801             "description": ""
24802           },
24803           {
24804             "group": "Body",
24805             "type": "String",
24806             "optional": true,
24807             "field": "context",
24808             "description": ""
24809           },
24810           {
24811             "group": "Body",
24812             "type": "String",
24813             "optional": true,
24814             "field": "extension",
24815             "description": ""
24816           },
24817           {
24818             "group": "Body",
24819             "type": "String",
24820             "optional": true,
24821             "field": "priority",
24822             "description": ""
24823           },
24824           {
24825             "group": "Body",
24826             "type": "String",
24827             "optional": true,
24828             "field": "accountcode",
24829             "description": ""
24830           },
24831           {
24832             "group": "Body",
24833             "type": "String",
24834             "optional": true,
24835             "field": "dnid",
24836             "description": ""
24837           },
24838           {
24839             "group": "Body",
24840             "type": "String",
24841             "optional": true,
24842             "field": "projectName",
24843             "description": ""
24844           },
24845           {
24846             "group": "Body",
24847             "type": "String",
24848             "optional": true,
24849             "field": "saveName",
24850             "description": ""
24851           },
24852           {
24853             "group": "Body",
24854             "type": "String",
24855             "optional": true,
24856             "field": "filename",
24857             "description": ""
24858           },
24859           {
24860             "group": "Body",
24861             "type": "String",
24862             "optional": true,
24863             "field": "savePath",
24864             "description": ""
24865           },
24866           {
24867             "group": "Body",
24868             "type": "Virtual",
24869             "optional": true,
24870             "field": "format",
24871             "description": ""
24872           }
24873         ]
24874       }
24875     },
24876     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24877     "version": "0.0.0",
24878     "filename": "server/api/squareRecording/index.js",
24879     "groupTitle": "Square_Recordings"
24880   },
24881   {
24882     "type": "get",
24883     "url": "/api/square/recordings",
24884     "title": "Gets a list of Recordings",
24885     "examples": [
24886       {
24887         "title": "Example usage:",
24888         "content": "curl https://{domain}/api/square/recordings -v -u {name}:{password}",
24889         "type": "json"
24890       }
24891     ],
24892     "name": "GetRecordings",
24893     "group": "Square_Recordings",
24894     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24895     "version": "0.0.0",
24896     "filename": "server/api/squareRecording/index.js",
24897     "groupTitle": "Square_Recordings"
24898   },
24899   {
24900     "type": "get",
24901     "url": "/api/square/recordings/{id}",
24902     "title": "Gets a single Recording",
24903     "examples": [
24904       {
24905         "title": "Example usage:",
24906         "content": "curl https://{domain}/api/square/recordings/{id} -v -u {name}:{password}",
24907         "type": "json"
24908       }
24909     ],
24910     "name": "ShowRecordings",
24911     "group": "Square_Recordings",
24912     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24913     "version": "0.0.0",
24914     "filename": "server/api/squareRecording/index.js",
24915     "groupTitle": "Square_Recordings"
24916   },
24917   {
24918     "type": "delete",
24919     "url": "/api/square/recordings/{id}/delete",
24920     "title": "Delete recording",
24921     "examples": [
24922       {
24923         "title": "Example usage:",
24924         "content": "curl https://{domain}/api/square/recordings/{id}/delete -v -u {name}:{password} -X DELETE",
24925         "type": "json"
24926       }
24927     ],
24928     "name": "destroy",
24929     "group": "Square_Recordings",
24930     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24931     "version": "0.0.0",
24932     "filename": "server/api/squareRecording/index.js",
24933     "groupTitle": "Square_Recordings"
24934   },
24935   {
24936     "type": "get",
24937     "url": "/api/square/recordings/{id}/download",
24938     "title": "Download Recording",
24939     "examples": [
24940       {
24941         "title": "Example usage:",
24942         "content": "curl https://{domain}/api/square/recordings/{id}/download -v -u {name}:{password} -X GET",
24943         "type": "json"
24944       }
24945     ],
24946     "name": "download",
24947     "group": "Square_Recordings",
24948     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24949     "version": "0.0.0",
24950     "filename": "server/api/squareRecording/index.js",
24951     "groupTitle": "Square_Recordings"
24952   },
24953   {
24954     "type": "put",
24955     "url": "/api/square/recordings/{id}",
24956     "title": "Update an existing Recording",
24957     "examples": [
24958       {
24959         "title": "Example usage:",
24960         "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",
24961         "type": "json"
24962       }
24963     ],
24964     "name": "updateRecordings",
24965     "group": "Square_Recordings",
24966     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24967     "version": "0.0.0",
24968     "filename": "server/api/squareRecording/index.js",
24969     "groupTitle": "Square_Recordings"
24970   },
24971   {
24972     "type": "post",
24973     "url": "/api/square/reports",
24974     "title": "Creates a new Square Report",
24975     "examples": [
24976       {
24977         "title": "Example usage:",
24978         "content": "curl https://{domain}/api/square/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24979         "type": "json"
24980       }
24981     ],
24982     "name": "CreateSquare_Reports",
24983     "group": "Square_Reports",
24984     "parameter": {
24985       "fields": {
24986         "Body": [
24987           {
24988             "group": "Body",
24989             "type": "String",
24990             "optional": true,
24991             "field": "network",
24992             "description": ""
24993           },
24994           {
24995             "group": "Body",
24996             "type": "String",
24997             "optional": true,
24998             "field": "network_script",
24999             "description": ""
25000           },
25001           {
25002             "group": "Body",
25003             "type": "String",
25004             "optional": true,
25005             "field": "request",
25006             "description": ""
25007           },
25008           {
25009             "group": "Body",
25010             "type": "String",
25011             "optional": true,
25012             "field": "channel",
25013             "description": ""
25014           },
25015           {
25016             "group": "Body",
25017             "type": "String",
25018             "optional": true,
25019             "field": "language",
25020             "description": ""
25021           },
25022           {
25023             "group": "Body",
25024             "type": "String",
25025             "optional": true,
25026             "field": "type",
25027             "description": ""
25028           },
25029           {
25030             "group": "Body",
25031             "type": "String",
25032             "optional": true,
25033             "field": "uniqueid",
25034             "description": ""
25035           },
25036           {
25037             "group": "Body",
25038             "type": "String",
25039             "optional": true,
25040             "field": "version",
25041             "description": ""
25042           },
25043           {
25044             "group": "Body",
25045             "type": "String",
25046             "optional": true,
25047             "field": "callerid",
25048             "description": ""
25049           },
25050           {
25051             "group": "Body",
25052             "type": "String",
25053             "optional": true,
25054             "field": "calleridname",
25055             "description": ""
25056           },
25057           {
25058             "group": "Body",
25059             "type": "String",
25060             "optional": true,
25061             "field": "callingpres",
25062             "description": ""
25063           },
25064           {
25065             "group": "Body",
25066             "type": "String",
25067             "optional": true,
25068             "field": "callingani2",
25069             "description": ""
25070           },
25071           {
25072             "group": "Body",
25073             "type": "String",
25074             "optional": true,
25075             "field": "callington",
25076             "description": ""
25077           },
25078           {
25079             "group": "Body",
25080             "type": "String",
25081             "optional": true,
25082             "field": "callingtns",
25083             "description": ""
25084           },
25085           {
25086             "group": "Body",
25087             "type": "String",
25088             "optional": true,
25089             "field": "dnid",
25090             "description": ""
25091           },
25092           {
25093             "group": "Body",
25094             "type": "String",
25095             "optional": true,
25096             "field": "rdnis",
25097             "description": ""
25098           },
25099           {
25100             "group": "Body",
25101             "type": "String",
25102             "optional": true,
25103             "field": "context",
25104             "description": ""
25105           },
25106           {
25107             "group": "Body",
25108             "type": "String",
25109             "optional": true,
25110             "field": "extension",
25111             "description": ""
25112           },
25113           {
25114             "group": "Body",
25115             "type": "String",
25116             "optional": true,
25117             "field": "priority",
25118             "description": ""
25119           },
25120           {
25121             "group": "Body",
25122             "type": "String",
25123             "optional": true,
25124             "field": "enhanced",
25125             "description": ""
25126           },
25127           {
25128             "group": "Body",
25129             "type": "String",
25130             "optional": true,
25131             "field": "accountcode",
25132             "description": ""
25133           },
25134           {
25135             "group": "Body",
25136             "type": "String",
25137             "optional": true,
25138             "field": "threadid",
25139             "description": ""
25140           },
25141           {
25142             "group": "Body",
25143             "type": "String",
25144             "optional": true,
25145             "field": "project_name",
25146             "description": ""
25147           },
25148           {
25149             "group": "Body",
25150             "type": "String",
25151             "optional": true,
25152             "field": "joinAt",
25153             "description": ""
25154           },
25155           {
25156             "group": "Body",
25157             "type": "String",
25158             "optional": true,
25159             "field": "leaveAt",
25160             "description": ""
25161           },
25162           {
25163             "group": "Body",
25164             "type": "Boolean",
25165             "optional": true,
25166             "field": "bot",
25167             "description": ""
25168           }
25169         ]
25170       }
25171     },
25172     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25173     "version": "0.0.0",
25174     "filename": "server/api/squareReport/index.js",
25175     "groupTitle": "Square_Reports"
25176   },
25177   {
25178     "type": "delete",
25179     "url": "/api/square/reports/{id}",
25180     "title": "Deletes a Square Report",
25181     "examples": [
25182       {
25183         "title": "Example usage:",
25184         "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password} -X DELETE",
25185         "type": "json"
25186       }
25187     ],
25188     "name": "DeleteSquare_Reports",
25189     "group": "Square_Reports",
25190     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25191     "version": "0.0.0",
25192     "filename": "server/api/squareReport/index.js",
25193     "groupTitle": "Square_Reports"
25194   },
25195   {
25196     "type": "get",
25197     "url": "/api/square/reports/describe",
25198     "title": "Gets table info about Square Reports",
25199     "examples": [
25200       {
25201         "title": "Example usage:",
25202         "content": "curl https://{domain}/api/square/reports/describe -v -u {name}:{password}",
25203         "type": "json"
25204       }
25205     ],
25206     "name": "DescribeSquare_Reports",
25207     "group": "Square_Reports",
25208     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25209     "version": "0.0.0",
25210     "filename": "server/api/squareReport/index.js",
25211     "groupTitle": "Square_Reports"
25212   },
25213   {
25214     "type": "get",
25215     "url": "/api/square/reports",
25216     "title": "Gets a list of Square Reports",
25217     "examples": [
25218       {
25219         "title": "Example usage:",
25220         "content": "curl https://{domain}/api/square/reports -v -u {name}:{password}",
25221         "type": "json"
25222       }
25223     ],
25224     "name": "GetSquare_Reports",
25225     "group": "Square_Reports",
25226     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25227     "version": "0.0.0",
25228     "filename": "server/api/squareReport/index.js",
25229     "groupTitle": "Square_Reports"
25230   },
25231   {
25232     "type": "get",
25233     "url": "/api/square/reports/{id}",
25234     "title": "Gets a single Square Report",
25235     "examples": [
25236       {
25237         "title": "Example usage:",
25238         "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password}",
25239         "type": "json"
25240       }
25241     ],
25242     "name": "ShowSquare_Reports",
25243     "group": "Square_Reports",
25244     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25245     "version": "0.0.0",
25246     "filename": "server/api/squareReport/index.js",
25247     "groupTitle": "Square_Reports"
25248   },
25249   {
25250     "type": "put",
25251     "url": "/api/square/reports/{id}",
25252     "title": "Update an existing Square Report",
25253     "examples": [
25254       {
25255         "title": "Example usage:",
25256         "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",
25257         "type": "json"
25258       }
25259     ],
25260     "name": "updateSquare_Reports",
25261     "group": "Square_Reports",
25262     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25263     "version": "0.0.0",
25264     "filename": "server/api/squareReport/index.js",
25265     "groupTitle": "Square_Reports"
25266   },
25267   {
25268     "type": "post",
25269     "url": "/api/integrations/sugarcrm/configurations",
25270     "title": "Creates a new SugarCRM Configuration",
25271     "examples": [
25272       {
25273         "title": "Example usage:",
25274         "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",
25275         "type": "json"
25276       }
25277     ],
25278     "name": "CreateSugarCRM_Configurations",
25279     "group": "SugarCRM_Configurations",
25280     "parameter": {
25281       "fields": {
25282         "Body": [
25283           {
25284             "group": "Body",
25285             "type": "String",
25286             "optional": true,
25287             "field": "name",
25288             "description": ""
25289           },
25290           {
25291             "group": "Body",
25292             "type": "String",
25293             "optional": true,
25294             "field": "description",
25295             "description": ""
25296           }
25297         ]
25298       }
25299     },
25300     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25301     "version": "0.0.0",
25302     "filename": "server/api/intSugarcrmConfiguration/index.js",
25303     "groupTitle": "SugarCRM_Configurations"
25304   },
25305   {
25306     "type": "delete",
25307     "url": "/api/integrations/sugarcrm/configurations/{id}",
25308     "title": "Deletes a SugarCRM Configuration",
25309     "examples": [
25310       {
25311         "title": "Example usage:",
25312         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password} -X DELETE",
25313         "type": "json"
25314       }
25315     ],
25316     "name": "DeleteSugarCRM_Configurations",
25317     "group": "SugarCRM_Configurations",
25318     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25319     "version": "0.0.0",
25320     "filename": "server/api/intSugarcrmConfiguration/index.js",
25321     "groupTitle": "SugarCRM_Configurations"
25322   },
25323   {
25324     "type": "get",
25325     "url": "/api/integrations/sugarcrm/configurations",
25326     "title": "Gets a list of SugarCRM Configurations",
25327     "examples": [
25328       {
25329         "title": "Example usage:",
25330         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations -v -u {name}:{password}",
25331         "type": "json"
25332       }
25333     ],
25334     "name": "GetSugarCRM_Configurations",
25335     "group": "SugarCRM_Configurations",
25336     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25337     "version": "0.0.0",
25338     "filename": "server/api/intSugarcrmConfiguration/index.js",
25339     "groupTitle": "SugarCRM_Configurations"
25340   },
25341   {
25342     "type": "get",
25343     "url": "/api/integrations/sugarcrm/configurations/{id}",
25344     "title": "Gets a single SugarCRM Configuration",
25345     "examples": [
25346       {
25347         "title": "Example usage:",
25348         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password}",
25349         "type": "json"
25350       }
25351     ],
25352     "name": "ShowSugarCRM_Configurations",
25353     "group": "SugarCRM_Configurations",
25354     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25355     "version": "0.0.0",
25356     "filename": "server/api/intSugarcrmConfiguration/index.js",
25357     "groupTitle": "SugarCRM_Configurations"
25358   },
25359   {
25360     "type": "put",
25361     "url": "/api/integrations/sugarcrm/configurations/{id}",
25362     "title": "Update an existing SugarCRM Configuration",
25363     "examples": [
25364       {
25365         "title": "Example usage:",
25366         "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",
25367         "type": "json"
25368       }
25369     ],
25370     "name": "updateSugarCRM_Configurations",
25371     "group": "SugarCRM_Configurations",
25372     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25373     "version": "0.0.0",
25374     "filename": "server/api/intSugarcrmConfiguration/index.js",
25375     "groupTitle": "SugarCRM_Configurations"
25376   },
25377   {
25378     "type": "post",
25379     "url": "/api/integrations/sugarcrm/accounts",
25380     "title": "Creates a new Sugarcrm Account",
25381     "examples": [
25382       {
25383         "title": "Example usage:",
25384         "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",
25385         "type": "json"
25386       }
25387     ],
25388     "name": "CreateSugarcrm_Accounts",
25389     "group": "Sugarcrm_Accounts",
25390     "parameter": {
25391       "fields": {
25392         "Body": [
25393           {
25394             "group": "Body",
25395             "type": "String",
25396             "optional": true,
25397             "field": "name",
25398             "description": ""
25399           },
25400           {
25401             "group": "Body",
25402             "type": "String",
25403             "optional": true,
25404             "field": "description",
25405             "description": ""
25406           },
25407           {
25408             "group": "Body",
25409             "type": "String",
25410             "optional": true,
25411             "field": "username",
25412             "description": ""
25413           },
25414           {
25415             "group": "Body",
25416             "type": "String",
25417             "optional": true,
25418             "field": "password",
25419             "description": ""
25420           },
25421           {
25422             "group": "Body",
25423             "type": "String",
25424             "optional": true,
25425             "field": "remoteUri",
25426             "description": ""
25427           },
25428           {
25429             "group": "Body",
25430             "type": "String",
25431             "optional": false,
25432             "field": "serverUrl",
25433             "description": ""
25434           }
25435         ]
25436       }
25437     },
25438     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25439     "version": "0.0.0",
25440     "filename": "server/api/intSugarcrmAccount/index.js",
25441     "groupTitle": "Sugarcrm_Accounts"
25442   },
25443   {
25444     "type": "delete",
25445     "url": "/api/integrations/sugarcrm/accounts/{id}",
25446     "title": "Deletes a Sugarcrm Account",
25447     "examples": [
25448       {
25449         "title": "Example usage:",
25450         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password} -X DELETE",
25451         "type": "json"
25452       }
25453     ],
25454     "name": "DeleteSugarcrm_Accounts",
25455     "group": "Sugarcrm_Accounts",
25456     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25457     "version": "0.0.0",
25458     "filename": "server/api/intSugarcrmAccount/index.js",
25459     "groupTitle": "Sugarcrm_Accounts"
25460   },
25461   {
25462     "type": "get",
25463     "url": "/api/integrations/sugarcrm/accounts",
25464     "title": "Gets a list of Sugarcrm Accounts",
25465     "examples": [
25466       {
25467         "title": "Example usage:",
25468         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts -v -u {name}:{password}",
25469         "type": "json"
25470       }
25471     ],
25472     "name": "GetSugarcrm_Accounts",
25473     "group": "Sugarcrm_Accounts",
25474     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25475     "version": "0.0.0",
25476     "filename": "server/api/intSugarcrmAccount/index.js",
25477     "groupTitle": "Sugarcrm_Accounts"
25478   },
25479   {
25480     "type": "get",
25481     "url": "/api/integrations/sugarcrm/accounts/{id}",
25482     "title": "Gets a single Sugarcrm Account",
25483     "examples": [
25484       {
25485         "title": "Example usage:",
25486         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password}",
25487         "type": "json"
25488       }
25489     ],
25490     "name": "ShowSugarcrm_Accounts",
25491     "group": "Sugarcrm_Accounts",
25492     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25493     "version": "0.0.0",
25494     "filename": "server/api/intSugarcrmAccount/index.js",
25495     "groupTitle": "Sugarcrm_Accounts"
25496   },
25497   {
25498     "type": "post",
25499     "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
25500     "title": "Creates new configuration",
25501     "examples": [
25502       {
25503         "title": "Example usage:",
25504         "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",
25505         "type": "json"
25506       }
25507     ],
25508     "name": "addConfiguration",
25509     "group": "Sugarcrm_Accounts",
25510     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25511     "version": "0.0.0",
25512     "filename": "server/api/intSugarcrmAccount/index.js",
25513     "groupTitle": "Sugarcrm_Accounts"
25514   },
25515   {
25516     "type": "get",
25517     "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
25518     "title": "Gets account configurations",
25519     "examples": [
25520       {
25521         "title": "Example usage:",
25522         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/configurations -v -u {name}:{password} -X GET",
25523         "type": "json"
25524       }
25525     ],
25526     "name": "getConfigurations",
25527     "group": "Sugarcrm_Accounts",
25528     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25529     "version": "0.0.0",
25530     "filename": "server/api/intSugarcrmAccount/index.js",
25531     "groupTitle": "Sugarcrm_Accounts"
25532   },
25533   {
25534     "type": "get",
25535     "url": "/api/integrations/sugarcrm/accounts/{id}/fields",
25536     "title": "Gets account fields",
25537     "examples": [
25538       {
25539         "title": "Example usage:",
25540         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/fields -v -u {name}:{password} -X GET",
25541         "type": "json"
25542       }
25543     ],
25544     "name": "getFields",
25545     "group": "Sugarcrm_Accounts",
25546     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25547     "version": "0.0.0",
25548     "filename": "server/api/intSugarcrmAccount/index.js",
25549     "groupTitle": "Sugarcrm_Accounts"
25550   },
25551   {
25552     "type": "put",
25553     "url": "/api/integrations/sugarcrm/accounts/{id}",
25554     "title": "Update an existing Sugarcrm Account",
25555     "examples": [
25556       {
25557         "title": "Example usage:",
25558         "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",
25559         "type": "json"
25560       }
25561     ],
25562     "name": "updateSugarcrm_Accounts",
25563     "group": "Sugarcrm_Accounts",
25564     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25565     "version": "0.0.0",
25566     "filename": "server/api/intSugarcrmAccount/index.js",
25567     "groupTitle": "Sugarcrm_Accounts"
25568   },
25569   {
25570     "type": "get",
25571     "url": "/api/integrations/sugarcrm/configurations/{id}/descriptions",
25572     "title": "Gets configurations descriptions",
25573     "examples": [
25574       {
25575         "title": "Example usage:",
25576         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
25577         "type": "json"
25578       }
25579     ],
25580     "name": "getDescriptions",
25581     "group": "Sugarcrm_Configurations",
25582     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25583     "version": "0.0.0",
25584     "filename": "server/api/intSugarcrmConfiguration/index.js",
25585     "groupTitle": "Sugarcrm_Configurations"
25586   },
25587   {
25588     "type": "get",
25589     "url": "/api/integrations/sugarcrm/configurations/{id}/fields",
25590     "title": "Gets configurations fields",
25591     "examples": [
25592       {
25593         "title": "Example usage:",
25594         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/fields -v -u {name}:{password} -X GET",
25595         "type": "json"
25596       }
25597     ],
25598     "name": "getFields",
25599     "group": "Sugarcrm_Configurations",
25600     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25601     "version": "0.0.0",
25602     "filename": "server/api/intSugarcrmConfiguration/index.js",
25603     "groupTitle": "Sugarcrm_Configurations"
25604   },
25605   {
25606     "type": "get",
25607     "url": "/api/integrations/sugarcrm/configurations/{id}/subjects",
25608     "title": "Gets configurations subjects",
25609     "examples": [
25610       {
25611         "title": "Example usage:",
25612         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/subjects -v -u {name}:{password} -X GET",
25613         "type": "json"
25614       }
25615     ],
25616     "name": "getSubjects",
25617     "group": "Sugarcrm_Configurations",
25618     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25619     "version": "0.0.0",
25620     "filename": "server/api/intSugarcrmConfiguration/index.js",
25621     "groupTitle": "Sugarcrm_Configurations"
25622   },
25623   {
25624     "type": "post",
25625     "url": "/api/integrations/sugarcrm/fields",
25626     "title": "Creates a new Sugarcrm Field",
25627     "examples": [
25628       {
25629         "title": "Example usage:",
25630         "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",
25631         "type": "json"
25632       }
25633     ],
25634     "name": "CreateSugarcrm_Fields",
25635     "group": "Sugarcrm_Fields",
25636     "parameter": {
25637       "fields": {
25638         "Body": [
25639           {
25640             "group": "Body",
25641             "type": "String",
25642             "allowedValues": [
25643               "\"string\"",
25644               "\"variable\"",
25645               "\"customVariable\"",
25646               "\"keyValue\""
25647             ],
25648             "optional": true,
25649             "field": "type",
25650             "description": ""
25651           },
25652           {
25653             "group": "Body",
25654             "type": "String",
25655             "optional": true,
25656             "field": "content",
25657             "description": ""
25658           },
25659           {
25660             "group": "Body",
25661             "type": "String",
25662             "optional": true,
25663             "field": "key",
25664             "description": ""
25665           },
25666           {
25667             "group": "Body",
25668             "type": "String",
25669             "allowedValues": [
25670               "\"string\"",
25671               "\"variable\"",
25672               "\"customVariable\""
25673             ],
25674             "optional": true,
25675             "field": "keyType",
25676             "description": ""
25677           },
25678           {
25679             "group": "Body",
25680             "type": "String",
25681             "optional": true,
25682             "field": "keyContent",
25683             "description": ""
25684           },
25685           {
25686             "group": "Body",
25687             "type": "String",
25688             "optional": true,
25689             "field": "idField",
25690             "description": ""
25691           },
25692           {
25693             "group": "Body",
25694             "type": "String",
25695             "optional": true,
25696             "field": "nameField",
25697             "description": ""
25698           },
25699           {
25700             "group": "Body",
25701             "type": "Boolean",
25702             "optional": true,
25703             "field": "customField",
25704             "description": ""
25705           },
25706           {
25707             "group": "Body",
25708             "type": "String",
25709             "optional": true,
25710             "field": "variableName",
25711             "description": ""
25712           }
25713         ]
25714       }
25715     },
25716     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25717     "version": "0.0.0",
25718     "filename": "server/api/intSugarcrmField/index.js",
25719     "groupTitle": "Sugarcrm_Fields"
25720   },
25721   {
25722     "type": "delete",
25723     "url": "/api/integrations/sugarcrm/fields/{id}",
25724     "title": "Deletes a Sugarcrm Field",
25725     "examples": [
25726       {
25727         "title": "Example usage:",
25728         "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password} -X DELETE",
25729         "type": "json"
25730       }
25731     ],
25732     "name": "DeleteSugarcrm_Fields",
25733     "group": "Sugarcrm_Fields",
25734     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25735     "version": "0.0.0",
25736     "filename": "server/api/intSugarcrmField/index.js",
25737     "groupTitle": "Sugarcrm_Fields"
25738   },
25739   {
25740     "type": "get",
25741     "url": "/api/integrations/sugarcrm/fields",
25742     "title": "Gets a list of Sugarcrm Fields",
25743     "examples": [
25744       {
25745         "title": "Example usage:",
25746         "content": "curl https://{domain}/api/integrations/sugarcrm/fields -v -u {name}:{password}",
25747         "type": "json"
25748       }
25749     ],
25750     "name": "GetSugarcrm_Fields",
25751     "group": "Sugarcrm_Fields",
25752     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25753     "version": "0.0.0",
25754     "filename": "server/api/intSugarcrmField/index.js",
25755     "groupTitle": "Sugarcrm_Fields"
25756   },
25757   {
25758     "type": "get",
25759     "url": "/api/integrations/sugarcrm/fields/{id}",
25760     "title": "Gets a single Sugarcrm Field",
25761     "examples": [
25762       {
25763         "title": "Example usage:",
25764         "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password}",
25765         "type": "json"
25766       }
25767     ],
25768     "name": "ShowSugarcrm_Fields",
25769     "group": "Sugarcrm_Fields",
25770     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25771     "version": "0.0.0",
25772     "filename": "server/api/intSugarcrmField/index.js",
25773     "groupTitle": "Sugarcrm_Fields"
25774   },
25775   {
25776     "type": "put",
25777     "url": "/api/integrations/sugarcrm/fields/{id}",
25778     "title": "Update an existing Sugarcrm Field",
25779     "examples": [
25780       {
25781         "title": "Example usage:",
25782         "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",
25783         "type": "json"
25784       }
25785     ],
25786     "name": "updateSugarcrm_Fields",
25787     "group": "Sugarcrm_Fields",
25788     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25789     "version": "0.0.0",
25790     "filename": "server/api/intSugarcrmField/index.js",
25791     "groupTitle": "Sugarcrm_Fields"
25792   },
25793   {
25794     "type": "get",
25795     "url": "/api/system",
25796     "title": "Gets system information",
25797     "examples": [
25798       {
25799         "title": "Example usage:",
25800         "content": "curl https://{domain}/api/system -v -u {name}:{password}",
25801         "type": "json"
25802       }
25803     ],
25804     "name": "GetSystemInformation",
25805     "group": "System_Information",
25806     "description": "<p>Motion returns the system information.</p>",
25807     "version": "0.0.0",
25808     "filename": "server/api/system/index.js",
25809     "groupTitle": "System_Information"
25810   },
25811   {
25812     "type": "get",
25813     "url": "/api/system/process",
25814     "title": "Gets system information",
25815     "examples": [
25816       {
25817         "title": "Example usage:",
25818         "content": "curl https://{domain}/api/system -v -u {name}:{password}",
25819         "type": "json"
25820       }
25821     ],
25822     "name": "GetSystemInformation",
25823     "group": "System_Information",
25824     "description": "<p>Motion returns the system information.</p>",
25825     "version": "0.0.0",
25826     "filename": "server/api/system/index.js",
25827     "groupTitle": "System_Information"
25828   },
25829   {
25830     "type": "post",
25831     "url": "/api/tags",
25832     "title": "Creates a new Tag",
25833     "examples": [
25834       {
25835         "title": "Example usage:",
25836         "content": "curl https://{domain}/api/tags -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25837         "type": "json"
25838       }
25839     ],
25840     "name": "CreateTags",
25841     "group": "Tags",
25842     "parameter": {
25843       "fields": {
25844         "Body": [
25845           {
25846             "group": "Body",
25847             "type": "String",
25848             "optional": false,
25849             "field": "name",
25850             "description": ""
25851           },
25852           {
25853             "group": "Body",
25854             "type": "String",
25855             "optional": true,
25856             "field": "color",
25857             "description": ""
25858           },
25859           {
25860             "group": "Body",
25861             "type": "String",
25862             "optional": true,
25863             "field": "description",
25864             "description": ""
25865           }
25866         ]
25867       }
25868     },
25869     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25870     "version": "0.0.0",
25871     "filename": "server/api/tag/index.js",
25872     "groupTitle": "Tags"
25873   },
25874   {
25875     "type": "delete",
25876     "url": "/api/tags/{id}",
25877     "title": "Deletes a Tag",
25878     "examples": [
25879       {
25880         "title": "Example usage:",
25881         "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password} -X DELETE",
25882         "type": "json"
25883       }
25884     ],
25885     "name": "DeleteTags",
25886     "group": "Tags",
25887     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25888     "version": "0.0.0",
25889     "filename": "server/api/tag/index.js",
25890     "groupTitle": "Tags"
25891   },
25892   {
25893     "type": "get",
25894     "url": "/api/tags",
25895     "title": "Gets a list of Tags",
25896     "examples": [
25897       {
25898         "title": "Example usage:",
25899         "content": "curl https://{domain}/api/tags -v -u {name}:{password}",
25900         "type": "json"
25901       }
25902     ],
25903     "name": "GetTags",
25904     "group": "Tags",
25905     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25906     "version": "0.0.0",
25907     "filename": "server/api/tag/index.js",
25908     "groupTitle": "Tags"
25909   },
25910   {
25911     "type": "get",
25912     "url": "/api/tags/{id}",
25913     "title": "Gets a single Tag",
25914     "examples": [
25915       {
25916         "title": "Example usage:",
25917         "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password}",
25918         "type": "json"
25919       }
25920     ],
25921     "name": "ShowTags",
25922     "group": "Tags",
25923     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25924     "version": "0.0.0",
25925     "filename": "server/api/tag/index.js",
25926     "groupTitle": "Tags"
25927   },
25928   {
25929     "type": "put",
25930     "url": "/api/tags/{id}",
25931     "title": "Update an existing Tag",
25932     "examples": [
25933       {
25934         "title": "Example usage:",
25935         "content": "curl https://{domain}/api/tags/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
25936         "type": "json"
25937       }
25938     ],
25939     "name": "updateTags",
25940     "group": "Tags",
25941     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25942     "version": "0.0.0",
25943     "filename": "server/api/tag/index.js",
25944     "groupTitle": "Tags"
25945   },
25946   {
25947     "type": "post",
25948     "url": "/api/teams/{id}/queues",
25949     "title": "Add queues to a team",
25950     "examples": [
25951       {
25952         "title": "Example usage:",
25953         "content": "curl https://{domain}/api/teams/{id}/queues -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
25954         "type": "json"
25955       }
25956     ],
25957     "name": "AddQueues",
25958     "group": "Teams",
25959     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25960     "version": "0.0.0",
25961     "filename": "server/api/team/index.js",
25962     "groupTitle": "Teams"
25963   },
25964   {
25965     "type": "post",
25966     "url": "/api/teams",
25967     "title": "Creates a new Team",
25968     "examples": [
25969       {
25970         "title": "Example usage:",
25971         "content": "curl https://{domain}/api/teams -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25972         "type": "json"
25973       }
25974     ],
25975     "name": "CreateTeams",
25976     "group": "Teams",
25977     "parameter": {
25978       "fields": {
25979         "Body": [
25980           {
25981             "group": "Body",
25982             "type": "String",
25983             "optional": false,
25984             "field": "name",
25985             "description": ""
25986           },
25987           {
25988             "group": "Body",
25989             "type": "String",
25990             "optional": true,
25991             "field": "description",
25992             "description": ""
25993           }
25994         ]
25995       }
25996     },
25997     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25998     "version": "0.0.0",
25999     "filename": "server/api/team/index.js",
26000     "groupTitle": "Teams"
26001   },
26002   {
26003     "type": "delete",
26004     "url": "/api/teams/{id}",
26005     "title": "Deletes a Team",
26006     "examples": [
26007       {
26008         "title": "Example usage:",
26009         "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password} -X DELETE",
26010         "type": "json"
26011       }
26012     ],
26013     "name": "DeleteTeams",
26014     "group": "Teams",
26015     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26016     "version": "0.0.0",
26017     "filename": "server/api/team/index.js",
26018     "groupTitle": "Teams"
26019   },
26020   {
26021     "type": "get",
26022     "url": "/api/teams/{id}/users",
26023     "title": "Gets agents from team",
26024     "examples": [
26025       {
26026         "title": "Example usage:",
26027         "content": "curl https://{domain}/api/teams/{id}/users -v -u {name}:{password} -X GET",
26028         "type": "json"
26029       }
26030     ],
26031     "name": "GetAgents",
26032     "group": "Teams",
26033     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26034     "version": "0.0.0",
26035     "filename": "server/api/team/index.js",
26036     "groupTitle": "Teams"
26037   },
26038   {
26039     "type": "get",
26040     "url": "/api/teams/{id}/queues?channel={channel}",
26041     "title": "Gets Queues list",
26042     "examples": [
26043       {
26044         "title": "Example usage:",
26045         "content": "curl https://{domain}/api/teams/{id}/queues?channel={channel} -v -u {name}:{password}",
26046         "type": "json"
26047       }
26048     ],
26049     "name": "GetQueues",
26050     "group": "Teams",
26051     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26052     "version": "0.0.0",
26053     "filename": "server/api/team/index.js",
26054     "groupTitle": "Teams"
26055   },
26056   {
26057     "type": "get",
26058     "url": "/api/teams",
26059     "title": "Gets a list of Teams",
26060     "examples": [
26061       {
26062         "title": "Example usage:",
26063         "content": "curl https://{domain}/api/teams -v -u {name}:{password}",
26064         "type": "json"
26065       }
26066     ],
26067     "name": "GetTeams",
26068     "group": "Teams",
26069     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26070     "version": "0.0.0",
26071     "filename": "server/api/team/index.js",
26072     "groupTitle": "Teams"
26073   },
26074   {
26075     "type": "delete",
26076     "url": "/api/teams/{id}/users",
26077     "title": "Removes agents from a team",
26078     "examples": [
26079       {
26080         "title": "Example usage:",
26081         "content": "curl https://{domain}/api/teams/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
26082         "type": "json"
26083       }
26084     ],
26085     "name": "RemoveAgents",
26086     "group": "Teams",
26087     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26088     "version": "0.0.0",
26089     "filename": "server/api/team/index.js",
26090     "groupTitle": "Teams"
26091   },
26092   {
26093     "type": "delete",
26094     "url": "/api/teams/{id}/queues",
26095     "title": "Remove queues to a team",
26096     "examples": [
26097       {
26098         "title": "Example usage:",
26099         "content": "curl https://{domain}/api/teams/{id}/queues?channel=voice&ids=1&ids=2 -v -u {name}:{password} -X DELETE",
26100         "type": "json"
26101       }
26102     ],
26103     "name": "RemoveQueues",
26104     "group": "Teams",
26105     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26106     "version": "0.0.0",
26107     "filename": "server/api/team/index.js",
26108     "groupTitle": "Teams"
26109   },
26110   {
26111     "type": "delete",
26112     "url": "/api/whatsapp/queues/{id}/teams",
26113     "title": "Remove teams from a queue",
26114     "examples": [
26115       {
26116         "title": "Example usage:",
26117         "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26118         "type": "json"
26119       }
26120     ],
26121     "name": "RemoveTeams",
26122     "group": "Teams",
26123     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26124     "version": "0.0.0",
26125     "filename": "server/api/whatsappQueue/index.js",
26126     "groupTitle": "Teams"
26127   },
26128   {
26129     "type": "delete",
26130     "url": "/api/openchannel/queues/{id}/teams",
26131     "title": "Remove teams from a queue",
26132     "examples": [
26133       {
26134         "title": "Example usage:",
26135         "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26136         "type": "json"
26137       }
26138     ],
26139     "name": "RemoveTeams",
26140     "group": "Teams",
26141     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26142     "version": "0.0.0",
26143     "filename": "server/api/openchannelQueue/index.js",
26144     "groupTitle": "Teams"
26145   },
26146   {
26147     "type": "delete",
26148     "url": "/api/voice/queues/{id}/teams",
26149     "title": "Remove teams from a queue",
26150     "examples": [
26151       {
26152         "title": "Example usage:",
26153         "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26154         "type": "json"
26155       }
26156     ],
26157     "name": "RemoveTeams",
26158     "group": "Teams",
26159     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26160     "version": "0.0.0",
26161     "filename": "server/api/voiceQueue/index.js",
26162     "groupTitle": "Teams"
26163   },
26164   {
26165     "type": "delete",
26166     "url": "/api/sms/queues/{id}/teams",
26167     "title": "Remove teams from a queue",
26168     "examples": [
26169       {
26170         "title": "Example usage:",
26171         "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26172         "type": "json"
26173       }
26174     ],
26175     "name": "RemoveTeams",
26176     "group": "Teams",
26177     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26178     "version": "0.0.0",
26179     "filename": "server/api/smsQueue/index.js",
26180     "groupTitle": "Teams"
26181   },
26182   {
26183     "type": "delete",
26184     "url": "/api/chat/queues/{id}/teams",
26185     "title": "Remove teams from a queue",
26186     "examples": [
26187       {
26188         "title": "Example usage:",
26189         "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26190         "type": "json"
26191       }
26192     ],
26193     "name": "RemoveTeams",
26194     "group": "Teams",
26195     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26196     "version": "0.0.0",
26197     "filename": "server/api/chatQueue/index.js",
26198     "groupTitle": "Teams"
26199   },
26200   {
26201     "type": "delete",
26202     "url": "/api/mail/queues/{id}/teams",
26203     "title": "Remove teams from a queue",
26204     "examples": [
26205       {
26206         "title": "Example usage:",
26207         "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26208         "type": "json"
26209       }
26210     ],
26211     "name": "RemoveTeams",
26212     "group": "Teams",
26213     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26214     "version": "0.0.0",
26215     "filename": "server/api/mailQueue/index.js",
26216     "groupTitle": "Teams"
26217   },
26218   {
26219     "type": "delete",
26220     "url": "/api/fax/queues/{id}/teams",
26221     "title": "Remove teams from a queue",
26222     "examples": [
26223       {
26224         "title": "Example usage:",
26225         "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26226         "type": "json"
26227       }
26228     ],
26229     "name": "RemoveTeams",
26230     "group": "Teams",
26231     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26232     "version": "0.0.0",
26233     "filename": "server/api/faxQueue/index.js",
26234     "groupTitle": "Teams"
26235   },
26236   {
26237     "type": "get",
26238     "url": "/api/teams/{id}",
26239     "title": "Gets a single Team",
26240     "examples": [
26241       {
26242         "title": "Example usage:",
26243         "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password}",
26244         "type": "json"
26245       }
26246     ],
26247     "name": "ShowTeams",
26248     "group": "Teams",
26249     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26250     "version": "0.0.0",
26251     "filename": "server/api/team/index.js",
26252     "groupTitle": "Teams"
26253   },
26254   {
26255     "type": "post",
26256     "url": "/api/teams/{id}/users",
26257     "title": "Adds agents to a team",
26258     "examples": [
26259       {
26260         "title": "Example usage:",
26261         "content": "curl https://{domain}/api/teams/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26262         "type": "json"
26263       }
26264     ],
26265     "name": "addAgents",
26266     "group": "Teams",
26267     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26268     "version": "0.0.0",
26269     "filename": "server/api/team/index.js",
26270     "groupTitle": "Teams"
26271   },
26272   {
26273     "type": "put",
26274     "url": "/api/teams/{id}",
26275     "title": "Update an existing Team",
26276     "examples": [
26277       {
26278         "title": "Example usage:",
26279         "content": "curl https://{domain}/api/teams/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26280         "type": "json"
26281       }
26282     ],
26283     "name": "updateTeams",
26284     "group": "Teams",
26285     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26286     "version": "0.0.0",
26287     "filename": "server/api/team/index.js",
26288     "groupTitle": "Teams"
26289   },
26290   {
26291     "type": "post",
26292     "url": "/api/templates",
26293     "title": "Creates a new Template",
26294     "examples": [
26295       {
26296         "title": "Example usage:",
26297         "content": "curl https://{domain}/api/templates -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26298         "type": "json"
26299       }
26300     ],
26301     "name": "CreateTemplates",
26302     "group": "Templates",
26303     "parameter": {
26304       "fields": {
26305         "Body": [
26306           {
26307             "group": "Body",
26308             "type": "String",
26309             "optional": true,
26310             "field": "name",
26311             "description": ""
26312           },
26313           {
26314             "group": "Body",
26315             "type": "String",
26316             "optional": true,
26317             "field": "description",
26318             "description": ""
26319           },
26320           {
26321             "group": "Body",
26322             "type": "Text",
26323             "optional": true,
26324             "field": "html",
26325             "description": ""
26326           }
26327         ]
26328       }
26329     },
26330     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26331     "version": "0.0.0",
26332     "filename": "server/api/template/index.js",
26333     "groupTitle": "Templates"
26334   },
26335   {
26336     "type": "delete",
26337     "url": "/api/templates/{id}",
26338     "title": "Deletes a Template",
26339     "examples": [
26340       {
26341         "title": "Example usage:",
26342         "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password} -X DELETE",
26343         "type": "json"
26344       }
26345     ],
26346     "name": "DeleteTemplates",
26347     "group": "Templates",
26348     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26349     "version": "0.0.0",
26350     "filename": "server/api/template/index.js",
26351     "groupTitle": "Templates"
26352   },
26353   {
26354     "type": "get",
26355     "url": "/api/templates",
26356     "title": "Gets a list of Templates",
26357     "examples": [
26358       {
26359         "title": "Example usage:",
26360         "content": "curl https://{domain}/api/templates -v -u {name}:{password}",
26361         "type": "json"
26362       }
26363     ],
26364     "name": "GetTemplates",
26365     "group": "Templates",
26366     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26367     "version": "0.0.0",
26368     "filename": "server/api/template/index.js",
26369     "groupTitle": "Templates"
26370   },
26371   {
26372     "type": "get",
26373     "url": "/api/templates/{id}",
26374     "title": "Gets a single Template",
26375     "examples": [
26376       {
26377         "title": "Example usage:",
26378         "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password}",
26379         "type": "json"
26380       }
26381     ],
26382     "name": "ShowTemplates",
26383     "group": "Templates",
26384     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26385     "version": "0.0.0",
26386     "filename": "server/api/template/index.js",
26387     "groupTitle": "Templates"
26388   },
26389   {
26390     "type": "put",
26391     "url": "/api/templates/{id}",
26392     "title": "Update an existing Template",
26393     "examples": [
26394       {
26395         "title": "Example usage:",
26396         "content": "curl https://{domain}/api/templates/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26397         "type": "json"
26398       }
26399     ],
26400     "name": "updateTemplates",
26401     "group": "Templates",
26402     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26403     "version": "0.0.0",
26404     "filename": "server/api/template/index.js",
26405     "groupTitle": "Templates"
26406   },
26407   {
26408     "type": "post",
26409     "url": "/api/triggers",
26410     "title": "Creates a new Trigger",
26411     "examples": [
26412       {
26413         "title": "Example usage:",
26414         "content": "curl https://{domain}/api/triggers -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26415         "type": "json"
26416       }
26417     ],
26418     "name": "CreateTriggers",
26419     "group": "Triggers",
26420     "parameter": {
26421       "fields": {
26422         "Body": [
26423           {
26424             "group": "Body",
26425             "type": "String",
26426             "optional": true,
26427             "field": "name",
26428             "description": ""
26429           },
26430           {
26431             "group": "Body",
26432             "type": "String",
26433             "optional": true,
26434             "field": "channel",
26435             "description": ""
26436           },
26437           {
26438             "group": "Body",
26439             "type": "String",
26440             "optional": true,
26441             "field": "description",
26442             "description": ""
26443           },
26444           {
26445             "group": "Body",
26446             "type": "Boolean",
26447             "optional": true,
26448             "field": "status",
26449             "description": ""
26450           }
26451         ]
26452       }
26453     },
26454     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26455     "version": "0.0.0",
26456     "filename": "server/api/trigger/index.js",
26457     "groupTitle": "Triggers"
26458   },
26459   {
26460     "type": "delete",
26461     "url": "/api/triggers/{id}",
26462     "title": "Deletes a Trigger",
26463     "examples": [
26464       {
26465         "title": "Example usage:",
26466         "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password} -X DELETE",
26467         "type": "json"
26468       }
26469     ],
26470     "name": "DeleteTriggers",
26471     "group": "Triggers",
26472     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26473     "version": "0.0.0",
26474     "filename": "server/api/trigger/index.js",
26475     "groupTitle": "Triggers"
26476   },
26477   {
26478     "type": "get",
26479     "url": "/api/triggers",
26480     "title": "Gets a list of Triggers",
26481     "examples": [
26482       {
26483         "title": "Example usage:",
26484         "content": "curl https://{domain}/api/triggers -v -u {name}:{password}",
26485         "type": "json"
26486       }
26487     ],
26488     "name": "GetTriggers",
26489     "group": "Triggers",
26490     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26491     "version": "0.0.0",
26492     "filename": "server/api/trigger/index.js",
26493     "groupTitle": "Triggers"
26494   },
26495   {
26496     "type": "get",
26497     "url": "/api/triggers/{id}",
26498     "title": "Gets a single Trigger",
26499     "examples": [
26500       {
26501         "title": "Example usage:",
26502         "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password}",
26503         "type": "json"
26504       }
26505     ],
26506     "name": "ShowTriggers",
26507     "group": "Triggers",
26508     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26509     "version": "0.0.0",
26510     "filename": "server/api/trigger/index.js",
26511     "groupTitle": "Triggers"
26512   },
26513   {
26514     "type": "post",
26515     "url": "/api/triggers/{id}/actions",
26516     "title": "Creates new actions",
26517     "examples": [
26518       {
26519         "title": "Example usage:",
26520         "content": "curl https://{domain}/api/triggers/{id}/actions -d '{\"action\": \"contactManager\",\"data1\": \"1\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26521         "type": "json"
26522       }
26523     ],
26524     "name": "addAction",
26525     "group": "Triggers",
26526     "parameter": {
26527       "fields": {
26528         "Body": [
26529           {
26530             "group": "Body",
26531             "type": "Virtual",
26532             "optional": true,
26533             "field": "name",
26534             "description": ""
26535           },
26536           {
26537             "group": "Body",
26538             "type": "String",
26539             "optional": false,
26540             "field": "action",
26541             "description": "<p>Allowed values: contactManager, integration, motionbar, jscripty, urlForward, browser, bot, script</p>"
26542           },
26543           {
26544             "group": "Body",
26545             "type": "String",
26546             "optional": true,
26547             "field": "data1",
26548             "description": "<p>contactManager[ListId], integration[intName(zendesk)], motionbar[Popup(0),URL(1),WinApp(2)], urlForward[GET,POST], browser[TemplateId(0),URL(1)]</p>"
26549           },
26550           {
26551             "group": "Body",
26552             "type": "String",
26553             "optional": true,
26554             "field": "data2",
26555             "description": "<p>integration[AccountId], motionbar[TemplateId,URL,WinAppPath], urlForward[URL]</p>"
26556           },
26557           {
26558             "group": "Body",
26559             "type": "String",
26560             "optional": true,
26561             "field": "data3",
26562             "description": "<p>motionbar[NULL,NULL,WinAppArguments]</p>"
26563           },
26564           {
26565             "group": "Body",
26566             "type": "String",
26567             "optional": true,
26568             "field": "data4",
26569             "description": ""
26570           },
26571           {
26572             "group": "Body",
26573             "type": "String",
26574             "optional": true,
26575             "field": "data5",
26576             "description": ""
26577           },
26578           {
26579             "group": "Body",
26580             "type": "String",
26581             "optional": true,
26582             "field": "data6",
26583             "description": ""
26584           },
26585           {
26586             "group": "Body",
26587             "type": "Text",
26588             "optional": true,
26589             "field": "data7",
26590             "description": ""
26591           }
26592         ]
26593       }
26594     },
26595     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26596     "version": "0.0.0",
26597     "filename": "server/api/trigger/index.js",
26598     "groupTitle": "Triggers"
26599   },
26600   {
26601     "type": "post",
26602     "url": "/api/triggers/{id}/all_conditions",
26603     "title": "Creates a new \"AND\"condition",
26604     "examples": [
26605       {
26606         "title": "Example usage:",
26607         "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",
26608         "type": "json"
26609       }
26610     ],
26611     "name": "addAllCondition",
26612     "group": "Triggers",
26613     "parameter": {
26614       "fields": {
26615         "Body": [
26616           {
26617             "group": "Body",
26618             "type": "Virtual",
26619             "optional": true,
26620             "field": "name",
26621             "description": ""
26622           },
26623           {
26624             "group": "Body",
26625             "type": "String",
26626             "optional": false,
26627             "field": "field",
26628             "description": ""
26629           },
26630           {
26631             "group": "Body",
26632             "type": "String",
26633             "optional": false,
26634             "field": "operator",
26635             "description": ""
26636           },
26637           {
26638             "group": "Body",
26639             "type": "String",
26640             "optional": false,
26641             "field": "value",
26642             "description": ""
26643           }
26644         ]
26645       }
26646     },
26647     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26648     "version": "0.0.0",
26649     "filename": "server/api/trigger/index.js",
26650     "groupTitle": "Triggers"
26651   },
26652   {
26653     "type": "post",
26654     "url": "/api/triggers/{id}/any_conditions",
26655     "title": "Creates a new \"OR\"condition",
26656     "examples": [
26657       {
26658         "title": "Example usage:",
26659         "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",
26660         "type": "json"
26661       }
26662     ],
26663     "name": "addAnyCondition",
26664     "group": "Triggers",
26665     "parameter": {
26666       "fields": {
26667         "Body": [
26668           {
26669             "group": "Body",
26670             "type": "Virtual",
26671             "optional": true,
26672             "field": "name",
26673             "description": ""
26674           },
26675           {
26676             "group": "Body",
26677             "type": "String",
26678             "optional": false,
26679             "field": "field",
26680             "description": ""
26681           },
26682           {
26683             "group": "Body",
26684             "type": "String",
26685             "optional": false,
26686             "field": "operator",
26687             "description": ""
26688           },
26689           {
26690             "group": "Body",
26691             "type": "String",
26692             "optional": false,
26693             "field": "value",
26694             "description": ""
26695           }
26696         ]
26697       }
26698     },
26699     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26700     "version": "0.0.0",
26701     "filename": "server/api/trigger/index.js",
26702     "groupTitle": "Triggers"
26703   },
26704   {
26705     "type": "get",
26706     "url": "/api/triggers/{id}/actions",
26707     "title": "Gets Trigger Actions",
26708     "examples": [
26709       {
26710         "title": "Example usage:",
26711         "content": "curl https://{domain}/api/triggers/{id}/actions -v -u {name}:{password} -X GET",
26712         "type": "json"
26713       }
26714     ],
26715     "name": "getActions",
26716     "group": "Triggers",
26717     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26718     "version": "0.0.0",
26719     "filename": "server/api/trigger/index.js",
26720     "groupTitle": "Triggers"
26721   },
26722   {
26723     "type": "get",
26724     "url": "/api/triggers/{id}/all_conditions",
26725     "title": "Gets \"AND\" Trigger Conditions",
26726     "examples": [
26727       {
26728         "title": "Example usage:",
26729         "content": "curl https://{domain}/api/triggers/{id}/all_conditions -v -u {name}:{password} -X GET",
26730         "type": "json"
26731       }
26732     ],
26733     "name": "getAllConditions",
26734     "group": "Triggers",
26735     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26736     "version": "0.0.0",
26737     "filename": "server/api/trigger/index.js",
26738     "groupTitle": "Triggers"
26739   },
26740   {
26741     "type": "get",
26742     "url": "/api/triggers/{id}/any_conditions",
26743     "title": "Gets \"OR\" Trigger Conditions",
26744     "examples": [
26745       {
26746         "title": "Example usage:",
26747         "content": "curl https://{domain}/api/triggers/{id}/any_conditions -v -u {name}:{password} -X GET",
26748         "type": "json"
26749       }
26750     ],
26751     "name": "getAnyConditions",
26752     "group": "Triggers",
26753     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26754     "version": "0.0.0",
26755     "filename": "server/api/trigger/index.js",
26756     "groupTitle": "Triggers"
26757   },
26758   {
26759     "type": "put",
26760     "url": "/api/triggers/{id}",
26761     "title": "Update an existing Trigger",
26762     "examples": [
26763       {
26764         "title": "Example usage:",
26765         "content": "curl https://{domain}/api/triggers/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26766         "type": "json"
26767       }
26768     ],
26769     "name": "updateTriggers",
26770     "group": "Triggers",
26771     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26772     "version": "0.0.0",
26773     "filename": "server/api/trigger/index.js",
26774     "groupTitle": "Triggers"
26775   },
26776   {
26777     "type": "post",
26778     "url": "/api/trunks/clone",
26779     "title": "Clone an existing Trunk",
26780     "examples": [
26781       {
26782         "title": "Example usage:",
26783         "content": "curl https://{domain}/api/trunks/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26784         "type": "json"
26785       }
26786     ],
26787     "name": "CloneTrunks",
26788     "group": "Trunks",
26789     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26790     "version": "0.0.0",
26791     "filename": "server/api/trunk/index.js",
26792     "groupTitle": "Trunks"
26793   },
26794   {
26795     "type": "post",
26796     "url": "/api/trunks",
26797     "title": "Create a new trunk",
26798     "examples": [
26799       {
26800         "title": "Example usage:",
26801         "content": "curl https://{domain}/api/trunks -v -u {name}:{password} -X POST",
26802         "type": "json"
26803       }
26804     ],
26805     "name": "Create",
26806     "group": "Trunks",
26807     "parameter": {
26808       "fields": {
26809         "Body": [
26810           {
26811             "group": "Body",
26812             "type": "String",
26813             "optional": false,
26814             "field": "name",
26815             "description": ""
26816           },
26817           {
26818             "group": "Body",
26819             "type": "String",
26820             "allowedValues": [
26821               "\"friend\"",
26822               "\"user\"",
26823               "\"peer\""
26824             ],
26825             "optional": false,
26826             "field": "type",
26827             "description": ""
26828           },
26829           {
26830             "group": "Body",
26831             "type": "String",
26832             "optional": false,
26833             "field": "context",
26834             "description": ""
26835           },
26836           {
26837             "group": "Body",
26838             "type": "String",
26839             "allowedValues": [
26840               "\"ALLOWED_NOT_SCREENED\"",
26841               "\"ALLOWED_PASSED_SCREEN\"",
26842               "\"ALLOWED_FAILED_SCREEN\"",
26843               "\"ALLOWED\"",
26844               "\"PROHIB_NOT_SCREENED\"",
26845               "\"PROHIB_PASSED_SCREEN\"",
26846               "\"PROHIB_FAILED_SCREEN\"",
26847               "\"PROHIB\""
26848             ],
26849             "optional": true,
26850             "field": "callingpres",
26851             "description": ""
26852           },
26853           {
26854             "group": "Body",
26855             "type": "String",
26856             "optional": true,
26857             "field": "deny",
26858             "description": ""
26859           },
26860           {
26861             "group": "Body",
26862             "type": "String",
26863             "optional": true,
26864             "field": "permit",
26865             "description": ""
26866           },
26867           {
26868             "group": "Body",
26869             "type": "String",
26870             "optional": true,
26871             "field": "secret",
26872             "description": ""
26873           },
26874           {
26875             "group": "Body",
26876             "type": "String",
26877             "optional": true,
26878             "field": "md5secret",
26879             "description": ""
26880           },
26881           {
26882             "group": "Body",
26883             "type": "String",
26884             "optional": true,
26885             "field": "remotesecret",
26886             "description": ""
26887           },
26888           {
26889             "group": "Body",
26890             "type": "String",
26891             "optional": true,
26892             "field": "transport",
26893             "description": "<p>String is deprecated. Please use an Array as [&quot;udp&quot;, &quot;tcp&quot;]</p>"
26894           },
26895           {
26896             "group": "Body",
26897             "type": "String",
26898             "allowedValues": [
26899               "\"rfc2833\"",
26900               "\"info\"",
26901               "\"shortinfo\"",
26902               "\"inband\"",
26903               "\"auto\""
26904             ],
26905             "optional": true,
26906             "field": "dtmfmode",
26907             "description": ""
26908           },
26909           {
26910             "group": "Body",
26911             "type": "String",
26912             "allowedValues": [
26913               "\"yes\"",
26914               "\"no\"",
26915               "\"nonat\"",
26916               "\"update\"",
26917               "\"outgoing\""
26918             ],
26919             "optional": true,
26920             "field": "directmedia",
26921             "description": ""
26922           },
26923           {
26924             "group": "Body",
26925             "type": "String",
26926             "allowedValues": [
26927               "\"yes\"",
26928               "\"no\""
26929             ],
26930             "optional": true,
26931             "field": "directrtpsetup",
26932             "description": ""
26933           },
26934           {
26935             "group": "Body",
26936             "type": "String",
26937             "optional": true,
26938             "field": "directmediapermit",
26939             "description": ""
26940           },
26941           {
26942             "group": "Body",
26943             "type": "String",
26944             "optional": true,
26945             "field": "directmediadeny",
26946             "description": ""
26947           },
26948           {
26949             "group": "Body",
26950             "type": "String",
26951             "optional": true,
26952             "field": "nat",
26953             "description": "<p>String is deprecated. Please use an Array as [&quot;force_rport&quot;, &quot;comedia&quot;]</p>"
26954           },
26955           {
26956             "group": "Body",
26957             "type": "String",
26958             "optional": true,
26959             "field": "callgroup",
26960             "description": ""
26961           },
26962           {
26963             "group": "Body",
26964             "type": "String",
26965             "optional": true,
26966             "field": "namedcallgroup",
26967             "description": ""
26968           },
26969           {
26970             "group": "Body",
26971             "type": "String",
26972             "optional": true,
26973             "field": "pickupgroup",
26974             "description": ""
26975           },
26976           {
26977             "group": "Body",
26978             "type": "String",
26979             "optional": true,
26980             "field": "namedpickupgroup",
26981             "description": ""
26982           },
26983           {
26984             "group": "Body",
26985             "type": "String",
26986             "optional": true,
26987             "field": "language",
26988             "description": ""
26989           },
26990           {
26991             "group": "Body",
26992             "type": "String",
26993             "optional": true,
26994             "field": "tonezone",
26995             "description": ""
26996           },
26997           {
26998             "group": "Body",
26999             "type": "String",
27000             "optional": true,
27001             "field": "disallow",
27002             "description": ""
27003           },
27004           {
27005             "group": "Body",
27006             "type": "String",
27007             "optional": false,
27008             "field": "allow",
27009             "description": "<p>String is deprecated. Please use an Array as [&quot;ulaw&quot;, &quot;alaw&quot;, &quot;alaw&quot;]</p>"
27010           },
27011           {
27012             "group": "Body",
27013             "type": "String",
27014             "allowedValues": [
27015               "\"yes\"",
27016               "\"no\""
27017             ],
27018             "optional": true,
27019             "field": "autoframing",
27020             "description": ""
27021           },
27022           {
27023             "group": "Body",
27024             "type": "String",
27025             "optional": true,
27026             "field": "insecure",
27027             "description": "<p>String is deprecated. Please use an Array as [&quot;port&quot;, &quot;invite&quot;]</p>"
27028           },
27029           {
27030             "group": "Body",
27031             "type": "String",
27032             "allowedValues": [
27033               "\"yes\"",
27034               "\"no\""
27035             ],
27036             "optional": true,
27037             "field": "trustrpid",
27038             "description": ""
27039           },
27040           {
27041             "group": "Body",
27042             "type": "String",
27043             "allowedValues": [
27044               "\"yes\"",
27045               "\"no\""
27046             ],
27047             "optional": true,
27048             "field": "trust_id_outbound",
27049             "description": ""
27050           },
27051           {
27052             "group": "Body",
27053             "type": "String",
27054             "allowedValues": [
27055               "\"yes\"",
27056               "\"no\"",
27057               "\"never\""
27058             ],
27059             "optional": true,
27060             "field": "progressinband",
27061             "description": ""
27062           },
27063           {
27064             "group": "Body",
27065             "type": "String",
27066             "allowedValues": [
27067               "\"yes\"",
27068               "\"no\""
27069             ],
27070             "optional": true,
27071             "field": "promiscredir",
27072             "description": ""
27073           },
27074           {
27075             "group": "Body",
27076             "type": "String",
27077             "allowedValues": [
27078               "\"yes\"",
27079               "\"no\""
27080             ],
27081             "optional": true,
27082             "field": "useclientcode",
27083             "description": ""
27084           },
27085           {
27086             "group": "Body",
27087             "type": "Integer",
27088             "optional": true,
27089             "field": "accountcode",
27090             "description": ""
27091           },
27092           {
27093             "group": "Body",
27094             "type": "String",
27095             "optional": true,
27096             "field": "setvar",
27097             "description": ""
27098           },
27099           {
27100             "group": "Body",
27101             "type": "String",
27102             "optional": true,
27103             "field": "callerid",
27104             "description": ""
27105           },
27106           {
27107             "group": "Body",
27108             "type": "String",
27109             "optional": true,
27110             "field": "amaflags",
27111             "description": ""
27112           },
27113           {
27114             "group": "Body",
27115             "type": "String",
27116             "allowedValues": [
27117               "\"yes\"",
27118               "\"no\""
27119             ],
27120             "optional": true,
27121             "field": "callcounter",
27122             "description": ""
27123           },
27124           {
27125             "group": "Body",
27126             "type": "Integer",
27127             "optional": true,
27128             "field": "busylevel",
27129             "description": ""
27130           },
27131           {
27132             "group": "Body",
27133             "type": "String",
27134             "allowedValues": [
27135               "\"yes\"",
27136               "\"no\""
27137             ],
27138             "optional": true,
27139             "field": "allowoverlap",
27140             "description": ""
27141           },
27142           {
27143             "group": "Body",
27144             "type": "String",
27145             "allowedValues": [
27146               "\"yes\"",
27147               "\"no\""
27148             ],
27149             "optional": true,
27150             "field": "allowsubscribe",
27151             "description": ""
27152           },
27153           {
27154             "group": "Body",
27155             "type": "String",
27156             "allowedValues": [
27157               "\"yes\"",
27158               "\"no\""
27159             ],
27160             "optional": true,
27161             "field": "allowtransfer",
27162             "description": ""
27163           },
27164           {
27165             "group": "Body",
27166             "type": "String",
27167             "allowedValues": [
27168               "\"yes\"",
27169               "\"no\""
27170             ],
27171             "optional": true,
27172             "field": "ignoresdpversion",
27173             "description": ""
27174           },
27175           {
27176             "group": "Body",
27177             "type": "String",
27178             "optional": true,
27179             "field": "subscribecontext",
27180             "description": ""
27181           },
27182           {
27183             "group": "Body",
27184             "type": "String",
27185             "optional": true,
27186             "field": "template",
27187             "description": ""
27188           },
27189           {
27190             "group": "Body",
27191             "type": "String",
27192             "allowedValues": [
27193               "\"yes\"",
27194               "\"no\"",
27195               "\"always\""
27196             ],
27197             "optional": true,
27198             "field": "videosupport",
27199             "description": ""
27200           },
27201           {
27202             "group": "Body",
27203             "type": "Integer",
27204             "optional": true,
27205             "field": "maxcallbitrate",
27206             "description": ""
27207           },
27208           {
27209             "group": "Body",
27210             "type": "String",
27211             "allowedValues": [
27212               "\"yes\"",
27213               "\"no\""
27214             ],
27215             "optional": true,
27216             "field": "rfc2833compensate",
27217             "description": ""
27218           },
27219           {
27220             "group": "Body",
27221             "type": "String",
27222             "optional": true,
27223             "field": "mailbox",
27224             "description": ""
27225           },
27226           {
27227             "group": "Body",
27228             "type": "String",
27229             "allowedValues": [
27230               "\"accept\"",
27231               "\"refuse\"",
27232               "\"originate\""
27233             ],
27234             "optional": true,
27235             "field": "session_timers",
27236             "description": ""
27237           },
27238           {
27239             "group": "Body",
27240             "type": "Integer",
27241             "optional": true,
27242             "field": "session_expires",
27243             "description": ""
27244           },
27245           {
27246             "group": "Body",
27247             "type": "Integer",
27248             "optional": true,
27249             "field": "session_minse",
27250             "description": ""
27251           },
27252           {
27253             "group": "Body",
27254             "type": "String",
27255             "allowedValues": [
27256               "\"uac\"",
27257               "\"uas\""
27258             ],
27259             "optional": true,
27260             "field": "session_refresher",
27261             "description": ""
27262           },
27263           {
27264             "group": "Body",
27265             "type": "String",
27266             "optional": true,
27267             "field": "t38pt_usertpsource",
27268             "description": ""
27269           },
27270           {
27271             "group": "Body",
27272             "type": "String",
27273             "optional": true,
27274             "field": "regexten",
27275             "description": ""
27276           },
27277           {
27278             "group": "Body",
27279             "type": "String",
27280             "optional": true,
27281             "field": "fromdomain",
27282             "description": ""
27283           },
27284           {
27285             "group": "Body",
27286             "type": "String",
27287             "optional": true,
27288             "field": "fromuser",
27289             "description": ""
27290           },
27291           {
27292             "group": "Body",
27293             "type": "Integer",
27294             "optional": true,
27295             "field": "port",
27296             "description": ""
27297           },
27298           {
27299             "group": "Body",
27300             "type": "String",
27301             "allowedValues": [
27302               "\"yes\"",
27303               "\"no\""
27304             ],
27305             "optional": true,
27306             "field": "qualify",
27307             "description": ""
27308           },
27309           {
27310             "group": "Body",
27311             "type": "Integer",
27312             "optional": true,
27313             "field": "keepalive",
27314             "description": ""
27315           },
27316           {
27317             "group": "Body",
27318             "type": "String",
27319             "optional": true,
27320             "field": "defaultip",
27321             "description": ""
27322           },
27323           {
27324             "group": "Body",
27325             "type": "String",
27326             "optional": true,
27327             "field": "defaultuser",
27328             "description": ""
27329           },
27330           {
27331             "group": "Body",
27332             "type": "Integer",
27333             "optional": true,
27334             "field": "rtptimeout",
27335             "description": ""
27336           },
27337           {
27338             "group": "Body",
27339             "type": "Integer",
27340             "optional": true,
27341             "field": "rtpholdtimeout",
27342             "description": ""
27343           },
27344           {
27345             "group": "Body",
27346             "type": "Integer",
27347             "optional": true,
27348             "field": "rtpkeepalive",
27349             "description": ""
27350           },
27351           {
27352             "group": "Body",
27353             "type": "String",
27354             "allowedValues": [
27355               "\"yes\"",
27356               "\"no\"",
27357               "\"pai\""
27358             ],
27359             "optional": true,
27360             "field": "sendrpid",
27361             "description": ""
27362           },
27363           {
27364             "group": "Body",
27365             "type": "String",
27366             "optional": true,
27367             "field": "outboundproxy",
27368             "description": ""
27369           },
27370           {
27371             "group": "Body",
27372             "type": "String",
27373             "optional": true,
27374             "field": "callbackextension",
27375             "description": ""
27376           },
27377           {
27378             "group": "Body",
27379             "type": "Integer",
27380             "optional": true,
27381             "field": "timert1",
27382             "description": ""
27383           },
27384           {
27385             "group": "Body",
27386             "type": "Integer",
27387             "optional": true,
27388             "field": "timerb",
27389             "description": ""
27390           },
27391           {
27392             "group": "Body",
27393             "type": "Integer",
27394             "optional": true,
27395             "field": "qualifyfreq",
27396             "description": ""
27397           },
27398           {
27399             "group": "Body",
27400             "type": "String",
27401             "optional": true,
27402             "field": "contactpermit",
27403             "description": ""
27404           },
27405           {
27406             "group": "Body",
27407             "type": "String",
27408             "optional": true,
27409             "field": "contactdeny",
27410             "description": ""
27411           },
27412           {
27413             "group": "Body",
27414             "type": "String",
27415             "optional": true,
27416             "field": "contactacl",
27417             "description": ""
27418           },
27419           {
27420             "group": "Body",
27421             "type": "String",
27422             "optional": true,
27423             "field": "unsolicited_mailbox",
27424             "description": ""
27425           },
27426           {
27427             "group": "Body",
27428             "type": "String",
27429             "optional": true,
27430             "field": "use_q850_reason",
27431             "description": ""
27432           },
27433           {
27434             "group": "Body",
27435             "type": "Integer",
27436             "optional": true,
27437             "field": "maxforwards",
27438             "description": ""
27439           },
27440           {
27441             "group": "Body",
27442             "type": "String",
27443             "allowedValues": [
27444               "\"yes\"",
27445               "\"no\""
27446             ],
27447             "optional": true,
27448             "field": "encryption",
27449             "description": ""
27450           },
27451           {
27452             "group": "Body",
27453             "type": "String",
27454             "allowedValues": [
27455               "\"yes\"",
27456               "\"no\""
27457             ],
27458             "optional": true,
27459             "field": "avpf",
27460             "description": ""
27461           },
27462           {
27463             "group": "Body",
27464             "type": "String",
27465             "allowedValues": [
27466               "\"yes\"",
27467               "\"no\""
27468             ],
27469             "optional": true,
27470             "field": "force_avp",
27471             "description": ""
27472           },
27473           {
27474             "group": "Body",
27475             "type": "String",
27476             "allowedValues": [
27477               "\"yes\"",
27478               "\"no\""
27479             ],
27480             "optional": true,
27481             "field": "icesupport",
27482             "description": ""
27483           },
27484           {
27485             "group": "Body",
27486             "type": "String",
27487             "allowedValues": [
27488               "\"yes\"",
27489               "\"no\""
27490             ],
27491             "optional": true,
27492             "field": "dtlsenable",
27493             "description": ""
27494           },
27495           {
27496             "group": "Body",
27497             "type": "String",
27498             "allowedValues": [
27499               "\"yes\"",
27500               "\"no\"",
27501               "\"fingerprint\"",
27502               "\"certificate\""
27503             ],
27504             "optional": true,
27505             "field": "dtlsverify",
27506             "description": ""
27507           },
27508           {
27509             "group": "Body",
27510             "type": "Integer",
27511             "optional": true,
27512             "field": "dtlsrekey",
27513             "description": ""
27514           },
27515           {
27516             "group": "Body",
27517             "type": "String",
27518             "optional": true,
27519             "field": "dtlscertfile",
27520             "description": ""
27521           },
27522           {
27523             "group": "Body",
27524             "type": "String",
27525             "optional": true,
27526             "field": "dtlsprivatekey",
27527             "description": ""
27528           },
27529           {
27530             "group": "Body",
27531             "type": "String",
27532             "optional": true,
27533             "field": "dtlscipher",
27534             "description": ""
27535           },
27536           {
27537             "group": "Body",
27538             "type": "String",
27539             "optional": true,
27540             "field": "dtlscafile",
27541             "description": ""
27542           },
27543           {
27544             "group": "Body",
27545             "type": "String",
27546             "optional": true,
27547             "field": "dtlscapath",
27548             "description": ""
27549           },
27550           {
27551             "group": "Body",
27552             "type": "String",
27553             "allowedValues": [
27554               "\"active\"",
27555               "\"passive\"",
27556               "\"actpass\""
27557             ],
27558             "optional": true,
27559             "field": "dtlssetup",
27560             "description": ""
27561           },
27562           {
27563             "group": "Body",
27564             "type": "String",
27565             "optional": true,
27566             "field": "dtlsfingerprint",
27567             "description": ""
27568           },
27569           {
27570             "group": "Body",
27571             "type": "String",
27572             "allowedValues": [
27573               "\"yes\"",
27574               "\"no\""
27575             ],
27576             "optional": true,
27577             "field": "usereqphone",
27578             "description": ""
27579           },
27580           {
27581             "group": "Body",
27582             "type": "String",
27583             "optional": true,
27584             "field": "recordonfeature",
27585             "description": ""
27586           },
27587           {
27588             "group": "Body",
27589             "type": "String",
27590             "optional": true,
27591             "field": "recordofffeature",
27592             "description": ""
27593           },
27594           {
27595             "group": "Body",
27596             "type": "Integer",
27597             "optional": true,
27598             "field": "call_limit",
27599             "description": ""
27600           },
27601           {
27602             "group": "Body",
27603             "type": "String",
27604             "allowedValues": [
27605               "\"yes\"",
27606               "\"no\""
27607             ],
27608             "optional": true,
27609             "field": "registertrying",
27610             "description": ""
27611           },
27612           {
27613             "group": "Body",
27614             "type": "String",
27615             "allowedValues": [
27616               "\"yes\"",
27617               "\"no\""
27618             ],
27619             "optional": true,
27620             "field": "subscribemwi",
27621             "description": ""
27622           },
27623           {
27624             "group": "Body",
27625             "type": "String",
27626             "optional": true,
27627             "field": "vmexten",
27628             "description": ""
27629           },
27630           {
27631             "group": "Body",
27632             "type": "String",
27633             "optional": true,
27634             "field": "mohinterpret",
27635             "description": ""
27636           },
27637           {
27638             "group": "Body",
27639             "type": "String",
27640             "optional": true,
27641             "field": "mohsuggest",
27642             "description": ""
27643           },
27644           {
27645             "group": "Body",
27646             "type": "String",
27647             "optional": true,
27648             "field": "parkinglot",
27649             "description": ""
27650           },
27651           {
27652             "group": "Body",
27653             "type": "String",
27654             "optional": true,
27655             "field": "description",
27656             "description": ""
27657           },
27658           {
27659             "group": "Body",
27660             "type": "String",
27661             "optional": true,
27662             "field": "host",
27663             "description": ""
27664           },
27665           {
27666             "group": "Body",
27667             "type": "String",
27668             "allowedValues": [
27669               "\"yes\"",
27670               "\"no\"",
27671               "\"nonat\"",
27672               "\"update\"",
27673               "\"update,nonat\""
27674             ],
27675             "optional": true,
27676             "field": "canreinvite",
27677             "description": ""
27678           },
27679           {
27680             "group": "Body",
27681             "type": "String",
27682             "optional": true,
27683             "field": "registry",
27684             "description": ""
27685           },
27686           {
27687             "group": "Body",
27688             "type": "String",
27689             "optional": true,
27690             "field": "otherFields",
27691             "description": ""
27692           },
27693           {
27694             "group": "Body",
27695             "type": "Boolean",
27696             "optional": false,
27697             "field": "active",
27698             "description": ""
27699           },
27700           {
27701             "group": "Body",
27702             "type": "String",
27703             "optional": true,
27704             "field": "t38pt_udptl",
27705             "description": ""
27706           }
27707         ]
27708       }
27709     },
27710     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27711     "version": "0.0.0",
27712     "filename": "server/api/trunk/index.js",
27713     "groupTitle": "Trunks"
27714   },
27715   {
27716     "type": "delete",
27717     "url": "/api/trunks/{id}",
27718     "title": "Deletes a trunk",
27719     "examples": [
27720       {
27721         "title": "Example usage:",
27722         "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X DELETE",
27723         "type": "json"
27724       }
27725     ],
27726     "name": "Delete",
27727     "group": "Trunks",
27728     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27729     "version": "0.0.0",
27730     "filename": "server/api/trunk/index.js",
27731     "groupTitle": "Trunks"
27732   },
27733   {
27734     "type": "get",
27735     "url": "/api/trunks",
27736     "title": "Gets a list of Trunks",
27737     "examples": [
27738       {
27739         "title": "Example usage:",
27740         "content": "curl https://{domain}/api/trunks -v -u {name}:{password}",
27741         "type": "json"
27742       }
27743     ],
27744     "name": "GetTrunks",
27745     "group": "Trunks",
27746     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
27747     "version": "0.0.0",
27748     "filename": "server/api/trunk/index.js",
27749     "groupTitle": "Trunks"
27750   },
27751   {
27752     "type": "get",
27753     "url": "/api/trunks/{id}",
27754     "title": "Gets a single Trunk",
27755     "examples": [
27756       {
27757         "title": "Example usage:",
27758         "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password}",
27759         "type": "json"
27760       }
27761     ],
27762     "name": "ShowTrunks",
27763     "group": "Trunks",
27764     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27765     "version": "0.0.0",
27766     "filename": "server/api/trunk/index.js",
27767     "groupTitle": "Trunks"
27768   },
27769   {
27770     "type": "put",
27771     "url": "/api/trunks/{id}",
27772     "title": "Update an existing trunk",
27773     "examples": [
27774       {
27775         "title": "Example usage:",
27776         "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X PUT",
27777         "type": "json"
27778       }
27779     ],
27780     "name": "Update",
27781     "group": "Trunks",
27782     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27783     "version": "0.0.0",
27784     "filename": "server/api/trunk/index.js",
27785     "groupTitle": "Trunks"
27786   },
27787   {
27788     "type": "post",
27789     "url": "/api/userProfile/resources",
27790     "title": "Creates a new User Profile Resource",
27791     "examples": [
27792       {
27793         "title": "Example usage:",
27794         "content": "curl https://{domain}/api/userProfile/resources -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27795         "type": "json"
27796       }
27797     ],
27798     "name": "CreateUser_Profile_Resources",
27799     "group": "User_Profile_Resources",
27800     "parameter": {
27801       "fields": {
27802         "Body": [
27803           {
27804             "group": "Body",
27805             "type": "String",
27806             "optional": false,
27807             "field": "name",
27808             "description": ""
27809           },
27810           {
27811             "group": "Body",
27812             "type": "Integer",
27813             "optional": false,
27814             "field": "resourceId",
27815             "description": ""
27816           },
27817           {
27818             "group": "Body",
27819             "type": "String",
27820             "optional": false,
27821             "field": "type",
27822             "description": ""
27823           }
27824         ]
27825       }
27826     },
27827     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27828     "version": "0.0.0",
27829     "filename": "server/api/userProfileResource/index.js",
27830     "groupTitle": "User_Profile_Resources"
27831   },
27832   {
27833     "type": "delete",
27834     "url": "/api/userProfile/resources/{id}",
27835     "title": "Deletes a User Profile Resource",
27836     "examples": [
27837       {
27838         "title": "Example usage:",
27839         "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password} -X DELETE",
27840         "type": "json"
27841       }
27842     ],
27843     "name": "DeleteUser_Profile_Resources",
27844     "group": "User_Profile_Resources",
27845     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27846     "version": "0.0.0",
27847     "filename": "server/api/userProfileResource/index.js",
27848     "groupTitle": "User_Profile_Resources"
27849   },
27850   {
27851     "type": "get",
27852     "url": "/api/userProfile/resources/describe",
27853     "title": "Gets table info about User Profile Resources",
27854     "examples": [
27855       {
27856         "title": "Example usage:",
27857         "content": "curl https://{domain}/api/userProfile/resources/describe -v -u {name}:{password}",
27858         "type": "json"
27859       }
27860     ],
27861     "name": "DescribeUser_Profile_Resources",
27862     "group": "User_Profile_Resources",
27863     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27864     "version": "0.0.0",
27865     "filename": "server/api/userProfileResource/index.js",
27866     "groupTitle": "User_Profile_Resources"
27867   },
27868   {
27869     "type": "get",
27870     "url": "/api/userProfile/resources",
27871     "title": "Gets a list of User Profile Resources",
27872     "examples": [
27873       {
27874         "title": "Example usage:",
27875         "content": "curl https://{domain}/api/userProfile/resources -v -u {name}:{password}",
27876         "type": "json"
27877       }
27878     ],
27879     "name": "GetUser_Profile_Resources",
27880     "group": "User_Profile_Resources",
27881     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
27882     "version": "0.0.0",
27883     "filename": "server/api/userProfileResource/index.js",
27884     "groupTitle": "User_Profile_Resources"
27885   },
27886   {
27887     "type": "get",
27888     "url": "/api/userProfile/resources/{id}",
27889     "title": "Gets a single User Profile Resource",
27890     "examples": [
27891       {
27892         "title": "Example usage:",
27893         "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password}",
27894         "type": "json"
27895       }
27896     ],
27897     "name": "ShowUser_Profile_Resources",
27898     "group": "User_Profile_Resources",
27899     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27900     "version": "0.0.0",
27901     "filename": "server/api/userProfileResource/index.js",
27902     "groupTitle": "User_Profile_Resources"
27903   },
27904   {
27905     "type": "put",
27906     "url": "/api/userProfile/resources/{id}",
27907     "title": "Update an existing User Profile Resource",
27908     "examples": [
27909       {
27910         "title": "Example usage:",
27911         "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",
27912         "type": "json"
27913       }
27914     ],
27915     "name": "updateUser_Profile_Resources",
27916     "group": "User_Profile_Resources",
27917     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27918     "version": "0.0.0",
27919     "filename": "server/api/userProfileResource/index.js",
27920     "groupTitle": "User_Profile_Resources"
27921   },
27922   {
27923     "type": "post",
27924     "url": "/api/userProfile/sections",
27925     "title": "Creates a new User Profile Section",
27926     "examples": [
27927       {
27928         "title": "Example usage:",
27929         "content": "curl https://{domain}/api/userProfile/sections -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27930         "type": "json"
27931       }
27932     ],
27933     "name": "CreateUser_Profile_Sections",
27934     "group": "User_Profile_Sections",
27935     "parameter": {
27936       "fields": {
27937         "Body": [
27938           {
27939             "group": "Body",
27940             "type": "String",
27941             "optional": false,
27942             "field": "name",
27943             "description": ""
27944           },
27945           {
27946             "group": "Body",
27947             "type": "String",
27948             "optional": false,
27949             "field": "category",
27950             "description": ""
27951           },
27952           {
27953             "group": "Body",
27954             "type": "Integer",
27955             "optional": false,
27956             "field": "sectionId",
27957             "description": ""
27958           },
27959           {
27960             "group": "Body",
27961             "type": "Boolean",
27962             "optional": true,
27963             "field": "enabled",
27964             "description": ""
27965           },
27966           {
27967             "group": "Body",
27968             "type": "Boolean",
27969             "optional": true,
27970             "field": "autoAssociation",
27971             "description": ""
27972           },
27973           {
27974             "group": "Body",
27975             "type": "String",
27976             "optional": true,
27977             "field": "crudPermissions",
27978             "description": ""
27979           }
27980         ]
27981       }
27982     },
27983     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27984     "version": "0.0.0",
27985     "filename": "server/api/userProfileSection/index.js",
27986     "groupTitle": "User_Profile_Sections"
27987   },
27988   {
27989     "type": "delete",
27990     "url": "/api/userProfile/sections/{id}",
27991     "title": "Deletes a User Profile Section",
27992     "examples": [
27993       {
27994         "title": "Example usage:",
27995         "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password} -X DELETE",
27996         "type": "json"
27997       }
27998     ],
27999     "name": "DeleteUser_Profile_Sections",
28000     "group": "User_Profile_Sections",
28001     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28002     "version": "0.0.0",
28003     "filename": "server/api/userProfileSection/index.js",
28004     "groupTitle": "User_Profile_Sections"
28005   },
28006   {
28007     "type": "get",
28008     "url": "/api/userProfile/sections/describe",
28009     "title": "Gets table info about User Profile Sections",
28010     "examples": [
28011       {
28012         "title": "Example usage:",
28013         "content": "curl https://{domain}/api/userProfile/sections/describe -v -u {name}:{password}",
28014         "type": "json"
28015       }
28016     ],
28017     "name": "DescribeUser_Profile_Sections",
28018     "group": "User_Profile_Sections",
28019     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28020     "version": "0.0.0",
28021     "filename": "server/api/userProfileSection/index.js",
28022     "groupTitle": "User_Profile_Sections"
28023   },
28024   {
28025     "type": "get",
28026     "url": "/api/userProfile/sections",
28027     "title": "Gets a list of User Profile Sections",
28028     "examples": [
28029       {
28030         "title": "Example usage:",
28031         "content": "curl https://{domain}/api/userProfile/sections -v -u {name}:{password}",
28032         "type": "json"
28033       }
28034     ],
28035     "name": "GetUser_Profile_Sections",
28036     "group": "User_Profile_Sections",
28037     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
28038     "version": "0.0.0",
28039     "filename": "server/api/userProfileSection/index.js",
28040     "groupTitle": "User_Profile_Sections"
28041   },
28042   {
28043     "type": "get",
28044     "url": "/api/userProfile/sections/{id}",
28045     "title": "Gets a single User Profile Section",
28046     "examples": [
28047       {
28048         "title": "Example usage:",
28049         "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password}",
28050         "type": "json"
28051       }
28052     ],
28053     "name": "ShowUser_Profile_Sections",
28054     "group": "User_Profile_Sections",
28055     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28056     "version": "0.0.0",
28057     "filename": "server/api/userProfileSection/index.js",
28058     "groupTitle": "User_Profile_Sections"
28059   },
28060   {
28061     "type": "put",
28062     "url": "/api/userProfile/sections/{id}",
28063     "title": "Update an existing User Profile Section",
28064     "examples": [
28065       {
28066         "title": "Example usage:",
28067         "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",
28068         "type": "json"
28069       }
28070     ],
28071     "name": "updateUser_Profile_Sections",
28072     "group": "User_Profile_Sections",
28073     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28074     "version": "0.0.0",
28075     "filename": "server/api/userProfileSection/index.js",
28076     "groupTitle": "User_Profile_Sections"
28077   },
28078   {
28079     "type": "post",
28080     "url": "/api/userProfiles/{id}/resources",
28081     "title": "Add resources' permissions to User Profile",
28082     "examples": [
28083       {
28084         "title": "Example usage:",
28085         "content": "curl https://{domain}/api/userProfiles/{id}/resources -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28086         "type": "json"
28087       }
28088     ],
28089     "name": "AddResources",
28090     "group": "User_Profiles",
28091     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28092     "version": "0.0.0",
28093     "filename": "server/api/userProfile/index.js",
28094     "groupTitle": "User_Profiles"
28095   },
28096   {
28097     "type": "post",
28098     "url": "/api/userProfiles/{id}/sections",
28099     "title": "Add sections' permissions to User Profile",
28100     "examples": [
28101       {
28102         "title": "Example usage:",
28103         "content": "curl https://{domain}/api/userProfiles/{id}/sections -d '[{\"sectionId\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28104         "type": "json"
28105       }
28106     ],
28107     "name": "AddSections",
28108     "group": "User_Profiles",
28109     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28110     "version": "0.0.0",
28111     "filename": "server/api/userProfile/index.js",
28112     "groupTitle": "User_Profiles"
28113   },
28114   {
28115     "type": "post",
28116     "url": "/api/userProfiles/clone",
28117     "title": "Clone an existing User Profile",
28118     "examples": [
28119       {
28120         "title": "Example usage:",
28121         "content": "curl https://{domain}/api/userProfiles/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28122         "type": "json"
28123       }
28124     ],
28125     "name": "CloneUser_Profiles",
28126     "group": "User_Profiles",
28127     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28128     "version": "0.0.0",
28129     "filename": "server/api/userProfile/index.js",
28130     "groupTitle": "User_Profiles"
28131   },
28132   {
28133     "type": "post",
28134     "url": "/api/userProfiles",
28135     "title": "Creates a new User Profile",
28136     "examples": [
28137       {
28138         "title": "Example usage:",
28139         "content": "curl https://{domain}/api/userProfiles -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28140         "type": "json"
28141       }
28142     ],
28143     "name": "CreateUser_Profiles",
28144     "group": "User_Profiles",
28145     "parameter": {
28146       "fields": {
28147         "Body": [
28148           {
28149             "group": "Body",
28150             "type": "String",
28151             "optional": false,
28152             "field": "name",
28153             "description": ""
28154           },
28155           {
28156             "group": "Body",
28157             "type": "String",
28158             "optional": false,
28159             "field": "crudPermissions",
28160             "description": ""
28161           },
28162           {
28163             "group": "Body",
28164             "type": "String",
28165             "optional": true,
28166             "field": "description",
28167             "description": ""
28168           }
28169         ]
28170       }
28171     },
28172     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28173     "version": "0.0.0",
28174     "filename": "server/api/userProfile/index.js",
28175     "groupTitle": "User_Profiles"
28176   },
28177   {
28178     "type": "delete",
28179     "url": "/api/userProfiles/{id}",
28180     "title": "Deletes a User Profile",
28181     "examples": [
28182       {
28183         "title": "Example usage:",
28184         "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password} -X DELETE",
28185         "type": "json"
28186       }
28187     ],
28188     "name": "DeleteUser_Profiles",
28189     "group": "User_Profiles",
28190     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28191     "version": "0.0.0",
28192     "filename": "server/api/userProfile/index.js",
28193     "groupTitle": "User_Profiles"
28194   },
28195   {
28196     "type": "get",
28197     "url": "/api/userProfiles/describe",
28198     "title": "Gets table info about User Profiles",
28199     "examples": [
28200       {
28201         "title": "Example usage:",
28202         "content": "curl https://{domain}/api/userProfiles/describe -v -u {name}:{password}",
28203         "type": "json"
28204       }
28205     ],
28206     "name": "DescribeUser_Profiles",
28207     "group": "User_Profiles",
28208     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28209     "version": "0.0.0",
28210     "filename": "server/api/userProfile/index.js",
28211     "groupTitle": "User_Profiles"
28212   },
28213   {
28214     "type": "get",
28215     "url": "/api/userProfiles/{id}/resources?section={section}",
28216     "title": "Get Resources assigned to a Section",
28217     "examples": [
28218       {
28219         "title": "Example usage:",
28220         "content": "curl https://{domain}/api/userProfiles/{id}/resources?section={section} -v -u {name}:{password} -X GET",
28221         "type": "json"
28222       }
28223     ],
28224     "name": "GetResources",
28225     "group": "User_Profiles",
28226     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28227     "version": "0.0.0",
28228     "filename": "server/api/userProfile/index.js",
28229     "groupTitle": "User_Profiles"
28230   },
28231   {
28232     "type": "get",
28233     "url": "/api/userProfiles/{id}/sections",
28234     "title": "Get sections associated to a User Profile",
28235     "examples": [
28236       {
28237         "title": "Example usage:",
28238         "content": "curl https://{domain}/api/userProfiles/{id}/sections -v -u {name}:{password} -X GET",
28239         "type": "json"
28240       }
28241     ],
28242     "name": "GetSections",
28243     "group": "User_Profiles",
28244     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28245     "version": "0.0.0",
28246     "filename": "server/api/userProfile/index.js",
28247     "groupTitle": "User_Profiles"
28248   },
28249   {
28250     "type": "get",
28251     "url": "/api/userProfiles",
28252     "title": "Gets a list of User Profiles",
28253     "examples": [
28254       {
28255         "title": "Example usage:",
28256         "content": "curl https://{domain}/api/userProfiles -v -u {name}:{password}",
28257         "type": "json"
28258       }
28259     ],
28260     "name": "GetUser_Profiles",
28261     "group": "User_Profiles",
28262     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
28263     "version": "0.0.0",
28264     "filename": "server/api/userProfile/index.js",
28265     "groupTitle": "User_Profiles"
28266   },
28267   {
28268     "type": "delete",
28269     "url": "/api/userProfiles/{id}/resources",
28270     "title": "Removes resources' permissions from User Profile",
28271     "examples": [
28272       {
28273         "title": "Example usage:",
28274         "content": "curl https://{domain}/api/userProfiles/{id}/resources?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
28275         "type": "json"
28276       }
28277     ],
28278     "name": "RemoveResources",
28279     "group": "User_Profiles",
28280     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28281     "version": "0.0.0",
28282     "filename": "server/api/userProfile/index.js",
28283     "groupTitle": "User_Profiles"
28284   },
28285   {
28286     "type": "delete",
28287     "url": "/api/userProfiles/{id}/sections",
28288     "title": "Removes sections' permissions from User Profile",
28289     "examples": [
28290       {
28291         "title": "Example usage:",
28292         "content": "curl https://{domain}/api/userProfiles/{id}/sections?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
28293         "type": "json"
28294       }
28295     ],
28296     "name": "RemoveSections",
28297     "group": "User_Profiles",
28298     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28299     "version": "0.0.0",
28300     "filename": "server/api/userProfile/index.js",
28301     "groupTitle": "User_Profiles"
28302   },
28303   {
28304     "type": "get",
28305     "url": "/api/userProfiles/{id}",
28306     "title": "Gets a single User Profile",
28307     "examples": [
28308       {
28309         "title": "Example usage:",
28310         "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password}",
28311         "type": "json"
28312       }
28313     ],
28314     "name": "ShowUser_Profiles",
28315     "group": "User_Profiles",
28316     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28317     "version": "0.0.0",
28318     "filename": "server/api/userProfile/index.js",
28319     "groupTitle": "User_Profiles"
28320   },
28321   {
28322     "type": "put",
28323     "url": "/api/userProfiles/{id}",
28324     "title": "Update an existing User Profile",
28325     "examples": [
28326       {
28327         "title": "Example usage:",
28328         "content": "curl https://{domain}/api/userProfiles/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
28329         "type": "json"
28330       }
28331     ],
28332     "name": "updateUser_Profiles",
28333     "group": "User_Profiles",
28334     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28335     "version": "0.0.0",
28336     "filename": "server/api/userProfile/index.js",
28337     "groupTitle": "User_Profiles"
28338   },
28339   {
28340     "type": "post",
28341     "url": "/api/users/{id}/chat_interactions",
28342     "title": "Add chat interaction tabs to an agent",
28343     "examples": [
28344       {
28345         "title": "Example usage:",
28346         "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",
28347         "type": "json"
28348       }
28349     ],
28350     "name": "AddChatInteractions",
28351     "group": "Users",
28352     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28353     "version": "0.0.0",
28354     "filename": "server/api/user/index.js",
28355     "groupTitle": "Users"
28356   },
28357   {
28358     "type": "post",
28359     "url": "/api/users/{id}/chat_websites",
28360     "title": "Add a Chat Website to a user",
28361     "examples": [
28362       {
28363         "title": "Example usage:",
28364         "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",
28365         "type": "json"
28366       }
28367     ],
28368     "name": "AddChatWebsites",
28369     "group": "Users",
28370     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28371     "version": "0.0.0",
28372     "filename": "server/api/user/index.js",
28373     "groupTitle": "Users"
28374   },
28375   {
28376     "type": "post",
28377     "url": "/api/users/{id}/contacts",
28378     "title": "Add contacts to a user",
28379     "examples": [
28380       {
28381         "title": "Example usage:",
28382         "content": "curl https://{domain}/api/users/{id}/contacts -d '{\"ids\": [1,2]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28383         "type": "json"
28384       }
28385     ],
28386     "name": "AddContacts",
28387     "group": "Users",
28388     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28389     "version": "0.0.0",
28390     "filename": "server/api/user/index.js",
28391     "groupTitle": "Users"
28392   },
28393   {
28394     "type": "post",
28395     "url": "/api/users/{id}/fax_accounts",
28396     "title": "Add a Fax Account to a user",
28397     "examples": [
28398       {
28399         "title": "Example usage:",
28400         "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",
28401         "type": "json"
28402       }
28403     ],
28404     "name": "AddFaxAccounts",
28405     "group": "Users",
28406     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28407     "version": "0.0.0",
28408     "filename": "server/api/user/index.js",
28409     "groupTitle": "Users"
28410   },
28411   {
28412     "type": "post",
28413     "url": "/api/users/{id}/fax_interactions",
28414     "title": "Add fax interaction tabs to an agent",
28415     "examples": [
28416       {
28417         "title": "Example usage:",
28418         "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",
28419         "type": "json"
28420       }
28421     ],
28422     "name": "AddFaxInteractions",
28423     "group": "Users",
28424     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28425     "version": "0.0.0",
28426     "filename": "server/api/user/index.js",
28427     "groupTitle": "Users"
28428   },
28429   {
28430     "type": "post",
28431     "url": "/api/users/{id}/mail_accounts",
28432     "title": "Add a Mail Account to a user",
28433     "examples": [
28434       {
28435         "title": "Example usage:",
28436         "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",
28437         "type": "json"
28438       }
28439     ],
28440     "name": "AddMailAccounts",
28441     "group": "Users",
28442     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28443     "version": "0.0.0",
28444     "filename": "server/api/user/index.js",
28445     "groupTitle": "Users"
28446   },
28447   {
28448     "type": "post",
28449     "url": "/api/users/{id}/mail_interactions",
28450     "title": "Add mail interaction tabs to an agent",
28451     "examples": [
28452       {
28453         "title": "Example usage:",
28454         "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",
28455         "type": "json"
28456       }
28457     ],
28458     "name": "AddMailInteractions",
28459     "group": "Users",
28460     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28461     "version": "0.0.0",
28462     "filename": "server/api/user/index.js",
28463     "groupTitle": "Users"
28464   },
28465   {
28466     "type": "post",
28467     "url": "/api/users/{id}/openchannel_accounts",
28468     "title": "Add a Open Channel Account to a user",
28469     "examples": [
28470       {
28471         "title": "Example usage:",
28472         "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",
28473         "type": "json"
28474       }
28475     ],
28476     "name": "AddOpenchannelAccounts",
28477     "group": "Users",
28478     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28479     "version": "0.0.0",
28480     "filename": "server/api/user/index.js",
28481     "groupTitle": "Users"
28482   },
28483   {
28484     "type": "post",
28485     "url": "/api/users/{id}/openchannel_interactions",
28486     "title": "Add openchannel interaction tabs to an agent",
28487     "examples": [
28488       {
28489         "title": "Example usage:",
28490         "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",
28491         "type": "json"
28492       }
28493     ],
28494     "name": "AddOpenchannelInteractions",
28495     "group": "Users",
28496     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28497     "version": "0.0.0",
28498     "filename": "server/api/user/index.js",
28499     "groupTitle": "Users"
28500   },
28501   {
28502     "type": "post",
28503     "url": "/api/users/{id}/queues",
28504     "title": "Add queues to an agent",
28505     "examples": [
28506       {
28507         "title": "Example usage:",
28508         "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",
28509         "type": "json"
28510       }
28511     ],
28512     "name": "AddQueues",
28513     "group": "Users",
28514     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28515     "version": "0.0.0",
28516     "filename": "server/api/user/index.js",
28517     "groupTitle": "Users"
28518   },
28519   {
28520     "type": "post",
28521     "url": "/api/users/{id}/sms_accounts",
28522     "title": "Add a Sms Account to a user",
28523     "examples": [
28524       {
28525         "title": "Example usage:",
28526         "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",
28527         "type": "json"
28528       }
28529     ],
28530     "name": "AddSmsAccounts",
28531     "group": "Users",
28532     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28533     "version": "0.0.0",
28534     "filename": "server/api/user/index.js",
28535     "groupTitle": "Users"
28536   },
28537   {
28538     "type": "post",
28539     "url": "/api/users/{id}/sms_interactions",
28540     "title": "Add sms interaction tabs to an agent",
28541     "examples": [
28542       {
28543         "title": "Example usage:",
28544         "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",
28545         "type": "json"
28546       }
28547     ],
28548     "name": "AddSmsInteractions",
28549     "group": "Users",
28550     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28551     "version": "0.0.0",
28552     "filename": "server/api/user/index.js",
28553     "groupTitle": "Users"
28554   },
28555   {
28556     "type": "post",
28557     "url": "/api/users/{id}/square_projects",
28558     "title": "Add a Square Project to a user",
28559     "examples": [
28560       {
28561         "title": "Example usage:",
28562         "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",
28563         "type": "json"
28564       }
28565     ],
28566     "name": "AddSquareProjects",
28567     "group": "Users",
28568     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28569     "version": "0.0.0",
28570     "filename": "server/api/user/index.js",
28571     "groupTitle": "Users"
28572   },
28573   {
28574     "type": "post",
28575     "url": "/api/users/{id}/teams",
28576     "title": "Add teams to an agent",
28577     "examples": [
28578       {
28579         "title": "Example usage:",
28580         "content": "curl https://{domain}/api/users/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28581         "type": "json"
28582       }
28583     ],
28584     "name": "AddTeams",
28585     "group": "Users",
28586     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28587     "version": "0.0.0",
28588     "filename": "server/api/user/index.js",
28589     "groupTitle": "Users"
28590   },
28591   {
28592     "type": "post",
28593     "url": "/api/users/{id}/whatsapp_accounts",
28594     "title": "Add a Whatsapp Account to a user",
28595     "examples": [
28596       {
28597         "title": "Example usage:",
28598         "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",
28599         "type": "json"
28600       }
28601     ],
28602     "name": "AddWhatsappAccounts",
28603     "group": "Users",
28604     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28605     "version": "0.0.0",
28606     "filename": "server/api/user/index.js",
28607     "groupTitle": "Users"
28608   },
28609   {
28610     "type": "post",
28611     "url": "/api/users/{id}/whatsapp_interactions",
28612     "title": "Add Whatsapp interaction tabs to an agent",
28613     "examples": [
28614       {
28615         "title": "Example usage:",
28616         "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",
28617         "type": "json"
28618       }
28619     ],
28620     "name": "AddWhatsappInteractions",
28621     "group": "Users",
28622     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28623     "version": "0.0.0",
28624     "filename": "server/api/user/index.js",
28625     "groupTitle": "Users"
28626   },
28627   {
28628     "type": "put",
28629     "url": "/api/users/{id}/password",
28630     "title": "Change user password",
28631     "examples": [
28632       {
28633         "title": "Example usage:",
28634         "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",
28635         "type": "json"
28636       }
28637     ],
28638     "name": "ChangePwd",
28639     "group": "Users",
28640     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28641     "version": "0.0.0",
28642     "filename": "server/api/user/index.js",
28643     "groupTitle": "Users"
28644   },
28645   {
28646     "type": "post",
28647     "url": "/api/users",
28648     "title": "Create a new user",
28649     "examples": [
28650       {
28651         "title": "Example usage:",
28652         "content": "curl https://{domain}/api/users -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28653         "type": "json"
28654       }
28655     ],
28656     "name": "Create",
28657     "group": "Users",
28658     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28659     "version": "0.0.0",
28660     "filename": "server/api/user/index.js",
28661     "groupTitle": "Users"
28662   },
28663   {
28664     "type": "post",
28665     "url": "/api/users/{id}/api_key",
28666     "title": "Create a new API access key for the user",
28667     "examples": [
28668       {
28669         "title": "Example usage:",
28670         "content": "curl https://{domain}/api/users/:id/api_key -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28671         "type": "json"
28672       }
28673     ],
28674     "name": "CreateApiKey",
28675     "group": "Users",
28676     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28677     "version": "0.0.0",
28678     "filename": "server/api/user/index.js",
28679     "groupTitle": "Users"
28680   },
28681   {
28682     "type": "delete",
28683     "url": "/api/users/{id}",
28684     "title": "Deletes a user",
28685     "examples": [
28686       {
28687         "title": "Example usage:",
28688         "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password} -X DELETE",
28689         "type": "json"
28690       }
28691     ],
28692     "name": "Delete",
28693     "group": "Users",
28694     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28695     "version": "0.0.0",
28696     "filename": "server/api/user/index.js",
28697     "groupTitle": "Users"
28698   },
28699   {
28700     "type": "get",
28701     "url": "/api/users/describe",
28702     "title": "Gets table info about Users",
28703     "examples": [
28704       {
28705         "title": "Example usage:",
28706         "content": "curl https://{domain}/api/users/describe -v -u {name}:{password}",
28707         "type": "json"
28708       }
28709     ],
28710     "name": "DescribeUsers",
28711     "group": "Users",
28712     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28713     "version": "0.0.0",
28714     "filename": "server/api/user/index.js",
28715     "groupTitle": "Users"
28716   },
28717   {
28718     "type": "get",
28719     "url": "/api/users/{id}/agents",
28720     "title": "GetAgents",
28721     "examples": [
28722       {
28723         "title": "Example usage:",
28724         "content": "curl https://{domain}/api/users/{id}/agents -v -u {name}:{password} -X GET",
28725         "type": "json"
28726       }
28727     ],
28728     "name": "GetAgents",
28729     "group": "Users",
28730     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28731     "version": "0.0.0",
28732     "filename": "server/api/user/index.js",
28733     "groupTitle": "Users"
28734   },
28735   {
28736     "type": "get",
28737     "url": "/api/users/{id}/api_key",
28738     "title": "Get the API access key for the user",
28739     "examples": [
28740       {
28741         "title": "Example usage:",
28742         "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X GET",
28743         "type": "json"
28744       }
28745     ],
28746     "name": "GetApiKey",
28747     "group": "Users",
28748     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28749     "version": "0.0.0",
28750     "filename": "server/api/user/index.js",
28751     "groupTitle": "Users"
28752   },
28753   {
28754     "type": "get",
28755     "url": "/api/users/{id}/groups",
28756     "title": "GetChatGroups",
28757     "examples": [
28758       {
28759         "title": "Example usage:",
28760         "content": "curl https://{domain}/api/users/{id}/groups -v -u {name}:{password} -X GET",
28761         "type": "json"
28762       }
28763     ],
28764     "name": "GetChatGroups",
28765     "group": "Users",
28766     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28767     "version": "0.0.0",
28768     "filename": "server/api/user/index.js",
28769     "groupTitle": "Users"
28770   },
28771   {
28772     "type": "get",
28773     "url": "/api/users/{id}/chat/interactions",
28774     "title": "GetChatInteractions",
28775     "examples": [
28776       {
28777         "title": "Example usage:",
28778         "content": "curl https://{domain}/api/users/{id}/chat/interactions -v -u {name}:{password} -X GET",
28779         "type": "json"
28780       }
28781     ],
28782     "name": "GetChatInteractions",
28783     "group": "Users",
28784     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28785     "version": "0.0.0",
28786     "filename": "server/api/user/index.js",
28787     "groupTitle": "Users"
28788   },
28789   {
28790     "type": "get",
28791     "url": "/api/users/{id}/chat_websites",
28792     "title": "GetChatWebsites",
28793     "examples": [
28794       {
28795         "title": "Example usage:",
28796         "content": "curl https://{domain}/api/users/{id}/chat_websites -v -u {name}:{password} -X GET",
28797         "type": "json"
28798       }
28799     ],
28800     "name": "GetChatWebsites",
28801     "group": "Users",
28802     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28803     "version": "0.0.0",
28804     "filename": "server/api/user/index.js",
28805     "groupTitle": "Users"
28806   },
28807   {
28808     "type": "get",
28809     "url": "/api/users/{id}/contacts",
28810     "title": "GetContacts",
28811     "examples": [
28812       {
28813         "title": "Example usage:",
28814         "content": "curl https://{domain}/api/users/{id}/contacts -v -u {name}:{password} -X GET",
28815         "type": "json"
28816       }
28817     ],
28818     "name": "GetContacts",
28819     "group": "Users",
28820     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28821     "version": "0.0.0",
28822     "filename": "server/api/user/index.js",
28823     "groupTitle": "Users"
28824   },
28825   {
28826     "type": "get",
28827     "url": "/api/users/{id}/fax_accounts",
28828     "title": "GetFaxAccounts",
28829     "examples": [
28830       {
28831         "title": "Example usage:",
28832         "content": "curl https://{domain}/api/users/{id}/fax_accounts -v -u {name}:{password} -X GET",
28833         "type": "json"
28834       }
28835     ],
28836     "name": "GetFaxAccounts",
28837     "group": "Users",
28838     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28839     "version": "0.0.0",
28840     "filename": "server/api/user/index.js",
28841     "groupTitle": "Users"
28842   },
28843   {
28844     "type": "get",
28845     "url": "/api/users/{id}/fax/interactions",
28846     "title": "GetFaxInteractions",
28847     "examples": [
28848       {
28849         "title": "Example usage:",
28850         "content": "curl https://{domain}/api/users/{id}/fax/interactions -v -u {name}:{password} -X GET",
28851         "type": "json"
28852       }
28853     ],
28854     "name": "GetFaxInteractions",
28855     "group": "Users",
28856     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28857     "version": "0.0.0",
28858     "filename": "server/api/user/index.js",
28859     "groupTitle": "Users"
28860   },
28861   {
28862     "type": "get",
28863     "url": "/api/users/{id}/lists",
28864     "title": "GetLists",
28865     "examples": [
28866       {
28867         "title": "Example usage:",
28868         "content": "curl https://{domain}/api/users/{id}/lists -v -u {name}:{password} -X GET",
28869         "type": "json"
28870       }
28871     ],
28872     "name": "GetLists",
28873     "group": "Users",
28874     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28875     "version": "0.0.0",
28876     "filename": "server/api/user/index.js",
28877     "groupTitle": "Users"
28878   },
28879   {
28880     "type": "get",
28881     "url": "/api/users/{id}/mail_accounts",
28882     "title": "GetMailAccounts",
28883     "examples": [
28884       {
28885         "title": "Example usage:",
28886         "content": "curl https://{domain}/api/users/{id}/mail_accounts -v -u {name}:{password} -X GET",
28887         "type": "json"
28888       }
28889     ],
28890     "name": "GetMailAccounts",
28891     "group": "Users",
28892     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28893     "version": "0.0.0",
28894     "filename": "server/api/user/index.js",
28895     "groupTitle": "Users"
28896   },
28897   {
28898     "type": "get",
28899     "url": "/api/users/{id}/mail/interactions",
28900     "title": "GetMailInteractions",
28901     "examples": [
28902       {
28903         "title": "Example usage:",
28904         "content": "curl https://{domain}/api/users/{id}/mail/interactions -v -u {name}:{password} -X GET",
28905         "type": "json"
28906       }
28907     ],
28908     "name": "GetMailInteractions",
28909     "group": "Users",
28910     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28911     "version": "0.0.0",
28912     "filename": "server/api/user/index.js",
28913     "groupTitle": "Users"
28914   },
28915   {
28916     "type": "get",
28917     "url": "/api/users/{id}/openchannel_accounts",
28918     "title": "GetOpenchannelAccounts",
28919     "examples": [
28920       {
28921         "title": "Example usage:",
28922         "content": "curl https://{domain}/api/users/{id}/openchannel_accounts -v -u {name}:{password} -X GET",
28923         "type": "json"
28924       }
28925     ],
28926     "name": "GetOpenchannelAccounts",
28927     "group": "Users",
28928     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28929     "version": "0.0.0",
28930     "filename": "server/api/user/index.js",
28931     "groupTitle": "Users"
28932   },
28933   {
28934     "type": "get",
28935     "url": "/api/users/{id}/openchannel/interactions",
28936     "title": "GetOpenchannelInteractions",
28937     "examples": [
28938       {
28939         "title": "Example usage:",
28940         "content": "curl https://{domain}/api/users/{id}/openchannel/interactions -v -u {name}:{password}",
28941         "type": "json"
28942       }
28943     ],
28944     "name": "GetOpenchannelInteractions",
28945     "group": "Users",
28946     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28947     "version": "0.0.0",
28948     "filename": "server/api/user/index.js",
28949     "groupTitle": "Users"
28950   },
28951   {
28952     "type": "get",
28953     "url": "/api/users/{id}/prefixes",
28954     "title": "GetPrefixes",
28955     "examples": [
28956       {
28957         "title": "Example usage:",
28958         "content": "curl https://{domain}/api/users/{id}/prefixes -v -u {name}:{password} -X GET",
28959         "type": "json"
28960       }
28961     ],
28962     "name": "GetPrefixes",
28963     "group": "Users",
28964     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28965     "version": "0.0.0",
28966     "filename": "server/api/user/index.js",
28967     "groupTitle": "Users"
28968   },
28969   {
28970     "type": "get",
28971     "url": "/api/users/{id}/queues?channel={channel}",
28972     "title": "Gets Queues list",
28973     "examples": [
28974       {
28975         "title": "Example usage:",
28976         "content": "curl https://{domain}/api/users/{id}/queues/?channel={channel} -v -u {name}:{password} -X GET",
28977         "type": "json"
28978       }
28979     ],
28980     "name": "GetQueues",
28981     "group": "Users",
28982     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28983     "version": "0.0.0",
28984     "filename": "server/api/user/index.js",
28985     "groupTitle": "Users"
28986   },
28987   {
28988     "type": "get",
28989     "url": "/api/users/{id}/recordings",
28990     "title": "GetRecordings",
28991     "examples": [
28992       {
28993         "title": "Example usage:",
28994         "content": "curl https://{domain}/api/users/{id}/recordings -v -u {name}:{password} -X GET",
28995         "type": "json"
28996       }
28997     ],
28998     "name": "GetRecordings",
28999     "group": "Users",
29000     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29001     "version": "0.0.0",
29002     "filename": "server/api/user/index.js",
29003     "groupTitle": "Users"
29004   },
29005   {
29006     "type": "get",
29007     "url": "/api/users/{id}/scheduled_calls",
29008     "title": "GetScheduledCalls",
29009     "examples": [
29010       {
29011         "title": "Example usage:",
29012         "content": "curl https://{domain}/api/users/{id}/scheduled_calls -v -u {name}:{password} -X GET",
29013         "type": "json"
29014       }
29015     ],
29016     "name": "GetScheduledCalls",
29017     "group": "Users",
29018     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29019     "version": "0.0.0",
29020     "filename": "server/api/user/index.js",
29021     "groupTitle": "Users"
29022   },
29023   {
29024     "type": "get",
29025     "url": "/api/users/{id}/screen_recordings",
29026     "title": "GetScreenRecordings",
29027     "examples": [
29028       {
29029         "title": "Example usage:",
29030         "content": "curl https://{domain}/api/users/{id}/screen_recordings -v -u {name}:{password} -X GET",
29031         "type": "json"
29032       }
29033     ],
29034     "name": "GetScreenRecordings",
29035     "group": "Users",
29036     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29037     "version": "0.0.0",
29038     "filename": "server/api/user/index.js",
29039     "groupTitle": "Users"
29040   },
29041   {
29042     "type": "get",
29043     "url": "/api/users/{id}/sms_accounts",
29044     "title": "GetSmsAccounts",
29045     "examples": [
29046       {
29047         "title": "Example usage:",
29048         "content": "curl https://{domain}/api/users/{id}/sms_accounts -v -u {name}:{password} -X GET",
29049         "type": "json"
29050       }
29051     ],
29052     "name": "GetSmsAccounts",
29053     "group": "Users",
29054     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29055     "version": "0.0.0",
29056     "filename": "server/api/user/index.js",
29057     "groupTitle": "Users"
29058   },
29059   {
29060     "type": "get",
29061     "url": "/api/users/{id}/sms/interactions",
29062     "title": "GetSmsInteractions",
29063     "examples": [
29064       {
29065         "title": "Example usage:",
29066         "content": "curl https://{domain}/api/users/{id}/sms/interactions -v -u {name}:{password} -X GET",
29067         "type": "json"
29068       }
29069     ],
29070     "name": "GetSmsInteractions",
29071     "group": "Users",
29072     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29073     "version": "0.0.0",
29074     "filename": "server/api/user/index.js",
29075     "groupTitle": "Users"
29076   },
29077   {
29078     "type": "get",
29079     "url": "/api/users/{id}/square_projects",
29080     "title": "GetSquareProjects",
29081     "examples": [
29082       {
29083         "title": "Example usage:",
29084         "content": "curl https://{domain}/api/users/{id}/square_projects -v -u {name}:{password} -X GET",
29085         "type": "json"
29086       }
29087     ],
29088     "name": "GetSquareProjects",
29089     "group": "Users",
29090     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29091     "version": "0.0.0",
29092     "filename": "server/api/user/index.js",
29093     "groupTitle": "Users"
29094   },
29095   {
29096     "type": "get",
29097     "url": "/api/users/{id}/teams",
29098     "title": "GetTeams",
29099     "examples": [
29100       {
29101         "title": "Example usage:",
29102         "content": "curl https://{domain}/api/users/{id}/teams -v -u {name}:{password} -X GET",
29103         "type": "json"
29104       }
29105     ],
29106     "name": "GetTeams",
29107     "group": "Users",
29108     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29109     "version": "0.0.0",
29110     "filename": "server/api/user/index.js",
29111     "groupTitle": "Users"
29112   },
29113   {
29114     "type": "get",
29115     "url": "/api/users",
29116     "title": "Gets a list of Users",
29117     "examples": [
29118       {
29119         "title": "Example usage:",
29120         "content": "curl https://{domain}/api/users -v -u {name}:{password}",
29121         "type": "json"
29122       }
29123     ],
29124     "name": "GetUsers",
29125     "group": "Users",
29126     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
29127     "version": "0.0.0",
29128     "filename": "server/api/user/index.js",
29129     "groupTitle": "Users"
29130   },
29131   {
29132     "type": "get",
29133     "url": "/api/users/{id}/queues_rt",
29134     "title": "GetVoiceQueuesRt",
29135     "examples": [
29136       {
29137         "title": "Example usage:",
29138         "content": "curl https://{domain}/api/users/{id}/queues_rt -v -u {name}:{password} -X GET",
29139         "type": "json"
29140       }
29141     ],
29142     "name": "GetVoiceQueuesRt",
29143     "group": "Users",
29144     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29145     "version": "0.0.0",
29146     "filename": "server/api/user/index.js",
29147     "groupTitle": "Users"
29148   },
29149   {
29150     "type": "get",
29151     "url": "/api/users/{id}/whatsapp_accounts",
29152     "title": "GetWhatsappAccounts",
29153     "examples": [
29154       {
29155         "title": "Example usage:",
29156         "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts -v -u {name}:{password} -X GET",
29157         "type": "json"
29158       }
29159     ],
29160     "name": "GetWhatsappAccounts",
29161     "group": "Users",
29162     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29163     "version": "0.0.0",
29164     "filename": "server/api/user/index.js",
29165     "groupTitle": "Users"
29166   },
29167   {
29168     "type": "get",
29169     "url": "/api/users/{id}/whatsapp/interactions",
29170     "title": "GetWhatsappInteractions",
29171     "examples": [
29172       {
29173         "title": "Example usage:",
29174         "content": "curl https://{domain}/api/users/{id}/whatsapp/interactions -v -u {name}:{password} -X GET",
29175         "type": "json"
29176       }
29177     ],
29178     "name": "GetWhatsappInteractions",
29179     "group": "Users",
29180     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29181     "version": "0.0.0",
29182     "filename": "server/api/user/index.js",
29183     "groupTitle": "Users"
29184   },
29185   {
29186     "type": "post",
29187     "url": "/api/users/{id}/login",
29188     "title": "Login",
29189     "examples": [
29190       {
29191         "title": "Example usage:",
29192         "content": "curl https://{domain}/api/users/{id}/login  -v -u {name}:{password} -X POST",
29193         "type": "json"
29194       }
29195     ],
29196     "name": "Login",
29197     "group": "Users",
29198     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29199     "version": "0.0.0",
29200     "filename": "server/api/user/index.js",
29201     "groupTitle": "Users"
29202   },
29203   {
29204     "type": "post",
29205     "url": "/api/users/{id}/logout",
29206     "title": "Logout",
29207     "examples": [
29208       {
29209         "title": "Example usage:",
29210         "content": "curl https://{domain}/api/users/{id}/logout -v -u {name}:{password} -X POST",
29211         "type": "json"
29212       }
29213     ],
29214     "name": "Logout",
29215     "group": "Users",
29216     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29217     "version": "0.0.0",
29218     "filename": "server/api/user/index.js",
29219     "groupTitle": "Users"
29220   },
29221   {
29222     "type": "post",
29223     "url": "/api/users/{id}/pause",
29224     "title": "Pause",
29225     "examples": [
29226       {
29227         "title": "Example usage:",
29228         "content": "curl https://{domain}/api/users/{id}/pause -v -u {name}:{password} -X POST",
29229         "type": "json"
29230       }
29231     ],
29232     "name": "Pause",
29233     "group": "Users",
29234     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29235     "version": "0.0.0",
29236     "filename": "server/api/user/index.js",
29237     "groupTitle": "Users"
29238   },
29239   {
29240     "type": "delete",
29241     "url": "/api/users/{id}/api_key",
29242     "title": "Remove API access key for the user",
29243     "examples": [
29244       {
29245         "title": "Example usage:",
29246         "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X DELETE",
29247         "type": "json"
29248       }
29249     ],
29250     "name": "RemoveApiKey",
29251     "group": "Users",
29252     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29253     "version": "0.0.0",
29254     "filename": "server/api/user/index.js",
29255     "groupTitle": "Users"
29256   },
29257   {
29258     "type": "delete",
29259     "url": "/api/users/{id}/chat_interactions",
29260     "title": "Removes interactions from an agent",
29261     "examples": [
29262       {
29263         "title": "Example usage:",
29264         "content": "curl https://{domain}/api/users/{id}/chat_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29265         "type": "json"
29266       }
29267     ],
29268     "name": "RemoveChatInteractions",
29269     "group": "Users",
29270     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29271     "version": "0.0.0",
29272     "filename": "server/api/user/index.js",
29273     "groupTitle": "Users"
29274   },
29275   {
29276     "type": "delete",
29277     "url": "/api/users/{id}/chat_websites",
29278     "title": "Removes a Chat Website from a user",
29279     "examples": [
29280       {
29281         "title": "Example usage:",
29282         "content": "curl https://{domain}/api/users/{id}/chat_websites?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29283         "type": "json"
29284       }
29285     ],
29286     "name": "RemoveChatWebsites",
29287     "group": "Users",
29288     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29289     "version": "0.0.0",
29290     "filename": "server/api/user/index.js",
29291     "groupTitle": "Users"
29292   },
29293   {
29294     "type": "delete",
29295     "url": "/api/users/{id}/fax_accounts",
29296     "title": "Removes a Fax Account from a user",
29297     "examples": [
29298       {
29299         "title": "Example usage:",
29300         "content": "curl https://{domain}/api/users/{id}/fax_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29301         "type": "json"
29302       }
29303     ],
29304     "name": "RemoveFaxAccounts",
29305     "group": "Users",
29306     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29307     "version": "0.0.0",
29308     "filename": "server/api/user/index.js",
29309     "groupTitle": "Users"
29310   },
29311   {
29312     "type": "delete",
29313     "url": "/api/users/{id}/fax_interactions",
29314     "title": "Removes interactions from an agent",
29315     "examples": [
29316       {
29317         "title": "Example usage:",
29318         "content": "curl https://{domain}/api/users/{id}/fax_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29319         "type": "json"
29320       }
29321     ],
29322     "name": "RemoveFaxInteractions",
29323     "group": "Users",
29324     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29325     "version": "0.0.0",
29326     "filename": "server/api/user/index.js",
29327     "groupTitle": "Users"
29328   },
29329   {
29330     "type": "delete",
29331     "url": "/api/users/{id}/mail_accounts",
29332     "title": "Removes a Mail Account from a user",
29333     "examples": [
29334       {
29335         "title": "Example usage:",
29336         "content": "curl https://{domain}/api/users/{id}/mail_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29337         "type": "json"
29338       }
29339     ],
29340     "name": "RemoveMailAccounts",
29341     "group": "Users",
29342     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29343     "version": "0.0.0",
29344     "filename": "server/api/user/index.js",
29345     "groupTitle": "Users"
29346   },
29347   {
29348     "type": "delete",
29349     "url": "/api/users/{id}/mail_interactions",
29350     "title": "Removes interactions from an agent",
29351     "examples": [
29352       {
29353         "title": "Example usage:",
29354         "content": "curl https://{domain}/api/users/{id}/mail_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29355         "type": "json"
29356       }
29357     ],
29358     "name": "RemoveMailInteractions",
29359     "group": "Users",
29360     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29361     "version": "0.0.0",
29362     "filename": "server/api/user/index.js",
29363     "groupTitle": "Users"
29364   },
29365   {
29366     "type": "delete",
29367     "url": "/api/users/{id}/openchannel_accounts",
29368     "title": "Removes a Open Channel Account from a user",
29369     "examples": [
29370       {
29371         "title": "Example usage:",
29372         "content": "curl https://{domain}/api/users/{id}/openchannel_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29373         "type": "json"
29374       }
29375     ],
29376     "name": "RemoveOpenchannelAccounts",
29377     "group": "Users",
29378     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29379     "version": "0.0.0",
29380     "filename": "server/api/user/index.js",
29381     "groupTitle": "Users"
29382   },
29383   {
29384     "type": "delete",
29385     "url": "/api/users/{id}/openchannel_interactions",
29386     "title": "Removes openchannel interactions from an agent",
29387     "examples": [
29388       {
29389         "title": "Example usage:",
29390         "content": "curl https://{domain}/api/users/{id}/openchannel_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29391         "type": "json"
29392       }
29393     ],
29394     "name": "RemoveOpenchannelInteractions",
29395     "group": "Users",
29396     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29397     "version": "0.0.0",
29398     "filename": "server/api/user/index.js",
29399     "groupTitle": "Users"
29400   },
29401   {
29402     "type": "delete",
29403     "url": "/api/users/{id}/queues",
29404     "title": "Remove queues to an agent",
29405     "examples": [
29406       {
29407         "title": "Example usage:",
29408         "content": "curl https://{domain}/api/users/{id}/queues?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29409         "type": "json"
29410       }
29411     ],
29412     "name": "RemoveQueues",
29413     "group": "Users",
29414     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29415     "version": "0.0.0",
29416     "filename": "server/api/user/index.js",
29417     "groupTitle": "Users"
29418   },
29419   {
29420     "type": "delete",
29421     "url": "/api/users/{id}/sms_accounts",
29422     "title": "Removes a Sms Account from a user",
29423     "examples": [
29424       {
29425         "title": "Example usage:",
29426         "content": "curl https://{domain}/api/users/{id}/sms_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29427         "type": "json"
29428       }
29429     ],
29430     "name": "RemoveSmsAccounts",
29431     "group": "Users",
29432     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29433     "version": "0.0.0",
29434     "filename": "server/api/user/index.js",
29435     "groupTitle": "Users"
29436   },
29437   {
29438     "type": "delete",
29439     "url": "/api/users/{id}/sms_interactions",
29440     "title": "Removes interactions from an agent",
29441     "examples": [
29442       {
29443         "title": "Example usage:",
29444         "content": "curl https://{domain}/api/users/{id}/sms_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29445         "type": "json"
29446       }
29447     ],
29448     "name": "RemoveSmsInteractions",
29449     "group": "Users",
29450     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29451     "version": "0.0.0",
29452     "filename": "server/api/user/index.js",
29453     "groupTitle": "Users"
29454   },
29455   {
29456     "type": "delete",
29457     "url": "/api/users/{id}/square_projects",
29458     "title": "Removes a Square Project from a user",
29459     "examples": [
29460       {
29461         "title": "Example usage:",
29462         "content": "curl https://{domain}/api/users/{id}/square_projects?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29463         "type": "json"
29464       }
29465     ],
29466     "name": "RemoveSquareProjects",
29467     "group": "Users",
29468     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29469     "version": "0.0.0",
29470     "filename": "server/api/user/index.js",
29471     "groupTitle": "Users"
29472   },
29473   {
29474     "type": "delete",
29475     "url": "/api/users/{id}/teams",
29476     "title": "Removes teams from an agent",
29477     "examples": [
29478       {
29479         "title": "Example usage:",
29480         "content": "curl https://{domain}/api/users/{id}/teams?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29481         "type": "json"
29482       }
29483     ],
29484     "name": "RemoveTeams",
29485     "group": "Users",
29486     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29487     "version": "0.0.0",
29488     "filename": "server/api/user/index.js",
29489     "groupTitle": "Users"
29490   },
29491   {
29492     "type": "delete",
29493     "url": "/api/users/{id}/whatsapp_accounts",
29494     "title": "Removes a Whatsapp Account from a user",
29495     "examples": [
29496       {
29497         "title": "Example usage:",
29498         "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29499         "type": "json"
29500       }
29501     ],
29502     "name": "RemoveWhatsappAccounts",
29503     "group": "Users",
29504     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29505     "version": "0.0.0",
29506     "filename": "server/api/user/index.js",
29507     "groupTitle": "Users"
29508   },
29509   {
29510     "type": "delete",
29511     "url": "/api/users/{id}/whatsapp_interactions",
29512     "title": "Removes Whatsapp interactions from an agent",
29513     "examples": [
29514       {
29515         "title": "Example usage:",
29516         "content": "curl https://{domain}/api/users/{id}/whatsapp_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29517         "type": "json"
29518       }
29519     ],
29520     "name": "RemoveWhatsappInteractions",
29521     "group": "Users",
29522     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29523     "version": "0.0.0",
29524     "filename": "server/api/user/index.js",
29525     "groupTitle": "Users"
29526   },
29527   {
29528     "type": "get",
29529     "url": "/api/users/{id}",
29530     "title": "Gets a single User",
29531     "examples": [
29532       {
29533         "title": "Example usage:",
29534         "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password}",
29535         "type": "json"
29536       }
29537     ],
29538     "name": "ShowUsers",
29539     "group": "Users",
29540     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29541     "version": "0.0.0",
29542     "filename": "server/api/user/index.js",
29543     "groupTitle": "Users"
29544   },
29545   {
29546     "type": "post",
29547     "url": "/api/users/{id}/unpause",
29548     "title": "Unpause",
29549     "examples": [
29550       {
29551         "title": "Example usage:",
29552         "content": "curl https://{domain}/api/users/{id}/unpause -v -u {name}:{password} -X POST",
29553         "type": "json"
29554       }
29555     ],
29556     "name": "Unpause",
29557     "group": "Users",
29558     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29559     "version": "0.0.0",
29560     "filename": "server/api/user/index.js",
29561     "groupTitle": "Users"
29562   },
29563   {
29564     "type": "get",
29565     "url": "/api/users/whoami",
29566     "title": "WhoAmI",
29567     "examples": [
29568       {
29569         "title": "Example usage:",
29570         "content": "curl https://{domain}/api/users/whoami -v -u {name}:{password} -X GET",
29571         "type": "json"
29572       }
29573     ],
29574     "name": "WhoAmI",
29575     "group": "Users",
29576     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29577     "version": "0.0.0",
29578     "filename": "server/api/user/index.js",
29579     "groupTitle": "Users"
29580   },
29581   {
29582     "type": "post",
29583     "url": "/api/users/{id}/avatar",
29584     "title": "Add avatar",
29585     "examples": [
29586       {
29587         "title": "Example usage:",
29588         "content": "curl https://{domain}/api/users/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
29589         "type": "json"
29590       }
29591     ],
29592     "name": "addAvatar",
29593     "group": "Users",
29594     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29595     "version": "0.0.0",
29596     "filename": "server/api/user/index.js",
29597     "groupTitle": "Users"
29598   },
29599   {
29600     "type": "post",
29601     "url": "/api/users/create_many",
29602     "title": "Create Users",
29603     "examples": [
29604       {
29605         "title": "Example usage:",
29606         "content": "curl https://{domain}/api/users/create_many -d '[{\"name\": \"john.doe\", \"role\": \"user\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",
29607         "type": "json"
29608       }
29609     ],
29610     "name": "bulkCreate",
29611     "group": "Users",
29612     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29613     "version": "0.0.0",
29614     "filename": "server/api/user/index.js",
29615     "groupTitle": "Users"
29616   },
29617   {
29618     "type": "get",
29619     "url": "/api/users/{id}/avatar",
29620     "title": "Get avatar",
29621     "examples": [
29622       {
29623         "title": "Example usage:",
29624         "content": "curl https://{domain}/api/users/{id}/avatar -v -u {name}:{password} -X GET",
29625         "type": "json"
29626       }
29627     ],
29628     "name": "getAvatar",
29629     "group": "Users",
29630     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29631     "version": "0.0.0",
29632     "filename": "server/api/user/index.js",
29633     "groupTitle": "Users"
29634   },
29635   {
29636     "type": "put",
29637     "url": "/api/users/{id}",
29638     "title": "Update an existing User",
29639     "examples": [
29640       {
29641         "title": "Example usage:",
29642         "content": "curl https://{domain}/api/users/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
29643         "type": "json"
29644       }
29645     ],
29646     "name": "updateUsers",
29647     "group": "Users",
29648     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29649     "version": "0.0.0",
29650     "filename": "server/api/user/index.js",
29651     "groupTitle": "Users"
29652   },
29653   {
29654     "type": "post",
29655     "url": "/api/variables",
29656     "title": "Creates a new Variable",
29657     "examples": [
29658       {
29659         "title": "Example usage:",
29660         "content": "curl https://{domain}/api/variables -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
29661         "type": "json"
29662       }
29663     ],
29664     "name": "CreateVariables",
29665     "group": "Variables",
29666     "parameter": {
29667       "fields": {
29668         "Body": [
29669           {
29670             "group": "Body",
29671             "type": "String",
29672             "optional": false,
29673             "field": "name",
29674             "description": ""
29675           },
29676           {
29677             "group": "Body",
29678             "type": "String",
29679             "optional": true,
29680             "field": "description",
29681             "description": ""
29682           }
29683         ]
29684       }
29685     },
29686     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29687     "version": "0.0.0",
29688     "filename": "server/api/variable/index.js",
29689     "groupTitle": "Variables"
29690   },
29691   {
29692     "type": "delete",
29693     "url": "/api/variables/{id}",
29694     "title": "Deletes a Variable",
29695     "examples": [
29696       {
29697         "title": "Example usage:",
29698         "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password} -X DELETE",
29699         "type": "json"
29700       }
29701     ],
29702     "name": "DeleteVariables",
29703     "group": "Variables",
29704     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29705     "version": "0.0.0",
29706     "filename": "server/api/variable/index.js",
29707     "groupTitle": "Variables"
29708   },
29709   {
29710     "type": "get",
29711     "url": "/api/variables",
29712     "title": "Gets a list of Variables",
29713     "examples": [
29714       {
29715         "title": "Example usage:",
29716         "content": "curl https://{domain}/api/variables -v -u {name}:{password}",
29717         "type": "json"
29718       }
29719     ],
29720     "name": "GetVariables",
29721     "group": "Variables",
29722     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
29723     "version": "0.0.0",
29724     "filename": "server/api/variable/index.js",
29725     "groupTitle": "Variables"
29726   },
29727   {
29728     "type": "get",
29729     "url": "/api/variables/{id}",
29730     "title": "Gets a single Variable",
29731     "examples": [
29732       {
29733         "title": "Example usage:",
29734         "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password}",
29735         "type": "json"
29736       }
29737     ],
29738     "name": "ShowVariables",
29739     "group": "Variables",
29740     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29741     "version": "0.0.0",
29742     "filename": "server/api/variable/index.js",
29743     "groupTitle": "Variables"
29744   },
29745   {
29746     "type": "put",
29747     "url": "/api/variables/{id}",
29748     "title": "Update an existing Variable",
29749     "examples": [
29750       {
29751         "title": "Example usage:",
29752         "content": "curl https://{domain}/api/variables/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
29753         "type": "json"
29754       }
29755     ],
29756     "name": "updateVariables",
29757     "group": "Variables",
29758     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29759     "version": "0.0.0",
29760     "filename": "server/api/variable/index.js",
29761     "groupTitle": "Variables"
29762   },
29763   {
29764     "type": "get",
29765     "url": "/api/version/fetch",
29766     "title": "Fetch git version",
29767     "examples": [
29768       {
29769         "title": "Example usage:",
29770         "content": "curl https://{domain}/api/version/fetch -v -u {name}:{password}",
29771         "type": "json"
29772       }
29773     ],
29774     "name": "FetchVersion",
29775     "group": "Version",
29776     "description": "<p>Motion run the following command: git fetch origin master</p>",
29777     "version": "0.0.0",
29778     "filename": "server/api/version/index.js",
29779     "groupTitle": "Version"
29780   },
29781   {
29782     "type": "get",
29783     "url": "/api/version",
29784     "title": "Gets version",
29785     "examples": [
29786       {
29787         "title": "Example usage:",
29788         "content": "curl https://{domain}/api/version -v -u {name}:{password}",
29789         "type": "json"
29790       }
29791     ],
29792     "name": "GetVersion",
29793     "group": "Version",
29794     "description": "<p>Motion returns the current and latest motion version.</p>",
29795     "version": "0.0.0",
29796     "filename": "server/api/version/index.js",
29797     "groupTitle": "Version"
29798   },
29799   {
29800     "type": "get",
29801     "url": "/api/version/migrations",
29802     "title": "Launch database migrations",
29803     "examples": [
29804       {
29805         "title": "Example usage:",
29806         "content": "curl https://{domain}/api/version/migrations -v -u {name}:{password}",
29807         "type": "json"
29808       }
29809     ],
29810     "name": "MigrateVersion",
29811     "group": "Version",
29812     "description": "<p>Motion launch the database migrations, according to the application version</p>",
29813     "version": "0.0.0",
29814     "filename": "server/api/version/index.js",
29815     "groupTitle": "Version"
29816   },
29817   {
29818     "type": "get",
29819     "url": "/api/version/pull",
29820     "title": "Pull git version",
29821     "examples": [
29822       {
29823         "title": "Example usage:",
29824         "content": "curl https://{domain}/api/version/pull -v -u {name}:{password}",
29825         "type": "json"
29826       }
29827     ],
29828     "name": "PullVersion",
29829     "group": "Version",
29830     "description": "<p>Motion run the following command: git pull</p>",
29831     "version": "0.0.0",
29832     "filename": "server/api/version/index.js",
29833     "groupTitle": "Version"
29834   },
29835   {
29836     "type": "get",
29837     "url": "/api/version/reset",
29838     "title": "Reset git version",
29839     "examples": [
29840       {
29841         "title": "Example usage:",
29842         "content": "curl https://{domain}/api/version/reset -v -u {name}:{password}",
29843         "type": "json"
29844       }
29845     ],
29846     "name": "ResetVersion",
29847     "group": "Version",
29848     "description": "<p>Motion run the following command: git reset --hard FETCH_HEAD</p>",
29849     "version": "0.0.0",
29850     "filename": "server/api/version/index.js",
29851     "groupTitle": "Version"
29852   },
29853   {
29854     "type": "get",
29855     "url": "/api/version/restart",
29856     "title": "Restart motion2 after update",
29857     "examples": [
29858       {
29859         "title": "Example usage:",
29860         "content": "curl https://{domain}/api/version/restart -v -u {name}:{password}",
29861         "type": "json"
29862       }
29863     ],
29864     "name": "RestartVersion",
29865     "group": "Version",
29866     "description": "<p>Motion run the following command: pm2 restart motion</p>",
29867     "version": "0.0.0",
29868     "filename": "server/api/version/index.js",
29869     "groupTitle": "Version"
29870   },
29871   {
29872     "type": "get",
29873     "url": "/api/voice/agents/reports/describe",
29874     "title": "Gets table info about Agent Reports",
29875     "examples": [
29876       {
29877         "title": "Example usage:",
29878         "content": "curl https://{domain}/api/voice/agents/reports/describe -v -u {name}:{password}",
29879         "type": "json"
29880       }
29881     ],
29882     "name": "DescribeAgent_Reports",
29883     "group": "Voice_Agent_Reports",
29884     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29885     "version": "0.0.0",
29886     "filename": "server/api/voiceAgentReport/index.js",
29887     "groupTitle": "Voice_Agent_Reports"
29888   },
29889   {
29890     "type": "get",
29891     "url": "/api/voice/agents/reports",
29892     "title": "Gets a list of Agent Reports",
29893     "examples": [
29894       {
29895         "title": "Example usage:",
29896         "content": "curl https://{domain}/api/voice/agents/reports -v -u {name}:{password}",
29897         "type": "json"
29898       }
29899     ],
29900     "name": "GetAgent_Reports",
29901     "group": "Voice_Agent_Reports",
29902     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
29903     "version": "0.0.0",
29904     "filename": "server/api/voiceAgentReport/index.js",
29905     "groupTitle": "Voice_Agent_Reports"
29906   },
29907   {
29908     "type": "get",
29909     "url": "/api/voice/agents/reports/{id}",
29910     "title": "Gets a single Agent Report",
29911     "examples": [
29912       {
29913         "title": "Example usage:",
29914         "content": "curl https://{domain}/api/voice/agents/reports/{id} -v -u {name}:{password}",
29915         "type": "json"
29916       }
29917     ],
29918     "name": "ShowAgent_Reports",
29919     "group": "Voice_Agent_Reports",
29920     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29921     "version": "0.0.0",
29922     "filename": "server/api/voiceAgentReport/index.js",
29923     "groupTitle": "Voice_Agent_Reports"
29924   },
29925   {
29926     "type": "get",
29927     "url": "/api/voice/calls/reports/describe",
29928     "title": "Gets table info about Call Reports",
29929     "examples": [
29930       {
29931         "title": "Example usage:",
29932         "content": "curl https://{domain}/api/voice/calls/reports/describe -v -u {name}:{password}",
29933         "type": "json"
29934       }
29935     ],
29936     "name": "DescribeCall_Reports",
29937     "group": "Voice_Call_Reports",
29938     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29939     "version": "0.0.0",
29940     "filename": "server/api/voiceCallReport/index.js",
29941     "groupTitle": "Voice_Call_Reports"
29942   },
29943   {
29944     "type": "get",
29945     "url": "/api/voice/calls/reports",
29946     "title": "Gets a list of Call Reports",
29947     "examples": [
29948       {
29949         "title": "Example usage:",
29950         "content": "curl https://{domain}/api/voice/calls/reports -v -u {name}:{password}",
29951         "type": "json"
29952       }
29953     ],
29954     "name": "GetCall_Reports",
29955     "group": "Voice_Call_Reports",
29956     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
29957     "version": "0.0.0",
29958     "filename": "server/api/voiceCallReport/index.js",
29959     "groupTitle": "Voice_Call_Reports"
29960   },
29961   {
29962     "type": "get",
29963     "url": "/api/voice/calls/reports/{id}",
29964     "title": "Gets a single Call Report",
29965     "examples": [
29966       {
29967         "title": "Example usage:",
29968         "content": "curl https://{domain}/api/voice/calls/reports/{id} -v -u {name}:{password}",
29969         "type": "json"
29970       }
29971     ],
29972     "name": "ShowCall_Reports",
29973     "group": "Voice_Call_Reports",
29974     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29975     "version": "0.0.0",
29976     "filename": "server/api/voiceCallReport/index.js",
29977     "groupTitle": "Voice_Call_Reports"
29978   },
29979   {
29980     "type": "put",
29981     "url": "/api/voice/calls/reports/{id}",
29982     "title": "Update a single cdr",
29983     "examples": [
29984       {
29985         "title": "Example usage:",
29986         "content": "curl https://{domain}/api/voice/calls/reports/{id} -d '{\"userDispositio\": \"OK\"}' -v -u {name}:{password} -X PUT",
29987         "type": "json"
29988       }
29989     ],
29990     "name": "update",
29991     "group": "Voice_Call_Reports",
29992     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29993     "version": "0.0.0",
29994     "filename": "server/api/voiceCallReport/index.js",
29995     "groupTitle": "Voice_Call_Reports"
29996   },
29997   {
29998     "type": "post",
29999     "url": "/api/voice/chanspy",
30000     "title": "Creates a new ChanSpy",
30001     "examples": [
30002       {
30003         "title": "Example usage:",
30004         "content": "curl https://{domain}/api/voice/chanspy -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
30005         "type": "json"
30006       }
30007     ],
30008     "name": "CreateChanSpy",
30009     "group": "Voice_ChanSpy",
30010     "parameter": {
30011       "fields": {
30012         "Body": [
30013           {
30014             "group": "Body",
30015             "type": "String",
30016             "optional": true,
30017             "field": "name",
30018             "description": ""
30019           },
30020           {
30021             "group": "Body",
30022             "type": "String",
30023             "optional": false,
30024             "field": "prefix",
30025             "description": ""
30026           },
30027           {
30028             "group": "Body",
30029             "type": "String",
30030             "optional": true,
30031             "field": "options",
30032             "description": ""
30033           },
30034           {
30035             "group": "Body",
30036             "type": "Boolean",
30037             "optional": true,
30038             "field": "auth",
30039             "description": ""
30040           },
30041           {
30042             "group": "Body",
30043             "type": "String",
30044             "optional": true,
30045             "field": "password",
30046             "description": ""
30047           },
30048           {
30049             "group": "Body",
30050             "type": "Boolean",
30051             "optional": true,
30052             "field": "record",
30053             "description": ""
30054           },
30055           {
30056             "group": "Body",
30057             "type": "String",
30058             "optional": true,
30059             "field": "recordingFormat",
30060             "description": ""
30061           },
30062           {
30063             "group": "Body",
30064             "type": "String",
30065             "optional": true,
30066             "field": "description",
30067             "description": ""
30068           }
30069         ]
30070       }
30071     },
30072     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30073     "version": "0.0.0",
30074     "filename": "server/api/voiceChanSpy/index.js",
30075     "groupTitle": "Voice_ChanSpy"
30076   },
30077   {
30078     "type": "delete",
30079     "url": "/api/voice/chanspy/{id}",
30080     "title": "Deletes a ChanSpy",
30081     "examples": [
30082       {
30083         "title": "Example usage:",
30084         "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password} -X DELETE",
30085         "type": "json"
30086       }
30087     ],
30088     "name": "DeleteChanSpy",
30089     "group": "Voice_ChanSpy",
30090     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/voiceChanSpy/index.js",
30093     "groupTitle": "Voice_ChanSpy"
30094   },
30095   {
30096     "type": "get",
30097     "url": "/api/voice/chanspy",
30098     "title": "Gets a list of ChanSpy",
30099     "examples": [
30100       {
30101         "title": "Example usage:",
30102         "content": "curl https://{domain}/api/voice/chanspy -v -u {name}:{password}",
30103         "type": "json"
30104       }
30105     ],
30106     "name": "GetChanSpy",
30107     "group": "Voice_ChanSpy",
30108     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30109     "version": "0.0.0",
30110     "filename": "server/api/voiceChanSpy/index.js",
30111     "groupTitle": "Voice_ChanSpy"
30112   },
30113   {
30114     "type": "get",
30115     "url": "/api/voice/chanspy/{id}",
30116     "title": "Gets a single ChanSpy",
30117     "examples": [
30118       {
30119         "title": "Example usage:",
30120         "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password}",
30121         "type": "json"
30122       }
30123     ],
30124     "name": "ShowChanSpy",
30125     "group": "Voice_ChanSpy",
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/voiceChanSpy/index.js",
30129     "groupTitle": "Voice_ChanSpy"
30130   },
30131   {
30132     "type": "put",
30133     "url": "/api/voice/chanspy/{id}",
30134     "title": "Update an existing ChanSpy",
30135     "examples": [
30136       {
30137         "title": "Example usage:",
30138         "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",
30139         "type": "json"
30140       }
30141     ],
30142     "name": "updateChanSpy",
30143     "group": "Voice_ChanSpy",
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/voiceChanSpy/index.js",
30147     "groupTitle": "Voice_ChanSpy"
30148   },
30149   {
30150     "type": "post",
30151     "url": "/api/voice/contexts",
30152     "title": "Create a new context",
30153     "examples": [
30154       {
30155         "title": "Example usage:",
30156         "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password} -X POST",
30157         "type": "json"
30158       }
30159     ],
30160     "name": "Create",
30161     "group": "Voice_Contexts",
30162     "parameter": {
30163       "fields": {
30164         "Body": [
30165           {
30166             "group": "Body",
30167             "type": "String",
30168             "optional": true,
30169             "field": "name",
30170             "description": ""
30171           },
30172           {
30173             "group": "Body",
30174             "type": "String",
30175             "optional": true,
30176             "field": "description",
30177             "description": ""
30178           },
30179           {
30180             "group": "Body",
30181             "type": "Boolean",
30182             "optional": true,
30183             "field": "defaultEntry",
30184             "description": ""
30185           }
30186         ]
30187       }
30188     },
30189     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30190     "version": "0.0.0",
30191     "filename": "server/api/voiceContext/index.js",
30192     "groupTitle": "Voice_Contexts"
30193   },
30194   {
30195     "type": "delete",
30196     "url": "/api/voice/contexts/{id}",
30197     "title": "Deletes a context",
30198     "examples": [
30199       {
30200         "title": "Example usage:",
30201         "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X DELETE",
30202         "type": "json"
30203       }
30204     ],
30205     "name": "Delete",
30206     "group": "Voice_Contexts",
30207     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30208     "version": "0.0.0",
30209     "filename": "server/api/voiceContext/index.js",
30210     "groupTitle": "Voice_Contexts"
30211   },
30212   {
30213     "type": "get",
30214     "url": "/api/voice/contexts",
30215     "title": "Gets a list of Contexts",
30216     "examples": [
30217       {
30218         "title": "Example usage:",
30219         "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password}",
30220         "type": "json"
30221       }
30222     ],
30223     "name": "GetContexts",
30224     "group": "Voice_Contexts",
30225     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30226     "version": "0.0.0",
30227     "filename": "server/api/voiceContext/index.js",
30228     "groupTitle": "Voice_Contexts"
30229   },
30230   {
30231     "type": "get",
30232     "url": "/api/voice/contexts/{id}",
30233     "title": "Gets a single Context",
30234     "examples": [
30235       {
30236         "title": "Example usage:",
30237         "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password}",
30238         "type": "json"
30239       }
30240     ],
30241     "name": "ShowContexts",
30242     "group": "Voice_Contexts",
30243     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30244     "version": "0.0.0",
30245     "filename": "server/api/voiceContext/index.js",
30246     "groupTitle": "Voice_Contexts"
30247   },
30248   {
30249     "type": "put",
30250     "url": "/api/voice/contexts/{id}",
30251     "title": "Update an existing context",
30252     "examples": [
30253       {
30254         "title": "Example usage:",
30255         "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X PUT",
30256         "type": "json"
30257       }
30258     ],
30259     "name": "Update",
30260     "group": "Voice_Contexts",
30261     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30262     "version": "0.0.0",
30263     "filename": "server/api/voiceContext/index.js",
30264     "groupTitle": "Voice_Contexts"
30265   },
30266   {
30267     "type": "get",
30268     "url": "/api/voice/dials/reports/describe",
30269     "title": "Gets table info about Dial Reports",
30270     "examples": [
30271       {
30272         "title": "Example usage:",
30273         "content": "curl https://{domain}/api/voice/dials/reports/describe -v -u {name}:{password}",
30274         "type": "json"
30275       }
30276     ],
30277     "name": "DescribeDial_Reports",
30278     "group": "Voice_Dial_Reports",
30279     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30280     "version": "0.0.0",
30281     "filename": "server/api/voiceDialReport/index.js",
30282     "groupTitle": "Voice_Dial_Reports"
30283   },
30284   {
30285     "type": "get",
30286     "url": "/api/voice/dials/reports",
30287     "title": "Gets a list of Dial Reports",
30288     "examples": [
30289       {
30290         "title": "Example usage:",
30291         "content": "curl https://{domain}/api/voice/dials/reports -v -u {name}:{password}",
30292         "type": "json"
30293       }
30294     ],
30295     "name": "GetDial_Reports",
30296     "group": "Voice_Dial_Reports",
30297     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30298     "version": "0.0.0",
30299     "filename": "server/api/voiceDialReport/index.js",
30300     "groupTitle": "Voice_Dial_Reports"
30301   },
30302   {
30303     "type": "get",
30304     "url": "/api/voice/dials/reports/{id}",
30305     "title": "Gets a single Dial Report",
30306     "examples": [
30307       {
30308         "title": "Example usage:",
30309         "content": "curl https://{domain}/api/voice/dials/reports/{id} -v -u {name}:{password}",
30310         "type": "json"
30311       }
30312     ],
30313     "name": "ShowDial_Reports",
30314     "group": "Voice_Dial_Reports",
30315     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30316     "version": "0.0.0",
30317     "filename": "server/api/voiceDialReport/index.js",
30318     "groupTitle": "Voice_Dial_Reports"
30319   },
30320   {
30321     "type": "delete",
30322     "url": "/api/voice/extensions/{id}",
30323     "title": "Deletes a Extension",
30324     "examples": [
30325       {
30326         "title": "Example usage:",
30327         "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password} -X DELETE",
30328         "type": "json"
30329       }
30330     ],
30331     "name": "DeleteExtensions",
30332     "group": "Voice_Extensions",
30333     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30334     "version": "0.0.0",
30335     "filename": "server/api/voiceExtension/index.js",
30336     "groupTitle": "Voice_Extensions"
30337   },
30338   {
30339     "type": "get",
30340     "url": "/api/voice/extensions",
30341     "title": "Gets a list of Extensions",
30342     "examples": [
30343       {
30344         "title": "Example usage:",
30345         "content": "curl https://{domain}/api/voice/extensions -v -u {name}:{password}",
30346         "type": "json"
30347       }
30348     ],
30349     "name": "GetExtensions",
30350     "group": "Voice_Extensions",
30351     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30352     "version": "0.0.0",
30353     "filename": "server/api/voiceExtension/index.js",
30354     "groupTitle": "Voice_Extensions"
30355   },
30356   {
30357     "type": "get",
30358     "url": "/api/voice/extensions/{id}",
30359     "title": "Gets a single Extension",
30360     "examples": [
30361       {
30362         "title": "Example usage:",
30363         "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password}",
30364         "type": "json"
30365       }
30366     ],
30367     "name": "ShowExtensions",
30368     "group": "Voice_Extensions",
30369     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30370     "version": "0.0.0",
30371     "filename": "server/api/voiceExtension/index.js",
30372     "groupTitle": "Voice_Extensions"
30373   },
30374   {
30375     "type": "post",
30376     "url": "/api/voice/extensions",
30377     "title": "Create new applications",
30378     "examples": [
30379       {
30380         "title": "Example usage:",
30381         "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",
30382         "type": "json"
30383       }
30384     ],
30385     "name": "addApplications",
30386     "group": "Voice_Extensions",
30387     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30388     "version": "0.0.0",
30389     "filename": "server/api/voiceExtension/index.js",
30390     "groupTitle": "Voice_Extensions"
30391   },
30392   {
30393     "type": "post",
30394     "url": "/api/voice/extensions",
30395     "title": "Create an extension",
30396     "examples": [
30397       {
30398         "title": "Example usage:",
30399         "content": "curl https://{domain}/api/voice/extensions -d '{\"exten\": \"12345\", \"context\": \"from-custom\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30400         "type": "json"
30401       }
30402     ],
30403     "name": "create",
30404     "group": "Voice_Extensions",
30405     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30406     "version": "0.0.0",
30407     "filename": "server/api/voiceExtension/index.js",
30408     "groupTitle": "Voice_Extensions"
30409   },
30410   {
30411     "type": "put",
30412     "url": "/api/voice/extensions/{id}",
30413     "title": "Update an extension",
30414     "examples": [
30415       {
30416         "title": "Example usage:",
30417         "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",
30418         "type": "json"
30419       }
30420     ],
30421     "name": "update",
30422     "group": "Voice_Extensions",
30423     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30424     "version": "0.0.0",
30425     "filename": "server/api/voiceExtension/index.js",
30426     "groupTitle": "Voice_Extensions"
30427   },
30428   {
30429     "type": "post",
30430     "url": "/api/voice/mohs",
30431     "title": "Create a new a new MOH",
30432     "examples": [
30433       {
30434         "title": "Example usage:",
30435         "content": "curl https://{domain}/api/voice/mohs -d '{\"name\": \"xmas_musics\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30436         "type": "json"
30437       }
30438     ],
30439     "name": "AddMoh",
30440     "group": "Voice_MOHs",
30441     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30442     "version": "0.0.0",
30443     "filename": "server/api/voiceMusicOnHold/index.js",
30444     "groupTitle": "Voice_MOHs"
30445   },
30446   {
30447     "type": "post",
30448     "url": "/api/voice/mohs/{id}/sounds",
30449     "title": "Add sound to MOH",
30450     "examples": [
30451       {
30452         "title": "Example usage:",
30453         "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -d '{\"id\": 1}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30454         "type": "json"
30455       }
30456     ],
30457     "name": "AddSound",
30458     "group": "Voice_MOHs",
30459     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30460     "version": "0.0.0",
30461     "filename": "server/api/voiceMusicOnHold/index.js",
30462     "groupTitle": "Voice_MOHs"
30463   },
30464   {
30465     "type": "delete",
30466     "url": "/api/voice/mohs/{id}",
30467     "title": "Deletes an MOH",
30468     "examples": [
30469       {
30470         "title": "Example usage:",
30471         "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password} -X DELETE",
30472         "type": "json"
30473       }
30474     ],
30475     "name": "DestroyMoh",
30476     "group": "Voice_MOHs",
30477     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30478     "version": "0.0.0",
30479     "filename": "server/api/voiceMusicOnHold/index.js",
30480     "groupTitle": "Voice_MOHs"
30481   },
30482   {
30483     "type": "get",
30484     "url": "/api/voice/mohs",
30485     "title": "Gets a list of Music On Holds",
30486     "examples": [
30487       {
30488         "title": "Example usage:",
30489         "content": "curl https://{domain}/api/voice/mohs -v -u {name}:{password}",
30490         "type": "json"
30491       }
30492     ],
30493     "name": "GetMusic_On_Holds",
30494     "group": "Voice_MOHs",
30495     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30496     "version": "0.0.0",
30497     "filename": "server/api/voiceMusicOnHold/index.js",
30498     "groupTitle": "Voice_MOHs"
30499   },
30500   {
30501     "type": "get",
30502     "url": "/api/voice/mohs/{id}/sounds",
30503     "title": "Gets sounds from MOH",
30504     "examples": [
30505       {
30506         "title": "Example usage:",
30507         "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -v -u {name}:{password} -X DELETE",
30508         "type": "json"
30509       }
30510     ],
30511     "name": "GetSounds",
30512     "group": "Voice_MOHs",
30513     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30514     "version": "0.0.0",
30515     "filename": "server/api/voiceMusicOnHold/index.js",
30516     "groupTitle": "Voice_MOHs"
30517   },
30518   {
30519     "type": "delete",
30520     "url": "/api/voice/mohs/{id}/sounds/{id2}",
30521     "title": "Remove sound from MOH",
30522     "examples": [
30523       {
30524         "title": "Example usage:",
30525         "content": "curl https://{domain}/api/voice/mohs/{id}/sounds/{id2} -v -u {name}:{password} -X DELETE",
30526         "type": "json"
30527       }
30528     ],
30529     "name": "RemoveSound",
30530     "group": "Voice_MOHs",
30531     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30532     "version": "0.0.0",
30533     "filename": "server/api/voiceMusicOnHold/index.js",
30534     "groupTitle": "Voice_MOHs"
30535   },
30536   {
30537     "type": "get",
30538     "url": "/api/voice/mohs/{id}",
30539     "title": "Gets a single Music On Hold",
30540     "examples": [
30541       {
30542         "title": "Example usage:",
30543         "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password}",
30544         "type": "json"
30545       }
30546     ],
30547     "name": "ShowMusic_On_Holds",
30548     "group": "Voice_MOHs",
30549     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30550     "version": "0.0.0",
30551     "filename": "server/api/voiceMusicOnHold/index.js",
30552     "groupTitle": "Voice_MOHs"
30553   },
30554   {
30555     "type": "put",
30556     "url": "/api/voice/mohs/{id}",
30557     "title": "Update an existing Music On Hold",
30558     "examples": [
30559       {
30560         "title": "Example usage:",
30561         "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",
30562         "type": "json"
30563       }
30564     ],
30565     "name": "updateMusic_On_Holds",
30566     "group": "Voice_MOHs",
30567     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30568     "version": "0.0.0",
30569     "filename": "server/api/voiceMusicOnHold/index.js",
30570     "groupTitle": "Voice_MOHs"
30571   },
30572   {
30573     "type": "post",
30574     "url": "/api/voice/mails",
30575     "title": "Creates a new Mail",
30576     "examples": [
30577       {
30578         "title": "Example usage:",
30579         "content": "curl https://{domain}/api/voice/mails -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
30580         "type": "json"
30581       }
30582     ],
30583     "name": "CreateMails",
30584     "group": "Voice_Mails",
30585     "parameter": {
30586       "fields": {
30587         "Body": [
30588           {
30589             "group": "Body",
30590             "type": "String",
30591             "optional": true,
30592             "field": "customer_id",
30593             "description": ""
30594           },
30595           {
30596             "group": "Body",
30597             "type": "String",
30598             "optional": true,
30599             "field": "context",
30600             "description": ""
30601           },
30602           {
30603             "group": "Body",
30604             "type": "String",
30605             "optional": false,
30606             "field": "mailbox",
30607             "description": ""
30608           },
30609           {
30610             "group": "Body",
30611             "type": "String",
30612             "optional": true,
30613             "field": "password",
30614             "description": ""
30615           },
30616           {
30617             "group": "Body",
30618             "type": "String",
30619             "optional": true,
30620             "field": "fullname",
30621             "description": ""
30622           },
30623           {
30624             "group": "Body",
30625             "type": "String",
30626             "optional": true,
30627             "field": "email",
30628             "description": ""
30629           },
30630           {
30631             "group": "Body",
30632             "type": "String",
30633             "optional": true,
30634             "field": "pager",
30635             "description": ""
30636           },
30637           {
30638             "group": "Body",
30639             "type": "String",
30640             "optional": true,
30641             "field": "tz",
30642             "description": ""
30643           },
30644           {
30645             "group": "Body",
30646             "type": "String",
30647             "allowedValues": [
30648               "\"yes\"",
30649               "\"no\""
30650             ],
30651             "optional": false,
30652             "field": "attach",
30653             "description": ""
30654           },
30655           {
30656             "group": "Body",
30657             "type": "String",
30658             "allowedValues": [
30659               "\"yes\"",
30660               "\"no\""
30661             ],
30662             "optional": false,
30663             "field": "saycid",
30664             "description": ""
30665           },
30666           {
30667             "group": "Body",
30668             "type": "String",
30669             "optional": true,
30670             "field": "dialout",
30671             "description": ""
30672           },
30673           {
30674             "group": "Body",
30675             "type": "String",
30676             "optional": true,
30677             "field": "callback",
30678             "description": ""
30679           },
30680           {
30681             "group": "Body",
30682             "type": "String",
30683             "allowedValues": [
30684               "\"yes\"",
30685               "\"no\""
30686             ],
30687             "optional": false,
30688             "field": "review",
30689             "description": ""
30690           },
30691           {
30692             "group": "Body",
30693             "type": "String",
30694             "allowedValues": [
30695               "\"yes\"",
30696               "\"no\""
30697             ],
30698             "optional": false,
30699             "field": "operator",
30700             "description": ""
30701           },
30702           {
30703             "group": "Body",
30704             "type": "String",
30705             "allowedValues": [
30706               "\"yes\"",
30707               "\"no\""
30708             ],
30709             "optional": false,
30710             "field": "envelope",
30711             "description": ""
30712           },
30713           {
30714             "group": "Body",
30715             "type": "String",
30716             "allowedValues": [
30717               "\"yes\"",
30718               "\"no\""
30719             ],
30720             "optional": false,
30721             "field": "sayduration",
30722             "description": ""
30723           },
30724           {
30725             "group": "Body",
30726             "type": "String",
30727             "optional": false,
30728             "field": "saydurationm",
30729             "description": ""
30730           },
30731           {
30732             "group": "Body",
30733             "type": "String",
30734             "allowedValues": [
30735               "\"yes\"",
30736               "\"no\""
30737             ],
30738             "optional": false,
30739             "field": "sendvoicemail",
30740             "description": ""
30741           },
30742           {
30743             "group": "Body",
30744             "type": "String",
30745             "allowedValues": [
30746               "\"yes\"",
30747               "\"no\""
30748             ],
30749             "optional": false,
30750             "field": "delete",
30751             "description": ""
30752           },
30753           {
30754             "group": "Body",
30755             "type": "String",
30756             "allowedValues": [
30757               "\"yes\"",
30758               "\"no\""
30759             ],
30760             "optional": false,
30761             "field": "nextaftercmd",
30762             "description": ""
30763           },
30764           {
30765             "group": "Body",
30766             "type": "String",
30767             "allowedValues": [
30768               "\"yes\"",
30769               "\"no\""
30770             ],
30771             "optional": false,
30772             "field": "forcename",
30773             "description": ""
30774           },
30775           {
30776             "group": "Body",
30777             "type": "String",
30778             "allowedValues": [
30779               "\"yes\"",
30780               "\"no\""
30781             ],
30782             "optional": false,
30783             "field": "forcegreetings",
30784             "description": ""
30785           },
30786           {
30787             "group": "Body",
30788             "type": "String",
30789             "allowedValues": [
30790               "\"yes\"",
30791               "\"no\""
30792             ],
30793             "optional": false,
30794             "field": "hidefromdir",
30795             "description": ""
30796           },
30797           {
30798             "group": "Body",
30799             "type": "String",
30800             "optional": true,
30801             "field": "stamp",
30802             "description": ""
30803           },
30804           {
30805             "group": "Body",
30806             "type": "String",
30807             "optional": true,
30808             "field": "emailsubject",
30809             "description": ""
30810           },
30811           {
30812             "group": "Body",
30813             "type": "String",
30814             "optional": true,
30815             "field": "emailbody",
30816             "description": ""
30817           },
30818           {
30819             "group": "Body",
30820             "type": "Integer",
30821             "optional": false,
30822             "field": "maxsecs",
30823             "description": ""
30824           },
30825           {
30826             "group": "Body",
30827             "type": "Integer",
30828             "optional": false,
30829             "field": "maxmsg",
30830             "description": ""
30831           },
30832           {
30833             "group": "Body",
30834             "type": "Virtual",
30835             "optional": true,
30836             "field": "name",
30837             "description": ""
30838           }
30839         ]
30840       }
30841     },
30842     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30843     "version": "0.0.0",
30844     "filename": "server/api/voiceMail/index.js",
30845     "groupTitle": "Voice_Mails"
30846   },
30847   {
30848     "type": "delete",
30849     "url": "/api/voice/mails/{id}",
30850     "title": "Deletes a Mail",
30851     "examples": [
30852       {
30853         "title": "Example usage:",
30854         "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password} -X DELETE",
30855         "type": "json"
30856       }
30857     ],
30858     "name": "DeleteMails",
30859     "group": "Voice_Mails",
30860     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30861     "version": "0.0.0",
30862     "filename": "server/api/voiceMail/index.js",
30863     "groupTitle": "Voice_Mails"
30864   },
30865   {
30866     "type": "get",
30867     "url": "/api/voice/mails",
30868     "title": "Gets a list of Mails",
30869     "examples": [
30870       {
30871         "title": "Example usage:",
30872         "content": "curl https://{domain}/api/voice/mails -v -u {name}:{password}",
30873         "type": "json"
30874       }
30875     ],
30876     "name": "GetMails",
30877     "group": "Voice_Mails",
30878     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/voice/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>",
30879     "version": "0.0.0",
30880     "filename": "server/api/voiceMail/index.js",
30881     "groupTitle": "Voice_Mails"
30882   },
30883   {
30884     "type": "get",
30885     "url": "/api/voice/mails/{id}",
30886     "title": "Gets a single Mail",
30887     "examples": [
30888       {
30889         "title": "Example usage:",
30890         "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password}",
30891         "type": "json"
30892       }
30893     ],
30894     "name": "ShowMails",
30895     "group": "Voice_Mails",
30896     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30897     "version": "0.0.0",
30898     "filename": "server/api/voiceMail/index.js",
30899     "groupTitle": "Voice_Mails"
30900   },
30901   {
30902     "type": "get",
30903     "url": "/api/voice/mails/{id}/messages",
30904     "title": "Gets voice mail messages",
30905     "examples": [
30906       {
30907         "title": "Example usage:",
30908         "content": "curl https://{domain}/api/voice/mails/{id}/messages -v -u {name}:{password} -X GET",
30909         "type": "json"
30910       }
30911     ],
30912     "name": "getMessages",
30913     "group": "Voice_Mails",
30914     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30915     "version": "0.0.0",
30916     "filename": "server/api/voiceMail/index.js",
30917     "groupTitle": "Voice_Mails"
30918   },
30919   {
30920     "type": "put",
30921     "url": "/api/voice/mails/{id}",
30922     "title": "Update an existing Mail",
30923     "examples": [
30924       {
30925         "title": "Example usage:",
30926         "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",
30927         "type": "json"
30928       }
30929     ],
30930     "name": "updateMails",
30931     "group": "Voice_Mails",
30932     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30933     "version": "0.0.0",
30934     "filename": "server/api/voiceMail/index.js",
30935     "groupTitle": "Voice_Mails"
30936   },
30937   {
30938     "type": "post",
30939     "url": "/api/voice/mails/messages",
30940     "title": "Creates a new Message",
30941     "examples": [
30942       {
30943         "title": "Example usage:",
30944         "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",
30945         "type": "json"
30946       }
30947     ],
30948     "name": "CreateMessages",
30949     "group": "Voice_Messages",
30950     "parameter": {
30951       "fields": {
30952         "Body": [
30953           {
30954             "group": "Body",
30955             "type": "Virtual",
30956             "optional": true,
30957             "field": "name",
30958             "description": ""
30959           },
30960           {
30961             "group": "Body",
30962             "type": "Integer",
30963             "optional": false,
30964             "field": "msgnum",
30965             "description": ""
30966           },
30967           {
30968             "group": "Body",
30969             "type": "String",
30970             "optional": true,
30971             "field": "dir",
30972             "description": ""
30973           },
30974           {
30975             "group": "Body",
30976             "type": "String",
30977             "optional": true,
30978             "field": "context",
30979             "description": ""
30980           },
30981           {
30982             "group": "Body",
30983             "type": "String",
30984             "optional": true,
30985             "field": "macrocontext",
30986             "description": ""
30987           },
30988           {
30989             "group": "Body",
30990             "type": "String",
30991             "optional": true,
30992             "field": "callerid",
30993             "description": ""
30994           },
30995           {
30996             "group": "Body",
30997             "type": "String",
30998             "optional": true,
30999             "field": "origtime",
31000             "description": ""
31001           },
31002           {
31003             "group": "Body",
31004             "type": "String",
31005             "optional": true,
31006             "field": "duration",
31007             "description": ""
31008           },
31009           {
31010             "group": "Body",
31011             "type": "String",
31012             "optional": true,
31013             "field": "mailboxuser",
31014             "description": ""
31015           },
31016           {
31017             "group": "Body",
31018             "type": "String",
31019             "optional": true,
31020             "field": "mailboxcontext",
31021             "description": ""
31022           },
31023           {
31024             "group": "Body",
31025             "type": "Blob",
31026             "optional": true,
31027             "field": "recording",
31028             "description": ""
31029           },
31030           {
31031             "group": "Body",
31032             "type": "String",
31033             "optional": true,
31034             "field": "flag",
31035             "description": ""
31036           },
31037           {
31038             "group": "Body",
31039             "type": "String",
31040             "optional": true,
31041             "field": "msg_id",
31042             "description": ""
31043           },
31044           {
31045             "group": "Body",
31046             "type": "String",
31047             "optional": false,
31048             "field": "stamp",
31049             "description": ""
31050           }
31051         ]
31052       }
31053     },
31054     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31055     "version": "0.0.0",
31056     "filename": "server/api/voiceMailMessage/index.js",
31057     "groupTitle": "Voice_Messages"
31058   },
31059   {
31060     "type": "delete",
31061     "url": "/api/voice/mails/messages/{id}",
31062     "title": "Deletes a Message",
31063     "examples": [
31064       {
31065         "title": "Example usage:",
31066         "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password} -X DELETE",
31067         "type": "json"
31068       }
31069     ],
31070     "name": "DeleteMessages",
31071     "group": "Voice_Messages",
31072     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31073     "version": "0.0.0",
31074     "filename": "server/api/voiceMailMessage/index.js",
31075     "groupTitle": "Voice_Messages"
31076   },
31077   {
31078     "type": "get",
31079     "url": "/api/voice/mails/messages",
31080     "title": "Gets a list of Messages",
31081     "examples": [
31082       {
31083         "title": "Example usage:",
31084         "content": "curl https://{domain}/api/voice/mails/messages -v -u {name}:{password}",
31085         "type": "json"
31086       }
31087     ],
31088     "name": "GetMessages",
31089     "group": "Voice_Messages",
31090     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31091     "version": "0.0.0",
31092     "filename": "server/api/voiceMailMessage/index.js",
31093     "groupTitle": "Voice_Messages"
31094   },
31095   {
31096     "type": "get",
31097     "url": "/api/voice/mails/messages/{id}",
31098     "title": "Gets a single Message",
31099     "examples": [
31100       {
31101         "title": "Example usage:",
31102         "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password}",
31103         "type": "json"
31104       }
31105     ],
31106     "name": "ShowMessages",
31107     "group": "Voice_Messages",
31108     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31109     "version": "0.0.0",
31110     "filename": "server/api/voiceMailMessage/index.js",
31111     "groupTitle": "Voice_Messages"
31112   },
31113   {
31114     "type": "get",
31115     "url": "voice/mails/messages/{id}/download",
31116     "title": "Download Voice Message",
31117     "examples": [
31118       {
31119         "title": "Example usage:",
31120         "content": "curl https://{domain}voice/mails/messages/{id}/download -v -u {name}:{password} -X GET",
31121         "type": "json"
31122       }
31123     ],
31124     "name": "download",
31125     "group": "Voice_Messages",
31126     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31127     "version": "0.0.0",
31128     "filename": "server/api/voiceMailMessage/index.js",
31129     "groupTitle": "Voice_Messages"
31130   },
31131   {
31132     "type": "put",
31133     "url": "/api/voice/mails/messages/{id}",
31134     "title": "Update an existing Message",
31135     "examples": [
31136       {
31137         "title": "Example usage:",
31138         "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",
31139         "type": "json"
31140       }
31141     ],
31142     "name": "updateMessages",
31143     "group": "Voice_Messages",
31144     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/voiceMailMessage/index.js",
31147     "groupTitle": "Voice_Messages"
31148   },
31149   {
31150     "type": "post",
31151     "url": "/api/voice/prefixes/{id}/users",
31152     "title": "Add agents to a prefix",
31153     "examples": [
31154       {
31155         "title": "Example usage:",
31156         "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",
31157         "type": "json"
31158       }
31159     ],
31160     "name": "AddAgents",
31161     "group": "Voice_Prefixes",
31162     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31163     "version": "0.0.0",
31164     "filename": "server/api/voicePrefix/index.js",
31165     "groupTitle": "Voice_Prefixes"
31166   },
31167   {
31168     "type": "delete",
31169     "url": "/api/voice/prefixes/{id}",
31170     "title": "Deletes a Prefix",
31171     "examples": [
31172       {
31173         "title": "Example usage:",
31174         "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X DELETE",
31175         "type": "json"
31176       }
31177     ],
31178     "name": "DeletePrefixes",
31179     "group": "Voice_Prefixes",
31180     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/voicePrefix/index.js",
31183     "groupTitle": "Voice_Prefixes"
31184   },
31185   {
31186     "type": "get",
31187     "url": "/api/voice/prefixes/describe",
31188     "title": "Gets table info about Prefixes",
31189     "examples": [
31190       {
31191         "title": "Example usage:",
31192         "content": "curl https://{domain}/api/voice/prefixes/describe -v -u {name}:{password}",
31193         "type": "json"
31194       }
31195     ],
31196     "name": "DescribePrefixes",
31197     "group": "Voice_Prefixes",
31198     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31199     "version": "0.0.0",
31200     "filename": "server/api/voicePrefix/index.js",
31201     "groupTitle": "Voice_Prefixes"
31202   },
31203   {
31204     "type": "get",
31205     "url": "/api/voice/prefixes/{id}/users",
31206     "title": "Gets agents from prefix",
31207     "examples": [
31208       {
31209         "title": "Example usage:",
31210         "content": "curl https://{domain}/api/voice/prefixes/{id}/users -v -u {name}:{password} -X GET",
31211         "type": "json"
31212       }
31213     ],
31214     "name": "GetAgents",
31215     "group": "Voice_Prefixes",
31216     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31217     "version": "0.0.0",
31218     "filename": "server/api/voicePrefix/index.js",
31219     "groupTitle": "Voice_Prefixes"
31220   },
31221   {
31222     "type": "get",
31223     "url": "/api/voice/prefixes",
31224     "title": "Gets a list of Prefixes",
31225     "examples": [
31226       {
31227         "title": "Example usage:",
31228         "content": "curl https://{domain}/api/voice/prefixes -v -u {name}:{password}",
31229         "type": "json"
31230       }
31231     ],
31232     "name": "GetPrefixes",
31233     "group": "Voice_Prefixes",
31234     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31235     "version": "0.0.0",
31236     "filename": "server/api/voicePrefix/index.js",
31237     "groupTitle": "Voice_Prefixes"
31238   },
31239   {
31240     "type": "delete",
31241     "url": "/api/voice/prefixes/{id}/users",
31242     "title": "Removes agents from a prefix",
31243     "examples": [
31244       {
31245         "title": "Example usage:",
31246         "content": "curl https://{domain}/api/voice/prefixes/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
31247         "type": "json"
31248       }
31249     ],
31250     "name": "RemoveAgents",
31251     "group": "Voice_Prefixes",
31252     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31253     "version": "0.0.0",
31254     "filename": "server/api/voicePrefix/index.js",
31255     "groupTitle": "Voice_Prefixes"
31256   },
31257   {
31258     "type": "get",
31259     "url": "/api/voice/prefixes/{id}",
31260     "title": "Gets a single Prefix",
31261     "examples": [
31262       {
31263         "title": "Example usage:",
31264         "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password}",
31265         "type": "json"
31266       }
31267     ],
31268     "name": "ShowPrefixes",
31269     "group": "Voice_Prefixes",
31270     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31271     "version": "0.0.0",
31272     "filename": "server/api/voicePrefix/index.js",
31273     "groupTitle": "Voice_Prefixes"
31274   },
31275   {
31276     "type": "put",
31277     "url": "/api/voice/prefixes/{id}",
31278     "title": "Update an existing prefix",
31279     "examples": [
31280       {
31281         "title": "Example usage:",
31282         "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X PUT",
31283         "type": "json"
31284       }
31285     ],
31286     "name": "Update",
31287     "group": "Voice_Prefixes",
31288     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31289     "version": "0.0.0",
31290     "filename": "server/api/voicePrefix/index.js",
31291     "groupTitle": "Voice_Prefixes"
31292   },
31293   {
31294     "type": "post",
31295     "url": "/api/voice/prefixes",
31296     "title": "Create a prefix",
31297     "examples": [
31298       {
31299         "title": "Example usage:",
31300         "content": "curl https://{domain}/api/voice/prefixes -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31301         "type": "json"
31302       }
31303     ],
31304     "name": "create",
31305     "group": "Voice_Prefixes",
31306     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31307     "version": "0.0.0",
31308     "filename": "server/api/voicePrefix/index.js",
31309     "groupTitle": "Voice_Prefixes"
31310   },
31311   {
31312     "type": "get",
31313     "url": "/api/voice/queues/reports/describe",
31314     "title": "Gets table info about Queue Reports",
31315     "examples": [
31316       {
31317         "title": "Example usage:",
31318         "content": "curl https://{domain}/api/voice/queues/reports/describe -v -u {name}:{password}",
31319         "type": "json"
31320       }
31321     ],
31322     "name": "DescribeQueue_Reports",
31323     "group": "Voice_Queue_Reports",
31324     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31325     "version": "0.0.0",
31326     "filename": "server/api/voiceQueueReport/index.js",
31327     "groupTitle": "Voice_Queue_Reports"
31328   },
31329   {
31330     "type": "get",
31331     "url": "/api/voice/queues/reports",
31332     "title": "Gets a list of Queue Reports",
31333     "examples": [
31334       {
31335         "title": "Example usage:",
31336         "content": "curl https://{domain}/api/voice/queues/reports -v -u {name}:{password}",
31337         "type": "json"
31338       }
31339     ],
31340     "name": "GetQueue_Reports",
31341     "group": "Voice_Queue_Reports",
31342     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31343     "version": "0.0.0",
31344     "filename": "server/api/voiceQueueReport/index.js",
31345     "groupTitle": "Voice_Queue_Reports"
31346   },
31347   {
31348     "type": "get",
31349     "url": "/api/voice/queues/reports/{id}",
31350     "title": "Gets a single Queue Report",
31351     "examples": [
31352       {
31353         "title": "Example usage:",
31354         "content": "curl https://{domain}/api/voice/queues/reports/{id} -v -u {name}:{password}",
31355         "type": "json"
31356       }
31357     ],
31358     "name": "ShowQueue_Reports",
31359     "group": "Voice_Queue_Reports",
31360     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31361     "version": "0.0.0",
31362     "filename": "server/api/voiceQueueReport/index.js",
31363     "groupTitle": "Voice_Queue_Reports"
31364   },
31365   {
31366     "type": "get",
31367     "url": "/api/voice/queues/reports/index",
31368     "title": "Get Voice Queues Report",
31369     "examples": [
31370       {
31371         "title": "Example usage:",
31372         "content": "curl https://{domain}/api/voice/queues/reports/index -v -u {name}:{password} -X GET",
31373         "type": "json"
31374       }
31375     ],
31376     "name": "getVoiceQueuesReport",
31377     "group": "Voice_Queue_Reports",
31378     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31379     "version": "0.0.0",
31380     "filename": "server/api/voiceQueueReport/index.js",
31381     "groupTitle": "Voice_Queue_Reports"
31382   },
31383   {
31384     "type": "post",
31385     "url": "/api/voice/queues/{id}/users",
31386     "title": "Add agents to queue",
31387     "examples": [
31388       {
31389         "title": "Example usage:",
31390         "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",
31391         "type": "json"
31392       }
31393     ],
31394     "name": "AddAgents",
31395     "group": "Voice_Queues",
31396     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31397     "version": "0.0.0",
31398     "filename": "server/api/voiceQueue/index.js",
31399     "groupTitle": "Voice_Queues"
31400   },
31401   {
31402     "type": "post",
31403     "url": "/api/voice/queues/{id}/blacklists",
31404     "title": "Add blacklists to a queue",
31405     "examples": [
31406       {
31407         "title": "Example usage:",
31408         "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",
31409         "type": "json"
31410       }
31411     ],
31412     "name": "AddBlackLists",
31413     "group": "Voice_Queues",
31414     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31415     "version": "0.0.0",
31416     "filename": "server/api/voiceQueue/index.js",
31417     "groupTitle": "Voice_Queues"
31418   },
31419   {
31420     "type": "post",
31421     "url": "/api/voice/queues/{id}/lists",
31422     "title": "Add lists to a queue",
31423     "examples": [
31424       {
31425         "title": "Example usage:",
31426         "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",
31427         "type": "json"
31428       }
31429     ],
31430     "name": "AddLists",
31431     "group": "Voice_Queues",
31432     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31433     "version": "0.0.0",
31434     "filename": "server/api/voiceQueue/index.js",
31435     "groupTitle": "Voice_Queues"
31436   },
31437   {
31438     "type": "post",
31439     "url": "/api/voice/queues/{id}/teams",
31440     "title": "Add teams to queue",
31441     "examples": [
31442       {
31443         "title": "Example usage:",
31444         "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",
31445         "type": "json"
31446       }
31447     ],
31448     "name": "AddTeams",
31449     "group": "Voice_Queues",
31450     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31451     "version": "0.0.0",
31452     "filename": "server/api/voiceQueue/index.js",
31453     "groupTitle": "Voice_Queues"
31454   },
31455   {
31456     "type": "post",
31457     "url": "/api/voice/queues/clone",
31458     "title": "Clone an existing Queue",
31459     "examples": [
31460       {
31461         "title": "Example usage:",
31462         "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",
31463         "type": "json"
31464       }
31465     ],
31466     "name": "CloneQueues",
31467     "group": "Voice_Queues",
31468     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31469     "version": "0.0.0",
31470     "filename": "server/api/voiceQueue/index.js",
31471     "groupTitle": "Voice_Queues"
31472   },
31473   {
31474     "type": "post",
31475     "url": "/api/voice/queues",
31476     "title": "Creates a new Queue",
31477     "examples": [
31478       {
31479         "title": "Example usage:",
31480         "content": "curl https://{domain}/api/voice/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
31481         "type": "json"
31482       }
31483     ],
31484     "name": "CreateQueues",
31485     "group": "Voice_Queues",
31486     "parameter": {
31487       "fields": {
31488         "Body": [
31489           {
31490             "group": "Body",
31491             "type": "String",
31492             "optional": false,
31493             "field": "name",
31494             "description": ""
31495           },
31496           {
31497             "group": "Body",
31498             "type": "String",
31499             "allowedValues": [
31500               "\"inbound\"",
31501               "\"outbound\""
31502             ],
31503             "optional": false,
31504             "field": "type",
31505             "description": ""
31506           },
31507           {
31508             "group": "Body",
31509             "type": "String",
31510             "optional": true,
31511             "field": "musiconhold",
31512             "description": ""
31513           },
31514           {
31515             "group": "Body",
31516             "type": "String",
31517             "optional": true,
31518             "field": "announce",
31519             "description": ""
31520           },
31521           {
31522             "group": "Body",
31523             "type": "String",
31524             "allowedValues": [
31525               "\"rr\"",
31526               "\"ringall\"",
31527               "\"leastrecent\"",
31528               "\"fewestcalls\"",
31529               "\"random\"",
31530               "\"rrmemory\"",
31531               "\"linear\"",
31532               "\"wrandom\"",
31533               "\"rrordered\""
31534             ],
31535             "optional": false,
31536             "field": "strategy",
31537             "description": ""
31538           },
31539           {
31540             "group": "Body",
31541             "type": "Integer",
31542             "optional": true,
31543             "field": "servicelevel",
31544             "description": ""
31545           },
31546           {
31547             "group": "Body",
31548             "type": "String",
31549             "optional": true,
31550             "field": "context",
31551             "description": ""
31552           },
31553           {
31554             "group": "Body",
31555             "type": "Integer",
31556             "optional": true,
31557             "field": "penaltymemberslimit",
31558             "description": ""
31559           },
31560           {
31561             "group": "Body",
31562             "type": "Integer",
31563             "optional": true,
31564             "field": "timeout",
31565             "description": ""
31566           },
31567           {
31568             "group": "Body",
31569             "type": "Integer",
31570             "optional": true,
31571             "field": "retry",
31572             "description": ""
31573           },
31574           {
31575             "group": "Body",
31576             "type": "String",
31577             "optional": true,
31578             "field": "timeoutpriority",
31579             "description": ""
31580           },
31581           {
31582             "group": "Body",
31583             "type": "Integer",
31584             "optional": true,
31585             "field": "weight",
31586             "description": ""
31587           },
31588           {
31589             "group": "Body",
31590             "type": "Integer",
31591             "optional": true,
31592             "field": "wrapuptime",
31593             "description": ""
31594           },
31595           {
31596             "group": "Body",
31597             "type": "String",
31598             "allowedValues": [
31599               "\"yes\"",
31600               "\"no\""
31601             ],
31602             "optional": true,
31603             "field": "autofill",
31604             "description": ""
31605           },
31606           {
31607             "group": "Body",
31608             "type": "String",
31609             "allowedValues": [
31610               "\"yes\"",
31611               "\"no\"",
31612               "\"all\""
31613             ],
31614             "optional": true,
31615             "field": "autopause",
31616             "description": ""
31617           },
31618           {
31619             "group": "Body",
31620             "type": "Integer",
31621             "optional": true,
31622             "field": "autopausedelay",
31623             "description": ""
31624           },
31625           {
31626             "group": "Body",
31627             "type": "String",
31628             "allowedValues": [
31629               "\"yes\"",
31630               "\"no\""
31631             ],
31632             "optional": true,
31633             "field": "autopausebusy",
31634             "description": ""
31635           },
31636           {
31637             "group": "Body",
31638             "type": "String",
31639             "allowedValues": [
31640               "\"yes\"",
31641               "\"no\""
31642             ],
31643             "optional": true,
31644             "field": "autopauseunavail",
31645             "description": ""
31646           },
31647           {
31648             "group": "Body",
31649             "type": "Integer",
31650             "optional": true,
31651             "field": "maxlen",
31652             "description": ""
31653           },
31654           {
31655             "group": "Body",
31656             "type": "String",
31657             "allowedValues": [
31658               "\"yes\"",
31659               "\"no\""
31660             ],
31661             "optional": true,
31662             "field": "setinterfacevar",
31663             "description": ""
31664           },
31665           {
31666             "group": "Body",
31667             "type": "String",
31668             "allowedValues": [
31669               "\"yes\"",
31670               "\"no\""
31671             ],
31672             "optional": true,
31673             "field": "setqueueentryvar",
31674             "description": ""
31675           },
31676           {
31677             "group": "Body",
31678             "type": "String",
31679             "allowedValues": [
31680               "\"yes\"",
31681               "\"no\""
31682             ],
31683             "optional": true,
31684             "field": "setqueuevar",
31685             "description": ""
31686           },
31687           {
31688             "group": "Body",
31689             "type": "String",
31690             "allowedValues": [
31691               "\"yes\"",
31692               "\"no\""
31693             ],
31694             "optional": true,
31695             "field": "eventmemberstatus",
31696             "description": ""
31697           },
31698           {
31699             "group": "Body",
31700             "type": "String",
31701             "optional": true,
31702             "field": "membermacro",
31703             "description": ""
31704           },
31705           {
31706             "group": "Body",
31707             "type": "String",
31708             "optional": true,
31709             "field": "membergosub",
31710             "description": ""
31711           },
31712           {
31713             "group": "Body",
31714             "type": "Integer",
31715             "optional": true,
31716             "field": "announce_frequency",
31717             "description": ""
31718           },
31719           {
31720             "group": "Body",
31721             "type": "Integer",
31722             "optional": true,
31723             "field": "min_announce_frequency",
31724             "description": ""
31725           },
31726           {
31727             "group": "Body",
31728             "type": "Integer",
31729             "optional": true,
31730             "field": "periodic_announce_frequency",
31731             "description": ""
31732           },
31733           {
31734             "group": "Body",
31735             "type": "String",
31736             "allowedValues": [
31737               "\"yes\"",
31738               "\"no\""
31739             ],
31740             "optional": true,
31741             "field": "random_periodic_announce",
31742             "description": ""
31743           },
31744           {
31745             "group": "Body",
31746             "type": "String",
31747             "allowedValues": [
31748               "\"yes\"",
31749               "\"no\""
31750             ],
31751             "optional": true,
31752             "field": "relative_periodic_announce",
31753             "description": ""
31754           },
31755           {
31756             "group": "Body",
31757             "type": "String",
31758             "allowedValues": [
31759               "\"yes\"",
31760               "\"no\"",
31761               "\"once\""
31762             ],
31763             "optional": true,
31764             "field": "announce_holdtime",
31765             "description": ""
31766           },
31767           {
31768             "group": "Body",
31769             "type": "String",
31770             "optional": true,
31771             "field": "announce_position",
31772             "description": ""
31773           },
31774           {
31775             "group": "Body",
31776             "type": "String",
31777             "allowedValues": [
31778               "\"yes\"",
31779               "\"no\""
31780             ],
31781             "optional": true,
31782             "field": "announce_to_first_user",
31783             "description": ""
31784           },
31785           {
31786             "group": "Body",
31787             "type": "Integer",
31788             "optional": true,
31789             "field": "announce_position_limit",
31790             "description": ""
31791           },
31792           {
31793             "group": "Body",
31794             "type": "String",
31795             "allowedValues": [
31796               "\"0\"",
31797               "\"5\"",
31798               "\"10\"",
31799               "\"15\"",
31800               "\"20\"",
31801               "\"30\""
31802             ],
31803             "optional": true,
31804             "field": "announce_round_seconds",
31805             "description": ""
31806           },
31807           {
31808             "group": "Body",
31809             "type": "String",
31810             "optional": true,
31811             "field": "monitor_format",
31812             "description": ""
31813           },
31814           {
31815             "group": "Body",
31816             "type": "String",
31817             "optional": true,
31818             "field": "monitor_type",
31819             "description": ""
31820           },
31821           {
31822             "group": "Body",
31823             "type": "String",
31824             "optional": true,
31825             "field": "queue_youarenext",
31826             "description": ""
31827           },
31828           {
31829             "group": "Body",
31830             "type": "String",
31831             "optional": true,
31832             "field": "queue_thereare",
31833             "description": ""
31834           },
31835           {
31836             "group": "Body",
31837             "type": "String",
31838             "optional": true,
31839             "field": "queue_callswaiting",
31840             "description": ""
31841           },
31842           {
31843             "group": "Body",
31844             "type": "String",
31845             "optional": true,
31846             "field": "queue_holdtime",
31847             "description": ""
31848           },
31849           {
31850             "group": "Body",
31851             "type": "String",
31852             "optional": true,
31853             "field": "queue_minute",
31854             "description": ""
31855           },
31856           {
31857             "group": "Body",
31858             "type": "String",
31859             "optional": true,
31860             "field": "queue_minutes",
31861             "description": ""
31862           },
31863           {
31864             "group": "Body",
31865             "type": "String",
31866             "optional": true,
31867             "field": "queue_seconds",
31868             "description": ""
31869           },
31870           {
31871             "group": "Body",
31872             "type": "String",
31873             "optional": true,
31874             "field": "queue_thankyou",
31875             "description": ""
31876           },
31877           {
31878             "group": "Body",
31879             "type": "String",
31880             "optional": true,
31881             "field": "queue_reporthold",
31882             "description": ""
31883           },
31884           {
31885             "group": "Body",
31886             "type": "String",
31887             "optional": true,
31888             "field": "queue_quantity1",
31889             "description": ""
31890           },
31891           {
31892             "group": "Body",
31893             "type": "String",
31894             "optional": true,
31895             "field": "queue_quantity2",
31896             "description": ""
31897           },
31898           {
31899             "group": "Body",
31900             "type": "String",
31901             "optional": true,
31902             "field": "queue_periodic_announce",
31903             "description": ""
31904           },
31905           {
31906             "group": "Body",
31907             "type": "String",
31908             "optional": true,
31909             "field": "queue_less_than",
31910             "description": ""
31911           },
31912           {
31913             "group": "Body",
31914             "type": "Text",
31915             "optional": true,
31916             "field": "periodic_announce",
31917             "description": ""
31918           },
31919           {
31920             "group": "Body",
31921             "type": "String",
31922             "optional": true,
31923             "field": "joinempty",
31924             "description": ""
31925           },
31926           {
31927             "group": "Body",
31928             "type": "String",
31929             "optional": true,
31930             "field": "leavewhenempty",
31931             "description": ""
31932           },
31933           {
31934             "group": "Body",
31935             "type": "String",
31936             "allowedValues": [
31937               "\"yes\"",
31938               "\"no\""
31939             ],
31940             "optional": true,
31941             "field": "reportholdtime",
31942             "description": ""
31943           },
31944           {
31945             "group": "Body",
31946             "type": "String",
31947             "allowedValues": [
31948               "\"yes\"",
31949               "\"no\""
31950             ],
31951             "optional": true,
31952             "field": "ringinuse",
31953             "description": ""
31954           },
31955           {
31956             "group": "Body",
31957             "type": "Integer",
31958             "optional": true,
31959             "field": "memberdelay",
31960             "description": ""
31961           },
31962           {
31963             "group": "Body",
31964             "type": "String",
31965             "allowedValues": [
31966               "\"yes\"",
31967               "\"no\""
31968             ],
31969             "optional": true,
31970             "field": "timeoutrestart",
31971             "description": ""
31972           },
31973           {
31974             "group": "Body",
31975             "type": "String",
31976             "optional": true,
31977             "field": "defaultrule",
31978             "description": ""
31979           },
31980           {
31981             "group": "Body",
31982             "type": "String",
31983             "optional": true,
31984             "field": "description",
31985             "description": ""
31986           },
31987           {
31988             "group": "Body",
31989             "type": "Boolean",
31990             "optional": true,
31991             "field": "acw",
31992             "description": ""
31993           },
31994           {
31995             "group": "Body",
31996             "type": "Integer",
31997             "optional": true,
31998             "field": "acwTimeout",
31999             "description": ""
32000           },
32001           {
32002             "group": "Body",
32003             "type": "Boolean",
32004             "optional": true,
32005             "field": "dialActive",
32006             "description": "<p>Active/Disactive Campaign</p>"
32007           },
32008           {
32009             "group": "Body",
32010             "type": "String",
32011             "allowedValues": [
32012               "\"preview\"",
32013               "\"progressive\"",
32014               "\"power\"",
32015               "\"predictive\"",
32016               "\"booked\""
32017             ],
32018             "optional": true,
32019             "field": "dialMethod",
32020             "description": "<p>Dial Method.</p>"
32021           },
32022           {
32023             "group": "Body",
32024             "type": "Integer",
32025             "optional": true,
32026             "field": "dialLimitChannel",
32027             "description": "<p>Max 9999 channels, 0 means unlimited.</p>"
32028           },
32029           {
32030             "group": "Body",
32031             "type": "Integer",
32032             "optional": true,
32033             "field": "dialLimitQueue",
32034             "description": "<p>Max 9999 member in queue(min:1, max:9999), 0 means unlimited.</p>"
32035           },
32036           {
32037             "group": "Body",
32038             "type": "Float",
32039             "optional": true,
32040             "field": "dialPowerLevel",
32041             "description": "<p>Power Level: Calls for agents (min:1, max:10).</p>"
32042           },
32043           {
32044             "group": "Body",
32045             "type": "String",
32046             "allowedValues": [
32047               "\"agentBusyFactor\"",
32048               "\"dropRate\""
32049             ],
32050             "optional": true,
32051             "field": "dialPredictiveOptimization",
32052             "description": "<p>Only for predictive method.</p>"
32053           },
32054           {
32055             "group": "Body",
32056             "type": "Float",
32057             "optional": true,
32058             "field": "dialPredictiveOptimizationPercentage",
32059             "description": "<p>Predictive Optimization Percentage (min: 1, max: 95)</p>"
32060           },
32061           {
32062             "group": "Body",
32063             "type": "Integer",
32064             "optional": true,
32065             "field": "dialPredictiveInterval",
32066             "description": "<p>Interval Predictive Minutes (min:5 max:30)</p>"
32067           },
32068           {
32069             "group": "Body",
32070             "type": "String",
32071             "optional": true,
32072             "field": "dialOriginateCallerIdName",
32073             "description": ""
32074           },
32075           {
32076             "group": "Body",
32077             "type": "String",
32078             "optional": true,
32079             "field": "dialOriginateCallerIdNumber",
32080             "description": ""
32081           },
32082           {
32083             "group": "Body",
32084             "type": "Integer",
32085             "optional": true,
32086             "field": "dialOriginateTimeout",
32087             "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
32088           },
32089           {
32090             "group": "Body",
32091             "type": "String",
32092             "optional": true,
32093             "field": "dialQueueOptions",
32094             "description": "<p>https://wiki.asterisk.org/wiki/display/AST/Asterisk+13+Application_Queue</p>"
32095           },
32096           {
32097             "group": "Body",
32098             "type": "Integer",
32099             "optional": true,
32100             "field": "dialQueueTimeout",
32101             "description": "<p>Queue Timeout Seconds (min:1, max:999)</p>"
32102           },
32103           {
32104             "group": "Body",
32105             "type": "String",
32106             "optional": true,
32107             "field": "dialQueueProject",
32108             "description": "<p>AGI queue option (use: agi://127.0.0.1/square,&lt;project_name&gt;)</p>"
32109           },
32110           {
32111             "group": "Body",
32112             "type": "Integer",
32113             "optional": true,
32114             "field": "dialCongestionMaxRetry",
32115             "description": "<p>#Congestion Retry (min:1, max:999)</p>"
32116           },
32117           {
32118             "group": "Body",
32119             "type": "Integer",
32120             "optional": true,
32121             "field": "dialCongestionRetryFrequency",
32122             "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
32123           },
32124           {
32125             "group": "Body",
32126             "type": "Integer",
32127             "optional": true,
32128             "field": "dialBusyMaxRetry",
32129             "description": "<p>#Busy Retry (min:1, max:999)</p>"
32130           },
32131           {
32132             "group": "Body",
32133             "type": "Integer",
32134             "optional": true,
32135             "field": "dialBusyRetryFrequency",
32136             "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
32137           },
32138           {
32139             "group": "Body",
32140             "type": "Integer",
32141             "optional": true,
32142             "field": "dialNoAnswerMaxRetry",
32143             "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
32144           },
32145           {
32146             "group": "Body",
32147             "type": "Integer",
32148             "optional": true,
32149             "field": "dialNoAnswerRetryFrequency",
32150             "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
32151           },
32152           {
32153             "group": "Body",
32154             "type": "Integer",
32155             "optional": true,
32156             "field": "dialGlobalMaxRetry",
32157             "description": "<p>#Global Max Retry (min:1, max:999)</p>"
32158           },
32159           {
32160             "group": "Body",
32161             "type": "String",
32162             "optional": true,
32163             "field": "dialTimezone",
32164             "description": ""
32165           },
32166           {
32167             "group": "Body",
32168             "type": "String",
32169             "optional": true,
32170             "field": "dialGlobalInterval",
32171             "description": ""
32172           },
32173           {
32174             "group": "Body",
32175             "type": "String",
32176             "optional": true,
32177             "field": "dialPrefix",
32178             "description": ""
32179           },
32180           {
32181             "group": "Body",
32182             "type": "String",
32183             "allowedValues": [
32184               "\"always\"",
32185               "\"never\"",
32186               "\"onlyIfOpen\""
32187             ],
32188             "optional": true,
32189             "field": "dialCheckDuplicateType",
32190             "description": ""
32191           },
32192           {
32193             "group": "Body",
32194             "type": "Boolean",
32195             "optional": true,
32196             "field": "dialAMDActive",
32197             "description": "<p>Active/Disactive AMD</p>"
32198           },
32199           {
32200             "group": "Body",
32201             "type": "Integer",
32202             "optional": true,
32203             "field": "dialAMDInitialSilence",
32204             "description": "<p>#AMD Initial Silence</p>"
32205           },
32206           {
32207             "group": "Body",
32208             "type": "Integer",
32209             "optional": true,
32210             "field": "dialAMDGreeting",
32211             "description": "<p>#AMD Greeting</p>"
32212           },
32213           {
32214             "group": "Body",
32215             "type": "Integer",
32216             "optional": true,
32217             "field": "dialAMDAfterGreetingSilence",
32218             "description": "<p>#AMD After Greeting Silence</p>"
32219           },
32220           {
32221             "group": "Body",
32222             "type": "Integer",
32223             "optional": true,
32224             "field": "dialAMDTotalAnalysisTime",
32225             "description": "<p>#AMD Total Analysis Time</p>"
32226           },
32227           {
32228             "group": "Body",
32229             "type": "Integer",
32230             "optional": true,
32231             "field": "dialAMDMinWordLength",
32232             "description": "<p>#AMD Min Word Length</p>"
32233           },
32234           {
32235             "group": "Body",
32236             "type": "Integer",
32237             "optional": true,
32238             "field": "dialAMDBetweenWordsSilence",
32239             "description": "<p>#AMD Between Words Silence</p>"
32240           },
32241           {
32242             "group": "Body",
32243             "type": "Integer",
32244             "optional": true,
32245             "field": "dialAMDMaximumNumberOfWords",
32246             "description": "<p>#AMD Maximum Number Of Words</p>"
32247           },
32248           {
32249             "group": "Body",
32250             "type": "Integer",
32251             "optional": true,
32252             "field": "dialAMDSilenceThreshold",
32253             "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
32254           },
32255           {
32256             "group": "Body",
32257             "type": "Integer",
32258             "optional": true,
32259             "field": "dialAMDMaximumWordLength",
32260             "description": "<p>#AMD Maximum Word Length</p>"
32261           },
32262           {
32263             "group": "Body",
32264             "type": "Integer",
32265             "optional": true,
32266             "field": "dialRecallMeTimeout",
32267             "description": "<p>#RecallMe Timeout (min:1)</p>"
32268           },
32269           {
32270             "group": "Body",
32271             "type": "Boolean",
32272             "optional": true,
32273             "field": "dialRecallInQueue",
32274             "description": "<p>Active/Disactive Recall In Queue</p>"
32275           },
32276           {
32277             "group": "Body",
32278             "type": "String",
32279             "allowedValues": [
32280               "\"DESC\"",
32281               "\"ASC\""
32282             ],
32283             "optional": true,
32284             "field": "dialOrderByScheduledAt",
32285             "description": ""
32286           },
32287           {
32288             "group": "Body",
32289             "type": "String",
32290             "optional": true,
32291             "field": "dialQueueProject2",
32292             "description": "<p>AGI queue option (use: agi://127.0.0.1/square,&lt;project_name&gt;)</p>"
32293           },
32294           {
32295             "group": "Body",
32296             "type": "Boolean",
32297             "optional": true,
32298             "field": "dialAgiAfterHangupClient",
32299             "description": ""
32300           },
32301           {
32302             "group": "Body",
32303             "type": "Boolean",
32304             "optional": true,
32305             "field": "dialAgiAfterHangupAgent",
32306             "description": ""
32307           },
32308           {
32309             "group": "Body",
32310             "type": "Integer",
32311             "optional": true,
32312             "field": "dialRandomLastDigitCallerIdNumber",
32313             "description": "<p>Random Last Digit (min:1, max:15)</p>"
32314           },
32315           {
32316             "group": "Body",
32317             "type": "Integer",
32318             "optional": true,
32319             "field": "dialCutDigit",
32320             "description": "<p>Cut Digit (min:1, max:15)</p>"
32321           },
32322           {
32323             "group": "Body",
32324             "type": "Integer",
32325             "optional": true,
32326             "field": "dialNoSuchNumberMaxRetry",
32327             "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
32328           },
32329           {
32330             "group": "Body",
32331             "type": "Integer",
32332             "optional": true,
32333             "field": "dialNoSuchNumberRetryFrequency",
32334             "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
32335           },
32336           {
32337             "group": "Body",
32338             "type": "Integer",
32339             "optional": true,
32340             "field": "dialDropMaxRetry",
32341             "description": "<p>#Drop Retry (min:1, max:999)</p>"
32342           },
32343           {
32344             "group": "Body",
32345             "type": "Integer",
32346             "optional": true,
32347             "field": "dialDropRetryFrequency",
32348             "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
32349           },
32350           {
32351             "group": "Body",
32352             "type": "Integer",
32353             "optional": true,
32354             "field": "dialAbandonedMaxRetry",
32355             "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
32356           },
32357           {
32358             "group": "Body",
32359             "type": "Integer",
32360             "optional": true,
32361             "field": "dialAbandonedRetryFrequency",
32362             "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
32363           },
32364           {
32365             "group": "Body",
32366             "type": "Integer",
32367             "optional": true,
32368             "field": "dialMachineMaxRetry",
32369             "description": "<p>#Machine Retry (min:1, max:999)</p>"
32370           },
32371           {
32372             "group": "Body",
32373             "type": "Integer",
32374             "optional": true,
32375             "field": "dialMachineRetryFrequency",
32376             "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
32377           },
32378           {
32379             "group": "Body",
32380             "type": "Integer",
32381             "optional": true,
32382             "field": "dialAgentRejectMaxRetry",
32383             "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
32384           },
32385           {
32386             "group": "Body",
32387             "type": "Integer",
32388             "optional": true,
32389             "field": "dialAgentRejectRetryFrequency",
32390             "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
32391           },
32392           {
32393             "group": "Body",
32394             "type": "Integer",
32395             "optional": true,
32396             "field": "mandatoryDispositionPauseId",
32397             "description": "<p>Status to put when mandatory disposition is enabled</p>"
32398           },
32399           {
32400             "group": "Body",
32401             "type": "Boolean",
32402             "optional": true,
32403             "field": "mandatoryDisposition",
32404             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
32405           },
32406           {
32407             "group": "Body",
32408             "type": "Integer",
32409             "optional": true,
32410             "field": "dialPredictiveIntervalMaxThreshold",
32411             "description": ""
32412           },
32413           {
32414             "group": "Body",
32415             "type": "Integer",
32416             "optional": true,
32417             "field": "dialPredictiveIntervalMinThreshold",
32418             "description": ""
32419           }
32420         ]
32421       }
32422     },
32423     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32424     "version": "0.0.0",
32425     "filename": "server/api/voiceQueue/index.js",
32426     "groupTitle": "Voice_Queues"
32427   },
32428   {
32429     "type": "delete",
32430     "url": "/api/voice/queues/{id}",
32431     "title": "Deletes a Queue",
32432     "examples": [
32433       {
32434         "title": "Example usage:",
32435         "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password} -X DELETE",
32436         "type": "json"
32437       }
32438     ],
32439     "name": "DeleteQueues",
32440     "group": "Voice_Queues",
32441     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32442     "version": "0.0.0",
32443     "filename": "server/api/voiceQueue/index.js",
32444     "groupTitle": "Voice_Queues"
32445   },
32446   {
32447     "type": "get",
32448     "url": "/api/voice/queues/{id}/users",
32449     "title": "Gets queue agents",
32450     "examples": [
32451       {
32452         "title": "Example usage:",
32453         "content": "curl https://{domain}/api/voice/queues/{id}/users -v -u {name}:{password} -X GET",
32454         "type": "json"
32455       }
32456     ],
32457     "name": "GetAgents",
32458     "group": "Voice_Queues",
32459     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32460     "version": "0.0.0",
32461     "filename": "server/api/voiceQueue/index.js",
32462     "groupTitle": "Voice_Queues"
32463   },
32464   {
32465     "type": "get",
32466     "url": "/api/voice/queues/{id}/blacklists",
32467     "title": "Get queue blacklists",
32468     "examples": [
32469       {
32470         "title": "Example usage:",
32471         "content": "curl https://{domain}/api/voice/queues/{id}/blacklists -v -u {name}:{password} -X GET",
32472         "type": "json"
32473       }
32474     ],
32475     "name": "GetBlackLists",
32476     "group": "Voice_Queues",
32477     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32478     "version": "0.0.0",
32479     "filename": "server/api/voiceQueue/index.js",
32480     "groupTitle": "Voice_Queues"
32481   },
32482   {
32483     "type": "get",
32484     "url": "/api/voice/queues/{id}/finals",
32485     "title": "Gets queue hopper finals",
32486     "examples": [
32487       {
32488         "title": "Example usage:",
32489         "content": "curl https://{domain}/api/voice/queues/{id}/hopper_finals -v -u {name}:{password}  -X GET",
32490         "type": "json"
32491       }
32492     ],
32493     "name": "GetHopperFinals",
32494     "group": "Voice_Queues",
32495     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32496     "version": "0.0.0",
32497     "filename": "server/api/voiceQueue/index.js",
32498     "groupTitle": "Voice_Queues"
32499   },
32500   {
32501     "type": "get",
32502     "url": "/api/voice/queues/{id}/hopper_histories",
32503     "title": "Gets queue hopper histories",
32504     "examples": [
32505       {
32506         "title": "Example usage:",
32507         "content": "curl https://{domain}/api/voice/queues/{id}/hopper_histories -v -u {name}:{password} -X GET",
32508         "type": "json"
32509       }
32510     ],
32511     "name": "GetHopperHistories",
32512     "group": "Voice_Queues",
32513     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32514     "version": "0.0.0",
32515     "filename": "server/api/voiceQueue/index.js",
32516     "groupTitle": "Voice_Queues"
32517   },
32518   {
32519     "type": "get",
32520     "url": "/api/voice/queues/{id}/hoppers",
32521     "title": "Gets queue hoppers",
32522     "examples": [
32523       {
32524         "title": "Example usage:",
32525         "content": "curl https://{domain}/api/voice/queues/{id}/hoppers -v -u {name}:{password} -X GET",
32526         "type": "json"
32527       }
32528     ],
32529     "name": "GetHoppers",
32530     "group": "Voice_Queues",
32531     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32532     "version": "0.0.0",
32533     "filename": "server/api/voiceQueue/index.js",
32534     "groupTitle": "Voice_Queues"
32535   },
32536   {
32537     "type": "get",
32538     "url": "/api/voice/queues/{id}/lists",
32539     "title": "Get queue lists",
32540     "examples": [
32541       {
32542         "title": "Example usage:",
32543         "content": "curl https://{domain}/api/voice/queues/{id}/lists -v -u {name}:{password} -X GET",
32544         "type": "json"
32545       }
32546     ],
32547     "name": "GetLists",
32548     "group": "Voice_Queues",
32549     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32550     "version": "0.0.0",
32551     "filename": "server/api/voiceQueue/index.js",
32552     "groupTitle": "Voice_Queues"
32553   },
32554   {
32555     "type": "get",
32556     "url": "/api/voice/queues/{id}/members",
32557     "title": "Gets queue members",
32558     "examples": [
32559       {
32560         "title": "Example usage:",
32561         "content": "curl https://{domain}/api/voice/queues/{id}/members -v -u {name}:{password} -X GET",
32562         "type": "json"
32563       }
32564     ],
32565     "name": "GetMembers",
32566     "group": "Voice_Queues",
32567     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32568     "version": "0.0.0",
32569     "filename": "server/api/voiceQueue/index.js",
32570     "groupTitle": "Voice_Queues"
32571   },
32572   {
32573     "type": "get",
32574     "url": "/api/voice/queues",
32575     "title": "Gets a list of Queues",
32576     "examples": [
32577       {
32578         "title": "Example usage:",
32579         "content": "curl https://{domain}/api/voice/queues -v -u {name}:{password}",
32580         "type": "json"
32581       }
32582     ],
32583     "name": "GetQueues",
32584     "group": "Voice_Queues",
32585     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
32586     "version": "0.0.0",
32587     "filename": "server/api/voiceQueue/index.js",
32588     "groupTitle": "Voice_Queues"
32589   },
32590   {
32591     "type": "get",
32592     "url": "/api/voice/queues/{id}/teams",
32593     "title": "Gets queue team",
32594     "examples": [
32595       {
32596         "title": "Example usage:",
32597         "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password}  -X GET",
32598         "type": "json"
32599       }
32600     ],
32601     "name": "GetTeams",
32602     "group": "Voice_Queues",
32603     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32604     "version": "0.0.0",
32605     "filename": "server/api/voiceQueue/index.js",
32606     "groupTitle": "Voice_Queues"
32607   },
32608   {
32609     "type": "delete",
32610     "url": "/api/voice/queues/{id}/users",
32611     "title": "Removes agents from a queue",
32612     "examples": [
32613       {
32614         "title": "Example usage:",
32615         "content": "curl https://{domain}/api/voice/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32616         "type": "json"
32617       }
32618     ],
32619     "name": "RemoveAgents",
32620     "group": "Voice_Queues",
32621     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32622     "version": "0.0.0",
32623     "filename": "server/api/voiceQueue/index.js",
32624     "groupTitle": "Voice_Queues"
32625   },
32626   {
32627     "type": "delete",
32628     "url": "/api/voice/queues/{id}/blacklists",
32629     "title": "Remove blacklists from a queue",
32630     "examples": [
32631       {
32632         "title": "Example usage:",
32633         "content": "curl https://{domain}/api/voice/queues/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32634         "type": "json"
32635       }
32636     ],
32637     "name": "RemoveBlackLists",
32638     "group": "Voice_Queues",
32639     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32640     "version": "0.0.0",
32641     "filename": "server/api/voiceQueue/index.js",
32642     "groupTitle": "Voice_Queues"
32643   },
32644   {
32645     "type": "delete",
32646     "url": "/api/voice/queues/{id}/lists",
32647     "title": "Remove lists from a queue",
32648     "examples": [
32649       {
32650         "title": "Example usage:",
32651         "content": "curl https://{domain}/api/voice/queues/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32652         "type": "json"
32653       }
32654     ],
32655     "name": "RemoveLists",
32656     "group": "Voice_Queues",
32657     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32658     "version": "0.0.0",
32659     "filename": "server/api/voiceQueue/index.js",
32660     "groupTitle": "Voice_Queues"
32661   },
32662   {
32663     "type": "get",
32664     "url": "/api/voice/queues/{id}",
32665     "title": "Gets a single Queue",
32666     "examples": [
32667       {
32668         "title": "Example usage:",
32669         "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password}",
32670         "type": "json"
32671       }
32672     ],
32673     "name": "ShowQueues",
32674     "group": "Voice_Queues",
32675     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32676     "version": "0.0.0",
32677     "filename": "server/api/voiceQueue/index.js",
32678     "groupTitle": "Voice_Queues"
32679   },
32680   {
32681     "type": "get",
32682     "url": "/api/voice/queues/{id}/blacks",
32683     "title": "Gets queue hopper blacks",
32684     "examples": [
32685       {
32686         "title": "Example usage:",
32687         "content": "curl https://{domain}/api/voice/queues/{id}/hopper_black -v -u {name}:{password}  -X GET",
32688         "type": "json"
32689       }
32690     ],
32691     "name": "getHopperBlacks",
32692     "group": "Voice_Queues",
32693     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32694     "version": "0.0.0",
32695     "filename": "server/api/voiceQueue/index.js",
32696     "groupTitle": "Voice_Queues"
32697   },
32698   {
32699     "type": "put",
32700     "url": "/api/voice/queues/{id}",
32701     "title": "Update an existing Queue",
32702     "examples": [
32703       {
32704         "title": "Example usage:",
32705         "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",
32706         "type": "json"
32707       }
32708     ],
32709     "name": "updateQueues",
32710     "group": "Voice_Queues",
32711     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32712     "version": "0.0.0",
32713     "filename": "server/api/voiceQueue/index.js",
32714     "groupTitle": "Voice_Queues"
32715   },
32716   {
32717     "type": "post",
32718     "url": "/api/voice/recordings",
32719     "title": "Creates a new Recording",
32720     "examples": [
32721       {
32722         "title": "Example usage:",
32723         "content": "curl https://{domain}/api/voice/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
32724         "type": "json"
32725       }
32726     ],
32727     "name": "CreateRecordings",
32728     "group": "Voice_Recordings",
32729     "parameter": {
32730       "fields": {
32731         "Body": [
32732           {
32733             "group": "Body",
32734             "type": "Virtual",
32735             "optional": true,
32736             "field": "format",
32737             "description": ""
32738           },
32739           {
32740             "group": "Body",
32741             "type": "String",
32742             "optional": true,
32743             "field": "uniqueid",
32744             "description": ""
32745           },
32746           {
32747             "group": "Body",
32748             "type": "String",
32749             "optional": true,
32750             "field": "channel",
32751             "description": ""
32752           },
32753           {
32754             "group": "Body",
32755             "type": "String",
32756             "optional": true,
32757             "field": "membername",
32758             "description": ""
32759           },
32760           {
32761             "group": "Body",
32762             "type": "String",
32763             "optional": true,
32764             "field": "calleridnum",
32765             "description": ""
32766           },
32767           {
32768             "group": "Body",
32769             "type": "String",
32770             "optional": true,
32771             "field": "calleridname",
32772             "description": ""
32773           },
32774           {
32775             "group": "Body",
32776             "type": "String",
32777             "optional": true,
32778             "field": "connectedlinenum",
32779             "description": ""
32780           },
32781           {
32782             "group": "Body",
32783             "type": "String",
32784             "optional": true,
32785             "field": "connectedlinename",
32786             "description": ""
32787           },
32788           {
32789             "group": "Body",
32790             "type": "String",
32791             "optional": true,
32792             "field": "accountcode",
32793             "description": ""
32794           },
32795           {
32796             "group": "Body",
32797             "type": "String",
32798             "optional": true,
32799             "field": "context",
32800             "description": ""
32801           },
32802           {
32803             "group": "Body",
32804             "type": "String",
32805             "optional": true,
32806             "field": "exten",
32807             "description": ""
32808           },
32809           {
32810             "group": "Body",
32811             "type": "String",
32812             "optional": true,
32813             "field": "value",
32814             "description": ""
32815           },
32816           {
32817             "group": "Body",
32818             "type": "String",
32819             "optional": true,
32820             "field": "type",
32821             "description": ""
32822           },
32823           {
32824             "group": "Body",
32825             "type": "Integer",
32826             "optional": true,
32827             "field": "rating",
32828             "description": ""
32829           },
32830           {
32831             "group": "Body",
32832             "type": "String",
32833             "optional": true,
32834             "field": "queue",
32835             "description": ""
32836           },
32837           {
32838             "group": "Body",
32839             "type": "String",
32840             "optional": true,
32841             "field": "userDisposition",
32842             "description": ""
32843           },
32844           {
32845             "group": "Body",
32846             "type": "String",
32847             "optional": true,
32848             "field": "userSecondDisposition",
32849             "description": ""
32850           },
32851           {
32852             "group": "Body",
32853             "type": "String",
32854             "optional": true,
32855             "field": "userThirdDisposition",
32856             "description": ""
32857           },
32858           {
32859             "group": "Body",
32860             "type": "Text",
32861             "optional": true,
32862             "field": "location",
32863             "description": ""
32864           },
32865           {
32866             "group": "Body",
32867             "type": "String",
32868             "optional": true,
32869             "field": "transcribeName",
32870             "description": ""
32871           },
32872           {
32873             "group": "Body",
32874             "type": "String",
32875             "optional": true,
32876             "field": "transcribeStatus",
32877             "description": ""
32878           },
32879           {
32880             "group": "Body",
32881             "type": "Text",
32882             "optional": true,
32883             "field": "fileUri",
32884             "description": ""
32885           },
32886           {
32887             "group": "Body",
32888             "type": "Text",
32889             "optional": true,
32890             "field": "fileText",
32891             "description": ""
32892           },
32893           {
32894             "group": "Body",
32895             "type": "Text",
32896             "optional": true,
32897             "field": "failureReason",
32898             "description": ""
32899           },
32900           {
32901             "group": "Body",
32902             "type": "String",
32903             "optional": true,
32904             "field": "sentiment",
32905             "description": ""
32906           },
32907           {
32908             "group": "Body",
32909             "type": "Float",
32910             "optional": true,
32911             "field": "sPositive",
32912             "description": ""
32913           },
32914           {
32915             "group": "Body",
32916             "type": "Float",
32917             "optional": true,
32918             "field": "sNegative",
32919             "description": ""
32920           },
32921           {
32922             "group": "Body",
32923             "type": "Float",
32924             "optional": true,
32925             "field": "sNeutral",
32926             "description": ""
32927           },
32928           {
32929             "group": "Body",
32930             "type": "Float",
32931             "optional": true,
32932             "field": "sMixed",
32933             "description": ""
32934           },
32935           {
32936             "group": "Body",
32937             "type": "Boolean",
32938             "optional": true,
32939             "field": "tempSentiment",
32940             "description": ""
32941           },
32942           {
32943             "group": "Body",
32944             "type": "String",
32945             "optional": true,
32946             "field": "createdAt",
32947             "description": ""
32948           },
32949           {
32950             "group": "Body",
32951             "type": "String",
32952             "optional": true,
32953             "field": "updatedAt",
32954             "description": ""
32955           }
32956         ]
32957       }
32958     },
32959     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32960     "version": "0.0.0",
32961     "filename": "server/api/voiceRecording/index.js",
32962     "groupTitle": "Voice_Recordings"
32963   },
32964   {
32965     "type": "get",
32966     "url": "/api/voice/recordings/describe",
32967     "title": "Gets table info about Recordings",
32968     "examples": [
32969       {
32970         "title": "Example usage:",
32971         "content": "curl https://{domain}/api/voice/recordings/describe -v -u {name}:{password}",
32972         "type": "json"
32973       }
32974     ],
32975     "name": "DescribeRecordings",
32976     "group": "Voice_Recordings",
32977     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32978     "version": "0.0.0",
32979     "filename": "server/api/voiceRecording/index.js",
32980     "groupTitle": "Voice_Recordings"
32981   },
32982   {
32983     "type": "get",
32984     "url": "/api/voice/recordings",
32985     "title": "Gets a list of Recordings",
32986     "examples": [
32987       {
32988         "title": "Example usage:",
32989         "content": "curl https://{domain}/api/voice/recordings -v -u {name}:{password}",
32990         "type": "json"
32991       }
32992     ],
32993     "name": "GetRecordings",
32994     "group": "Voice_Recordings",
32995     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
32996     "version": "0.0.0",
32997     "filename": "server/api/voiceRecording/index.js",
32998     "groupTitle": "Voice_Recordings"
32999   },
33000   {
33001     "type": "get",
33002     "url": "/api/voice/recordings/{id}",
33003     "title": "Gets a single Recording",
33004     "examples": [
33005       {
33006         "title": "Example usage:",
33007         "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password}",
33008         "type": "json"
33009       }
33010     ],
33011     "name": "ShowRecordings",
33012     "group": "Voice_Recordings",
33013     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33014     "version": "0.0.0",
33015     "filename": "server/api/voiceRecording/index.js",
33016     "groupTitle": "Voice_Recordings"
33017   },
33018   {
33019     "type": "delete",
33020     "url": "/api/voice/recordings/{id}",
33021     "title": "Delete voice recording",
33022     "examples": [
33023       {
33024         "title": "Example usage:",
33025         "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password} -X DELETE",
33026         "type": "json"
33027       }
33028     ],
33029     "name": "destroy",
33030     "group": "Voice_Recordings",
33031     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33032     "version": "0.0.0",
33033     "filename": "server/api/voiceRecording/index.js",
33034     "groupTitle": "Voice_Recordings"
33035   },
33036   {
33037     "type": "get",
33038     "url": "/api/voice/recordings/{id}/download",
33039     "title": "Download Recording",
33040     "examples": [
33041       {
33042         "title": "Example usage:",
33043         "content": "curl https://{domain}/api/voice/recordings/{id}/download -v -u {name}:{password} -X GET",
33044         "type": "json"
33045       }
33046     ],
33047     "name": "download",
33048     "group": "Voice_Recordings",
33049     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33050     "version": "0.0.0",
33051     "filename": "server/api/voiceRecording/index.js",
33052     "groupTitle": "Voice_Recordings"
33053   },
33054   {
33055     "type": "get",
33056     "url": "/api/voice/recordings/{id}/downloads",
33057     "title": "Download Recording",
33058     "examples": [
33059       {
33060         "title": "Example usage:",
33061         "content": "curl https://{domain}/api/voice/recordings/{id}/downloads -v -u {name}:{password} -X GET",
33062         "type": "json"
33063       }
33064     ],
33065     "name": "downloads",
33066     "group": "Voice_Recordings",
33067     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33068     "version": "0.0.0",
33069     "filename": "server/api/voiceRecording/index.js",
33070     "groupTitle": "Voice_Recordings"
33071   },
33072   {
33073     "type": "post",
33074     "url": "/api/voice/recordings/{id}/transcribe",
33075     "title": "Run Transcribe Recording",
33076     "examples": [
33077       {
33078         "title": "Example usage:",
33079         "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -d '{\"runSentiment\": \"true\"}' -v -u {name}:{password} -X POST",
33080         "type": "json"
33081       }
33082     ],
33083     "name": "transcribe",
33084     "group": "Voice_Recordings",
33085     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33086     "version": "0.0.0",
33087     "filename": "server/api/voiceRecording/index.js",
33088     "groupTitle": "Voice_Recordings"
33089   },
33090   {
33091     "type": "get",
33092     "url": "/api/voice/recordings/{id}/transcribe",
33093     "title": "Run Transcribe Recording",
33094     "examples": [
33095       {
33096         "title": "Example usage:",
33097         "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -v -u {name}:{password} -X GET",
33098         "type": "json"
33099       }
33100     ],
33101     "name": "transcribe",
33102     "group": "Voice_Recordings",
33103     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33104     "version": "0.0.0",
33105     "filename": "server/api/voiceRecording/index.js",
33106     "groupTitle": "Voice_Recordings"
33107   },
33108   {
33109     "type": "put",
33110     "url": "/api/voice/recordings/{id}",
33111     "title": "Update an existing Recording",
33112     "examples": [
33113       {
33114         "title": "Example usage:",
33115         "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",
33116         "type": "json"
33117       }
33118     ],
33119     "name": "updateRecordings",
33120     "group": "Voice_Recordings",
33121     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33122     "version": "0.0.0",
33123     "filename": "server/api/voiceRecording/index.js",
33124     "groupTitle": "Voice_Recordings"
33125   },
33126   {
33127     "type": "post",
33128     "url": "/api/voice/transfers/reports",
33129     "title": "Creates a new Transfer Report",
33130     "examples": [
33131       {
33132         "title": "Example usage:",
33133         "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",
33134         "type": "json"
33135       }
33136     ],
33137     "name": "CreateTransfer_Reports",
33138     "group": "Voice_Transfer_Reports",
33139     "parameter": {
33140       "fields": {
33141         "Body": [
33142           {
33143             "group": "Body",
33144             "type": "String",
33145             "allowedValues": [
33146               "\"blind\"",
33147               "\"attended\""
33148             ],
33149             "optional": true,
33150             "field": "type",
33151             "description": ""
33152           },
33153           {
33154             "group": "Body",
33155             "type": "String",
33156             "optional": true,
33157             "field": "result",
33158             "description": ""
33159           },
33160           {
33161             "group": "Body",
33162             "type": "String",
33163             "optional": true,
33164             "field": "transfererchannel",
33165             "description": ""
33166           },
33167           {
33168             "group": "Body",
33169             "type": "String",
33170             "optional": true,
33171             "field": "transferercalleridnum",
33172             "description": ""
33173           },
33174           {
33175             "group": "Body",
33176             "type": "String",
33177             "optional": true,
33178             "field": "transferercalleridname",
33179             "description": ""
33180           },
33181           {
33182             "group": "Body",
33183             "type": "String",
33184             "optional": true,
33185             "field": "transfererconnectedlinenum",
33186             "description": ""
33187           },
33188           {
33189             "group": "Body",
33190             "type": "String",
33191             "optional": true,
33192             "field": "transfererconnectedlinename",
33193             "description": ""
33194           },
33195           {
33196             "group": "Body",
33197             "type": "String",
33198             "optional": true,
33199             "field": "transfereraccountcode",
33200             "description": ""
33201           },
33202           {
33203             "group": "Body",
33204             "type": "String",
33205             "optional": true,
33206             "field": "transferercontext",
33207             "description": ""
33208           },
33209           {
33210             "group": "Body",
33211             "type": "String",
33212             "optional": true,
33213             "field": "transfererexten",
33214             "description": ""
33215           },
33216           {
33217             "group": "Body",
33218             "type": "String",
33219             "optional": true,
33220             "field": "transfererlinkedid",
33221             "description": ""
33222           },
33223           {
33224             "group": "Body",
33225             "type": "String",
33226             "optional": true,
33227             "field": "transfereechannel",
33228             "description": ""
33229           },
33230           {
33231             "group": "Body",
33232             "type": "String",
33233             "optional": true,
33234             "field": "transfereecalleridnum",
33235             "description": ""
33236           },
33237           {
33238             "group": "Body",
33239             "type": "String",
33240             "optional": true,
33241             "field": "transfereecalleridname",
33242             "description": ""
33243           },
33244           {
33245             "group": "Body",
33246             "type": "String",
33247             "optional": true,
33248             "field": "transfereeconnectedlinenum",
33249             "description": ""
33250           },
33251           {
33252             "group": "Body",
33253             "type": "String",
33254             "optional": true,
33255             "field": "transfereeconnectedlinename",
33256             "description": ""
33257           },
33258           {
33259             "group": "Body",
33260             "type": "String",
33261             "optional": true,
33262             "field": "transfereeaccountcode",
33263             "description": ""
33264           },
33265           {
33266             "group": "Body",
33267             "type": "String",
33268             "optional": true,
33269             "field": "transfereecontext",
33270             "description": ""
33271           },
33272           {
33273             "group": "Body",
33274             "type": "String",
33275             "optional": true,
33276             "field": "transfereeexten",
33277             "description": ""
33278           },
33279           {
33280             "group": "Body",
33281             "type": "String",
33282             "optional": true,
33283             "field": "transfereelinkedid",
33284             "description": ""
33285           },
33286           {
33287             "group": "Body",
33288             "type": "String",
33289             "allowedValues": [
33290               "\"Yes\"",
33291               "\"No\""
33292             ],
33293             "optional": true,
33294             "field": "isexternal",
33295             "description": ""
33296           },
33297           {
33298             "group": "Body",
33299             "type": "String",
33300             "optional": true,
33301             "field": "context",
33302             "description": ""
33303           },
33304           {
33305             "group": "Body",
33306             "type": "String",
33307             "optional": true,
33308             "field": "extension",
33309             "description": ""
33310           }
33311         ]
33312       }
33313     },
33314     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33315     "version": "0.0.0",
33316     "filename": "server/api/voiceTransferReport/index.js",
33317     "groupTitle": "Voice_Transfer_Reports"
33318   },
33319   {
33320     "type": "delete",
33321     "url": "/api/voice/transfers/reports/{id}",
33322     "title": "Deletes a Transfer Report",
33323     "examples": [
33324       {
33325         "title": "Example usage:",
33326         "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password} -X DELETE",
33327         "type": "json"
33328       }
33329     ],
33330     "name": "DeleteTransfer_Reports",
33331     "group": "Voice_Transfer_Reports",
33332     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33333     "version": "0.0.0",
33334     "filename": "server/api/voiceTransferReport/index.js",
33335     "groupTitle": "Voice_Transfer_Reports"
33336   },
33337   {
33338     "type": "get",
33339     "url": "/api/voice/transfers/reports",
33340     "title": "Gets a list of Transfer Reports",
33341     "examples": [
33342       {
33343         "title": "Example usage:",
33344         "content": "curl https://{domain}/api/voice/transfers/reports -v -u {name}:{password}",
33345         "type": "json"
33346       }
33347     ],
33348     "name": "GetTransfer_Reports",
33349     "group": "Voice_Transfer_Reports",
33350     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33351     "version": "0.0.0",
33352     "filename": "server/api/voiceTransferReport/index.js",
33353     "groupTitle": "Voice_Transfer_Reports"
33354   },
33355   {
33356     "type": "get",
33357     "url": "/api/voice/transfers/reports/{id}",
33358     "title": "Gets a single Transfer Report",
33359     "examples": [
33360       {
33361         "title": "Example usage:",
33362         "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password}",
33363         "type": "json"
33364       }
33365     ],
33366     "name": "ShowTransfer_Reports",
33367     "group": "Voice_Transfer_Reports",
33368     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33369     "version": "0.0.0",
33370     "filename": "server/api/voiceTransferReport/index.js",
33371     "groupTitle": "Voice_Transfer_Reports"
33372   },
33373   {
33374     "type": "put",
33375     "url": "/api/voice/transfers/reports/{id}",
33376     "title": "Update an existing Transfer Report",
33377     "examples": [
33378       {
33379         "title": "Example usage:",
33380         "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",
33381         "type": "json"
33382       }
33383     ],
33384     "name": "updateTransfer_Reports",
33385     "group": "Voice_Transfer_Reports",
33386     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33387     "version": "0.0.0",
33388     "filename": "server/api/voiceTransferReport/index.js",
33389     "groupTitle": "Voice_Transfer_Reports"
33390   },
33391   {
33392     "type": "post",
33393     "url": "/api/integrations/vtiger/accounts",
33394     "title": "Creates a new Vtiger Account",
33395     "examples": [
33396       {
33397         "title": "Example usage:",
33398         "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",
33399         "type": "json"
33400       }
33401     ],
33402     "name": "CreateVtiger_Accounts",
33403     "group": "Vtiger_Accounts",
33404     "parameter": {
33405       "fields": {
33406         "Body": [
33407           {
33408             "group": "Body",
33409             "type": "String",
33410             "optional": false,
33411             "field": "name",
33412             "description": ""
33413           },
33414           {
33415             "group": "Body",
33416             "type": "String",
33417             "optional": true,
33418             "field": "description",
33419             "description": ""
33420           },
33421           {
33422             "group": "Body",
33423             "type": "String",
33424             "optional": false,
33425             "field": "username",
33426             "description": ""
33427           },
33428           {
33429             "group": "Body",
33430             "type": "String",
33431             "optional": false,
33432             "field": "moduleName",
33433             "description": ""
33434           },
33435           {
33436             "group": "Body",
33437             "type": "String",
33438             "optional": false,
33439             "field": "remoteUri",
33440             "description": ""
33441           },
33442           {
33443             "group": "Body",
33444             "type": "String",
33445             "optional": false,
33446             "field": "serverUrl",
33447             "description": ""
33448           },
33449           {
33450             "group": "Body",
33451             "type": "String",
33452             "optional": false,
33453             "field": "accessKey",
33454             "description": ""
33455           }
33456         ]
33457       }
33458     },
33459     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33460     "version": "0.0.0",
33461     "filename": "server/api/intVtigerAccount/index.js",
33462     "groupTitle": "Vtiger_Accounts"
33463   },
33464   {
33465     "type": "delete",
33466     "url": "/api/integrations/vtiger/accounts/{id}",
33467     "title": "Deletes a Vtiger Account",
33468     "examples": [
33469       {
33470         "title": "Example usage:",
33471         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password} -X DELETE",
33472         "type": "json"
33473       }
33474     ],
33475     "name": "DeleteVtiger_Accounts",
33476     "group": "Vtiger_Accounts",
33477     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33478     "version": "0.0.0",
33479     "filename": "server/api/intVtigerAccount/index.js",
33480     "groupTitle": "Vtiger_Accounts"
33481   },
33482   {
33483     "type": "get",
33484     "url": "/api/integrations/vtiger/accounts",
33485     "title": "Gets a list of Vtiger Accounts",
33486     "examples": [
33487       {
33488         "title": "Example usage:",
33489         "content": "curl https://{domain}/api/integrations/vtiger/accounts -v -u {name}:{password}",
33490         "type": "json"
33491       }
33492     ],
33493     "name": "GetVtiger_Accounts",
33494     "group": "Vtiger_Accounts",
33495     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33496     "version": "0.0.0",
33497     "filename": "server/api/intVtigerAccount/index.js",
33498     "groupTitle": "Vtiger_Accounts"
33499   },
33500   {
33501     "type": "get",
33502     "url": "/api/integrations/vtiger/accounts/{id}",
33503     "title": "Gets a single Vtiger Account",
33504     "examples": [
33505       {
33506         "title": "Example usage:",
33507         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password}",
33508         "type": "json"
33509       }
33510     ],
33511     "name": "ShowVtiger_Accounts",
33512     "group": "Vtiger_Accounts",
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/intVtigerAccount/index.js",
33516     "groupTitle": "Vtiger_Accounts"
33517   },
33518   {
33519     "type": "post",
33520     "url": "/api/integrations/vtiger/accounts/{id}/configurations",
33521     "title": "Creates new configuration",
33522     "examples": [
33523       {
33524         "title": "Example usage:",
33525         "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",
33526         "type": "json"
33527       }
33528     ],
33529     "name": "addConfiguration",
33530     "group": "Vtiger_Accounts",
33531     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33532     "version": "0.0.0",
33533     "filename": "server/api/intVtigerAccount/index.js",
33534     "groupTitle": "Vtiger_Accounts"
33535   },
33536   {
33537     "type": "get",
33538     "url": "/api/integrations/vtiger/accounts/{id}/configurations",
33539     "title": "Gets account configurations",
33540     "examples": [
33541       {
33542         "title": "Example usage:",
33543         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/configurations -v -u {name}:{password} -X GET",
33544         "type": "json"
33545       }
33546     ],
33547     "name": "getConfigurations",
33548     "group": "Vtiger_Accounts",
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/intVtigerAccount/index.js",
33552     "groupTitle": "Vtiger_Accounts"
33553   },
33554   {
33555     "type": "get",
33556     "url": "/api/integrations/vtiger/accounts/{id}/fields",
33557     "title": "Gets account fields",
33558     "examples": [
33559       {
33560         "title": "Example usage:",
33561         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/fields -v -u {name}:{password} -X GET",
33562         "type": "json"
33563       }
33564     ],
33565     "name": "getFields",
33566     "group": "Vtiger_Accounts",
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/intVtigerAccount/index.js",
33570     "groupTitle": "Vtiger_Accounts"
33571   },
33572   {
33573     "type": "put",
33574     "url": "/api/integrations/vtiger/accounts/{id}",
33575     "title": "Update an existing Vtiger Account",
33576     "examples": [
33577       {
33578         "title": "Example usage:",
33579         "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",
33580         "type": "json"
33581       }
33582     ],
33583     "name": "updateVtiger_Accounts",
33584     "group": "Vtiger_Accounts",
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/intVtigerAccount/index.js",
33588     "groupTitle": "Vtiger_Accounts"
33589   },
33590   {
33591     "type": "post",
33592     "url": "/api/integrations/vtiger/configurations",
33593     "title": "Creates a new Vtiger Configuration",
33594     "examples": [
33595       {
33596         "title": "Example usage:",
33597         "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",
33598         "type": "json"
33599       }
33600     ],
33601     "name": "CreateVtiger_Configurations",
33602     "group": "Vtiger_Configurations",
33603     "parameter": {
33604       "fields": {
33605         "Body": [
33606           {
33607             "group": "Body",
33608             "type": "String",
33609             "optional": true,
33610             "field": "name",
33611             "description": ""
33612           },
33613           {
33614             "group": "Body",
33615             "type": "String",
33616             "optional": true,
33617             "field": "description",
33618             "description": ""
33619           }
33620         ]
33621       }
33622     },
33623     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33624     "version": "0.0.0",
33625     "filename": "server/api/intVtigerConfiguration/index.js",
33626     "groupTitle": "Vtiger_Configurations"
33627   },
33628   {
33629     "type": "delete",
33630     "url": "/api/integrations/vtiger/configurations/{id}",
33631     "title": "Deletes a Vtiger Configuration",
33632     "examples": [
33633       {
33634         "title": "Example usage:",
33635         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password} -X DELETE",
33636         "type": "json"
33637       }
33638     ],
33639     "name": "DeleteVtiger_Configurations",
33640     "group": "Vtiger_Configurations",
33641     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33642     "version": "0.0.0",
33643     "filename": "server/api/intVtigerConfiguration/index.js",
33644     "groupTitle": "Vtiger_Configurations"
33645   },
33646   {
33647     "type": "get",
33648     "url": "/api/integrations/vtiger/configurations",
33649     "title": "Gets a list of Vtiger Configurations",
33650     "examples": [
33651       {
33652         "title": "Example usage:",
33653         "content": "curl https://{domain}/api/integrations/vtiger/configurations -v -u {name}:{password}",
33654         "type": "json"
33655       }
33656     ],
33657     "name": "GetVtiger_Configurations",
33658     "group": "Vtiger_Configurations",
33659     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33660     "version": "0.0.0",
33661     "filename": "server/api/intVtigerConfiguration/index.js",
33662     "groupTitle": "Vtiger_Configurations"
33663   },
33664   {
33665     "type": "get",
33666     "url": "/api/integrations/vtiger/configurations/{id}",
33667     "title": "Gets a single Vtiger Configuration",
33668     "examples": [
33669       {
33670         "title": "Example usage:",
33671         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password}",
33672         "type": "json"
33673       }
33674     ],
33675     "name": "ShowVtiger_Configurations",
33676     "group": "Vtiger_Configurations",
33677     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33678     "version": "0.0.0",
33679     "filename": "server/api/intVtigerConfiguration/index.js",
33680     "groupTitle": "Vtiger_Configurations"
33681   },
33682   {
33683     "type": "get",
33684     "url": "/api/integrations/vtiger/configurations/{id}/descriptions",
33685     "title": "Gets configurations descriptions",
33686     "examples": [
33687       {
33688         "title": "Example usage:",
33689         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
33690         "type": "json"
33691       }
33692     ],
33693     "name": "getDescriptions",
33694     "group": "Vtiger_Configurations",
33695     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33696     "version": "0.0.0",
33697     "filename": "server/api/intVtigerConfiguration/index.js",
33698     "groupTitle": "Vtiger_Configurations"
33699   },
33700   {
33701     "type": "get",
33702     "url": "/api/integrations/vtiger/configurations/{id}/fields",
33703     "title": "Gets configurations fields",
33704     "examples": [
33705       {
33706         "title": "Example usage:",
33707         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/fields -v -u {name}:{password} -X GET",
33708         "type": "json"
33709       }
33710     ],
33711     "name": "getFields",
33712     "group": "Vtiger_Configurations",
33713     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33714     "version": "0.0.0",
33715     "filename": "server/api/intVtigerConfiguration/index.js",
33716     "groupTitle": "Vtiger_Configurations"
33717   },
33718   {
33719     "type": "get",
33720     "url": "/api/integrations/vtiger/configurations/{id}/subjects",
33721     "title": "Gets configurations subjects",
33722     "examples": [
33723       {
33724         "title": "Example usage:",
33725         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/subjects -v -u {name}:{password} -X GET",
33726         "type": "json"
33727       }
33728     ],
33729     "name": "getSubjects",
33730     "group": "Vtiger_Configurations",
33731     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33732     "version": "0.0.0",
33733     "filename": "server/api/intVtigerConfiguration/index.js",
33734     "groupTitle": "Vtiger_Configurations"
33735   },
33736   {
33737     "type": "put",
33738     "url": "/api/integrations/vtiger/configurations/{id}",
33739     "title": "Update an existing Vtiger Configuration",
33740     "examples": [
33741       {
33742         "title": "Example usage:",
33743         "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",
33744         "type": "json"
33745       }
33746     ],
33747     "name": "updateVtiger_Configurations",
33748     "group": "Vtiger_Configurations",
33749     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33750     "version": "0.0.0",
33751     "filename": "server/api/intVtigerConfiguration/index.js",
33752     "groupTitle": "Vtiger_Configurations"
33753   },
33754   {
33755     "type": "post",
33756     "url": "/api/integrations/vtiger/fields",
33757     "title": "Creates a new Vtiger Field",
33758     "examples": [
33759       {
33760         "title": "Example usage:",
33761         "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",
33762         "type": "json"
33763       }
33764     ],
33765     "name": "CreateVtiger_Fields",
33766     "group": "Vtiger_Fields",
33767     "parameter": {
33768       "fields": {
33769         "Body": [
33770           {
33771             "group": "Body",
33772             "type": "String",
33773             "allowedValues": [
33774               "\"string\"",
33775               "\"variable\"",
33776               "\"customVariable\"",
33777               "\"keyValue\""
33778             ],
33779             "optional": true,
33780             "field": "type",
33781             "description": ""
33782           },
33783           {
33784             "group": "Body",
33785             "type": "String",
33786             "optional": true,
33787             "field": "content",
33788             "description": ""
33789           },
33790           {
33791             "group": "Body",
33792             "type": "String",
33793             "optional": true,
33794             "field": "key",
33795             "description": ""
33796           },
33797           {
33798             "group": "Body",
33799             "type": "String",
33800             "allowedValues": [
33801               "\"string\"",
33802               "\"variable\"",
33803               "\"customVariable\""
33804             ],
33805             "optional": true,
33806             "field": "keyType",
33807             "description": ""
33808           },
33809           {
33810             "group": "Body",
33811             "type": "String",
33812             "optional": true,
33813             "field": "keyContent",
33814             "description": ""
33815           },
33816           {
33817             "group": "Body",
33818             "type": "String",
33819             "optional": true,
33820             "field": "idField",
33821             "description": ""
33822           },
33823           {
33824             "group": "Body",
33825             "type": "String",
33826             "optional": true,
33827             "field": "nameField",
33828             "description": ""
33829           },
33830           {
33831             "group": "Body",
33832             "type": "Boolean",
33833             "optional": true,
33834             "field": "customField",
33835             "description": ""
33836           },
33837           {
33838             "group": "Body",
33839             "type": "String",
33840             "optional": true,
33841             "field": "variableName",
33842             "description": ""
33843           }
33844         ]
33845       }
33846     },
33847     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33848     "version": "0.0.0",
33849     "filename": "server/api/intVtigerField/index.js",
33850     "groupTitle": "Vtiger_Fields"
33851   },
33852   {
33853     "type": "delete",
33854     "url": "/api/integrations/vtiger/fields/{id}",
33855     "title": "Deletes a Vtiger Field",
33856     "examples": [
33857       {
33858         "title": "Example usage:",
33859         "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password} -X DELETE",
33860         "type": "json"
33861       }
33862     ],
33863     "name": "DeleteVtiger_Fields",
33864     "group": "Vtiger_Fields",
33865     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33866     "version": "0.0.0",
33867     "filename": "server/api/intVtigerField/index.js",
33868     "groupTitle": "Vtiger_Fields"
33869   },
33870   {
33871     "type": "get",
33872     "url": "/api/integrations/vtiger/fields",
33873     "title": "Gets a list of Vtiger Fields",
33874     "examples": [
33875       {
33876         "title": "Example usage:",
33877         "content": "curl https://{domain}/api/integrations/vtiger/fields -v -u {name}:{password}",
33878         "type": "json"
33879       }
33880     ],
33881     "name": "GetVtiger_Fields",
33882     "group": "Vtiger_Fields",
33883     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33884     "version": "0.0.0",
33885     "filename": "server/api/intVtigerField/index.js",
33886     "groupTitle": "Vtiger_Fields"
33887   },
33888   {
33889     "type": "get",
33890     "url": "/api/integrations/vtiger/fields/{id}",
33891     "title": "Gets a single Vtiger Field",
33892     "examples": [
33893       {
33894         "title": "Example usage:",
33895         "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password}",
33896         "type": "json"
33897       }
33898     ],
33899     "name": "ShowVtiger_Fields",
33900     "group": "Vtiger_Fields",
33901     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33902     "version": "0.0.0",
33903     "filename": "server/api/intVtigerField/index.js",
33904     "groupTitle": "Vtiger_Fields"
33905   },
33906   {
33907     "type": "put",
33908     "url": "/api/integrations/vtiger/fields/{id}",
33909     "title": "Update an existing Vtiger Field",
33910     "examples": [
33911       {
33912         "title": "Example usage:",
33913         "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",
33914         "type": "json"
33915       }
33916     ],
33917     "name": "updateVtiger_Fields",
33918     "group": "Vtiger_Fields",
33919     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33920     "version": "0.0.0",
33921     "filename": "server/api/intVtigerField/index.js",
33922     "groupTitle": "Vtiger_Fields"
33923   },
33924   {
33925     "type": "post",
33926     "url": "/api/webbar/answer",
33927     "title": "answer webrtc call",
33928     "examples": [
33929       {
33930         "title": "Example usage:",
33931         "content": "curl https://{domain}/api/webbar/answer -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
33932         "type": "json"
33933       }
33934     ],
33935     "name": "Web_Bar_answer",
33936     "group": "WebBar",
33937     "parameter": {
33938       "fields": {
33939         "Body": [
33940           {
33941             "group": "Body",
33942             "type": "String",
33943             "optional": false,
33944             "field": "sessionId",
33945             "description": ""
33946           },
33947           {
33948             "group": "Body",
33949             "type": "number",
33950             "optional": false,
33951             "field": "userId",
33952             "description": ""
33953           }
33954         ]
33955       }
33956     },
33957     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33958     "version": "0.0.0",
33959     "filename": "server/api/webbar/index.js",
33960     "groupTitle": "WebBar"
33961   },
33962   {
33963     "type": "post",
33964     "url": "/api/webbar/calls",
33965     "title": "webrtc call list",
33966     "examples": [
33967       {
33968         "title": "Example usage:",
33969         "content": "curl https://{domain}/api/webbar/calls -d '{\"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
33970         "type": "json"
33971       }
33972     ],
33973     "name": "Web_Bar_calls",
33974     "group": "WebBar",
33975     "parameter": {
33976       "fields": {
33977         "Body": [
33978           {
33979             "group": "Body",
33980             "type": "number",
33981             "optional": false,
33982             "field": "userId",
33983             "description": ""
33984           }
33985         ]
33986       }
33987     },
33988     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33989     "version": "0.0.0",
33990     "filename": "server/api/webbar/index.js",
33991     "groupTitle": "WebBar"
33992   },
33993   {
33994     "type": "post",
33995     "url": "/api/webbar/hangup",
33996     "title": "hangup webrtc call",
33997     "examples": [
33998       {
33999         "title": "Example usage:",
34000         "content": "curl https://{domain}/api/webbar/hangup -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34001         "type": "json"
34002       }
34003     ],
34004     "name": "Web_Bar_hangup",
34005     "group": "WebBar",
34006     "parameter": {
34007       "fields": {
34008         "Body": [
34009           {
34010             "group": "Body",
34011             "type": "String",
34012             "optional": false,
34013             "field": "sessionId",
34014             "description": ""
34015           },
34016           {
34017             "group": "Body",
34018             "type": "number",
34019             "optional": false,
34020             "field": "userId",
34021             "description": ""
34022           }
34023         ]
34024       }
34025     },
34026     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34027     "version": "0.0.0",
34028     "filename": "server/api/webbar/index.js",
34029     "groupTitle": "WebBar"
34030   },
34031   {
34032     "type": "post",
34033     "url": "/api/webbar/unhold",
34034     "title": "unhold webrtc call",
34035     "examples": [
34036       {
34037         "title": "Example usage:",
34038         "content": "curl https://{domain}/api/webbar/unhold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34039         "type": "json"
34040       }
34041     ],
34042     "name": "Web_Bar_hold",
34043     "group": "WebBar",
34044     "parameter": {
34045       "fields": {
34046         "Body": [
34047           {
34048             "group": "Body",
34049             "type": "String",
34050             "optional": false,
34051             "field": "sessionId",
34052             "description": ""
34053           },
34054           {
34055             "group": "Body",
34056             "type": "number",
34057             "optional": false,
34058             "field": "userId",
34059             "description": ""
34060           }
34061         ]
34062       }
34063     },
34064     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34065     "version": "0.0.0",
34066     "filename": "server/api/webbar/index.js",
34067     "groupTitle": "WebBar"
34068   },
34069   {
34070     "type": "post",
34071     "url": "/api/webbar/hold",
34072     "title": "hold webrtc call",
34073     "examples": [
34074       {
34075         "title": "Example usage:",
34076         "content": "curl https://{domain}/api/webbar/hold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34077         "type": "json"
34078       }
34079     ],
34080     "name": "Web_Bar_hold",
34081     "group": "WebBar",
34082     "parameter": {
34083       "fields": {
34084         "Body": [
34085           {
34086             "group": "Body",
34087             "type": "String",
34088             "optional": true,
34089             "field": "sessionId",
34090             "description": ""
34091           },
34092           {
34093             "group": "Body",
34094             "type": "number",
34095             "optional": false,
34096             "field": "userId",
34097             "description": ""
34098           }
34099         ]
34100       }
34101     },
34102     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34103     "version": "0.0.0",
34104     "filename": "server/api/webbar/index.js",
34105     "groupTitle": "WebBar"
34106   },
34107   {
34108     "type": "post",
34109     "url": "/api/webbar/originate",
34110     "title": "Originate new webrtc call",
34111     "examples": [
34112       {
34113         "title": "Example usage:",
34114         "content": "curl https://{domain}/api/webbar/originate -d '{\"callNumber\": \"0119692844\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34115         "type": "json"
34116       }
34117     ],
34118     "name": "Web_Bar_originate",
34119     "group": "WebBar",
34120     "parameter": {
34121       "fields": {
34122         "Body": [
34123           {
34124             "group": "Body",
34125             "type": "String",
34126             "optional": false,
34127             "field": "callNumber",
34128             "description": ""
34129           },
34130           {
34131             "group": "Body",
34132             "type": "number",
34133             "optional": false,
34134             "field": "userId",
34135             "description": ""
34136           },
34137           {
34138             "group": "Body",
34139             "type": "String",
34140             "optional": false,
34141             "field": "callerId",
34142             "description": ""
34143           },
34144           {
34145             "group": "Body",
34146             "type": "String",
34147             "optional": false,
34148             "field": "callbackUrl",
34149             "description": ""
34150           }
34151         ]
34152       }
34153     },
34154     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34155     "version": "0.0.0",
34156     "filename": "server/api/webbar/index.js",
34157     "groupTitle": "WebBar"
34158   },
34159   {
34160     "type": "post",
34161     "url": "/api/webbar/transfer",
34162     "title": "blind transfer webrtc call",
34163     "examples": [
34164       {
34165         "title": "Example usage:",
34166         "content": "curl https://{domain}/api/webbar/transfer -d '{\"userId\": 54, \"sessionId\":\"<sessionId>\", \"transferNumber\":\"<transferNumber>\"}' \\\n -H \"Content-Type: application/json\" -X POST",
34167         "type": "json"
34168       }
34169     ],
34170     "name": "Web_Bar_transfer",
34171     "group": "WebBar",
34172     "parameter": {
34173       "fields": {
34174         "Body": [
34175           {
34176             "group": "Body",
34177             "type": "number",
34178             "optional": false,
34179             "field": "userId",
34180             "description": ""
34181           },
34182           {
34183             "group": "Body",
34184             "type": "string",
34185             "optional": false,
34186             "field": "sessionId",
34187             "description": ""
34188           },
34189           {
34190             "group": "Body",
34191             "type": "string",
34192             "optional": false,
34193             "field": "transferNumber",
34194             "description": ""
34195           }
34196         ]
34197       }
34198     },
34199     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34200     "version": "0.0.0",
34201     "filename": "server/api/webbar/index.js",
34202     "groupTitle": "WebBar"
34203   },
34204   {
34205     "type": "post",
34206     "url": "/api/whatsapp/accounts/{id}/users",
34207     "title": "Add agents to a whatsapp account",
34208     "examples": [
34209       {
34210         "title": "Example usage:",
34211         "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",
34212         "type": "json"
34213       }
34214     ],
34215     "name": "AddAgents",
34216     "group": "Whatsapp_Accounts",
34217     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34218     "version": "0.0.0",
34219     "filename": "server/api/whatsappAccount/index.js",
34220     "groupTitle": "Whatsapp_Accounts"
34221   },
34222   {
34223     "type": "post",
34224     "url": "/api/whatsapp/accounts",
34225     "title": "Creates a new Account",
34226     "examples": [
34227       {
34228         "title": "Example usage:",
34229         "content": "curl https://{domain}/api/whatsapp/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
34230         "type": "json"
34231       }
34232     ],
34233     "name": "CreateAccounts",
34234     "group": "Whatsapp_Accounts",
34235     "parameter": {
34236       "fields": {
34237         "Body": [
34238           {
34239             "group": "Body",
34240             "type": "String",
34241             "optional": false,
34242             "field": "name",
34243             "description": ""
34244           },
34245           {
34246             "group": "Body",
34247             "type": "String",
34248             "optional": false,
34249             "field": "key",
34250             "description": ""
34251           },
34252           {
34253             "group": "Body",
34254             "type": "String",
34255             "optional": false,
34256             "field": "remote",
34257             "description": ""
34258           },
34259           {
34260             "group": "Body",
34261             "type": "String",
34262             "optional": true,
34263             "field": "token",
34264             "description": ""
34265           },
34266           {
34267             "group": "Body",
34268             "type": "String",
34269             "optional": true,
34270             "field": "phone",
34271             "description": ""
34272           },
34273           {
34274             "group": "Body",
34275             "type": "String",
34276             "allowedValues": [
34277               "\"twilio\""
34278             ],
34279             "optional": true,
34280             "field": "type",
34281             "description": ""
34282           },
34283           {
34284             "group": "Body",
34285             "type": "String",
34286             "optional": true,
34287             "field": "accountSid",
34288             "description": ""
34289           },
34290           {
34291             "group": "Body",
34292             "type": "String",
34293             "optional": true,
34294             "field": "authToken",
34295             "description": ""
34296           },
34297           {
34298             "group": "Body",
34299             "type": "Text",
34300             "optional": true,
34301             "field": "notificationTemplate",
34302             "description": ""
34303           },
34304           {
34305             "group": "Body",
34306             "type": "Boolean",
34307             "optional": true,
34308             "field": "notificationSound",
34309             "description": ""
34310           },
34311           {
34312             "group": "Body",
34313             "type": "Boolean",
34314             "optional": true,
34315             "field": "notificationShake",
34316             "description": ""
34317           },
34318           {
34319             "group": "Body",
34320             "type": "Integer",
34321             "optional": true,
34322             "field": "waitForTheAssignedAgent",
34323             "description": ""
34324           },
34325           {
34326             "group": "Body",
34327             "type": "Boolean",
34328             "optional": true,
34329             "field": "queueTransfer",
34330             "description": ""
34331           },
34332           {
34333             "group": "Body",
34334             "type": "Integer",
34335             "optional": true,
34336             "field": "queueTransferTimeout",
34337             "description": ""
34338           },
34339           {
34340             "group": "Body",
34341             "type": "Boolean",
34342             "optional": true,
34343             "field": "agentTransfer",
34344             "description": ""
34345           },
34346           {
34347             "group": "Body",
34348             "type": "Integer",
34349             "optional": true,
34350             "field": "agentTransferTimeout",
34351             "description": ""
34352           },
34353           {
34354             "group": "Body",
34355             "type": "Integer",
34356             "optional": true,
34357             "field": "mandatoryDispositionPauseId",
34358             "description": "<p>Status to put when mandatory disposition is enabled</p>"
34359           },
34360           {
34361             "group": "Body",
34362             "type": "Boolean",
34363             "optional": true,
34364             "field": "mandatoryDisposition",
34365             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
34366           },
34367           {
34368             "group": "Body",
34369             "type": "String",
34370             "optional": true,
34371             "field": "description",
34372             "description": ""
34373           }
34374         ]
34375       }
34376     },
34377     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34378     "version": "0.0.0",
34379     "filename": "server/api/whatsappAccount/index.js",
34380     "groupTitle": "Whatsapp_Accounts"
34381   },
34382   {
34383     "type": "delete",
34384     "url": "/api/whatsapp/accounts/{id}",
34385     "title": "Deletes a Account",
34386     "examples": [
34387       {
34388         "title": "Example usage:",
34389         "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password} -X DELETE",
34390         "type": "json"
34391       }
34392     ],
34393     "name": "DeleteAccounts",
34394     "group": "Whatsapp_Accounts",
34395     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34396     "version": "0.0.0",
34397     "filename": "server/api/whatsappAccount/index.js",
34398     "groupTitle": "Whatsapp_Accounts"
34399   },
34400   {
34401     "type": "get",
34402     "url": "/api/whatsapp/accounts/describe",
34403     "title": "Gets table info about Accounts",
34404     "examples": [
34405       {
34406         "title": "Example usage:",
34407         "content": "curl https://{domain}/api/whatsapp/accounts/describe -v -u {name}:{password}",
34408         "type": "json"
34409       }
34410     ],
34411     "name": "DescribeAccounts",
34412     "group": "Whatsapp_Accounts",
34413     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34414     "version": "0.0.0",
34415     "filename": "server/api/whatsappAccount/index.js",
34416     "groupTitle": "Whatsapp_Accounts"
34417   },
34418   {
34419     "type": "get",
34420     "url": "/api/whatsapp/accounts",
34421     "title": "Gets a list of Accounts",
34422     "examples": [
34423       {
34424         "title": "Example usage:",
34425         "content": "curl https://{domain}/api/whatsapp/accounts -v -u {name}:{password}",
34426         "type": "json"
34427       }
34428     ],
34429     "name": "GetAccounts",
34430     "group": "Whatsapp_Accounts",
34431     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34432     "version": "0.0.0",
34433     "filename": "server/api/whatsappAccount/index.js",
34434     "groupTitle": "Whatsapp_Accounts"
34435   },
34436   {
34437     "type": "get",
34438     "url": "/api/whatsapp/accounts/{id}/users",
34439     "title": "Gets agents from whatsapp account",
34440     "examples": [
34441       {
34442         "title": "Example usage:",
34443         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users -v -u {name}:{password} -X GET",
34444         "type": "json"
34445       }
34446     ],
34447     "name": "GetAgents",
34448     "group": "Whatsapp_Accounts",
34449     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34450     "version": "0.0.0",
34451     "filename": "server/api/whatsappAccount/index.js",
34452     "groupTitle": "Whatsapp_Accounts"
34453   },
34454   {
34455     "type": "delete",
34456     "url": "/api/whatsapp/accounts/{id}/users",
34457     "title": "Removes agents from a whatsapp account",
34458     "examples": [
34459       {
34460         "title": "Example usage:",
34461         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
34462         "type": "json"
34463       }
34464     ],
34465     "name": "RemoveAgents",
34466     "group": "Whatsapp_Accounts",
34467     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34468     "version": "0.0.0",
34469     "filename": "server/api/whatsappAccount/index.js",
34470     "groupTitle": "Whatsapp_Accounts"
34471   },
34472   {
34473     "type": "delete",
34474     "url": "/api/whatsapp/accounts/{id}/canned_answers",
34475     "title": "Removes canned answers from account",
34476     "examples": [
34477       {
34478         "title": "Example usage:",
34479         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
34480         "type": "json"
34481       }
34482     ],
34483     "name": "RemoveAnswers",
34484     "group": "Whatsapp_Accounts",
34485     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34486     "version": "0.0.0",
34487     "filename": "server/api/whatsappAccount/index.js",
34488     "groupTitle": "Whatsapp_Accounts"
34489   },
34490   {
34491     "type": "delete",
34492     "url": "/api/whatsapp/accounts/{id}/dispositions",
34493     "title": "Removes dispositions from account",
34494     "examples": [
34495       {
34496         "title": "Example usage:",
34497         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
34498         "type": "json"
34499       }
34500     ],
34501     "name": "RemoveDispositions",
34502     "group": "Whatsapp_Accounts",
34503     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34504     "version": "0.0.0",
34505     "filename": "server/api/whatsappAccount/index.js",
34506     "groupTitle": "Whatsapp_Accounts"
34507   },
34508   {
34509     "type": "get",
34510     "url": "/api/whatsapp/accounts/{id}",
34511     "title": "Gets a single Account",
34512     "examples": [
34513       {
34514         "title": "Example usage:",
34515         "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password}",
34516         "type": "json"
34517       }
34518     ],
34519     "name": "ShowAccounts",
34520     "group": "Whatsapp_Accounts",
34521     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34522     "version": "0.0.0",
34523     "filename": "server/api/whatsappAccount/index.js",
34524     "groupTitle": "Whatsapp_Accounts"
34525   },
34526   {
34527     "type": "put",
34528     "url": "/api/whatsapp/messages/{id}/accept",
34529     "title": "Accepts message",
34530     "examples": [
34531       {
34532         "title": "Example usage:",
34533         "content": "curl https://{domain}/api/whatsapp/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
34534         "type": "json"
34535       }
34536     ],
34537     "name": "acceptMessage",
34538     "group": "Whatsapp_Accounts",
34539     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34540     "version": "0.0.0",
34541     "filename": "server/api/whatsappMessage/index.js",
34542     "groupTitle": "Whatsapp_Accounts"
34543   },
34544   {
34545     "type": "post",
34546     "url": "/api/whatsapp/accounts/{id}/canned_answers",
34547     "title": "Creates new canned answer",
34548     "examples": [
34549       {
34550         "title": "Example usage:",
34551         "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",
34552         "type": "json"
34553       }
34554     ],
34555     "name": "addAnswer",
34556     "group": "Whatsapp_Accounts",
34557     "parameter": {
34558       "fields": {
34559         "Body": [
34560           {
34561             "group": "Body",
34562             "type": "String",
34563             "optional": false,
34564             "field": "key",
34565             "description": ""
34566           },
34567           {
34568             "group": "Body",
34569             "type": "Text",
34570             "optional": false,
34571             "field": "value",
34572             "description": ""
34573           },
34574           {
34575             "group": "Body",
34576             "type": "String",
34577             "optional": true,
34578             "field": "description",
34579             "description": ""
34580           },
34581           {
34582             "group": "Body",
34583             "type": "Virtual",
34584             "optional": true,
34585             "field": "name",
34586             "description": ""
34587           }
34588         ]
34589       }
34590     },
34591     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34592     "version": "0.0.0",
34593     "filename": "server/api/whatsappAccount/index.js",
34594     "groupTitle": "Whatsapp_Accounts"
34595   },
34596   {
34597     "type": "post",
34598     "url": "/api/whatsapp/accounts/{id}/applications",
34599     "title": "Creates new applications",
34600     "examples": [
34601       {
34602         "title": "Example usage:",
34603         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
34604         "type": "json"
34605       }
34606     ],
34607     "name": "addApplications",
34608     "group": "Whatsapp_Accounts",
34609     "parameter": {
34610       "fields": {
34611         "Body": [
34612           {
34613             "group": "Body",
34614             "type": "Integer",
34615             "optional": false,
34616             "field": "priority",
34617             "description": ""
34618           },
34619           {
34620             "group": "Body",
34621             "type": "String",
34622             "optional": false,
34623             "field": "app",
34624             "description": ""
34625           },
34626           {
34627             "group": "Body",
34628             "type": "Text",
34629             "optional": true,
34630             "field": "appdata",
34631             "description": ""
34632           },
34633           {
34634             "group": "Body",
34635             "type": "String",
34636             "optional": true,
34637             "field": "description",
34638             "description": ""
34639           },
34640           {
34641             "group": "Body",
34642             "type": "String",
34643             "optional": true,
34644             "field": "interval",
34645             "description": ""
34646           }
34647         ]
34648       }
34649     },
34650     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34651     "version": "0.0.0",
34652     "filename": "server/api/whatsappAccount/index.js",
34653     "groupTitle": "Whatsapp_Accounts"
34654   },
34655   {
34656     "type": "post",
34657     "url": "/api/whatsapp/accounts/{id}/dispositions",
34658     "title": "Creates new disposition",
34659     "examples": [
34660       {
34661         "title": "Example usage:",
34662         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
34663         "type": "json"
34664       }
34665     ],
34666     "name": "addDisposition",
34667     "group": "Whatsapp_Accounts",
34668     "parameter": {
34669       "fields": {
34670         "Body": [
34671           {
34672             "group": "Body",
34673             "type": "String",
34674             "optional": false,
34675             "field": "name",
34676             "description": ""
34677           },
34678           {
34679             "group": "Body",
34680             "type": "String",
34681             "allowedValues": [
34682               "\"first\"",
34683               "\"second\"",
34684               "\"third\""
34685             ],
34686             "optional": false,
34687             "field": "level",
34688             "description": ""
34689           },
34690           {
34691             "group": "Body",
34692             "type": "String",
34693             "optional": true,
34694             "field": "description",
34695             "description": ""
34696           }
34697         ]
34698       }
34699     },
34700     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34701     "version": "0.0.0",
34702     "filename": "server/api/whatsappAccount/index.js",
34703     "groupTitle": "Whatsapp_Accounts"
34704   },
34705   {
34706     "type": "get",
34707     "url": "/api/whatsapp/accounts/{id}/canned_answers",
34708     "title": "Gets account canned answers",
34709     "examples": [
34710       {
34711         "title": "Example usage:",
34712         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
34713         "type": "json"
34714       }
34715     ],
34716     "name": "getAnswers",
34717     "group": "Whatsapp_Accounts",
34718     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34719     "version": "0.0.0",
34720     "filename": "server/api/whatsappAccount/index.js",
34721     "groupTitle": "Whatsapp_Accounts"
34722   },
34723   {
34724     "type": "get",
34725     "url": "/api/whatsapp/accounts/{id}/applications",
34726     "title": "Gets account applications",
34727     "examples": [
34728       {
34729         "title": "Example usage:",
34730         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -v -u {name}:{password} -X GET",
34731         "type": "json"
34732       }
34733     ],
34734     "name": "getApplications",
34735     "group": "Whatsapp_Accounts",
34736     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34737     "version": "0.0.0",
34738     "filename": "server/api/whatsappAccount/index.js",
34739     "groupTitle": "Whatsapp_Accounts"
34740   },
34741   {
34742     "type": "get",
34743     "url": "/api/whatsapp/accounts/{id}/dispositions",
34744     "title": "Gets account dispositions",
34745     "examples": [
34746       {
34747         "title": "Example usage:",
34748         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
34749         "type": "json"
34750       }
34751     ],
34752     "name": "getDispositions",
34753     "group": "Whatsapp_Accounts",
34754     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34755     "version": "0.0.0",
34756     "filename": "server/api/whatsappAccount/index.js",
34757     "groupTitle": "Whatsapp_Accounts"
34758   },
34759   {
34760     "type": "post",
34761     "url": "/api/whatsapp/accounts/{id}/notify",
34762     "title": "Notify new message",
34763     "examples": [
34764       {
34765         "title": "Example usage:",
34766         "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",
34767         "type": "json"
34768       }
34769     ],
34770     "name": "notify",
34771     "group": "Whatsapp_Accounts",
34772     "description": "<p>Motion 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>",
34773     "version": "0.0.0",
34774     "filename": "server/api/whatsappAccount/index.js",
34775     "groupTitle": "Whatsapp_Accounts"
34776   },
34777   {
34778     "type": "put",
34779     "url": "/api/whatsapp/messages/{id}/reject",
34780     "title": "Rejects message",
34781     "examples": [
34782       {
34783         "title": "Example usage:",
34784         "content": "curl https://{domain}/api/whatsapp/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
34785         "type": "json"
34786       }
34787     ],
34788     "name": "rejectMessage",
34789     "group": "Whatsapp_Accounts",
34790     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34791     "version": "0.0.0",
34792     "filename": "server/api/whatsappMessage/index.js",
34793     "groupTitle": "Whatsapp_Accounts"
34794   },
34795   {
34796     "type": "post",
34797     "url": "/api/whatsapp/accounts/{id}/send",
34798     "title": "Send new whatsapp message",
34799     "examples": [
34800       {
34801         "title": "Example usage:",
34802         "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",
34803         "type": "json"
34804       }
34805     ],
34806     "name": "sendWhatsapp",
34807     "group": "Whatsapp_Accounts",
34808     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34809     "version": "0.0.0",
34810     "filename": "server/api/whatsappAccount/index.js",
34811     "groupTitle": "Whatsapp_Accounts"
34812   },
34813   {
34814     "type": "post",
34815     "url": "/api/whatsapp/messages/{id}/status",
34816     "title": "Receive message status",
34817     "examples": [
34818       {
34819         "title": "Example usage:",
34820         "content": "curl https://{domain}/api/whatsapp/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
34821         "type": "json"
34822       }
34823     ],
34824     "name": "statusMessage",
34825     "group": "Whatsapp_Accounts",
34826     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34827     "version": "0.0.0",
34828     "filename": "server/api/whatsappMessage/index.js",
34829     "groupTitle": "Whatsapp_Accounts"
34830   },
34831   {
34832     "type": "put",
34833     "url": "/api/whatsapp/accounts/{id}",
34834     "title": "Update an existing Account",
34835     "examples": [
34836       {
34837         "title": "Example usage:",
34838         "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",
34839         "type": "json"
34840       }
34841     ],
34842     "name": "updateAccounts",
34843     "group": "Whatsapp_Accounts",
34844     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34845     "version": "0.0.0",
34846     "filename": "server/api/whatsappAccount/index.js",
34847     "groupTitle": "Whatsapp_Accounts"
34848   },
34849   {
34850     "type": "post",
34851     "url": "/api/whatsapp/applications",
34852     "title": "Creates a new Application",
34853     "examples": [
34854       {
34855         "title": "Example usage:",
34856         "content": "curl https://{domain}/api/whatsapp/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
34857         "type": "json"
34858       }
34859     ],
34860     "name": "CreateApplications",
34861     "group": "Whatsapp_Applications",
34862     "parameter": {
34863       "fields": {
34864         "Body": [
34865           {
34866             "group": "Body",
34867             "type": "Integer",
34868             "optional": false,
34869             "field": "priority",
34870             "description": ""
34871           },
34872           {
34873             "group": "Body",
34874             "type": "String",
34875             "optional": false,
34876             "field": "app",
34877             "description": ""
34878           },
34879           {
34880             "group": "Body",
34881             "type": "Text",
34882             "optional": true,
34883             "field": "appdata",
34884             "description": ""
34885           },
34886           {
34887             "group": "Body",
34888             "type": "String",
34889             "optional": true,
34890             "field": "description",
34891             "description": ""
34892           },
34893           {
34894             "group": "Body",
34895             "type": "String",
34896             "optional": true,
34897             "field": "interval",
34898             "description": ""
34899           }
34900         ]
34901       }
34902     },
34903     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34904     "version": "0.0.0",
34905     "filename": "server/api/whatsappApplication/index.js",
34906     "groupTitle": "Whatsapp_Applications"
34907   },
34908   {
34909     "type": "delete",
34910     "url": "/api/whatsapp/applications/{id}",
34911     "title": "Deletes a Application",
34912     "examples": [
34913       {
34914         "title": "Example usage:",
34915         "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password} -X DELETE",
34916         "type": "json"
34917       }
34918     ],
34919     "name": "DeleteApplications",
34920     "group": "Whatsapp_Applications",
34921     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34922     "version": "0.0.0",
34923     "filename": "server/api/whatsappApplication/index.js",
34924     "groupTitle": "Whatsapp_Applications"
34925   },
34926   {
34927     "type": "get",
34928     "url": "/api/whatsapp/applications",
34929     "title": "Gets a list of Applications",
34930     "examples": [
34931       {
34932         "title": "Example usage:",
34933         "content": "curl https://{domain}/api/whatsapp/applications -v -u {name}:{password}",
34934         "type": "json"
34935       }
34936     ],
34937     "name": "GetApplications",
34938     "group": "Whatsapp_Applications",
34939     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34940     "version": "0.0.0",
34941     "filename": "server/api/whatsappApplication/index.js",
34942     "groupTitle": "Whatsapp_Applications"
34943   },
34944   {
34945     "type": "get",
34946     "url": "/api/whatsapp/applications/{id}",
34947     "title": "Gets a single Application",
34948     "examples": [
34949       {
34950         "title": "Example usage:",
34951         "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password}",
34952         "type": "json"
34953       }
34954     ],
34955     "name": "ShowApplications",
34956     "group": "Whatsapp_Applications",
34957     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34958     "version": "0.0.0",
34959     "filename": "server/api/whatsappApplication/index.js",
34960     "groupTitle": "Whatsapp_Applications"
34961   },
34962   {
34963     "type": "put",
34964     "url": "/api/whatsapp/applications/{id}",
34965     "title": "Update an existing Application",
34966     "examples": [
34967       {
34968         "title": "Example usage:",
34969         "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",
34970         "type": "json"
34971       }
34972     ],
34973     "name": "updateApplications",
34974     "group": "Whatsapp_Applications",
34975     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34976     "version": "0.0.0",
34977     "filename": "server/api/whatsappApplication/index.js",
34978     "groupTitle": "Whatsapp_Applications"
34979   },
34980   {
34981     "type": "post",
34982     "url": "/api/whatsapp/interactions/{id}/tags",
34983     "title": "Add tags to the interaction",
34984     "examples": [
34985       {
34986         "title": "Example usage:",
34987         "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",
34988         "type": "json"
34989       }
34990     ],
34991     "name": "AddTags",
34992     "group": "Whatsapp_Interactions",
34993     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34994     "version": "0.0.0",
34995     "filename": "server/api/whatsappInteraction/index.js",
34996     "groupTitle": "Whatsapp_Interactions"
34997   },
34998   {
34999     "type": "post",
35000     "url": "/api/whatsapp/interactions",
35001     "title": "Creates a new Interaction",
35002     "examples": [
35003       {
35004         "title": "Example usage:",
35005         "content": "curl https://{domain}/api/whatsapp/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35006         "type": "json"
35007       }
35008     ],
35009     "name": "CreateInteractions",
35010     "group": "Whatsapp_Interactions",
35011     "parameter": {
35012       "fields": {
35013         "Body": [
35014           {
35015             "group": "Body",
35016             "type": "Boolean",
35017             "optional": true,
35018             "field": "closed",
35019             "description": ""
35020           },
35021           {
35022             "group": "Body",
35023             "type": "String",
35024             "optional": true,
35025             "field": "closedAt",
35026             "description": ""
35027           },
35028           {
35029             "group": "Body",
35030             "type": "String",
35031             "optional": true,
35032             "field": "disposition",
35033             "description": ""
35034           },
35035           {
35036             "group": "Body",
35037             "type": "String",
35038             "optional": true,
35039             "field": "secondDisposition",
35040             "description": ""
35041           },
35042           {
35043             "group": "Body",
35044             "type": "String",
35045             "optional": true,
35046             "field": "thirdDisposition",
35047             "description": ""
35048           },
35049           {
35050             "group": "Body",
35051             "type": "String",
35052             "optional": true,
35053             "field": "note",
35054             "description": ""
35055           },
35056           {
35057             "group": "Body",
35058             "type": "String",
35059             "optional": true,
35060             "field": "phone",
35061             "description": ""
35062           },
35063           {
35064             "group": "Body",
35065             "type": "String",
35066             "optional": true,
35067             "field": "read1stAt",
35068             "description": ""
35069           },
35070           {
35071             "group": "Body",
35072             "type": "String",
35073             "allowedValues": [
35074               "\"in\"",
35075               "\"out\""
35076             ],
35077             "optional": false,
35078             "field": "firstMsgDirection",
35079             "description": ""
35080           },
35081           {
35082             "group": "Body",
35083             "type": "String",
35084             "optional": true,
35085             "field": "lastMsgAt",
35086             "description": ""
35087           },
35088           {
35089             "group": "Body",
35090             "type": "String",
35091             "allowedValues": [
35092               "\"in\"",
35093               "\"out\""
35094             ],
35095             "optional": false,
35096             "field": "lastMsgDirection",
35097             "description": ""
35098           }
35099         ]
35100       }
35101     },
35102     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35103     "version": "0.0.0",
35104     "filename": "server/api/whatsappInteraction/index.js",
35105     "groupTitle": "Whatsapp_Interactions"
35106   },
35107   {
35108     "type": "delete",
35109     "url": "/api/whatsapp/interactions/{id}",
35110     "title": "Deletes a Interaction",
35111     "examples": [
35112       {
35113         "title": "Example usage:",
35114         "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password} -X DELETE",
35115         "type": "json"
35116       }
35117     ],
35118     "name": "DeleteInteractions",
35119     "group": "Whatsapp_Interactions",
35120     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35121     "version": "0.0.0",
35122     "filename": "server/api/whatsappInteraction/index.js",
35123     "groupTitle": "Whatsapp_Interactions"
35124   },
35125   {
35126     "type": "get",
35127     "url": "/api/whatsapp/interactions/describe",
35128     "title": "Gets table info about Interactions",
35129     "examples": [
35130       {
35131         "title": "Example usage:",
35132         "content": "curl https://{domain}/api/whatsapp/interactions/describe -v -u {name}:{password}",
35133         "type": "json"
35134       }
35135     ],
35136     "name": "DescribeInteractions",
35137     "group": "Whatsapp_Interactions",
35138     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35139     "version": "0.0.0",
35140     "filename": "server/api/whatsappInteraction/index.js",
35141     "groupTitle": "Whatsapp_Interactions"
35142   },
35143   {
35144     "type": "get",
35145     "url": "/api/whatsapp/interactions",
35146     "title": "Gets a list of Interactions",
35147     "examples": [
35148       {
35149         "title": "Example usage:",
35150         "content": "curl https://{domain}/api/whatsapp/interactions -v -u {name}:{password}",
35151         "type": "json"
35152       }
35153     ],
35154     "name": "GetInteractions",
35155     "group": "Whatsapp_Interactions",
35156     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35157     "version": "0.0.0",
35158     "filename": "server/api/whatsappInteraction/index.js",
35159     "groupTitle": "Whatsapp_Interactions"
35160   },
35161   {
35162     "type": "delete",
35163     "url": "/api/whatsapp/interactions/{id}/tags",
35164     "title": "Removes tags from interaction",
35165     "examples": [
35166       {
35167         "title": "Example usage:",
35168         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
35169         "type": "json"
35170       }
35171     ],
35172     "name": "RemoveTags",
35173     "group": "Whatsapp_Interactions",
35174     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35175     "version": "0.0.0",
35176     "filename": "server/api/whatsappInteraction/index.js",
35177     "groupTitle": "Whatsapp_Interactions"
35178   },
35179   {
35180     "type": "get",
35181     "url": "/api/whatsapp/interactions/{id}",
35182     "title": "Gets a single Interaction",
35183     "examples": [
35184       {
35185         "title": "Example usage:",
35186         "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password}",
35187         "type": "json"
35188       }
35189     ],
35190     "name": "ShowInteractions",
35191     "group": "Whatsapp_Interactions",
35192     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35193     "version": "0.0.0",
35194     "filename": "server/api/whatsappInteraction/index.js",
35195     "groupTitle": "Whatsapp_Interactions"
35196   },
35197   {
35198     "type": "post",
35199     "url": "/api/whatsapp/interactions/{id}/messages",
35200     "title": "Creates new messages",
35201     "examples": [
35202       {
35203         "title": "Example usage:",
35204         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35205         "type": "json"
35206       }
35207     ],
35208     "name": "addMessage",
35209     "group": "Whatsapp_Interactions",
35210     "parameter": {
35211       "fields": {
35212         "Body": [
35213           {
35214             "group": "Body",
35215             "type": "Text",
35216             "optional": false,
35217             "field": "body",
35218             "description": ""
35219           },
35220           {
35221             "group": "Body",
35222             "type": "Boolean",
35223             "optional": true,
35224             "field": "read",
35225             "description": ""
35226           },
35227           {
35228             "group": "Body",
35229             "type": "String",
35230             "allowedValues": [
35231               "\"in\"",
35232               "\"out\""
35233             ],
35234             "optional": false,
35235             "field": "direction",
35236             "description": ""
35237           },
35238           {
35239             "group": "Body",
35240             "type": "String",
35241             "optional": true,
35242             "field": "messageId",
35243             "description": ""
35244           },
35245           {
35246             "group": "Body",
35247             "type": "String",
35248             "optional": true,
35249             "field": "phone",
35250             "description": ""
35251           },
35252           {
35253             "group": "Body",
35254             "type": "String",
35255             "optional": true,
35256             "field": "readAt",
35257             "description": ""
35258           },
35259           {
35260             "group": "Body",
35261             "type": "Boolean",
35262             "optional": true,
35263             "field": "secret",
35264             "description": ""
35265           },
35266           {
35267             "group": "Body",
35268             "type": "String",
35269             "optional": true,
35270             "field": "providerName",
35271             "description": ""
35272           },
35273           {
35274             "group": "Body",
35275             "type": "Text",
35276             "optional": true,
35277             "field": "providerResponse",
35278             "description": ""
35279           }
35280         ]
35281       }
35282     },
35283     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35284     "version": "0.0.0",
35285     "filename": "server/api/whatsappInteraction/index.js",
35286     "groupTitle": "Whatsapp_Interactions"
35287   },
35288   {
35289     "type": "get",
35290     "url": "/api/whatsapp/interactions/{id}/download",
35291     "title": "Gets interaction",
35292     "examples": [
35293       {
35294         "title": "Example usage:",
35295         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/download -v -u {name}:{password} -X GET",
35296         "type": "json"
35297       }
35298     ],
35299     "name": "download",
35300     "group": "Whatsapp_Interactions",
35301     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35302     "version": "0.0.0",
35303     "filename": "server/api/whatsappInteraction/index.js",
35304     "groupTitle": "Whatsapp_Interactions"
35305   },
35306   {
35307     "type": "get",
35308     "url": "/api/whatsapp/interactions/{id}/messages",
35309     "title": "Gets interaction messages",
35310     "examples": [
35311       {
35312         "title": "Example usage:",
35313         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -v -u {name}:{password} -X GET",
35314         "type": "json"
35315       }
35316     ],
35317     "name": "getMessages",
35318     "group": "Whatsapp_Interactions",
35319     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35320     "version": "0.0.0",
35321     "filename": "server/api/whatsappInteraction/index.js",
35322     "groupTitle": "Whatsapp_Interactions"
35323   },
35324   {
35325     "type": "put",
35326     "url": "/api/whatsapp/interactions/{id}",
35327     "title": "Update an existing Interaction",
35328     "examples": [
35329       {
35330         "title": "Example usage:",
35331         "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",
35332         "type": "json"
35333       }
35334     ],
35335     "name": "updateInteractions",
35336     "group": "Whatsapp_Interactions",
35337     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35338     "version": "0.0.0",
35339     "filename": "server/api/whatsappInteraction/index.js",
35340     "groupTitle": "Whatsapp_Interactions"
35341   },
35342   {
35343     "type": "post",
35344     "url": "/api/whatsapp/messages",
35345     "title": "Creates a new Message",
35346     "examples": [
35347       {
35348         "title": "Example usage:",
35349         "content": "curl https://{domain}/api/whatsapp/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35350         "type": "json"
35351       }
35352     ],
35353     "name": "CreateMessages",
35354     "group": "Whatsapp_Messages",
35355     "parameter": {
35356       "fields": {
35357         "Body": [
35358           {
35359             "group": "Body",
35360             "type": "Text",
35361             "optional": false,
35362             "field": "body",
35363             "description": ""
35364           },
35365           {
35366             "group": "Body",
35367             "type": "Boolean",
35368             "optional": true,
35369             "field": "read",
35370             "description": ""
35371           },
35372           {
35373             "group": "Body",
35374             "type": "String",
35375             "allowedValues": [
35376               "\"in\"",
35377               "\"out\""
35378             ],
35379             "optional": false,
35380             "field": "direction",
35381             "description": ""
35382           },
35383           {
35384             "group": "Body",
35385             "type": "String",
35386             "optional": true,
35387             "field": "messageId",
35388             "description": ""
35389           },
35390           {
35391             "group": "Body",
35392             "type": "String",
35393             "optional": true,
35394             "field": "phone",
35395             "description": ""
35396           },
35397           {
35398             "group": "Body",
35399             "type": "String",
35400             "optional": true,
35401             "field": "readAt",
35402             "description": ""
35403           },
35404           {
35405             "group": "Body",
35406             "type": "Boolean",
35407             "optional": true,
35408             "field": "secret",
35409             "description": ""
35410           },
35411           {
35412             "group": "Body",
35413             "type": "String",
35414             "optional": true,
35415             "field": "providerName",
35416             "description": ""
35417           },
35418           {
35419             "group": "Body",
35420             "type": "Text",
35421             "optional": true,
35422             "field": "providerResponse",
35423             "description": ""
35424           }
35425         ]
35426       }
35427     },
35428     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35429     "version": "0.0.0",
35430     "filename": "server/api/whatsappMessage/index.js",
35431     "groupTitle": "Whatsapp_Messages"
35432   },
35433   {
35434     "type": "delete",
35435     "url": "/api/whatsapp/messages/{id}",
35436     "title": "Deletes a Message",
35437     "examples": [
35438       {
35439         "title": "Example usage:",
35440         "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password} -X DELETE",
35441         "type": "json"
35442       }
35443     ],
35444     "name": "DeleteMessages",
35445     "group": "Whatsapp_Messages",
35446     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35447     "version": "0.0.0",
35448     "filename": "server/api/whatsappMessage/index.js",
35449     "groupTitle": "Whatsapp_Messages"
35450   },
35451   {
35452     "type": "get",
35453     "url": "/api/whatsapp/messages/describe",
35454     "title": "Gets table info about Messages",
35455     "examples": [
35456       {
35457         "title": "Example usage:",
35458         "content": "curl https://{domain}/api/whatsapp/messages/describe -v -u {name}:{password}",
35459         "type": "json"
35460       }
35461     ],
35462     "name": "DescribeMessages",
35463     "group": "Whatsapp_Messages",
35464     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35465     "version": "0.0.0",
35466     "filename": "server/api/whatsappMessage/index.js",
35467     "groupTitle": "Whatsapp_Messages"
35468   },
35469   {
35470     "type": "get",
35471     "url": "/api/whatsapp/messages",
35472     "title": "Gets a list of Messages",
35473     "examples": [
35474       {
35475         "title": "Example usage:",
35476         "content": "curl https://{domain}/api/whatsapp/messages -v -u {name}:{password}",
35477         "type": "json"
35478       }
35479     ],
35480     "name": "GetMessages",
35481     "group": "Whatsapp_Messages",
35482     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35483     "version": "0.0.0",
35484     "filename": "server/api/whatsappMessage/index.js",
35485     "groupTitle": "Whatsapp_Messages"
35486   },
35487   {
35488     "type": "get",
35489     "url": "/api/whatsapp/messages/{id}",
35490     "title": "Gets a single Message",
35491     "examples": [
35492       {
35493         "title": "Example usage:",
35494         "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password}",
35495         "type": "json"
35496       }
35497     ],
35498     "name": "ShowMessages",
35499     "group": "Whatsapp_Messages",
35500     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35501     "version": "0.0.0",
35502     "filename": "server/api/whatsappMessage/index.js",
35503     "groupTitle": "Whatsapp_Messages"
35504   },
35505   {
35506     "type": "put",
35507     "url": "/api/whatsapp/messages/{id}",
35508     "title": "Update an existing Message",
35509     "examples": [
35510       {
35511         "title": "Example usage:",
35512         "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",
35513         "type": "json"
35514       }
35515     ],
35516     "name": "updateMessages",
35517     "group": "Whatsapp_Messages",
35518     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35519     "version": "0.0.0",
35520     "filename": "server/api/whatsappMessage/index.js",
35521     "groupTitle": "Whatsapp_Messages"
35522   },
35523   {
35524     "type": "post",
35525     "url": "/api/whatsapp/reports/queue",
35526     "title": "Creates a new Whatsapp Queue Report",
35527     "examples": [
35528       {
35529         "title": "Example usage:",
35530         "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",
35531         "type": "json"
35532       }
35533     ],
35534     "name": "CreateWhatsapp_Queue_Reports",
35535     "group": "Whatsapp_Queue_Reports",
35536     "parameter": {
35537       "fields": {
35538         "Body": [
35539           {
35540             "group": "Body",
35541             "type": "String",
35542             "optional": false,
35543             "field": "uniqueid",
35544             "description": ""
35545           },
35546           {
35547             "group": "Body",
35548             "type": "String",
35549             "optional": true,
35550             "field": "from",
35551             "description": ""
35552           },
35553           {
35554             "group": "Body",
35555             "type": "String",
35556             "optional": true,
35557             "field": "joinAt",
35558             "description": ""
35559           },
35560           {
35561             "group": "Body",
35562             "type": "String",
35563             "optional": true,
35564             "field": "leaveAt",
35565             "description": ""
35566           },
35567           {
35568             "group": "Body",
35569             "type": "String",
35570             "optional": true,
35571             "field": "acceptAt",
35572             "description": ""
35573           },
35574           {
35575             "group": "Body",
35576             "type": "String",
35577             "optional": true,
35578             "field": "exitAt",
35579             "description": ""
35580           },
35581           {
35582             "group": "Body",
35583             "type": "String",
35584             "optional": true,
35585             "field": "reason",
35586             "description": ""
35587           }
35588         ]
35589       }
35590     },
35591     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35592     "version": "0.0.0",
35593     "filename": "server/api/whatsappQueueReport/index.js",
35594     "groupTitle": "Whatsapp_Queue_Reports"
35595   },
35596   {
35597     "type": "delete",
35598     "url": "/api/whatsapp/reports/queue/{id}",
35599     "title": "Deletes a Whatsapp Queue Report",
35600     "examples": [
35601       {
35602         "title": "Example usage:",
35603         "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password} -X DELETE",
35604         "type": "json"
35605       }
35606     ],
35607     "name": "DeleteWhatsapp_Queue_Reports",
35608     "group": "Whatsapp_Queue_Reports",
35609     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35610     "version": "0.0.0",
35611     "filename": "server/api/whatsappQueueReport/index.js",
35612     "groupTitle": "Whatsapp_Queue_Reports"
35613   },
35614   {
35615     "type": "get",
35616     "url": "/api/whatsapp/reports/queue/describe",
35617     "title": "Gets table info about Whatsapp Queue Reports",
35618     "examples": [
35619       {
35620         "title": "Example usage:",
35621         "content": "curl https://{domain}/api/whatsapp/reports/queue/describe -v -u {name}:{password}",
35622         "type": "json"
35623       }
35624     ],
35625     "name": "DescribeWhatsapp_Queue_Reports",
35626     "group": "Whatsapp_Queue_Reports",
35627     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35628     "version": "0.0.0",
35629     "filename": "server/api/whatsappQueueReport/index.js",
35630     "groupTitle": "Whatsapp_Queue_Reports"
35631   },
35632   {
35633     "type": "get",
35634     "url": "/api/whatsapp/reports/queue",
35635     "title": "Gets a list of Whatsapp Queue Reports",
35636     "examples": [
35637       {
35638         "title": "Example usage:",
35639         "content": "curl https://{domain}/api/whatsapp/reports/queue -v -u {name}:{password}",
35640         "type": "json"
35641       }
35642     ],
35643     "name": "GetWhatsapp_Queue_Reports",
35644     "group": "Whatsapp_Queue_Reports",
35645     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35646     "version": "0.0.0",
35647     "filename": "server/api/whatsappQueueReport/index.js",
35648     "groupTitle": "Whatsapp_Queue_Reports"
35649   },
35650   {
35651     "type": "get",
35652     "url": "/api/whatsapp/reports/queue/{id}",
35653     "title": "Gets a single Whatsapp Queue Report",
35654     "examples": [
35655       {
35656         "title": "Example usage:",
35657         "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password}",
35658         "type": "json"
35659       }
35660     ],
35661     "name": "ShowWhatsapp_Queue_Reports",
35662     "group": "Whatsapp_Queue_Reports",
35663     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35664     "version": "0.0.0",
35665     "filename": "server/api/whatsappQueueReport/index.js",
35666     "groupTitle": "Whatsapp_Queue_Reports"
35667   },
35668   {
35669     "type": "put",
35670     "url": "/api/whatsapp/reports/queue/{id}",
35671     "title": "Update an existing Whatsapp Queue Report",
35672     "examples": [
35673       {
35674         "title": "Example usage:",
35675         "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",
35676         "type": "json"
35677       }
35678     ],
35679     "name": "updateWhatsapp_Queue_Reports",
35680     "group": "Whatsapp_Queue_Reports",
35681     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35682     "version": "0.0.0",
35683     "filename": "server/api/whatsappQueueReport/index.js",
35684     "groupTitle": "Whatsapp_Queue_Reports"
35685   },
35686   {
35687     "type": "post",
35688     "url": "/api/whatsapp/queues/{id}/users",
35689     "title": "Add agents to a queue",
35690     "examples": [
35691       {
35692         "title": "Example usage:",
35693         "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",
35694         "type": "json"
35695       }
35696     ],
35697     "name": "AddAgents",
35698     "group": "Whatsapp_Queues",
35699     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35700     "version": "0.0.0",
35701     "filename": "server/api/whatsappQueue/index.js",
35702     "groupTitle": "Whatsapp_Queues"
35703   },
35704   {
35705     "type": "post",
35706     "url": "/api/whatsapp/queues/{id}/teams",
35707     "title": "Add teams to a queue",
35708     "examples": [
35709       {
35710         "title": "Example usage:",
35711         "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",
35712         "type": "json"
35713       }
35714     ],
35715     "name": "AddTeams",
35716     "group": "Whatsapp_Queues",
35717     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35718     "version": "0.0.0",
35719     "filename": "server/api/whatsappQueue/index.js",
35720     "groupTitle": "Whatsapp_Queues"
35721   },
35722   {
35723     "type": "post",
35724     "url": "/api/whatsapp/queues",
35725     "title": "Creates a new Queue",
35726     "examples": [
35727       {
35728         "title": "Example usage:",
35729         "content": "curl https://{domain}/api/whatsapp/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35730         "type": "json"
35731       }
35732     ],
35733     "name": "CreateQueues",
35734     "group": "Whatsapp_Queues",
35735     "parameter": {
35736       "fields": {
35737         "Body": [
35738           {
35739             "group": "Body",
35740             "type": "String",
35741             "optional": true,
35742             "field": "name",
35743             "description": ""
35744           },
35745           {
35746             "group": "Body",
35747             "type": "Integer",
35748             "optional": true,
35749             "field": "timeout",
35750             "description": ""
35751           },
35752           {
35753             "group": "Body",
35754             "type": "String",
35755             "allowedValues": [
35756               "\"rrmemory\"",
35757               "\"beepall\"",
35758               "\"roundrobin\""
35759             ],
35760             "optional": true,
35761             "field": "strategy",
35762             "description": ""
35763           },
35764           {
35765             "group": "Body",
35766             "type": "String",
35767             "optional": true,
35768             "field": "description",
35769             "description": ""
35770           }
35771         ]
35772       }
35773     },
35774     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35775     "version": "0.0.0",
35776     "filename": "server/api/whatsappQueue/index.js",
35777     "groupTitle": "Whatsapp_Queues"
35778   },
35779   {
35780     "type": "delete",
35781     "url": "/api/whatsapp/queues/{id}",
35782     "title": "Deletes a Queue",
35783     "examples": [
35784       {
35785         "title": "Example usage:",
35786         "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password} -X DELETE",
35787         "type": "json"
35788       }
35789     ],
35790     "name": "DeleteQueues",
35791     "group": "Whatsapp_Queues",
35792     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35793     "version": "0.0.0",
35794     "filename": "server/api/whatsappQueue/index.js",
35795     "groupTitle": "Whatsapp_Queues"
35796   },
35797   {
35798     "type": "get",
35799     "url": "/api/whatsapp/queues/describe",
35800     "title": "Gets table info about Queues",
35801     "examples": [
35802       {
35803         "title": "Example usage:",
35804         "content": "curl https://{domain}/api/whatsapp/queues/describe -v -u {name}:{password}",
35805         "type": "json"
35806       }
35807     ],
35808     "name": "DescribeQueues",
35809     "group": "Whatsapp_Queues",
35810     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35811     "version": "0.0.0",
35812     "filename": "server/api/whatsappQueue/index.js",
35813     "groupTitle": "Whatsapp_Queues"
35814   },
35815   {
35816     "type": "get",
35817     "url": "/api/whatsapp/queues/{id}/users",
35818     "title": "Gets queue agents",
35819     "examples": [
35820       {
35821         "title": "Example usage:",
35822         "content": "curl https://{domain}/api/whatsapp/queues/{id}/users -v -u {name}:{password} -X POST",
35823         "type": "json"
35824       }
35825     ],
35826     "name": "GetAgents",
35827     "group": "Whatsapp_Queues",
35828     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35829     "version": "0.0.0",
35830     "filename": "server/api/whatsappQueue/index.js",
35831     "groupTitle": "Whatsapp_Queues"
35832   },
35833   {
35834     "type": "get",
35835     "url": "/api/whatsapp/queues/{id}/members",
35836     "title": "GetMembers",
35837     "examples": [
35838       {
35839         "title": "Example usage:",
35840         "content": "curl https://{domain}/api/whatsapp/queues/{id}/members  -v -u {name}:{password}",
35841         "type": "json"
35842       }
35843     ],
35844     "name": "GetMembers",
35845     "group": "Whatsapp_Queues",
35846     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35847     "version": "0.0.0",
35848     "filename": "server/api/whatsappQueue/index.js",
35849     "groupTitle": "Whatsapp_Queues"
35850   },
35851   {
35852     "type": "get",
35853     "url": "/api/whatsapp/queues",
35854     "title": "Gets a list of Queues",
35855     "examples": [
35856       {
35857         "title": "Example usage:",
35858         "content": "curl https://{domain}/api/whatsapp/queues -v -u {name}:{password}",
35859         "type": "json"
35860       }
35861     ],
35862     "name": "GetQueues",
35863     "group": "Whatsapp_Queues",
35864     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35865     "version": "0.0.0",
35866     "filename": "server/api/whatsappQueue/index.js",
35867     "groupTitle": "Whatsapp_Queues"
35868   },
35869   {
35870     "type": "get",
35871     "url": "/api/whatsapp/queues/{id}/teams",
35872     "title": "Gets queues list",
35873     "examples": [
35874       {
35875         "title": "Example usage:",
35876         "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password}",
35877         "type": "json"
35878       }
35879     ],
35880     "name": "GetTeams",
35881     "group": "Whatsapp_Queues",
35882     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35883     "version": "0.0.0",
35884     "filename": "server/api/whatsappQueue/index.js",
35885     "groupTitle": "Whatsapp_Queues"
35886   },
35887   {
35888     "type": "delete",
35889     "url": "/api/whatsapp/queues/{id}/users",
35890     "title": "Removes agents from a queue",
35891     "examples": [
35892       {
35893         "title": "Example usage:",
35894         "content": "curl https://{domain}/api/whatsapp/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
35895         "type": "json"
35896       }
35897     ],
35898     "name": "RemoveAgents",
35899     "group": "Whatsapp_Queues",
35900     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35901     "version": "0.0.0",
35902     "filename": "server/api/whatsappQueue/index.js",
35903     "groupTitle": "Whatsapp_Queues"
35904   },
35905   {
35906     "type": "get",
35907     "url": "/api/whatsapp/queues/{id}",
35908     "title": "Gets a single Queue",
35909     "examples": [
35910       {
35911         "title": "Example usage:",
35912         "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password}",
35913         "type": "json"
35914       }
35915     ],
35916     "name": "ShowQueues",
35917     "group": "Whatsapp_Queues",
35918     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35919     "version": "0.0.0",
35920     "filename": "server/api/whatsappQueue/index.js",
35921     "groupTitle": "Whatsapp_Queues"
35922   },
35923   {
35924     "type": "put",
35925     "url": "/api/whatsapp/queues/{id}",
35926     "title": "Update an existing Queue",
35927     "examples": [
35928       {
35929         "title": "Example usage:",
35930         "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",
35931         "type": "json"
35932       }
35933     ],
35934     "name": "updateQueues",
35935     "group": "Whatsapp_Queues",
35936     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35937     "version": "0.0.0",
35938     "filename": "server/api/whatsappQueue/index.js",
35939     "groupTitle": "Whatsapp_Queues"
35940   },
35941   {
35942     "type": "post",
35943     "url": "/api/whatsapp/reports/transfer",
35944     "title": "Creates a new Whatsapp Transfer Report",
35945     "examples": [
35946       {
35947         "title": "Example usage:",
35948         "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",
35949         "type": "json"
35950       }
35951     ],
35952     "name": "CreateWhatsapp_Transfer_Reports",
35953     "group": "Whatsapp_Transfer_Reports",
35954     "parameter": {
35955       "fields": {
35956         "Body": [
35957           {
35958             "group": "Body",
35959             "type": "String",
35960             "optional": false,
35961             "field": "uniqueid",
35962             "description": ""
35963           },
35964           {
35965             "group": "Body",
35966             "type": "String",
35967             "allowedValues": [
35968               "\"account\"",
35969               "\"agent\"",
35970               "\"queue\""
35971             ],
35972             "optional": false,
35973             "field": "type",
35974             "description": ""
35975           },
35976           {
35977             "group": "Body",
35978             "type": "String",
35979             "optional": true,
35980             "field": "transferredAt",
35981             "description": ""
35982           }
35983         ]
35984       }
35985     },
35986     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35987     "version": "0.0.0",
35988     "filename": "server/api/whatsappTransferReport/index.js",
35989     "groupTitle": "Whatsapp_Transfer_Reports"
35990   },
35991   {
35992     "type": "delete",
35993     "url": "/api/whatsapp/reports/transfer/{id}",
35994     "title": "Deletes a Whatsapp Transfer Report",
35995     "examples": [
35996       {
35997         "title": "Example usage:",
35998         "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
35999         "type": "json"
36000       }
36001     ],
36002     "name": "DeleteWhatsapp_Transfer_Reports",
36003     "group": "Whatsapp_Transfer_Reports",
36004     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36005     "version": "0.0.0",
36006     "filename": "server/api/whatsappTransferReport/index.js",
36007     "groupTitle": "Whatsapp_Transfer_Reports"
36008   },
36009   {
36010     "type": "get",
36011     "url": "/api/whatsapp/reports/transfer/describe",
36012     "title": "Gets table info about Whatsapp Transfer Reports",
36013     "examples": [
36014       {
36015         "title": "Example usage:",
36016         "content": "curl https://{domain}/api/whatsapp/reports/transfer/describe -v -u {name}:{password}",
36017         "type": "json"
36018       }
36019     ],
36020     "name": "DescribeWhatsapp_Transfer_Reports",
36021     "group": "Whatsapp_Transfer_Reports",
36022     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36023     "version": "0.0.0",
36024     "filename": "server/api/whatsappTransferReport/index.js",
36025     "groupTitle": "Whatsapp_Transfer_Reports"
36026   },
36027   {
36028     "type": "get",
36029     "url": "/api/whatsapp/reports/transfer",
36030     "title": "Gets a list of Whatsapp Transfer Reports",
36031     "examples": [
36032       {
36033         "title": "Example usage:",
36034         "content": "curl https://{domain}/api/whatsapp/reports/transfer -v -u {name}:{password}",
36035         "type": "json"
36036       }
36037     ],
36038     "name": "GetWhatsapp_Transfer_Reports",
36039     "group": "Whatsapp_Transfer_Reports",
36040     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36041     "version": "0.0.0",
36042     "filename": "server/api/whatsappTransferReport/index.js",
36043     "groupTitle": "Whatsapp_Transfer_Reports"
36044   },
36045   {
36046     "type": "get",
36047     "url": "/api/whatsapp/reports/transfer/{id}",
36048     "title": "Gets a single Whatsapp Transfer Report",
36049     "examples": [
36050       {
36051         "title": "Example usage:",
36052         "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password}",
36053         "type": "json"
36054       }
36055     ],
36056     "name": "ShowWhatsapp_Transfer_Reports",
36057     "group": "Whatsapp_Transfer_Reports",
36058     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36059     "version": "0.0.0",
36060     "filename": "server/api/whatsappTransferReport/index.js",
36061     "groupTitle": "Whatsapp_Transfer_Reports"
36062   },
36063   {
36064     "type": "put",
36065     "url": "/api/whatsapp/reports/transfer/{id}",
36066     "title": "Update an existing Whatsapp Transfer Report",
36067     "examples": [
36068       {
36069         "title": "Example usage:",
36070         "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",
36071         "type": "json"
36072       }
36073     ],
36074     "name": "updateWhatsapp_Transfer_Reports",
36075     "group": "Whatsapp_Transfer_Reports",
36076     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36077     "version": "0.0.0",
36078     "filename": "server/api/whatsappTransferReport/index.js",
36079     "groupTitle": "Whatsapp_Transfer_Reports"
36080   },
36081   {
36082     "type": "post",
36083     "url": "/api/integrations/zendesk/accounts",
36084     "title": "Creates a new Zendesk Account",
36085     "examples": [
36086       {
36087         "title": "Example usage:",
36088         "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",
36089         "type": "json"
36090       }
36091     ],
36092     "name": "CreateZendesk_Accounts",
36093     "group": "Zendesk_Accounts",
36094     "parameter": {
36095       "fields": {
36096         "Body": [
36097           {
36098             "group": "Body",
36099             "type": "String",
36100             "optional": true,
36101             "field": "name",
36102             "description": ""
36103           },
36104           {
36105             "group": "Body",
36106             "type": "String",
36107             "optional": true,
36108             "field": "description",
36109             "description": ""
36110           },
36111           {
36112             "group": "Body",
36113             "type": "String",
36114             "optional": true,
36115             "field": "username",
36116             "description": ""
36117           },
36118           {
36119             "group": "Body",
36120             "type": "String",
36121             "optional": true,
36122             "field": "password",
36123             "description": ""
36124           },
36125           {
36126             "group": "Body",
36127             "type": "String",
36128             "optional": true,
36129             "field": "token",
36130             "description": ""
36131           },
36132           {
36133             "group": "Body",
36134             "type": "String",
36135             "optional": true,
36136             "field": "remoteUri",
36137             "description": ""
36138           },
36139           {
36140             "group": "Body",
36141             "type": "String",
36142             "allowedValues": [
36143               "\"password\"",
36144               "\"token\""
36145             ],
36146             "optional": true,
36147             "field": "authType",
36148             "description": ""
36149           },
36150           {
36151             "group": "Body",
36152             "type": "String",
36153             "optional": false,
36154             "field": "serverUrl",
36155             "description": ""
36156           },
36157           {
36158             "group": "Body",
36159             "type": "String",
36160             "allowedValues": [
36161               "\"integrationTab\"",
36162               "\"newTab\""
36163             ],
36164             "optional": true,
36165             "field": "type",
36166             "description": ""
36167           }
36168         ]
36169       }
36170     },
36171     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36172     "version": "0.0.0",
36173     "filename": "server/api/intZendeskAccount/index.js",
36174     "groupTitle": "Zendesk_Accounts"
36175   },
36176   {
36177     "type": "delete",
36178     "url": "/api/integrations/zendesk/accounts/{id}",
36179     "title": "Deletes a Zendesk Account",
36180     "examples": [
36181       {
36182         "title": "Example usage:",
36183         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password} -X DELETE",
36184         "type": "json"
36185       }
36186     ],
36187     "name": "DeleteZendesk_Accounts",
36188     "group": "Zendesk_Accounts",
36189     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36190     "version": "0.0.0",
36191     "filename": "server/api/intZendeskAccount/index.js",
36192     "groupTitle": "Zendesk_Accounts"
36193   },
36194   {
36195     "type": "get",
36196     "url": "/api/integrations/zendesk/accounts",
36197     "title": "Gets a list of Zendesk Accounts",
36198     "examples": [
36199       {
36200         "title": "Example usage:",
36201         "content": "curl https://{domain}/api/integrations/zendesk/accounts -v -u {name}:{password}",
36202         "type": "json"
36203       }
36204     ],
36205     "name": "GetZendesk_Accounts",
36206     "group": "Zendesk_Accounts",
36207     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36208     "version": "0.0.0",
36209     "filename": "server/api/intZendeskAccount/index.js",
36210     "groupTitle": "Zendesk_Accounts"
36211   },
36212   {
36213     "type": "get",
36214     "url": "/api/integrations/zendesk/accounts/{id}",
36215     "title": "Gets a single Zendesk Account",
36216     "examples": [
36217       {
36218         "title": "Example usage:",
36219         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password}",
36220         "type": "json"
36221       }
36222     ],
36223     "name": "ShowZendesk_Accounts",
36224     "group": "Zendesk_Accounts",
36225     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36226     "version": "0.0.0",
36227     "filename": "server/api/intZendeskAccount/index.js",
36228     "groupTitle": "Zendesk_Accounts"
36229   },
36230   {
36231     "type": "post",
36232     "url": "/api/integrations/zendesk/accounts/{id}/configurations",
36233     "title": "Creates new configuration",
36234     "examples": [
36235       {
36236         "title": "Example usage:",
36237         "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",
36238         "type": "json"
36239       }
36240     ],
36241     "name": "addConfiguration",
36242     "group": "Zendesk_Accounts",
36243     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36244     "version": "0.0.0",
36245     "filename": "server/api/intZendeskAccount/index.js",
36246     "groupTitle": "Zendesk_Accounts"
36247   },
36248   {
36249     "type": "get",
36250     "url": "/api/integrations/zendesk/accounts/{id}/configurations",
36251     "title": "Gets account configurations",
36252     "examples": [
36253       {
36254         "title": "Example usage:",
36255         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
36256         "type": "json"
36257       }
36258     ],
36259     "name": "getConfigurations",
36260     "group": "Zendesk_Accounts",
36261     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36262     "version": "0.0.0",
36263     "filename": "server/api/intZendeskAccount/index.js",
36264     "groupTitle": "Zendesk_Accounts"
36265   },
36266   {
36267     "type": "get",
36268     "url": "/api/integrations/zendesk/accounts/{id}/fields",
36269     "title": "Gets account fields",
36270     "examples": [
36271       {
36272         "title": "Example usage:",
36273         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
36274         "type": "json"
36275       }
36276     ],
36277     "name": "getFields",
36278     "group": "Zendesk_Accounts",
36279     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36280     "version": "0.0.0",
36281     "filename": "server/api/intZendeskAccount/index.js",
36282     "groupTitle": "Zendesk_Accounts"
36283   },
36284   {
36285     "type": "put",
36286     "url": "/api/integrations/zendesk/accounts/{id}",
36287     "title": "Update an existing Zendesk Account",
36288     "examples": [
36289       {
36290         "title": "Example usage:",
36291         "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",
36292         "type": "json"
36293       }
36294     ],
36295     "name": "updateZendesk_Accounts",
36296     "group": "Zendesk_Accounts",
36297     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36298     "version": "0.0.0",
36299     "filename": "server/api/intZendeskAccount/index.js",
36300     "groupTitle": "Zendesk_Accounts"
36301   },
36302   {
36303     "type": "post",
36304     "url": "/api/integrations/zendesk/configurations",
36305     "title": "Creates a new Zendesk Configuration",
36306     "examples": [
36307       {
36308         "title": "Example usage:",
36309         "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",
36310         "type": "json"
36311       }
36312     ],
36313     "name": "CreateZendesk_Configurations",
36314     "group": "Zendesk_Configurations",
36315     "parameter": {
36316       "fields": {
36317         "Body": [
36318           {
36319             "group": "Body",
36320             "type": "String",
36321             "optional": true,
36322             "field": "name",
36323             "description": ""
36324           },
36325           {
36326             "group": "Body",
36327             "type": "String",
36328             "optional": true,
36329             "field": "description",
36330             "description": ""
36331           }
36332         ]
36333       }
36334     },
36335     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36336     "version": "0.0.0",
36337     "filename": "server/api/intZendeskConfiguration/index.js",
36338     "groupTitle": "Zendesk_Configurations"
36339   },
36340   {
36341     "type": "delete",
36342     "url": "/api/integrations/zendesk/configurations/{id}",
36343     "title": "Deletes a Zendesk Configuration",
36344     "examples": [
36345       {
36346         "title": "Example usage:",
36347         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password} -X DELETE",
36348         "type": "json"
36349       }
36350     ],
36351     "name": "DeleteZendesk_Configurations",
36352     "group": "Zendesk_Configurations",
36353     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36354     "version": "0.0.0",
36355     "filename": "server/api/intZendeskConfiguration/index.js",
36356     "groupTitle": "Zendesk_Configurations"
36357   },
36358   {
36359     "type": "get",
36360     "url": "/api/integrations/zendesk/configurations",
36361     "title": "Gets a list of Zendesk Configurations",
36362     "examples": [
36363       {
36364         "title": "Example usage:",
36365         "content": "curl https://{domain}/api/integrations/zendesk/configurations -v -u {name}:{password}",
36366         "type": "json"
36367       }
36368     ],
36369     "name": "GetZendesk_Configurations",
36370     "group": "Zendesk_Configurations",
36371     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36372     "version": "0.0.0",
36373     "filename": "server/api/intZendeskConfiguration/index.js",
36374     "groupTitle": "Zendesk_Configurations"
36375   },
36376   {
36377     "type": "get",
36378     "url": "/api/integrations/zendesk/configurations/{id}",
36379     "title": "Gets a single Zendesk Configuration",
36380     "examples": [
36381       {
36382         "title": "Example usage:",
36383         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password}",
36384         "type": "json"
36385       }
36386     ],
36387     "name": "ShowZendesk_Configurations",
36388     "group": "Zendesk_Configurations",
36389     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36390     "version": "0.0.0",
36391     "filename": "server/api/intZendeskConfiguration/index.js",
36392     "groupTitle": "Zendesk_Configurations"
36393   },
36394   {
36395     "type": "get",
36396     "url": "/api/integrations/zendesk/configurations/{id}/descriptions",
36397     "title": "Gets configurations descriptions",
36398     "examples": [
36399       {
36400         "title": "Example usage:",
36401         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
36402         "type": "json"
36403       }
36404     ],
36405     "name": "getDescriptions",
36406     "group": "Zendesk_Configurations",
36407     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36408     "version": "0.0.0",
36409     "filename": "server/api/intZendeskConfiguration/index.js",
36410     "groupTitle": "Zendesk_Configurations"
36411   },
36412   {
36413     "type": "get",
36414     "url": "/api/integrations/zendesk/configurations/{id}/fields",
36415     "title": "Gets configurations fields",
36416     "examples": [
36417       {
36418         "title": "Example usage:",
36419         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
36420         "type": "json"
36421       }
36422     ],
36423     "name": "getFields",
36424     "group": "Zendesk_Configurations",
36425     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/intZendeskConfiguration/index.js",
36428     "groupTitle": "Zendesk_Configurations"
36429   },
36430   {
36431     "type": "get",
36432     "url": "/api/integrations/zendesk/configurations/{id}/subjects",
36433     "title": "Gets configurations subjects",
36434     "examples": [
36435       {
36436         "title": "Example usage:",
36437         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
36438         "type": "json"
36439       }
36440     ],
36441     "name": "getSubjects",
36442     "group": "Zendesk_Configurations",
36443     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36444     "version": "0.0.0",
36445     "filename": "server/api/intZendeskConfiguration/index.js",
36446     "groupTitle": "Zendesk_Configurations"
36447   },
36448   {
36449     "type": "get",
36450     "url": "/api/integrations/zendesk/configurations/{id}/tags",
36451     "title": "Gets configurations tags",
36452     "examples": [
36453       {
36454         "title": "Example usage:",
36455         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
36456         "type": "json"
36457       }
36458     ],
36459     "name": "getTags",
36460     "group": "Zendesk_Configurations",
36461     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36462     "version": "0.0.0",
36463     "filename": "server/api/intZendeskConfiguration/index.js",
36464     "groupTitle": "Zendesk_Configurations"
36465   },
36466   {
36467     "type": "post",
36468     "url": "/api/integrations/zendesk/configurations/{id}/tags",
36469     "title": "Sets new tags",
36470     "examples": [
36471       {
36472         "title": "Example usage:",
36473         "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",
36474         "type": "json"
36475       }
36476     ],
36477     "name": "setTags",
36478     "group": "Zendesk_Configurations",
36479     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36480     "version": "0.0.0",
36481     "filename": "server/api/intZendeskConfiguration/index.js",
36482     "groupTitle": "Zendesk_Configurations"
36483   },
36484   {
36485     "type": "put",
36486     "url": "/api/integrations/zendesk/configurations/{id}",
36487     "title": "Update an existing Zendesk Configuration",
36488     "examples": [
36489       {
36490         "title": "Example usage:",
36491         "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",
36492         "type": "json"
36493       }
36494     ],
36495     "name": "updateZendesk_Configurations",
36496     "group": "Zendesk_Configurations",
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/intZendeskConfiguration/index.js",
36500     "groupTitle": "Zendesk_Configurations"
36501   },
36502   {
36503     "type": "post",
36504     "url": "/api/integrations/zendesk/fields",
36505     "title": "Creates a new Zendesk Field",
36506     "examples": [
36507       {
36508         "title": "Example usage:",
36509         "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",
36510         "type": "json"
36511       }
36512     ],
36513     "name": "CreateZendesk_Fields",
36514     "group": "Zendesk_Fields",
36515     "parameter": {
36516       "fields": {
36517         "Body": [
36518           {
36519             "group": "Body",
36520             "type": "String",
36521             "allowedValues": [
36522               "\"string\"",
36523               "\"variable\"",
36524               "\"customVariable\"",
36525               "\"keyValue\""
36526             ],
36527             "optional": true,
36528             "field": "type",
36529             "description": ""
36530           },
36531           {
36532             "group": "Body",
36533             "type": "String",
36534             "optional": true,
36535             "field": "content",
36536             "description": ""
36537           },
36538           {
36539             "group": "Body",
36540             "type": "String",
36541             "optional": true,
36542             "field": "key",
36543             "description": ""
36544           },
36545           {
36546             "group": "Body",
36547             "type": "String",
36548             "allowedValues": [
36549               "\"string\"",
36550               "\"variable\"",
36551               "\"customVariable\""
36552             ],
36553             "optional": true,
36554             "field": "keyType",
36555             "description": ""
36556           },
36557           {
36558             "group": "Body",
36559             "type": "String",
36560             "optional": true,
36561             "field": "keyContent",
36562             "description": ""
36563           },
36564           {
36565             "group": "Body",
36566             "type": "String",
36567             "optional": true,
36568             "field": "idField",
36569             "description": ""
36570           },
36571           {
36572             "group": "Body",
36573             "type": "String",
36574             "optional": true,
36575             "field": "nameField",
36576             "description": ""
36577           },
36578           {
36579             "group": "Body",
36580             "type": "Boolean",
36581             "optional": true,
36582             "field": "customField",
36583             "description": ""
36584           },
36585           {
36586             "group": "Body",
36587             "type": "String",
36588             "optional": true,
36589             "field": "variableName",
36590             "description": ""
36591           }
36592         ]
36593       }
36594     },
36595     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36596     "version": "0.0.0",
36597     "filename": "server/api/intZendeskField/index.js",
36598     "groupTitle": "Zendesk_Fields"
36599   },
36600   {
36601     "type": "delete",
36602     "url": "/api/integrations/zendesk/fields/{id}",
36603     "title": "Deletes a Zendesk Field",
36604     "examples": [
36605       {
36606         "title": "Example usage:",
36607         "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password} -X DELETE",
36608         "type": "json"
36609       }
36610     ],
36611     "name": "DeleteZendesk_Fields",
36612     "group": "Zendesk_Fields",
36613     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36614     "version": "0.0.0",
36615     "filename": "server/api/intZendeskField/index.js",
36616     "groupTitle": "Zendesk_Fields"
36617   },
36618   {
36619     "type": "get",
36620     "url": "/api/integrations/zendesk/fields",
36621     "title": "Gets a list of Zendesk Fields",
36622     "examples": [
36623       {
36624         "title": "Example usage:",
36625         "content": "curl https://{domain}/api/integrations/zendesk/fields -v -u {name}:{password}",
36626         "type": "json"
36627       }
36628     ],
36629     "name": "GetZendesk_Fields",
36630     "group": "Zendesk_Fields",
36631     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36632     "version": "0.0.0",
36633     "filename": "server/api/intZendeskField/index.js",
36634     "groupTitle": "Zendesk_Fields"
36635   },
36636   {
36637     "type": "get",
36638     "url": "/api/integrations/zendesk/fields/{id}",
36639     "title": "Gets a single Zendesk Field",
36640     "examples": [
36641       {
36642         "title": "Example usage:",
36643         "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password}",
36644         "type": "json"
36645       }
36646     ],
36647     "name": "ShowZendesk_Fields",
36648     "group": "Zendesk_Fields",
36649     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36650     "version": "0.0.0",
36651     "filename": "server/api/intZendeskField/index.js",
36652     "groupTitle": "Zendesk_Fields"
36653   },
36654   {
36655     "type": "put",
36656     "url": "/api/integrations/zendesk/fields/{id}",
36657     "title": "Update an existing Zendesk Field",
36658     "examples": [
36659       {
36660         "title": "Example usage:",
36661         "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",
36662         "type": "json"
36663       }
36664     ],
36665     "name": "updateZendesk_Fields",
36666     "group": "Zendesk_Fields",
36667     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36668     "version": "0.0.0",
36669     "filename": "server/api/intZendeskField/index.js",
36670     "groupTitle": "Zendesk_Fields"
36671   },
36672   {
36673     "type": "post",
36674     "url": "/api/integrations/zoho/accounts",
36675     "title": "Creates a new Zoho Account",
36676     "examples": [
36677       {
36678         "title": "Example usage:",
36679         "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",
36680         "type": "json"
36681       }
36682     ],
36683     "name": "CreateZoho_Accounts",
36684     "group": "Zoho_Accounts",
36685     "parameter": {
36686       "fields": {
36687         "Body": [
36688           {
36689             "group": "Body",
36690             "type": "String",
36691             "optional": true,
36692             "field": "name",
36693             "description": ""
36694           },
36695           {
36696             "group": "Body",
36697             "type": "String",
36698             "optional": true,
36699             "field": "description",
36700             "description": ""
36701           },
36702           {
36703             "group": "Body",
36704             "type": "String",
36705             "optional": true,
36706             "field": "host",
36707             "description": ""
36708           },
36709           {
36710             "group": "Body",
36711             "type": "String",
36712             "optional": true,
36713             "field": "zone",
36714             "description": ""
36715           },
36716           {
36717             "group": "Body",
36718             "type": "String",
36719             "optional": true,
36720             "field": "clientId",
36721             "description": ""
36722           },
36723           {
36724             "group": "Body",
36725             "type": "String",
36726             "optional": true,
36727             "field": "clientSecret",
36728             "description": ""
36729           },
36730           {
36731             "group": "Body",
36732             "type": "String",
36733             "optional": false,
36734             "field": "serverUrl",
36735             "description": ""
36736           },
36737           {
36738             "group": "Body",
36739             "type": "String",
36740             "optional": true,
36741             "field": "code",
36742             "description": ""
36743           },
36744           {
36745             "group": "Body",
36746             "type": "String",
36747             "optional": true,
36748             "field": "refreshToken",
36749             "description": ""
36750           }
36751         ]
36752       }
36753     },
36754     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36755     "version": "0.0.0",
36756     "filename": "server/api/intZohoAccount/index.js",
36757     "groupTitle": "Zoho_Accounts"
36758   },
36759   {
36760     "type": "delete",
36761     "url": "/api/integrations/zoho/accounts/{id}",
36762     "title": "Deletes a Zoho Account",
36763     "examples": [
36764       {
36765         "title": "Example usage:",
36766         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password} -X DELETE",
36767         "type": "json"
36768       }
36769     ],
36770     "name": "DeleteZoho_Accounts",
36771     "group": "Zoho_Accounts",
36772     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36773     "version": "0.0.0",
36774     "filename": "server/api/intZohoAccount/index.js",
36775     "groupTitle": "Zoho_Accounts"
36776   },
36777   {
36778     "type": "get",
36779     "url": "/api/integrations/zoho/accounts",
36780     "title": "Gets a list of Zoho Accounts",
36781     "examples": [
36782       {
36783         "title": "Example usage:",
36784         "content": "curl https://{domain}/api/integrations/zoho/accounts -v -u {name}:{password}",
36785         "type": "json"
36786       }
36787     ],
36788     "name": "GetZoho_Accounts",
36789     "group": "Zoho_Accounts",
36790     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36791     "version": "0.0.0",
36792     "filename": "server/api/intZohoAccount/index.js",
36793     "groupTitle": "Zoho_Accounts"
36794   },
36795   {
36796     "type": "get",
36797     "url": "/api/integrations/zoho/accounts/{id}",
36798     "title": "Gets a single Zoho Account",
36799     "examples": [
36800       {
36801         "title": "Example usage:",
36802         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password}",
36803         "type": "json"
36804       }
36805     ],
36806     "name": "ShowZoho_Accounts",
36807     "group": "Zoho_Accounts",
36808     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36809     "version": "0.0.0",
36810     "filename": "server/api/intZohoAccount/index.js",
36811     "groupTitle": "Zoho_Accounts"
36812   },
36813   {
36814     "type": "post",
36815     "url": "/api/integrations/zoho/accounts/{id}/configurations",
36816     "title": "Creates new configuration",
36817     "examples": [
36818       {
36819         "title": "Example usage:",
36820         "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",
36821         "type": "json"
36822       }
36823     ],
36824     "name": "addConfiguration",
36825     "group": "Zoho_Accounts",
36826     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36827     "version": "0.0.0",
36828     "filename": "server/api/intZohoAccount/index.js",
36829     "groupTitle": "Zoho_Accounts"
36830   },
36831   {
36832     "type": "get",
36833     "url": "/api/integrations/zoho/accounts/{id}/configurations",
36834     "title": "Gets account configurations",
36835     "examples": [
36836       {
36837         "title": "Example usage:",
36838         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/configurations -v -u {name}:{password} -X GET",
36839         "type": "json"
36840       }
36841     ],
36842     "name": "getConfigurations",
36843     "group": "Zoho_Accounts",
36844     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36845     "version": "0.0.0",
36846     "filename": "server/api/intZohoAccount/index.js",
36847     "groupTitle": "Zoho_Accounts"
36848   },
36849   {
36850     "type": "get",
36851     "url": "/api/integrations/zoho/accounts/{id}/fields",
36852     "title": "Gets account fields",
36853     "examples": [
36854       {
36855         "title": "Example usage:",
36856         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/fields -v -u {name}:{password} -X GET",
36857         "type": "json"
36858       }
36859     ],
36860     "name": "getFields",
36861     "group": "Zoho_Accounts",
36862     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36863     "version": "0.0.0",
36864     "filename": "server/api/intZohoAccount/index.js",
36865     "groupTitle": "Zoho_Accounts"
36866   },
36867   {
36868     "type": "put",
36869     "url": "/api/integrations/zoho/accounts/{id}",
36870     "title": "Update an existing Zoho Account",
36871     "examples": [
36872       {
36873         "title": "Example usage:",
36874         "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",
36875         "type": "json"
36876       }
36877     ],
36878     "name": "updateZoho_Accounts",
36879     "group": "Zoho_Accounts",
36880     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36881     "version": "0.0.0",
36882     "filename": "server/api/intZohoAccount/index.js",
36883     "groupTitle": "Zoho_Accounts"
36884   },
36885   {
36886     "type": "post",
36887     "url": "/api/integrations/zoho/configurations",
36888     "title": "Creates a new Zoho Configuration",
36889     "examples": [
36890       {
36891         "title": "Example usage:",
36892         "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",
36893         "type": "json"
36894       }
36895     ],
36896     "name": "CreateZoho_Configurations",
36897     "group": "Zoho_Configurations",
36898     "parameter": {
36899       "fields": {
36900         "Body": [
36901           {
36902             "group": "Body",
36903             "type": "String",
36904             "optional": true,
36905             "field": "name",
36906             "description": ""
36907           },
36908           {
36909             "group": "Body",
36910             "type": "String",
36911             "allowedValues": [
36912               "\"lead\"",
36913               "\"contact\"",
36914               "\"nothing\""
36915             ],
36916             "optional": true,
36917             "field": "moduleCreate",
36918             "description": ""
36919           },
36920           {
36921             "group": "Body",
36922             "type": "String",
36923             "allowedValues": [
36924               "\"contact_lead\"",
36925               "\"contact\"",
36926               "\"lead\""
36927             ],
36928             "optional": true,
36929             "field": "moduleSearch",
36930             "description": ""
36931           },
36932           {
36933             "group": "Body",
36934             "type": "String",
36935             "optional": true,
36936             "field": "description",
36937             "description": ""
36938           }
36939         ]
36940       }
36941     },
36942     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36943     "version": "0.0.0",
36944     "filename": "server/api/intZohoConfiguration/index.js",
36945     "groupTitle": "Zoho_Configurations"
36946   },
36947   {
36948     "type": "delete",
36949     "url": "/api/integrations/zoho/configurations/{id}",
36950     "title": "Deletes a Zoho Configuration",
36951     "examples": [
36952       {
36953         "title": "Example usage:",
36954         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password} -X DELETE",
36955         "type": "json"
36956       }
36957     ],
36958     "name": "DeleteZoho_Configurations",
36959     "group": "Zoho_Configurations",
36960     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36961     "version": "0.0.0",
36962     "filename": "server/api/intZohoConfiguration/index.js",
36963     "groupTitle": "Zoho_Configurations"
36964   },
36965   {
36966     "type": "get",
36967     "url": "/api/integrations/zoho/configurations",
36968     "title": "Gets a list of Zoho Configurations",
36969     "examples": [
36970       {
36971         "title": "Example usage:",
36972         "content": "curl https://{domain}/api/integrations/zoho/configurations -v -u {name}:{password}",
36973         "type": "json"
36974       }
36975     ],
36976     "name": "GetZoho_Configurations",
36977     "group": "Zoho_Configurations",
36978     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36979     "version": "0.0.0",
36980     "filename": "server/api/intZohoConfiguration/index.js",
36981     "groupTitle": "Zoho_Configurations"
36982   },
36983   {
36984     "type": "get",
36985     "url": "/api/integrations/zoho/configurations/{id}",
36986     "title": "Gets a single Zoho Configuration",
36987     "examples": [
36988       {
36989         "title": "Example usage:",
36990         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password}",
36991         "type": "json"
36992       }
36993     ],
36994     "name": "ShowZoho_Configurations",
36995     "group": "Zoho_Configurations",
36996     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36997     "version": "0.0.0",
36998     "filename": "server/api/intZohoConfiguration/index.js",
36999     "groupTitle": "Zoho_Configurations"
37000   },
37001   {
37002     "type": "get",
37003     "url": "/api/integrations/zoho/configurations/{id}/descriptions",
37004     "title": "Gets configurations descriptions",
37005     "examples": [
37006       {
37007         "title": "Example usage:",
37008         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
37009         "type": "json"
37010       }
37011     ],
37012     "name": "getDescriptions",
37013     "group": "Zoho_Configurations",
37014     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37015     "version": "0.0.0",
37016     "filename": "server/api/intZohoConfiguration/index.js",
37017     "groupTitle": "Zoho_Configurations"
37018   },
37019   {
37020     "type": "get",
37021     "url": "/api/integrations/zoho/configurations/{id}/fields",
37022     "title": "Gets configurations fields",
37023     "examples": [
37024       {
37025         "title": "Example usage:",
37026         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
37027         "type": "json"
37028       }
37029     ],
37030     "name": "getFields",
37031     "group": "Zoho_Configurations",
37032     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37033     "version": "0.0.0",
37034     "filename": "server/api/intZohoConfiguration/index.js",
37035     "groupTitle": "Zoho_Configurations"
37036   },
37037   {
37038     "type": "get",
37039     "url": "/api/integrations/zoho/configurations/{id}/subjects",
37040     "title": "Gets configurations subjects",
37041     "examples": [
37042       {
37043         "title": "Example usage:",
37044         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/subjects -v -u {name}:{password} -X GET",
37045         "type": "json"
37046       }
37047     ],
37048     "name": "getSubjects",
37049     "group": "Zoho_Configurations",
37050     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37051     "version": "0.0.0",
37052     "filename": "server/api/intZohoConfiguration/index.js",
37053     "groupTitle": "Zoho_Configurations"
37054   },
37055   {
37056     "type": "put",
37057     "url": "/api/integrations/zoho/configurations/{id}",
37058     "title": "Update an existing Zoho Configuration",
37059     "examples": [
37060       {
37061         "title": "Example usage:",
37062         "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",
37063         "type": "json"
37064       }
37065     ],
37066     "name": "updateZoho_Configurations",
37067     "group": "Zoho_Configurations",
37068     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37069     "version": "0.0.0",
37070     "filename": "server/api/intZohoConfiguration/index.js",
37071     "groupTitle": "Zoho_Configurations"
37072   },
37073   {
37074     "type": "post",
37075     "url": "/api/integrations/zoho/fields",
37076     "title": "Creates a new Zoho Field",
37077     "examples": [
37078       {
37079         "title": "Example usage:",
37080         "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",
37081         "type": "json"
37082       }
37083     ],
37084     "name": "CreateZoho_Fields",
37085     "group": "Zoho_Fields",
37086     "parameter": {
37087       "fields": {
37088         "Body": [
37089           {
37090             "group": "Body",
37091             "type": "String",
37092             "allowedValues": [
37093               "\"string\"",
37094               "\"variable\"",
37095               "\"customVariable\"",
37096               "\"keyValue\""
37097             ],
37098             "optional": true,
37099             "field": "type",
37100             "description": ""
37101           },
37102           {
37103             "group": "Body",
37104             "type": "String",
37105             "optional": true,
37106             "field": "content",
37107             "description": ""
37108           },
37109           {
37110             "group": "Body",
37111             "type": "String",
37112             "optional": true,
37113             "field": "key",
37114             "description": ""
37115           },
37116           {
37117             "group": "Body",
37118             "type": "String",
37119             "allowedValues": [
37120               "\"string\"",
37121               "\"variable\"",
37122               "\"customVariable\""
37123             ],
37124             "optional": true,
37125             "field": "keyType",
37126             "description": ""
37127           },
37128           {
37129             "group": "Body",
37130             "type": "String",
37131             "optional": true,
37132             "field": "keyContent",
37133             "description": ""
37134           },
37135           {
37136             "group": "Body",
37137             "type": "String",
37138             "optional": true,
37139             "field": "idField",
37140             "description": ""
37141           },
37142           {
37143             "group": "Body",
37144             "type": "String",
37145             "optional": true,
37146             "field": "nameField",
37147             "description": ""
37148           },
37149           {
37150             "group": "Body",
37151             "type": "Boolean",
37152             "optional": true,
37153             "field": "customField",
37154             "description": ""
37155           },
37156           {
37157             "group": "Body",
37158             "type": "String",
37159             "optional": true,
37160             "field": "variableName",
37161             "description": ""
37162           }
37163         ]
37164       }
37165     },
37166     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37167     "version": "0.0.0",
37168     "filename": "server/api/intZohoField/index.js",
37169     "groupTitle": "Zoho_Fields"
37170   },
37171   {
37172     "type": "delete",
37173     "url": "/api/integrations/zoho/fields/{id}",
37174     "title": "Deletes a Zoho Field",
37175     "examples": [
37176       {
37177         "title": "Example usage:",
37178         "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password} -X DELETE",
37179         "type": "json"
37180       }
37181     ],
37182     "name": "DeleteZoho_Fields",
37183     "group": "Zoho_Fields",
37184     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37185     "version": "0.0.0",
37186     "filename": "server/api/intZohoField/index.js",
37187     "groupTitle": "Zoho_Fields"
37188   },
37189   {
37190     "type": "get",
37191     "url": "/api/integrations/zoho/fields",
37192     "title": "Gets a list of Zoho Fields",
37193     "examples": [
37194       {
37195         "title": "Example usage:",
37196         "content": "curl https://{domain}/api/integrations/zoho/fields -v -u {name}:{password}",
37197         "type": "json"
37198       }
37199     ],
37200     "name": "GetZoho_Fields",
37201     "group": "Zoho_Fields",
37202     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37203     "version": "0.0.0",
37204     "filename": "server/api/intZohoField/index.js",
37205     "groupTitle": "Zoho_Fields"
37206   },
37207   {
37208     "type": "get",
37209     "url": "/api/integrations/zoho/fields/{id}",
37210     "title": "Gets a single Zoho Field",
37211     "examples": [
37212       {
37213         "title": "Example usage:",
37214         "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password}",
37215         "type": "json"
37216       }
37217     ],
37218     "name": "ShowZoho_Fields",
37219     "group": "Zoho_Fields",
37220     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37221     "version": "0.0.0",
37222     "filename": "server/api/intZohoField/index.js",
37223     "groupTitle": "Zoho_Fields"
37224   },
37225   {
37226     "type": "put",
37227     "url": "/api/integrations/zoho/fields/{id}",
37228     "title": "Update an existing Zoho Field",
37229     "examples": [
37230       {
37231         "title": "Example usage:",
37232         "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",
37233         "type": "json"
37234       }
37235     ],
37236     "name": "updateZoho_Fields",
37237     "group": "Zoho_Fields",
37238     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37239     "version": "0.0.0",
37240     "filename": "server/api/intZohoField/index.js",
37241     "groupTitle": "Zoho_Fields"
37242   },
37243   {
37244     "type": "post",
37245     "url": "/api/cdr",
37246     "title": "Creates a new Cdr",
37247     "examples": [
37248       {
37249         "title": "Example usage:",
37250         "content": "curl https://{domain}/api/cdr -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
37251         "type": "json"
37252       }
37253     ],
37254     "name": "CreateCdrs",
37255     "group": "cdr",
37256     "parameter": {
37257       "fields": {
37258         "Body": [
37259           {
37260             "group": "Body",
37261             "type": "String",
37262             "optional": false,
37263             "field": "calldate",
37264             "description": ""
37265           },
37266           {
37267             "group": "Body",
37268             "type": "String",
37269             "optional": true,
37270             "field": "clid",
37271             "description": ""
37272           },
37273           {
37274             "group": "Body",
37275             "type": "String",
37276             "optional": true,
37277             "field": "src",
37278             "description": ""
37279           },
37280           {
37281             "group": "Body",
37282             "type": "String",
37283             "optional": true,
37284             "field": "dst",
37285             "description": ""
37286           },
37287           {
37288             "group": "Body",
37289             "type": "String",
37290             "optional": true,
37291             "field": "dcontext",
37292             "description": ""
37293           },
37294           {
37295             "group": "Body",
37296             "type": "String",
37297             "optional": true,
37298             "field": "channel",
37299             "description": ""
37300           },
37301           {
37302             "group": "Body",
37303             "type": "String",
37304             "optional": true,
37305             "field": "dstchannel",
37306             "description": ""
37307           },
37308           {
37309             "group": "Body",
37310             "type": "String",
37311             "optional": true,
37312             "field": "lastapp",
37313             "description": ""
37314           },
37315           {
37316             "group": "Body",
37317             "type": "String",
37318             "optional": true,
37319             "field": "lastdata",
37320             "description": ""
37321           },
37322           {
37323             "group": "Body",
37324             "type": "Integer",
37325             "optional": false,
37326             "field": "duration",
37327             "description": ""
37328           },
37329           {
37330             "group": "Body",
37331             "type": "Integer",
37332             "optional": false,
37333             "field": "billsec",
37334             "description": ""
37335           },
37336           {
37337             "group": "Body",
37338             "type": "String",
37339             "optional": true,
37340             "field": "disposition",
37341             "description": ""
37342           },
37343           {
37344             "group": "Body",
37345             "type": "Integer",
37346             "optional": false,
37347             "field": "amaflags",
37348             "description": ""
37349           },
37350           {
37351             "group": "Body",
37352             "type": "String",
37353             "optional": true,
37354             "field": "accountcode",
37355             "description": ""
37356           },
37357           {
37358             "group": "Body",
37359             "type": "String",
37360             "optional": true,
37361             "field": "userfield",
37362             "description": ""
37363           },
37364           {
37365             "group": "Body",
37366             "type": "String",
37367             "optional": true,
37368             "field": "uniqueid",
37369             "description": ""
37370           },
37371           {
37372             "group": "Body",
37373             "type": "String",
37374             "optional": true,
37375             "field": "linkedid",
37376             "description": ""
37377           },
37378           {
37379             "group": "Body",
37380             "type": "String",
37381             "optional": true,
37382             "field": "sequence",
37383             "description": ""
37384           },
37385           {
37386             "group": "Body",
37387             "type": "String",
37388             "optional": true,
37389             "field": "peeraccount",
37390             "description": ""
37391           },
37392           {
37393             "group": "Body",
37394             "type": "String",
37395             "optional": true,
37396             "field": "type",
37397             "description": ""
37398           },
37399           {
37400             "group": "Body",
37401             "type": "String",
37402             "optional": true,
37403             "field": "tag",
37404             "description": ""
37405           }
37406         ]
37407       }
37408     },
37409     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37410     "version": "0.0.0",
37411     "filename": "server/api/cdr/index.js",
37412     "groupTitle": "cdr"
37413   },
37414   {
37415     "type": "delete",
37416     "url": "/api/cdr/{id}",
37417     "title": "Deletes a Cdr",
37418     "examples": [
37419       {
37420         "title": "Example usage:",
37421         "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password} -X DELETE",
37422         "type": "json"
37423       }
37424     ],
37425     "name": "DeleteCdrs",
37426     "group": "cdr",
37427     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37428     "version": "0.0.0",
37429     "filename": "server/api/cdr/index.js",
37430     "groupTitle": "cdr"
37431   },
37432   {
37433     "type": "get",
37434     "url": "/api/cdr/describe",
37435     "title": "Gets table info about Cdrs",
37436     "examples": [
37437       {
37438         "title": "Example usage:",
37439         "content": "curl https://{domain}/api/cdr/describe -v -u {name}:{password}",
37440         "type": "json"
37441       }
37442     ],
37443     "name": "DescribeCdrs",
37444     "group": "cdr",
37445     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37446     "version": "0.0.0",
37447     "filename": "server/api/cdr/index.js",
37448     "groupTitle": "cdr"
37449   },
37450   {
37451     "type": "get",
37452     "url": "/api/cdr",
37453     "title": "Gets a list of Cdrs",
37454     "examples": [
37455       {
37456         "title": "Example usage:",
37457         "content": "curl https://{domain}/api/cdr -v -u {name}:{password}",
37458         "type": "json"
37459       }
37460     ],
37461     "name": "GetCdrs",
37462     "group": "cdr",
37463     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37464     "version": "0.0.0",
37465     "filename": "server/api/cdr/index.js",
37466     "groupTitle": "cdr"
37467   },
37468   {
37469     "type": "get",
37470     "url": "/api/cdr/{id}",
37471     "title": "Gets a single Cdr",
37472     "examples": [
37473       {
37474         "title": "Example usage:",
37475         "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password}",
37476         "type": "json"
37477       }
37478     ],
37479     "name": "ShowCdrs",
37480     "group": "cdr",
37481     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37482     "version": "0.0.0",
37483     "filename": "server/api/cdr/index.js",
37484     "groupTitle": "cdr"
37485   },
37486   {
37487     "type": "put",
37488     "url": "/api/cdr/{id}",
37489     "title": "Update an existing Cdr",
37490     "examples": [
37491       {
37492         "title": "Example usage:",
37493         "content": "curl https://{domain}/api/cdr/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
37494         "type": "json"
37495       }
37496     ],
37497     "name": "updateCdrs",
37498     "group": "cdr",
37499     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37500     "version": "0.0.0",
37501     "filename": "server/api/cdr/index.js",
37502     "groupTitle": "cdr"
37503   },
37504   {
37505     "type": "post",
37506     "url": "/api/voiceQueuesLog",
37507     "title": "Creates a new VoiceQueuesLog",
37508     "examples": [
37509       {
37510         "title": "Example usage:",
37511         "content": "curl https://{domain}/api/voiceQueuesLog -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
37512         "type": "json"
37513       }
37514     ],
37515     "name": "CreateVoiceQueuesLogs",
37516     "group": "voiceQueuesLog",
37517     "parameter": {
37518       "fields": {
37519         "Body": [
37520           {
37521             "group": "Body",
37522             "type": "String",
37523             "optional": true,
37524             "field": "time",
37525             "description": ""
37526           },
37527           {
37528             "group": "Body",
37529             "type": "String",
37530             "optional": false,
37531             "field": "callid",
37532             "description": ""
37533           },
37534           {
37535             "group": "Body",
37536             "type": "String",
37537             "optional": false,
37538             "field": "queuename",
37539             "description": ""
37540           },
37541           {
37542             "group": "Body",
37543             "type": "String",
37544             "optional": false,
37545             "field": "agent",
37546             "description": ""
37547           },
37548           {
37549             "group": "Body",
37550             "type": "String",
37551             "optional": false,
37552             "field": "event",
37553             "description": ""
37554           },
37555           {
37556             "group": "Body",
37557             "type": "String",
37558             "optional": false,
37559             "field": "data",
37560             "description": ""
37561           },
37562           {
37563             "group": "Body",
37564             "type": "String",
37565             "optional": false,
37566             "field": "data1",
37567             "description": ""
37568           },
37569           {
37570             "group": "Body",
37571             "type": "String",
37572             "optional": false,
37573             "field": "data2",
37574             "description": ""
37575           },
37576           {
37577             "group": "Body",
37578             "type": "String",
37579             "optional": false,
37580             "field": "data3",
37581             "description": ""
37582           },
37583           {
37584             "group": "Body",
37585             "type": "String",
37586             "optional": false,
37587             "field": "data4",
37588             "description": ""
37589           },
37590           {
37591             "group": "Body",
37592             "type": "String",
37593             "optional": false,
37594             "field": "data5",
37595             "description": ""
37596           },
37597           {
37598             "group": "Body",
37599             "type": "String",
37600             "optional": false,
37601             "field": "dtm",
37602             "description": ""
37603           }
37604         ]
37605       }
37606     },
37607     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37608     "version": "0.0.0",
37609     "filename": "server/api/voiceQueuesLog/index.js",
37610     "groupTitle": "voiceQueuesLog"
37611   },
37612   {
37613     "type": "delete",
37614     "url": "/api/voiceQueuesLog/{id}",
37615     "title": "Deletes a VoiceQueuesLog",
37616     "examples": [
37617       {
37618         "title": "Example usage:",
37619         "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password} -X DELETE",
37620         "type": "json"
37621       }
37622     ],
37623     "name": "DeleteVoiceQueuesLogs",
37624     "group": "voiceQueuesLog",
37625     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37626     "version": "0.0.0",
37627     "filename": "server/api/voiceQueuesLog/index.js",
37628     "groupTitle": "voiceQueuesLog"
37629   },
37630   {
37631     "type": "get",
37632     "url": "/api/voiceQueuesLog",
37633     "title": "Gets a list of VoiceQueuesLogs",
37634     "examples": [
37635       {
37636         "title": "Example usage:",
37637         "content": "curl https://{domain}/api/voiceQueuesLog -v -u {name}:{password}",
37638         "type": "json"
37639       }
37640     ],
37641     "name": "GetVoiceQueuesLogs",
37642     "group": "voiceQueuesLog",
37643     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37644     "version": "0.0.0",
37645     "filename": "server/api/voiceQueuesLog/index.js",
37646     "groupTitle": "voiceQueuesLog"
37647   },
37648   {
37649     "type": "get",
37650     "url": "/api/voiceQueuesLog/{id}",
37651     "title": "Gets a single VoiceQueuesLog",
37652     "examples": [
37653       {
37654         "title": "Example usage:",
37655         "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password}",
37656         "type": "json"
37657       }
37658     ],
37659     "name": "ShowVoiceQueuesLogs",
37660     "group": "voiceQueuesLog",
37661     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37662     "version": "0.0.0",
37663     "filename": "server/api/voiceQueuesLog/index.js",
37664     "groupTitle": "voiceQueuesLog"
37665   },
37666   {
37667     "type": "put",
37668     "url": "/api/voiceQueuesLog/{id}",
37669     "title": "Update an existing VoiceQueuesLog",
37670     "examples": [
37671       {
37672         "title": "Example usage:",
37673         "content": "curl https://{domain}/api/voiceQueuesLog/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
37674         "type": "json"
37675       }
37676     ],
37677     "name": "updateVoiceQueuesLogs",
37678     "group": "voiceQueuesLog",
37679     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37680     "version": "0.0.0",
37681     "filename": "server/api/voiceQueuesLog/index.js",
37682     "groupTitle": "voiceQueuesLog"
37683   }
37684 ]