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": "post",
2438     "url": "/api/chat/interactions/{id}/messages",
2439     "title": "Creates new messages",
2440     "examples": [
2441       {
2442         "title": "Example usage:",
2443         "content": "curl https://{domain}/api/chat/interactions/{id}/messages -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     "parameter": {
2450       "fields": {
2451         "Body": [
2452           {
2453             "group": "Body",
2454             "type": "Text",
2455             "optional": false,
2456             "field": "body",
2457             "description": ""
2458           },
2459           {
2460             "group": "Body",
2461             "type": "Boolean",
2462             "optional": true,
2463             "field": "read",
2464             "description": ""
2465           },
2466           {
2467             "group": "Body",
2468             "type": "Boolean",
2469             "optional": true,
2470             "field": "secret",
2471             "description": ""
2472           },
2473           {
2474             "group": "Body",
2475             "type": "String",
2476             "allowedValues": [
2477               "\"in\"",
2478               "\"out\""
2479             ],
2480             "optional": false,
2481             "field": "direction",
2482             "description": ""
2483           },
2484           {
2485             "group": "Body",
2486             "type": "String",
2487             "optional": true,
2488             "field": "readAt",
2489             "description": ""
2490           },
2491           {
2492             "group": "Body",
2493             "type": "String",
2494             "optional": true,
2495             "field": "providerName",
2496             "description": ""
2497           },
2498           {
2499             "group": "Body",
2500             "type": "Text",
2501             "optional": true,
2502             "field": "providerResponse",
2503             "description": ""
2504           }
2505         ]
2506       }
2507     },
2508     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2509     "version": "0.0.0",
2510     "filename": "server/api/chatInteraction/index.js",
2511     "groupTitle": "Chat_Interactions"
2512   },
2513   {
2514     "type": "put",
2515     "url": "/api/chat/interactions/{id}/close",
2516     "title": "Close Interaction",
2517     "examples": [
2518       {
2519         "title": "Example usage:",
2520         "content": "curl https://{domain}/api/chat/interactions/{id}/close -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2521         "type": "json"
2522       }
2523     ],
2524     "name": "addMessage",
2525     "group": "Chat_Interactions",
2526     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2527     "version": "0.0.0",
2528     "filename": "server/api/chatInteraction/index.js",
2529     "groupTitle": "Chat_Interactions"
2530   },
2531   {
2532     "type": "post",
2533     "url": "/api/chat/interactions/{id}/attachment_upload",
2534     "title": "Add attachment",
2535     "examples": [
2536       {
2537         "title": "Example usage:",
2538         "content": "curl https://{domain}/api/chat/interactions/{id}/attachment_upload -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
2539         "type": "json"
2540       }
2541     ],
2542     "name": "attachmentUpload",
2543     "group": "Chat_Interactions",
2544     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2545     "version": "0.0.0",
2546     "filename": "server/api/chatInteraction/index.js",
2547     "groupTitle": "Chat_Interactions"
2548   },
2549   {
2550     "type": "post",
2551     "url": "/api/chat/interactions/{id}/vidaoo",
2552     "title": "Create Vidaoo Session",
2553     "examples": [
2554       {
2555         "title": "Example usage:",
2556         "content": "curl https://{domain}/api/chat/interactions/{id}/vidaoo  -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2557         "type": "json"
2558       }
2559     ],
2560     "name": "createVidaooSession",
2561     "group": "Chat_Interactions",
2562     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2563     "version": "0.0.0",
2564     "filename": "server/api/chatInteraction/index.js",
2565     "groupTitle": "Chat_Interactions"
2566   },
2567   {
2568     "type": "put",
2569     "url": "/api/chat/interactions/{id}/custom_update",
2570     "title": "Update interaction",
2571     "examples": [
2572       {
2573         "title": "Example usage:",
2574         "content": "curl https://{domain}/api/chat/interactions/{id}/custom_update -d '{\"channel\": \"chat\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
2575         "type": "json"
2576       }
2577     ],
2578     "name": "customUpdate",
2579     "group": "Chat_Interactions",
2580     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <p>This API is used to update an interaction.</p>",
2581     "version": "0.0.0",
2582     "filename": "server/api/chatInteraction/index.js",
2583     "groupTitle": "Chat_Interactions"
2584   },
2585   {
2586     "type": "get",
2587     "url": "/api/chat/interactions/{id}/download",
2588     "title": "Gets interaction",
2589     "examples": [
2590       {
2591         "title": "Example usage:",
2592         "content": "curl https://{domain}/api/chat/interactions/{id}/download -v -u {name}:{password} -X GET",
2593         "type": "json"
2594       }
2595     ],
2596     "name": "download",
2597     "group": "Chat_Interactions",
2598     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2599     "version": "0.0.0",
2600     "filename": "server/api/chatInteraction/index.js",
2601     "groupTitle": "Chat_Interactions"
2602   },
2603   {
2604     "type": "get",
2605     "url": "/api/chat/interactions/{id}/messages",
2606     "title": "Gets interaction messages",
2607     "examples": [
2608       {
2609         "title": "Example usage:",
2610         "content": "curl https://{domain}/api/chat/interactions/{id}/messages -v -u {name}:{password} -X GET",
2611         "type": "json"
2612       }
2613     ],
2614     "name": "getMessages",
2615     "group": "Chat_Interactions",
2616     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2617     "version": "0.0.0",
2618     "filename": "server/api/chatInteraction/index.js",
2619     "groupTitle": "Chat_Interactions"
2620   },
2621   {
2622     "type": "get",
2623     "url": "/api/chat/interactions/{id}/my_messages",
2624     "title": "Gets interaction messages",
2625     "examples": [
2626       {
2627         "title": "Example usage:",
2628         "content": "curl https://{domain}/api/chat/interactions/{id}/my_messages -v -u {name}:{password} -X GET",
2629         "type": "json"
2630       }
2631     ],
2632     "name": "getMyMessages",
2633     "group": "Chat_Interactions",
2634     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2635     "version": "0.0.0",
2636     "filename": "server/api/chatInteraction/index.js",
2637     "groupTitle": "Chat_Interactions"
2638   },
2639   {
2640     "type": "put",
2641     "url": "/api/chat/interactions/{id}",
2642     "title": "Update an existing Interaction",
2643     "examples": [
2644       {
2645         "title": "Example usage:",
2646         "content": "curl https://{domain}/api/chat/interactions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
2647         "type": "json"
2648       }
2649     ],
2650     "name": "updateInteractions",
2651     "group": "Chat_Interactions",
2652     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2653     "version": "0.0.0",
2654     "filename": "server/api/chatInteraction/index.js",
2655     "groupTitle": "Chat_Interactions"
2656   },
2657   {
2658     "type": "post",
2659     "url": "/api/chat/internal/messages",
2660     "title": "Creates a new Message",
2661     "examples": [
2662       {
2663         "title": "Example usage:",
2664         "content": "curl https://{domain}/api/chat/internal/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2665         "type": "json"
2666       }
2667     ],
2668     "name": "CreateMessages",
2669     "group": "Chat_Internal_Messages",
2670     "parameter": {
2671       "fields": {
2672         "Body": [
2673           {
2674             "group": "Body",
2675             "type": "Text",
2676             "optional": false,
2677             "field": "body",
2678             "description": ""
2679           },
2680           {
2681             "group": "Body",
2682             "type": "Boolean",
2683             "optional": true,
2684             "field": "read",
2685             "description": ""
2686           },
2687           {
2688             "group": "Body",
2689             "type": "Integer",
2690             "optional": true,
2691             "field": "ChatInternalMessageId",
2692             "description": ""
2693           }
2694         ]
2695       }
2696     },
2697     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2698     "version": "0.0.0",
2699     "filename": "server/api/chatInternalMessage/index.js",
2700     "groupTitle": "Chat_Internal_Messages"
2701   },
2702   {
2703     "type": "delete",
2704     "url": "/api/chat/internal/messages/{id}",
2705     "title": "Deletes a Message",
2706     "examples": [
2707       {
2708         "title": "Example usage:",
2709         "content": "curl https://{domain}/api/chat/internal/messages/{id} -v -u {name}:{password} -X DELETE",
2710         "type": "json"
2711       }
2712     ],
2713     "name": "DeleteMessages",
2714     "group": "Chat_Internal_Messages",
2715     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2716     "version": "0.0.0",
2717     "filename": "server/api/chatInternalMessage/index.js",
2718     "groupTitle": "Chat_Internal_Messages"
2719   },
2720   {
2721     "type": "get",
2722     "url": "/api/chat/internal/messages/describe",
2723     "title": "Gets table info about Messages",
2724     "examples": [
2725       {
2726         "title": "Example usage:",
2727         "content": "curl https://{domain}/api/chat/internal/messages/describe -v -u {name}:{password}",
2728         "type": "json"
2729       }
2730     ],
2731     "name": "DescribeMessages",
2732     "group": "Chat_Internal_Messages",
2733     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2734     "version": "0.0.0",
2735     "filename": "server/api/chatInternalMessage/index.js",
2736     "groupTitle": "Chat_Internal_Messages"
2737   },
2738   {
2739     "type": "get",
2740     "url": "/api/chat/internal/messages",
2741     "title": "Gets a list of Messages",
2742     "examples": [
2743       {
2744         "title": "Example usage:",
2745         "content": "curl https://{domain}/api/chat/internal/messages -v -u {name}:{password}",
2746         "type": "json"
2747       }
2748     ],
2749     "name": "GetMessages",
2750     "group": "Chat_Internal_Messages",
2751     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/internal/messages?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/internal/messages?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/internal/messages?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/internal/messages?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/internal/messages?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
2752     "version": "0.0.0",
2753     "filename": "server/api/chatInternalMessage/index.js",
2754     "groupTitle": "Chat_Internal_Messages"
2755   },
2756   {
2757     "type": "get",
2758     "url": "/api/chat/internal/messages/{id}",
2759     "title": "Gets a single Message",
2760     "examples": [
2761       {
2762         "title": "Example usage:",
2763         "content": "curl https://{domain}/api/chat/internal/messages/{id} -v -u {name}:{password}",
2764         "type": "json"
2765       }
2766     ],
2767     "name": "ShowMessages",
2768     "group": "Chat_Internal_Messages",
2769     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2770     "version": "0.0.0",
2771     "filename": "server/api/chatInternalMessage/index.js",
2772     "groupTitle": "Chat_Internal_Messages"
2773   },
2774   {
2775     "type": "put",
2776     "url": "/api/chat/internal/messages/{id}",
2777     "title": "Update an existing Message",
2778     "examples": [
2779       {
2780         "title": "Example usage:",
2781         "content": "curl https://{domain}/api/chat/internal/messages/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
2782         "type": "json"
2783       }
2784     ],
2785     "name": "updateMessages",
2786     "group": "Chat_Internal_Messages",
2787     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2788     "version": "0.0.0",
2789     "filename": "server/api/chatInternalMessage/index.js",
2790     "groupTitle": "Chat_Internal_Messages"
2791   },
2792   {
2793     "type": "post",
2794     "url": "/api/chat/messages",
2795     "title": "Creates a new Message",
2796     "examples": [
2797       {
2798         "title": "Example usage:",
2799         "content": "curl https://{domain}/api/chat/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2800         "type": "json"
2801       }
2802     ],
2803     "name": "CreateMessages",
2804     "group": "Chat_Messages",
2805     "parameter": {
2806       "fields": {
2807         "Body": [
2808           {
2809             "group": "Body",
2810             "type": "Text",
2811             "optional": false,
2812             "field": "body",
2813             "description": ""
2814           },
2815           {
2816             "group": "Body",
2817             "type": "Boolean",
2818             "optional": true,
2819             "field": "read",
2820             "description": ""
2821           },
2822           {
2823             "group": "Body",
2824             "type": "Boolean",
2825             "optional": true,
2826             "field": "secret",
2827             "description": ""
2828           },
2829           {
2830             "group": "Body",
2831             "type": "String",
2832             "allowedValues": [
2833               "\"in\"",
2834               "\"out\""
2835             ],
2836             "optional": false,
2837             "field": "direction",
2838             "description": ""
2839           },
2840           {
2841             "group": "Body",
2842             "type": "String",
2843             "optional": true,
2844             "field": "readAt",
2845             "description": ""
2846           },
2847           {
2848             "group": "Body",
2849             "type": "String",
2850             "optional": true,
2851             "field": "providerName",
2852             "description": ""
2853           },
2854           {
2855             "group": "Body",
2856             "type": "Text",
2857             "optional": true,
2858             "field": "providerResponse",
2859             "description": ""
2860           }
2861         ]
2862       }
2863     },
2864     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2865     "version": "0.0.0",
2866     "filename": "server/api/chatMessage/index.js",
2867     "groupTitle": "Chat_Messages"
2868   },
2869   {
2870     "type": "delete",
2871     "url": "/api/chat/messages/{id}",
2872     "title": "Deletes a Message",
2873     "examples": [
2874       {
2875         "title": "Example usage:",
2876         "content": "curl https://{domain}/api/chat/messages/{id} -v -u {name}:{password} -X DELETE",
2877         "type": "json"
2878       }
2879     ],
2880     "name": "DeleteMessages",
2881     "group": "Chat_Messages",
2882     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2883     "version": "0.0.0",
2884     "filename": "server/api/chatMessage/index.js",
2885     "groupTitle": "Chat_Messages"
2886   },
2887   {
2888     "type": "get",
2889     "url": "/api/chat/messages/describe",
2890     "title": "Gets table info about Messages",
2891     "examples": [
2892       {
2893         "title": "Example usage:",
2894         "content": "curl https://{domain}/api/chat/messages/describe -v -u {name}:{password}",
2895         "type": "json"
2896       }
2897     ],
2898     "name": "DescribeMessages",
2899     "group": "Chat_Messages",
2900     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2901     "version": "0.0.0",
2902     "filename": "server/api/chatMessage/index.js",
2903     "groupTitle": "Chat_Messages"
2904   },
2905   {
2906     "type": "get",
2907     "url": "/api/chat/messages",
2908     "title": "Gets a list of Messages",
2909     "examples": [
2910       {
2911         "title": "Example usage:",
2912         "content": "curl https://{domain}/api/chat/messages -v -u {name}:{password}",
2913         "type": "json"
2914       }
2915     ],
2916     "name": "GetMessages",
2917     "group": "Chat_Messages",
2918     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/messages?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/messages?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/messages?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/messages?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/messages?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
2919     "version": "0.0.0",
2920     "filename": "server/api/chatMessage/index.js",
2921     "groupTitle": "Chat_Messages"
2922   },
2923   {
2924     "type": "get",
2925     "url": "/api/chat/messages/{id}",
2926     "title": "Gets a single Message",
2927     "examples": [
2928       {
2929         "title": "Example usage:",
2930         "content": "curl https://{domain}/api/chat/messages/{id} -v -u {name}:{password}",
2931         "type": "json"
2932       }
2933     ],
2934     "name": "ShowMessages",
2935     "group": "Chat_Messages",
2936     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2937     "version": "0.0.0",
2938     "filename": "server/api/chatMessage/index.js",
2939     "groupTitle": "Chat_Messages"
2940   },
2941   {
2942     "type": "put",
2943     "url": "/api/chat/messages/{id}",
2944     "title": "Update an existing Message",
2945     "examples": [
2946       {
2947         "title": "Example usage:",
2948         "content": "curl https://{domain}/api/chat/messages/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
2949         "type": "json"
2950       }
2951     ],
2952     "name": "updateMessages",
2953     "group": "Chat_Messages",
2954     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2955     "version": "0.0.0",
2956     "filename": "server/api/chatMessage/index.js",
2957     "groupTitle": "Chat_Messages"
2958   },
2959   {
2960     "type": "post",
2961     "url": "/api/chat/offline_messages",
2962     "title": "Creates a new OfflineMessage",
2963     "examples": [
2964       {
2965         "title": "Example usage:",
2966         "content": "curl https://{domain}/api/chat/offline_messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2967         "type": "json"
2968       }
2969     ],
2970     "name": "CreateOfflineMessages",
2971     "group": "Chat_Offline_Messages",
2972     "parameter": {
2973       "fields": {
2974         "Body": [
2975           {
2976             "group": "Body",
2977             "type": "Text",
2978             "optional": false,
2979             "field": "body",
2980             "description": ""
2981           }
2982         ]
2983       }
2984     },
2985     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2986     "version": "0.0.0",
2987     "filename": "server/api/chatOfflineMessage/index.js",
2988     "groupTitle": "Chat_Offline_Messages"
2989   },
2990   {
2991     "type": "delete",
2992     "url": "/api/chat/offline_messages/{id}",
2993     "title": "Deletes a OfflineMessage",
2994     "examples": [
2995       {
2996         "title": "Example usage:",
2997         "content": "curl https://{domain}/api/chat/offline_messages/{id} -v -u {name}:{password} -X DELETE",
2998         "type": "json"
2999       }
3000     ],
3001     "name": "DeleteOfflineMessages",
3002     "group": "Chat_Offline_Messages",
3003     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3004     "version": "0.0.0",
3005     "filename": "server/api/chatOfflineMessage/index.js",
3006     "groupTitle": "Chat_Offline_Messages"
3007   },
3008   {
3009     "type": "get",
3010     "url": "/api/chat/offline_messages/describe",
3011     "title": "Gets table info about OfflineMessages",
3012     "examples": [
3013       {
3014         "title": "Example usage:",
3015         "content": "curl https://{domain}/api/chat/offline_messages/describe -v -u {name}:{password}",
3016         "type": "json"
3017       }
3018     ],
3019     "name": "DescribeOfflineMessages",
3020     "group": "Chat_Offline_Messages",
3021     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3022     "version": "0.0.0",
3023     "filename": "server/api/chatOfflineMessage/index.js",
3024     "groupTitle": "Chat_Offline_Messages"
3025   },
3026   {
3027     "type": "get",
3028     "url": "/api/chat/offline_messages",
3029     "title": "Gets a list of OfflineMessages",
3030     "examples": [
3031       {
3032         "title": "Example usage:",
3033         "content": "curl https://{domain}/api/chat/offline_messages -v -u {name}:{password}",
3034         "type": "json"
3035       }
3036     ],
3037     "name": "GetOfflineMessages",
3038     "group": "Chat_Offline_Messages",
3039     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/offline_messages?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/offline_messages?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/offline_messages?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/offline_messages?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/offline_messages?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
3040     "version": "0.0.0",
3041     "filename": "server/api/chatOfflineMessage/index.js",
3042     "groupTitle": "Chat_Offline_Messages"
3043   },
3044   {
3045     "type": "get",
3046     "url": "/api/chat/offline_messages/{id}",
3047     "title": "Gets a single OfflineMessage",
3048     "examples": [
3049       {
3050         "title": "Example usage:",
3051         "content": "curl https://{domain}/api/chat/offline_messages/{id} -v -u {name}:{password}",
3052         "type": "json"
3053       }
3054     ],
3055     "name": "ShowOfflineMessages",
3056     "group": "Chat_Offline_Messages",
3057     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3058     "version": "0.0.0",
3059     "filename": "server/api/chatOfflineMessage/index.js",
3060     "groupTitle": "Chat_Offline_Messages"
3061   },
3062   {
3063     "type": "put",
3064     "url": "/api/chat/offline_messages/{id}",
3065     "title": "Update an existing OfflineMessage",
3066     "examples": [
3067       {
3068         "title": "Example usage:",
3069         "content": "curl https://{domain}/api/chat/offline_messages/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
3070         "type": "json"
3071       }
3072     ],
3073     "name": "updateOfflineMessages",
3074     "group": "Chat_Offline_Messages",
3075     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3076     "version": "0.0.0",
3077     "filename": "server/api/chatOfflineMessage/index.js",
3078     "groupTitle": "Chat_Offline_Messages"
3079   },
3080   {
3081     "type": "post",
3082     "url": "/api/chat/proactive_actions",
3083     "title": "Creates a new Proactive Action",
3084     "examples": [
3085       {
3086         "title": "Example usage:",
3087         "content": "curl https://{domain}/api/chat/proactive_actions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3088         "type": "json"
3089       }
3090     ],
3091     "name": "CreateProactive_Actions",
3092     "group": "Chat_Proactive_Actions",
3093     "parameter": {
3094       "fields": {
3095         "Body": [
3096           {
3097             "group": "Body",
3098             "type": "String",
3099             "optional": false,
3100             "field": "name",
3101             "description": ""
3102           },
3103           {
3104             "group": "Body",
3105             "type": "String",
3106             "allowedValues": [
3107               "\"mouseOver\"",
3108               "\"timeout\""
3109             ],
3110             "optional": true,
3111             "field": "type",
3112             "description": ""
3113           },
3114           {
3115             "group": "Body",
3116             "type": "String",
3117             "optional": true,
3118             "field": "selector",
3119             "description": ""
3120           },
3121           {
3122             "group": "Body",
3123             "type": "Integer",
3124             "optional": true,
3125             "field": "timeout",
3126             "description": ""
3127           }
3128         ]
3129       }
3130     },
3131     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3132     "version": "0.0.0",
3133     "filename": "server/api/chatProactiveAction/index.js",
3134     "groupTitle": "Chat_Proactive_Actions"
3135   },
3136   {
3137     "type": "delete",
3138     "url": "/api/chat/proactive_actions/{id}",
3139     "title": "Deletes a Proactive Action",
3140     "examples": [
3141       {
3142         "title": "Example usage:",
3143         "content": "curl https://{domain}/api/chat/proactive_actions/{id} -v -u {name}:{password} -X DELETE",
3144         "type": "json"
3145       }
3146     ],
3147     "name": "DeleteProactive_Actions",
3148     "group": "Chat_Proactive_Actions",
3149     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3150     "version": "0.0.0",
3151     "filename": "server/api/chatProactiveAction/index.js",
3152     "groupTitle": "Chat_Proactive_Actions"
3153   },
3154   {
3155     "type": "get",
3156     "url": "/api/chat/proactive_actions/{id}",
3157     "title": "Gets a single Proactive Action",
3158     "examples": [
3159       {
3160         "title": "Example usage:",
3161         "content": "curl https://{domain}/api/chat/proactive_actions/{id} -v -u {name}:{password}",
3162         "type": "json"
3163       }
3164     ],
3165     "name": "ShowProactive_Actions",
3166     "group": "Chat_Proactive_Actions",
3167     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3168     "version": "0.0.0",
3169     "filename": "server/api/chatProactiveAction/index.js",
3170     "groupTitle": "Chat_Proactive_Actions"
3171   },
3172   {
3173     "type": "put",
3174     "url": "/api/chat/proactive_actions/{id}",
3175     "title": "Update an existing Proactive Action",
3176     "examples": [
3177       {
3178         "title": "Example usage:",
3179         "content": "curl https://{domain}/api/chat/proactive_actions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
3180         "type": "json"
3181       }
3182     ],
3183     "name": "updateProactive_Actions",
3184     "group": "Chat_Proactive_Actions",
3185     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3186     "version": "0.0.0",
3187     "filename": "server/api/chatProactiveAction/index.js",
3188     "groupTitle": "Chat_Proactive_Actions"
3189   },
3190   {
3191     "type": "post",
3192     "url": "/api/chat/reports/queue",
3193     "title": "Creates a new Chat Queue Report",
3194     "examples": [
3195       {
3196         "title": "Example usage:",
3197         "content": "curl https://{domain}/api/chat/reports/queue -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3198         "type": "json"
3199       }
3200     ],
3201     "name": "CreateChat_Queue_Reports",
3202     "group": "Chat_Queue_Reports",
3203     "parameter": {
3204       "fields": {
3205         "Body": [
3206           {
3207             "group": "Body",
3208             "type": "String",
3209             "optional": false,
3210             "field": "uniqueid",
3211             "description": ""
3212           },
3213           {
3214             "group": "Body",
3215             "type": "String",
3216             "optional": true,
3217             "field": "from",
3218             "description": ""
3219           },
3220           {
3221             "group": "Body",
3222             "type": "String",
3223             "optional": true,
3224             "field": "joinAt",
3225             "description": ""
3226           },
3227           {
3228             "group": "Body",
3229             "type": "String",
3230             "optional": true,
3231             "field": "leaveAt",
3232             "description": ""
3233           },
3234           {
3235             "group": "Body",
3236             "type": "String",
3237             "optional": true,
3238             "field": "acceptAt",
3239             "description": ""
3240           },
3241           {
3242             "group": "Body",
3243             "type": "String",
3244             "optional": true,
3245             "field": "exitAt",
3246             "description": ""
3247           },
3248           {
3249             "group": "Body",
3250             "type": "String",
3251             "optional": true,
3252             "field": "reason",
3253             "description": ""
3254           }
3255         ]
3256       }
3257     },
3258     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3259     "version": "0.0.0",
3260     "filename": "server/api/chatQueueReport/index.js",
3261     "groupTitle": "Chat_Queue_Reports"
3262   },
3263   {
3264     "type": "delete",
3265     "url": "/api/chat/reports/queue/{id}",
3266     "title": "Deletes a Chat Queue Report",
3267     "examples": [
3268       {
3269         "title": "Example usage:",
3270         "content": "curl https://{domain}/api/chat/reports/queue/{id} -v -u {name}:{password} -X DELETE",
3271         "type": "json"
3272       }
3273     ],
3274     "name": "DeleteChat_Queue_Reports",
3275     "group": "Chat_Queue_Reports",
3276     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3277     "version": "0.0.0",
3278     "filename": "server/api/chatQueueReport/index.js",
3279     "groupTitle": "Chat_Queue_Reports"
3280   },
3281   {
3282     "type": "get",
3283     "url": "/api/chat/reports/queue/describe",
3284     "title": "Gets table info about Chat Queue Reports",
3285     "examples": [
3286       {
3287         "title": "Example usage:",
3288         "content": "curl https://{domain}/api/chat/reports/queue/describe -v -u {name}:{password}",
3289         "type": "json"
3290       }
3291     ],
3292     "name": "DescribeChat_Queue_Reports",
3293     "group": "Chat_Queue_Reports",
3294     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3295     "version": "0.0.0",
3296     "filename": "server/api/chatQueueReport/index.js",
3297     "groupTitle": "Chat_Queue_Reports"
3298   },
3299   {
3300     "type": "get",
3301     "url": "/api/chat/reports/queue",
3302     "title": "Gets a list of Chat Queue Reports",
3303     "examples": [
3304       {
3305         "title": "Example usage:",
3306         "content": "curl https://{domain}/api/chat/reports/queue -v -u {name}:{password}",
3307         "type": "json"
3308       }
3309     ],
3310     "name": "GetChat_Queue_Reports",
3311     "group": "Chat_Queue_Reports",
3312     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/reports/queue?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/reports/queue?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/reports/queue?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/reports/queue?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/reports/queue?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
3313     "version": "0.0.0",
3314     "filename": "server/api/chatQueueReport/index.js",
3315     "groupTitle": "Chat_Queue_Reports"
3316   },
3317   {
3318     "type": "get",
3319     "url": "/api/chat/reports/queue/{id}",
3320     "title": "Gets a single Chat Queue Report",
3321     "examples": [
3322       {
3323         "title": "Example usage:",
3324         "content": "curl https://{domain}/api/chat/reports/queue/{id} -v -u {name}:{password}",
3325         "type": "json"
3326       }
3327     ],
3328     "name": "ShowChat_Queue_Reports",
3329     "group": "Chat_Queue_Reports",
3330     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3331     "version": "0.0.0",
3332     "filename": "server/api/chatQueueReport/index.js",
3333     "groupTitle": "Chat_Queue_Reports"
3334   },
3335   {
3336     "type": "put",
3337     "url": "/api/chat/reports/queue/{id}",
3338     "title": "Update an existing Chat Queue Report",
3339     "examples": [
3340       {
3341         "title": "Example usage:",
3342         "content": "curl https://{domain}/api/chat/reports/queue/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
3343         "type": "json"
3344       }
3345     ],
3346     "name": "updateChat_Queue_Reports",
3347     "group": "Chat_Queue_Reports",
3348     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3349     "version": "0.0.0",
3350     "filename": "server/api/chatQueueReport/index.js",
3351     "groupTitle": "Chat_Queue_Reports"
3352   },
3353   {
3354     "type": "post",
3355     "url": "/api/chat/queues/{id}/users",
3356     "title": "Add agents to a queue",
3357     "examples": [
3358       {
3359         "title": "Example usage:",
3360         "content": "curl https://{domain}/api/chat/queues/{id}/users -d '{\"ids\": [1,2], \"penalty\": 2}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
3361         "type": "json"
3362       }
3363     ],
3364     "name": "AddAgents",
3365     "group": "Chat_Queues",
3366     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3367     "version": "0.0.0",
3368     "filename": "server/api/chatQueue/index.js",
3369     "groupTitle": "Chat_Queues"
3370   },
3371   {
3372     "type": "post",
3373     "url": "/api/chat/queues/{id}/teams",
3374     "title": "Add teams to a queue",
3375     "examples": [
3376       {
3377         "title": "Example usage:",
3378         "content": "curl https://{domain}/api/chat/queues/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
3379         "type": "json"
3380       }
3381     ],
3382     "name": "AddTeams",
3383     "group": "Chat_Queues",
3384     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3385     "version": "0.0.0",
3386     "filename": "server/api/chatQueue/index.js",
3387     "groupTitle": "Chat_Queues"
3388   },
3389   {
3390     "type": "post",
3391     "url": "/api/chat/queues",
3392     "title": "Creates a new Queue",
3393     "examples": [
3394       {
3395         "title": "Example usage:",
3396         "content": "curl https://{domain}/api/chat/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3397         "type": "json"
3398       }
3399     ],
3400     "name": "CreateQueues",
3401     "group": "Chat_Queues",
3402     "parameter": {
3403       "fields": {
3404         "Body": [
3405           {
3406             "group": "Body",
3407             "type": "String",
3408             "optional": false,
3409             "field": "name",
3410             "description": ""
3411           },
3412           {
3413             "group": "Body",
3414             "type": "String",
3415             "optional": true,
3416             "field": "description",
3417             "description": ""
3418           },
3419           {
3420             "group": "Body",
3421             "type": "Integer",
3422             "optional": true,
3423             "field": "timeout",
3424             "description": ""
3425           },
3426           {
3427             "group": "Body",
3428             "type": "String",
3429             "allowedValues": [
3430               "\"rrmemory\"",
3431               "\"beepall\"",
3432               "\"roundrobin\""
3433             ],
3434             "optional": true,
3435             "field": "strategy",
3436             "description": ""
3437           }
3438         ]
3439       }
3440     },
3441     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3442     "version": "0.0.0",
3443     "filename": "server/api/chatQueue/index.js",
3444     "groupTitle": "Chat_Queues"
3445   },
3446   {
3447     "type": "delete",
3448     "url": "/api/chat/queues/{id}",
3449     "title": "Deletes a Queue",
3450     "examples": [
3451       {
3452         "title": "Example usage:",
3453         "content": "curl https://{domain}/api/chat/queues/{id} -v -u {name}:{password} -X DELETE",
3454         "type": "json"
3455       }
3456     ],
3457     "name": "DeleteQueues",
3458     "group": "Chat_Queues",
3459     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3460     "version": "0.0.0",
3461     "filename": "server/api/chatQueue/index.js",
3462     "groupTitle": "Chat_Queues"
3463   },
3464   {
3465     "type": "get",
3466     "url": "/api/chat/queues/describe",
3467     "title": "Gets table info about Queues",
3468     "examples": [
3469       {
3470         "title": "Example usage:",
3471         "content": "curl https://{domain}/api/chat/queues/describe -v -u {name}:{password}",
3472         "type": "json"
3473       }
3474     ],
3475     "name": "DescribeQueues",
3476     "group": "Chat_Queues",
3477     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3478     "version": "0.0.0",
3479     "filename": "server/api/chatQueue/index.js",
3480     "groupTitle": "Chat_Queues"
3481   },
3482   {
3483     "type": "get",
3484     "url": "/api/chat/queues/{id}/users",
3485     "title": "Gets queue agents",
3486     "examples": [
3487       {
3488         "title": "Example usage:",
3489         "content": "curl https://{domain}/api/chat/queues/{id}/users -v -u {name}:{password} -X POST",
3490         "type": "json"
3491       }
3492     ],
3493     "name": "GetAgents",
3494     "group": "Chat_Queues",
3495     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3496     "version": "0.0.0",
3497     "filename": "server/api/chatQueue/index.js",
3498     "groupTitle": "Chat_Queues"
3499   },
3500   {
3501     "type": "get",
3502     "url": "/api/chat/queues/{id}/members",
3503     "title": "GetMembers",
3504     "examples": [
3505       {
3506         "title": "Example usage:",
3507         "content": "curl https://{domain}/api/chat/queues/{id}/members  -v -u {name}:{password}",
3508         "type": "json"
3509       }
3510     ],
3511     "name": "GetMembers",
3512     "group": "Chat_Queues",
3513     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3514     "version": "0.0.0",
3515     "filename": "server/api/chatQueue/index.js",
3516     "groupTitle": "Chat_Queues"
3517   },
3518   {
3519     "type": "get",
3520     "url": "/api/chat/queues",
3521     "title": "Gets a list of Queues",
3522     "examples": [
3523       {
3524         "title": "Example usage:",
3525         "content": "curl https://{domain}/api/chat/queues -v -u {name}:{password}",
3526         "type": "json"
3527       }
3528     ],
3529     "name": "GetQueues",
3530     "group": "Chat_Queues",
3531     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/queues?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/queues?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/queues?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/queues?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/queues?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
3532     "version": "0.0.0",
3533     "filename": "server/api/chatQueue/index.js",
3534     "groupTitle": "Chat_Queues"
3535   },
3536   {
3537     "type": "get",
3538     "url": "/api/chat/queues/{id}/teams",
3539     "title": "Gets queues list",
3540     "examples": [
3541       {
3542         "title": "Example usage:",
3543         "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password}",
3544         "type": "json"
3545       }
3546     ],
3547     "name": "GetTeams",
3548     "group": "Chat_Queues",
3549     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3550     "version": "0.0.0",
3551     "filename": "server/api/chatQueue/index.js",
3552     "groupTitle": "Chat_Queues"
3553   },
3554   {
3555     "type": "delete",
3556     "url": "/api/chat/queues/{id}/users",
3557     "title": "Removes agents from a queue",
3558     "examples": [
3559       {
3560         "title": "Example usage:",
3561         "content": "curl https://{domain}/api/chat/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
3562         "type": "json"
3563       }
3564     ],
3565     "name": "RemoveAgents",
3566     "group": "Chat_Queues",
3567     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3568     "version": "0.0.0",
3569     "filename": "server/api/chatQueue/index.js",
3570     "groupTitle": "Chat_Queues"
3571   },
3572   {
3573     "type": "get",
3574     "url": "/api/chat/queues/{id}",
3575     "title": "Gets a single Queue",
3576     "examples": [
3577       {
3578         "title": "Example usage:",
3579         "content": "curl https://{domain}/api/chat/queues/{id} -v -u {name}:{password}",
3580         "type": "json"
3581       }
3582     ],
3583     "name": "ShowQueues",
3584     "group": "Chat_Queues",
3585     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3586     "version": "0.0.0",
3587     "filename": "server/api/chatQueue/index.js",
3588     "groupTitle": "Chat_Queues"
3589   },
3590   {
3591     "type": "put",
3592     "url": "/api/chat/queues/{id}",
3593     "title": "Update an existing Queue",
3594     "examples": [
3595       {
3596         "title": "Example usage:",
3597         "content": "curl https://{domain}/api/chat/queues/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
3598         "type": "json"
3599       }
3600     ],
3601     "name": "updateQueues",
3602     "group": "Chat_Queues",
3603     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3604     "version": "0.0.0",
3605     "filename": "server/api/chatQueue/index.js",
3606     "groupTitle": "Chat_Queues"
3607   },
3608   {
3609     "type": "post",
3610     "url": "/api/chat/reports/transfer",
3611     "title": "Creates a new Chat Transfer Report",
3612     "examples": [
3613       {
3614         "title": "Example usage:",
3615         "content": "curl https://{domain}/api/chat/reports/transfer -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3616         "type": "json"
3617       }
3618     ],
3619     "name": "CreateChat_Transfer_Reports",
3620     "group": "Chat_Transfer_Reports",
3621     "parameter": {
3622       "fields": {
3623         "Body": [
3624           {
3625             "group": "Body",
3626             "type": "String",
3627             "optional": false,
3628             "field": "uniqueid",
3629             "description": ""
3630           },
3631           {
3632             "group": "Body",
3633             "type": "String",
3634             "allowedValues": [
3635               "\"account\"",
3636               "\"agent\"",
3637               "\"queue\""
3638             ],
3639             "optional": false,
3640             "field": "type",
3641             "description": ""
3642           },
3643           {
3644             "group": "Body",
3645             "type": "String",
3646             "optional": false,
3647             "field": "transferredAt",
3648             "description": ""
3649           }
3650         ]
3651       }
3652     },
3653     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3654     "version": "0.0.0",
3655     "filename": "server/api/chatTransferReport/index.js",
3656     "groupTitle": "Chat_Transfer_Reports"
3657   },
3658   {
3659     "type": "delete",
3660     "url": "/api/chat/reports/transfer/{id}",
3661     "title": "Deletes a Chat Transfer Report",
3662     "examples": [
3663       {
3664         "title": "Example usage:",
3665         "content": "curl https://{domain}/api/chat/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
3666         "type": "json"
3667       }
3668     ],
3669     "name": "DeleteChat_Transfer_Reports",
3670     "group": "Chat_Transfer_Reports",
3671     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3672     "version": "0.0.0",
3673     "filename": "server/api/chatTransferReport/index.js",
3674     "groupTitle": "Chat_Transfer_Reports"
3675   },
3676   {
3677     "type": "get",
3678     "url": "/api/chat/reports/transfer/describe",
3679     "title": "Gets table info about Chat Transfer Reports",
3680     "examples": [
3681       {
3682         "title": "Example usage:",
3683         "content": "curl https://{domain}/api/chat/reports/transfer/describe -v -u {name}:{password}",
3684         "type": "json"
3685       }
3686     ],
3687     "name": "DescribeChat_Transfer_Reports",
3688     "group": "Chat_Transfer_Reports",
3689     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3690     "version": "0.0.0",
3691     "filename": "server/api/chatTransferReport/index.js",
3692     "groupTitle": "Chat_Transfer_Reports"
3693   },
3694   {
3695     "type": "get",
3696     "url": "/api/chat/reports/transfer",
3697     "title": "Gets a list of Chat Transfer Reports",
3698     "examples": [
3699       {
3700         "title": "Example usage:",
3701         "content": "curl https://{domain}/api/chat/reports/transfer -v -u {name}:{password}",
3702         "type": "json"
3703       }
3704     ],
3705     "name": "GetChat_Transfer_Reports",
3706     "group": "Chat_Transfer_Reports",
3707     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/reports/transfer?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/reports/transfer?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/reports/transfer?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/reports/transfer?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/reports/transfer?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
3708     "version": "0.0.0",
3709     "filename": "server/api/chatTransferReport/index.js",
3710     "groupTitle": "Chat_Transfer_Reports"
3711   },
3712   {
3713     "type": "get",
3714     "url": "/api/chat/reports/transfer/{id}",
3715     "title": "Gets a single Chat Transfer Report",
3716     "examples": [
3717       {
3718         "title": "Example usage:",
3719         "content": "curl https://{domain}/api/chat/reports/transfer/{id} -v -u {name}:{password}",
3720         "type": "json"
3721       }
3722     ],
3723     "name": "ShowChat_Transfer_Reports",
3724     "group": "Chat_Transfer_Reports",
3725     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3726     "version": "0.0.0",
3727     "filename": "server/api/chatTransferReport/index.js",
3728     "groupTitle": "Chat_Transfer_Reports"
3729   },
3730   {
3731     "type": "put",
3732     "url": "/api/chat/reports/transfer/{id}",
3733     "title": "Update an existing Chat Transfer Report",
3734     "examples": [
3735       {
3736         "title": "Example usage:",
3737         "content": "curl https://{domain}/api/chat/reports/transfer/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
3738         "type": "json"
3739       }
3740     ],
3741     "name": "updateChat_Transfer_Reports",
3742     "group": "Chat_Transfer_Reports",
3743     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3744     "version": "0.0.0",
3745     "filename": "server/api/chatTransferReport/index.js",
3746     "groupTitle": "Chat_Transfer_Reports"
3747   },
3748   {
3749     "type": "post",
3750     "url": "/api/chat/websites/{id}/users",
3751     "title": "Add agents to a website",
3752     "examples": [
3753       {
3754         "title": "Example usage:",
3755         "content": "curl https://{domain}/api/chat/websites/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
3756         "type": "json"
3757       }
3758     ],
3759     "name": "AddAgents",
3760     "group": "Chat_Websites",
3761     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3762     "version": "0.0.0",
3763     "filename": "server/api/chatWebsite/index.js",
3764     "groupTitle": "Chat_Websites"
3765   },
3766   {
3767     "type": "post",
3768     "url": "/api/chat/websites",
3769     "title": "Creates a new Website",
3770     "examples": [
3771       {
3772         "title": "Example usage:",
3773         "content": "curl https://{domain}/api/chat/websites -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3774         "type": "json"
3775       }
3776     ],
3777     "name": "CreateWebsites",
3778     "group": "Chat_Websites",
3779     "parameter": {
3780       "fields": {
3781         "Body": [
3782           {
3783             "group": "Body",
3784             "type": "String",
3785             "optional": false,
3786             "field": "name",
3787             "description": ""
3788           },
3789           {
3790             "group": "Body",
3791             "type": "String",
3792             "optional": false,
3793             "field": "address",
3794             "description": ""
3795           },
3796           {
3797             "group": "Body",
3798             "type": "String",
3799             "optional": true,
3800             "field": "description",
3801             "description": ""
3802           },
3803           {
3804             "group": "Body",
3805             "type": "String",
3806             "optional": true,
3807             "field": "mapKey",
3808             "description": ""
3809           },
3810           {
3811             "group": "Body",
3812             "type": "String",
3813             "optional": true,
3814             "field": "mapKeyOffline",
3815             "description": ""
3816           },
3817           {
3818             "group": "Body",
3819             "type": "String",
3820             "optional": false,
3821             "field": "key",
3822             "description": ""
3823           },
3824           {
3825             "group": "Body",
3826             "type": "String",
3827             "optional": true,
3828             "field": "agentAlias",
3829             "description": ""
3830           },
3831           {
3832             "group": "Body",
3833             "type": "String",
3834             "optional": true,
3835             "field": "customerAlias",
3836             "description": ""
3837           },
3838           {
3839             "group": "Body",
3840             "type": "String",
3841             "optional": false,
3842             "field": "color",
3843             "description": ""
3844           },
3845           {
3846             "group": "Body",
3847             "type": "String",
3848             "optional": false,
3849             "field": "color_button",
3850             "description": ""
3851           },
3852           {
3853             "group": "Body",
3854             "type": "String",
3855             "optional": false,
3856             "field": "textColor",
3857             "description": ""
3858           },
3859           {
3860             "group": "Body",
3861             "type": "Integer",
3862             "optional": true,
3863             "field": "fontSize",
3864             "description": ""
3865           },
3866           {
3867             "group": "Body",
3868             "type": "String",
3869             "optional": true,
3870             "field": "remote",
3871             "description": ""
3872           },
3873           {
3874             "group": "Body",
3875             "type": "Boolean",
3876             "optional": true,
3877             "field": "animation",
3878             "description": ""
3879           },
3880           {
3881             "group": "Body",
3882             "type": "String",
3883             "allowedValues": [
3884               "\"rounded\"",
3885               "\"squared\""
3886             ],
3887             "optional": true,
3888             "field": "header_shape",
3889             "description": ""
3890           },
3891           {
3892             "group": "Body",
3893             "type": "String",
3894             "optional": true,
3895             "field": "header_online",
3896             "description": ""
3897           },
3898           {
3899             "group": "Body",
3900             "type": "String",
3901             "optional": true,
3902             "field": "start_chat_button",
3903             "description": ""
3904           },
3905           {
3906             "group": "Body",
3907             "type": "String",
3908             "optional": true,
3909             "field": "offline_chat_button",
3910             "description": ""
3911           },
3912           {
3913             "group": "Body",
3914             "type": "String",
3915             "optional": true,
3916             "field": "header_offline",
3917             "description": ""
3918           },
3919           {
3920             "group": "Body",
3921             "type": "Boolean",
3922             "optional": true,
3923             "field": "download_transcript",
3924             "description": ""
3925           },
3926           {
3927             "group": "Body",
3928             "type": "Integer",
3929             "optional": true,
3930             "field": "timeout",
3931             "description": ""
3932           },
3933           {
3934             "group": "Body",
3935             "type": "String",
3936             "optional": true,
3937             "field": "whiteLabel",
3938             "description": ""
3939           },
3940           {
3941             "group": "Body",
3942             "type": "Boolean",
3943             "optional": true,
3944             "field": "defaultWhiteLabel",
3945             "description": ""
3946           },
3947           {
3948             "group": "Body",
3949             "type": "Text",
3950             "optional": true,
3951             "field": "sitepic",
3952             "description": ""
3953           },
3954           {
3955             "group": "Body",
3956             "type": "String",
3957             "optional": true,
3958             "field": "closingQuestion",
3959             "description": ""
3960           },
3961           {
3962             "group": "Body",
3963             "type": "String",
3964             "optional": true,
3965             "field": "formSubmitSuccessMessage",
3966             "description": ""
3967           },
3968           {
3969             "group": "Body",
3970             "type": "String",
3971             "optional": true,
3972             "field": "formSubmitFailureMessage",
3973             "description": ""
3974           },
3975           {
3976             "group": "Body",
3977             "type": "String",
3978             "optional": true,
3979             "field": "noteTitle",
3980             "description": ""
3981           },
3982           {
3983             "group": "Body",
3984             "type": "String",
3985             "optional": true,
3986             "field": "placeholderMessage",
3987             "description": ""
3988           },
3989           {
3990             "group": "Body",
3991             "type": "String",
3992             "optional": true,
3993             "field": "closingMessage",
3994             "description": ""
3995           },
3996           {
3997             "group": "Body",
3998             "type": "String",
3999             "optional": true,
4000             "field": "closingMessageButton",
4001             "description": ""
4002           },
4003           {
4004             "group": "Body",
4005             "type": "String",
4006             "optional": true,
4007             "field": "skipMessageButton",
4008             "description": ""
4009           },
4010           {
4011             "group": "Body",
4012             "type": "Boolean",
4013             "optional": true,
4014             "field": "conditionAgreement",
4015             "description": ""
4016           },
4017           {
4018             "group": "Body",
4019             "type": "Boolean",
4020             "optional": true,
4021             "field": "enableRating",
4022             "description": ""
4023           },
4024           {
4025             "group": "Body",
4026             "type": "Boolean",
4027             "optional": true,
4028             "field": "enableFeedback",
4029             "description": ""
4030           },
4031           {
4032             "group": "Body",
4033             "type": "Boolean",
4034             "optional": true,
4035             "field": "enableSendButton",
4036             "description": ""
4037           },
4038           {
4039             "group": "Body",
4040             "type": "String",
4041             "optional": true,
4042             "field": "feedbackTitle",
4043             "description": ""
4044           },
4045           {
4046             "group": "Body",
4047             "type": "String",
4048             "allowedValues": [
4049               "\"star\"",
4050               "\"thumb\""
4051             ],
4052             "optional": true,
4053             "field": "ratingType",
4054             "description": ""
4055           },
4056           {
4057             "group": "Body",
4058             "type": "Integer",
4059             "optional": true,
4060             "field": "ratingStarsNumber",
4061             "description": ""
4062           },
4063           {
4064             "group": "Body",
4065             "type": "Text",
4066             "optional": true,
4067             "field": "onlineForm",
4068             "description": ""
4069           },
4070           {
4071             "group": "Body",
4072             "type": "Text",
4073             "optional": true,
4074             "field": "offlineForm",
4075             "description": ""
4076           },
4077           {
4078             "group": "Body",
4079             "type": "String",
4080             "optional": true,
4081             "field": "token",
4082             "description": ""
4083           },
4084           {
4085             "group": "Body",
4086             "type": "Boolean",
4087             "optional": true,
4088             "field": "autoclose",
4089             "description": ""
4090           },
4091           {
4092             "group": "Body",
4093             "type": "Boolean",
4094             "optional": true,
4095             "field": "enableCustomerWriting",
4096             "description": ""
4097           },
4098           {
4099             "group": "Body",
4100             "type": "Boolean",
4101             "optional": true,
4102             "field": "forwardTranscript",
4103             "description": ""
4104           },
4105           {
4106             "group": "Body",
4107             "type": "String",
4108             "optional": true,
4109             "field": "forwardTranscriptMessage",
4110             "description": ""
4111           },
4112           {
4113             "group": "Body",
4114             "type": "Boolean",
4115             "optional": true,
4116             "field": "forwardOffline",
4117             "description": ""
4118           },
4119           {
4120             "group": "Body",
4121             "type": "String",
4122             "optional": true,
4123             "field": "forwardOfflineAddress",
4124             "description": ""
4125           },
4126           {
4127             "group": "Body",
4128             "type": "String",
4129             "optional": true,
4130             "field": "waitingTitle",
4131             "description": ""
4132           },
4133           {
4134             "group": "Body",
4135             "type": "String",
4136             "optional": true,
4137             "field": "waitingMessage",
4138             "description": ""
4139           },
4140           {
4141             "group": "Body",
4142             "type": "String",
4143             "optional": true,
4144             "field": "offlineMessageSubject",
4145             "description": ""
4146           },
4147           {
4148             "group": "Body",
4149             "type": "String",
4150             "optional": true,
4151             "field": "offlineMessageBody",
4152             "description": ""
4153           },
4154           {
4155             "group": "Body",
4156             "type": "Boolean",
4157             "optional": true,
4158             "field": "enableUnmanagedNote",
4159             "description": ""
4160           },
4161           {
4162             "group": "Body",
4163             "type": "String",
4164             "optional": true,
4165             "field": "unmanagedMessage",
4166             "description": ""
4167           },
4168           {
4169             "group": "Body",
4170             "type": "String",
4171             "optional": true,
4172             "field": "skipUnmanaged",
4173             "description": ""
4174           },
4175           {
4176             "group": "Body",
4177             "type": "String",
4178             "optional": true,
4179             "field": "sendUnmanaged",
4180             "description": ""
4181           },
4182           {
4183             "group": "Body",
4184             "type": "Boolean",
4185             "optional": true,
4186             "field": "enableCustomerAttachment",
4187             "description": ""
4188           },
4189           {
4190             "group": "Body",
4191             "type": "Boolean",
4192             "optional": true,
4193             "field": "enableCustomerCheckmarks",
4194             "description": ""
4195           },
4196           {
4197             "group": "Body",
4198             "type": "Text",
4199             "optional": true,
4200             "field": "agentAvatar",
4201             "description": ""
4202           },
4203           {
4204             "group": "Body",
4205             "type": "Boolean",
4206             "optional": true,
4207             "field": "showAgentAvatar",
4208             "description": ""
4209           },
4210           {
4211             "group": "Body",
4212             "type": "String",
4213             "optional": true,
4214             "field": "timezone",
4215             "description": ""
4216           },
4217           {
4218             "group": "Body",
4219             "type": "Text",
4220             "optional": true,
4221             "field": "notificationTemplate",
4222             "description": ""
4223           },
4224           {
4225             "group": "Body",
4226             "type": "Boolean",
4227             "optional": true,
4228             "field": "notificationSound",
4229             "description": ""
4230           },
4231           {
4232             "group": "Body",
4233             "type": "Boolean",
4234             "optional": true,
4235             "field": "notificationShake",
4236             "description": ""
4237           },
4238           {
4239             "group": "Body",
4240             "type": "Boolean",
4241             "optional": true,
4242             "field": "hideWhenOffline",
4243             "description": ""
4244           },
4245           {
4246             "group": "Body",
4247             "type": "String",
4248             "optional": true,
4249             "field": "agentIdentifier",
4250             "description": ""
4251           },
4252           {
4253             "group": "Body",
4254             "type": "Integer",
4255             "optional": true,
4256             "field": "waitForTheAssignedAgent",
4257             "description": ""
4258           },
4259           {
4260             "group": "Body",
4261             "type": "String",
4262             "optional": true,
4263             "field": "alignment",
4264             "description": ""
4265           },
4266           {
4267             "group": "Body",
4268             "type": "Integer",
4269             "optional": true,
4270             "field": "verticalAlignment",
4271             "description": ""
4272           },
4273           {
4274             "group": "Body",
4275             "type": "String",
4276             "optional": true,
4277             "field": "messagesAlignment",
4278             "description": ""
4279           },
4280           {
4281             "group": "Body",
4282             "type": "String",
4283             "optional": true,
4284             "field": "defaultTitle",
4285             "description": ""
4286           },
4287           {
4288             "group": "Body",
4289             "type": "Text",
4290             "optional": true,
4291             "field": "customerAvatar",
4292             "description": ""
4293           },
4294           {
4295             "group": "Body",
4296             "type": "Boolean",
4297             "optional": true,
4298             "field": "showCustomerAvatar",
4299             "description": ""
4300           },
4301           {
4302             "group": "Body",
4303             "type": "Integer",
4304             "optional": true,
4305             "field": "messageFontSize",
4306             "description": ""
4307           },
4308           {
4309             "group": "Body",
4310             "type": "String",
4311             "optional": false,
4312             "field": "backgroundColor",
4313             "description": ""
4314           },
4315           {
4316             "group": "Body",
4317             "type": "Boolean",
4318             "optional": true,
4319             "field": "queueTransfer",
4320             "description": ""
4321           },
4322           {
4323             "group": "Body",
4324             "type": "Integer",
4325             "optional": true,
4326             "field": "queueTransferTimeout",
4327             "description": ""
4328           },
4329           {
4330             "group": "Body",
4331             "type": "Boolean",
4332             "optional": true,
4333             "field": "agentTransfer",
4334             "description": ""
4335           },
4336           {
4337             "group": "Body",
4338             "type": "Integer",
4339             "optional": true,
4340             "field": "agentTransferTimeout",
4341             "description": ""
4342           },
4343           {
4344             "group": "Body",
4345             "type": "String",
4346             "optional": true,
4347             "field": "systemAlias",
4348             "description": ""
4349           },
4350           {
4351             "group": "Body",
4352             "type": "Text",
4353             "optional": true,
4354             "field": "systemAvatar",
4355             "description": ""
4356           },
4357           {
4358             "group": "Body",
4359             "type": "Integer",
4360             "optional": true,
4361             "field": "mandatoryDispositionPauseId",
4362             "description": "<p>Status to put when mandatory disposition is enabled</p>"
4363           },
4364           {
4365             "group": "Body",
4366             "type": "Boolean",
4367             "optional": true,
4368             "field": "mandatoryDisposition",
4369             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
4370           },
4371           {
4372             "group": "Body",
4373             "type": "Boolean",
4374             "optional": true,
4375             "field": "vidaooEscalation",
4376             "description": ""
4377           },
4378           {
4379             "group": "Body",
4380             "type": "String",
4381             "optional": true,
4382             "field": "vidaooApiKey",
4383             "description": ""
4384           },
4385           {
4386             "group": "Body",
4387             "type": "Boolean",
4388             "optional": true,
4389             "field": "openNewInteraction",
4390             "description": ""
4391           }
4392         ]
4393       }
4394     },
4395     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4396     "version": "0.0.0",
4397     "filename": "server/api/chatWebsite/index.js",
4398     "groupTitle": "Chat_Websites"
4399   },
4400   {
4401     "type": "delete",
4402     "url": "/api/chat/websites/{id}",
4403     "title": "Deletes a Website",
4404     "examples": [
4405       {
4406         "title": "Example usage:",
4407         "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password} -X DELETE",
4408         "type": "json"
4409       }
4410     ],
4411     "name": "DeleteWebsites",
4412     "group": "Chat_Websites",
4413     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4414     "version": "0.0.0",
4415     "filename": "server/api/chatWebsite/index.js",
4416     "groupTitle": "Chat_Websites"
4417   },
4418   {
4419     "type": "get",
4420     "url": "/api/chat/websites/describe",
4421     "title": "Gets table info about Websites",
4422     "examples": [
4423       {
4424         "title": "Example usage:",
4425         "content": "curl https://{domain}/api/chat/websites/describe -v -u {name}:{password}",
4426         "type": "json"
4427       }
4428     ],
4429     "name": "DescribeWebsites",
4430     "group": "Chat_Websites",
4431     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4432     "version": "0.0.0",
4433     "filename": "server/api/chatWebsite/index.js",
4434     "groupTitle": "Chat_Websites"
4435   },
4436   {
4437     "type": "get",
4438     "url": "/api/chat/websites/{id}/users",
4439     "title": "Gets agents from website",
4440     "examples": [
4441       {
4442         "title": "Example usage:",
4443         "content": "curl https://{domain}/api/chat/websites/{id}/users -v -u {name}:{password} -X GET",
4444         "type": "json"
4445       }
4446     ],
4447     "name": "GetAgents",
4448     "group": "Chat_Websites",
4449     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4450     "version": "0.0.0",
4451     "filename": "server/api/chatWebsite/index.js",
4452     "groupTitle": "Chat_Websites"
4453   },
4454   {
4455     "type": "get",
4456     "url": "/api/chat/websites",
4457     "title": "Gets a list of Websites",
4458     "examples": [
4459       {
4460         "title": "Example usage:",
4461         "content": "curl https://{domain}/api/chat/websites -v -u {name}:{password}",
4462         "type": "json"
4463       }
4464     ],
4465     "name": "GetWebsites",
4466     "group": "Chat_Websites",
4467     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
4468     "version": "0.0.0",
4469     "filename": "server/api/chatWebsite/index.js",
4470     "groupTitle": "Chat_Websites"
4471   },
4472   {
4473     "type": "delete",
4474     "url": "/api/chat/websites/{id}/users",
4475     "title": "Removes agents from a website",
4476     "examples": [
4477       {
4478         "title": "Example usage:",
4479         "content": "curl https://{domain}/api/chat/websites/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4480         "type": "json"
4481       }
4482     ],
4483     "name": "RemoveAgents",
4484     "group": "Chat_Websites",
4485     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4486     "version": "0.0.0",
4487     "filename": "server/api/chatWebsite/index.js",
4488     "groupTitle": "Chat_Websites"
4489   },
4490   {
4491     "type": "delete",
4492     "url": "/api/chat/websites/{id}/canned_answers",
4493     "title": "Removes canned answers from account",
4494     "examples": [
4495       {
4496         "title": "Example usage:",
4497         "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4498         "type": "json"
4499       }
4500     ],
4501     "name": "RemoveAnswers",
4502     "group": "Chat_Websites",
4503     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4504     "version": "0.0.0",
4505     "filename": "server/api/chatWebsite/index.js",
4506     "groupTitle": "Chat_Websites"
4507   },
4508   {
4509     "type": "delete",
4510     "url": "/api/chat/websites/{id}/dispositions",
4511     "title": "Removes canned answers from account",
4512     "examples": [
4513       {
4514         "title": "Example usage:",
4515         "content": "curl https://{domain}/api/chat/websites/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4516         "type": "json"
4517       }
4518     ],
4519     "name": "RemoveDispositions",
4520     "group": "Chat_Websites",
4521     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4522     "version": "0.0.0",
4523     "filename": "server/api/chatWebsite/index.js",
4524     "groupTitle": "Chat_Websites"
4525   },
4526   {
4527     "type": "get",
4528     "url": "/api/chat/websites/{id}",
4529     "title": "Gets a single Website",
4530     "examples": [
4531       {
4532         "title": "Example usage:",
4533         "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password}",
4534         "type": "json"
4535       }
4536     ],
4537     "name": "ShowWebsites",
4538     "group": "Chat_Websites",
4539     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4540     "version": "0.0.0",
4541     "filename": "server/api/chatWebsite/index.js",
4542     "groupTitle": "Chat_Websites"
4543   },
4544   {
4545     "type": "put",
4546     "url": "/api/chat/messages/{id}/accept",
4547     "title": "Accepts message",
4548     "examples": [
4549       {
4550         "title": "Example usage:",
4551         "content": "curl https://{domain}/api/chat/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
4552         "type": "json"
4553       }
4554     ],
4555     "name": "acceptMessage",
4556     "group": "Chat_Websites",
4557     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4558     "version": "0.0.0",
4559     "filename": "server/api/chatMessage/index.js",
4560     "groupTitle": "Chat_Websites"
4561   },
4562   {
4563     "type": "post",
4564     "url": "/api/chat/websites/{id}/canned_answers",
4565     "title": "Creates new canned answer",
4566     "examples": [
4567       {
4568         "title": "Example usage:",
4569         "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",
4570         "type": "json"
4571       }
4572     ],
4573     "name": "addAnswer",
4574     "group": "Chat_Websites",
4575     "parameter": {
4576       "fields": {
4577         "Body": [
4578           {
4579             "group": "Body",
4580             "type": "String",
4581             "optional": false,
4582             "field": "key",
4583             "description": ""
4584           },
4585           {
4586             "group": "Body",
4587             "type": "Text",
4588             "optional": false,
4589             "field": "value",
4590             "description": ""
4591           },
4592           {
4593             "group": "Body",
4594             "type": "String",
4595             "optional": true,
4596             "field": "description",
4597             "description": ""
4598           },
4599           {
4600             "group": "Body",
4601             "type": "Virtual",
4602             "optional": true,
4603             "field": "name",
4604             "description": ""
4605           }
4606         ]
4607       }
4608     },
4609     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4610     "version": "0.0.0",
4611     "filename": "server/api/chatWebsite/index.js",
4612     "groupTitle": "Chat_Websites"
4613   },
4614   {
4615     "type": "post",
4616     "url": "/api/chat/websites/{id}/applications",
4617     "title": "Creates new applications",
4618     "examples": [
4619       {
4620         "title": "Example usage:",
4621         "content": "curl https://{domain}/api/chat/websites/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4622         "type": "json"
4623       }
4624     ],
4625     "name": "addApplications",
4626     "group": "Chat_Websites",
4627     "parameter": {
4628       "fields": {
4629         "Body": [
4630           {
4631             "group": "Body",
4632             "type": "Integer",
4633             "optional": false,
4634             "field": "priority",
4635             "description": ""
4636           },
4637           {
4638             "group": "Body",
4639             "type": "String",
4640             "optional": false,
4641             "field": "app",
4642             "description": ""
4643           },
4644           {
4645             "group": "Body",
4646             "type": "Text",
4647             "optional": true,
4648             "field": "appdata",
4649             "description": ""
4650           },
4651           {
4652             "group": "Body",
4653             "type": "String",
4654             "optional": true,
4655             "field": "description",
4656             "description": ""
4657           },
4658           {
4659             "group": "Body",
4660             "type": "String",
4661             "optional": true,
4662             "field": "interval",
4663             "description": ""
4664           }
4665         ]
4666       }
4667     },
4668     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4669     "version": "0.0.0",
4670     "filename": "server/api/chatWebsite/index.js",
4671     "groupTitle": "Chat_Websites"
4672   },
4673   {
4674     "type": "post",
4675     "url": "/api/chat/websites/{id}/avatar",
4676     "title": "Add avatar",
4677     "examples": [
4678       {
4679         "title": "Example usage:",
4680         "content": "curl https://{domain}/api/chat/websites/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
4681         "type": "json"
4682       }
4683     ],
4684     "name": "addAvatar",
4685     "group": "Chat_Websites",
4686     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4687     "version": "0.0.0",
4688     "filename": "server/api/chatWebsite/index.js",
4689     "groupTitle": "Chat_Websites"
4690   },
4691   {
4692     "type": "post",
4693     "url": "/api/chat/websites/{id}/customer_avatar",
4694     "title": "Add customer avatar",
4695     "examples": [
4696       {
4697         "title": "Example usage:",
4698         "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",
4699         "type": "json"
4700       }
4701     ],
4702     "name": "addCustomerAvatar",
4703     "group": "Chat_Websites",
4704     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4705     "version": "0.0.0",
4706     "filename": "server/api/chatWebsite/index.js",
4707     "groupTitle": "Chat_Websites"
4708   },
4709   {
4710     "type": "post",
4711     "url": "/api/chat/websites/{id}/dispositions",
4712     "title": "Creates new disposition",
4713     "examples": [
4714       {
4715         "title": "Example usage:",
4716         "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4717         "type": "json"
4718       }
4719     ],
4720     "name": "addDisposition",
4721     "group": "Chat_Websites",
4722     "parameter": {
4723       "fields": {
4724         "Body": [
4725           {
4726             "group": "Body",
4727             "type": "String",
4728             "optional": false,
4729             "field": "name",
4730             "description": ""
4731           },
4732           {
4733             "group": "Body",
4734             "type": "String",
4735             "allowedValues": [
4736               "\"first\"",
4737               "\"second\"",
4738               "\"third\""
4739             ],
4740             "optional": false,
4741             "field": "level",
4742             "description": ""
4743           },
4744           {
4745             "group": "Body",
4746             "type": "String",
4747             "optional": true,
4748             "field": "description",
4749             "description": ""
4750           }
4751         ]
4752       }
4753     },
4754     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4755     "version": "0.0.0",
4756     "filename": "server/api/chatWebsite/index.js",
4757     "groupTitle": "Chat_Websites"
4758   },
4759   {
4760     "type": "post",
4761     "url": "/api/chat/accounts/{id}/interactions",
4762     "title": "Creates new interactions",
4763     "examples": [
4764       {
4765         "title": "Example usage:",
4766         "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",
4767         "type": "json"
4768       }
4769     ],
4770     "name": "addInteraction",
4771     "group": "Chat_Websites",
4772     "parameter": {
4773       "fields": {
4774         "Body": [
4775           {
4776             "group": "Body",
4777             "type": "Boolean",
4778             "optional": true,
4779             "field": "closed",
4780             "description": ""
4781           },
4782           {
4783             "group": "Body",
4784             "type": "Integer",
4785             "optional": true,
4786             "field": "ratingValue",
4787             "description": ""
4788           },
4789           {
4790             "group": "Body",
4791             "type": "String",
4792             "allowedValues": [
4793               "\"star\"",
4794               "\"thumb\""
4795             ],
4796             "optional": true,
4797             "field": "ratingType",
4798             "description": ""
4799           },
4800           {
4801             "group": "Body",
4802             "type": "Text",
4803             "optional": true,
4804             "field": "ratingMessage",
4805             "description": ""
4806           },
4807           {
4808             "group": "Body",
4809             "type": "Text",
4810             "optional": true,
4811             "field": "pathTranscript",
4812             "description": ""
4813           },
4814           {
4815             "group": "Body",
4816             "type": "String",
4817             "optional": true,
4818             "field": "mailTranscript",
4819             "description": ""
4820           },
4821           {
4822             "group": "Body",
4823             "type": "String",
4824             "optional": true,
4825             "field": "closedAt",
4826             "description": ""
4827           },
4828           {
4829             "group": "Body",
4830             "type": "String",
4831             "optional": true,
4832             "field": "disposition",
4833             "description": ""
4834           },
4835           {
4836             "group": "Body",
4837             "type": "String",
4838             "optional": true,
4839             "field": "secondDisposition",
4840             "description": ""
4841           },
4842           {
4843             "group": "Body",
4844             "type": "String",
4845             "optional": true,
4846             "field": "thirdDisposition",
4847             "description": ""
4848           },
4849           {
4850             "group": "Body",
4851             "type": "String",
4852             "optional": true,
4853             "field": "note",
4854             "description": ""
4855           },
4856           {
4857             "group": "Body",
4858             "type": "String",
4859             "optional": true,
4860             "field": "browserName",
4861             "description": ""
4862           },
4863           {
4864             "group": "Body",
4865             "type": "String",
4866             "optional": true,
4867             "field": "browserVersion",
4868             "description": ""
4869           },
4870           {
4871             "group": "Body",
4872             "type": "String",
4873             "optional": true,
4874             "field": "osName",
4875             "description": ""
4876           },
4877           {
4878             "group": "Body",
4879             "type": "String",
4880             "optional": true,
4881             "field": "osVersion",
4882             "description": ""
4883           },
4884           {
4885             "group": "Body",
4886             "type": "String",
4887             "optional": true,
4888             "field": "deviceModel",
4889             "description": ""
4890           },
4891           {
4892             "group": "Body",
4893             "type": "String",
4894             "optional": true,
4895             "field": "deviceVendor",
4896             "description": ""
4897           },
4898           {
4899             "group": "Body",
4900             "type": "String",
4901             "optional": true,
4902             "field": "deviceType",
4903             "description": ""
4904           },
4905           {
4906             "group": "Body",
4907             "type": "Text",
4908             "optional": true,
4909             "field": "referer",
4910             "description": ""
4911           },
4912           {
4913             "group": "Body",
4914             "type": "String",
4915             "optional": true,
4916             "field": "customerIp",
4917             "description": ""
4918           },
4919           {
4920             "group": "Body",
4921             "type": "Text",
4922             "optional": true,
4923             "field": "formData",
4924             "description": ""
4925           },
4926           {
4927             "group": "Body",
4928             "type": "String",
4929             "optional": true,
4930             "field": "read1stAt",
4931             "description": ""
4932           },
4933           {
4934             "group": "Body",
4935             "type": "String",
4936             "optional": true,
4937             "field": "lastMsgAt",
4938             "description": ""
4939           },
4940           {
4941             "group": "Body",
4942             "type": "String",
4943             "allowedValues": [
4944               "\"in\"",
4945               "\"out\""
4946             ],
4947             "optional": false,
4948             "field": "lastMsgDirection",
4949             "description": ""
4950           },
4951           {
4952             "group": "Body",
4953             "type": "String",
4954             "optional": true,
4955             "field": "closeReason",
4956             "description": ""
4957           },
4958           {
4959             "group": "Body",
4960             "type": "String",
4961             "optional": true,
4962             "field": "customerPort",
4963             "description": ""
4964           },
4965           {
4966             "group": "Body",
4967             "type": "Text",
4968             "optional": true,
4969             "field": "vidaooSessionId",
4970             "description": ""
4971           }
4972         ]
4973       }
4974     },
4975     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4976     "version": "0.0.0",
4977     "filename": "server/api/chatWebsite/index.js",
4978     "groupTitle": "Chat_Websites"
4979   },
4980   {
4981     "type": "post",
4982     "url": "/api/chat/websites/{id}/logo",
4983     "title": "Add logo",
4984     "examples": [
4985       {
4986         "title": "Example usage:",
4987         "content": "curl https://{domain}/api/chat/websites/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
4988         "type": "json"
4989       }
4990     ],
4991     "name": "addLogo",
4992     "group": "Chat_Websites",
4993     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4994     "version": "0.0.0",
4995     "filename": "server/api/chatWebsite/index.js",
4996     "groupTitle": "Chat_Websites"
4997   },
4998   {
4999     "type": "post",
5000     "url": "/api/chat/websites/{id}/proactive_actions",
5001     "title": "Creates new Proactive Actions",
5002     "examples": [
5003       {
5004         "title": "Example usage:",
5005         "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",
5006         "type": "json"
5007       }
5008     ],
5009     "name": "addProactiveActions",
5010     "group": "Chat_Websites",
5011     "parameter": {
5012       "fields": {
5013         "Body": [
5014           {
5015             "group": "Body",
5016             "type": "String",
5017             "optional": false,
5018             "field": "name",
5019             "description": ""
5020           },
5021           {
5022             "group": "Body",
5023             "type": "String",
5024             "allowedValues": [
5025               "\"mouseOver\"",
5026               "\"timeout\""
5027             ],
5028             "optional": true,
5029             "field": "type",
5030             "description": ""
5031           },
5032           {
5033             "group": "Body",
5034             "type": "String",
5035             "optional": true,
5036             "field": "selector",
5037             "description": ""
5038           },
5039           {
5040             "group": "Body",
5041             "type": "Integer",
5042             "optional": true,
5043             "field": "timeout",
5044             "description": ""
5045           }
5046         ]
5047       }
5048     },
5049     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5050     "version": "0.0.0",
5051     "filename": "server/api/chatWebsite/index.js",
5052     "groupTitle": "Chat_Websites"
5053   },
5054   {
5055     "type": "post",
5056     "url": "/api/chat/websites/{id}/system_avatar",
5057     "title": "Add system avatar",
5058     "examples": [
5059       {
5060         "title": "Example usage:",
5061         "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",
5062         "type": "json"
5063       }
5064     ],
5065     "name": "addSystemAvatar",
5066     "group": "Chat_Websites",
5067     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5068     "version": "0.0.0",
5069     "filename": "server/api/chatWebsite/index.js",
5070     "groupTitle": "Chat_Websites"
5071   },
5072   {
5073     "type": "get",
5074     "url": "/api/chat/websites/{id}/canned_answers",
5075     "title": "Gets account canned answers",
5076     "examples": [
5077       {
5078         "title": "Example usage:",
5079         "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers -v -u {name}:{password} -X GET",
5080         "type": "json"
5081       }
5082     ],
5083     "name": "getAnswers",
5084     "group": "Chat_Websites",
5085     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5086     "version": "0.0.0",
5087     "filename": "server/api/chatWebsite/index.js",
5088     "groupTitle": "Chat_Websites"
5089   },
5090   {
5091     "type": "get",
5092     "url": "/api/chat/websites/{id}/applications",
5093     "title": "Gets Website Applications",
5094     "examples": [
5095       {
5096         "title": "Example usage:",
5097         "content": "curl https://{domain}/api/chat/websites/{id}/applications -v -u {name}:{password} -X GET",
5098         "type": "json"
5099       }
5100     ],
5101     "name": "getApplications",
5102     "group": "Chat_Websites",
5103     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5104     "version": "0.0.0",
5105     "filename": "server/api/chatWebsite/index.js",
5106     "groupTitle": "Chat_Websites"
5107   },
5108   {
5109     "type": "get",
5110     "url": "/api/chat/websites/{id}/avatar",
5111     "title": "Get avatar",
5112     "examples": [
5113       {
5114         "title": "Example usage:",
5115         "content": "curl https://{domain}/api/chat/websites/{id}/avatar -v -u {name}:{password} -X GET",
5116         "type": "json"
5117       }
5118     ],
5119     "name": "getAvatar",
5120     "group": "Chat_Websites",
5121     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5122     "version": "0.0.0",
5123     "filename": "server/api/chatWebsite/index.js",
5124     "groupTitle": "Chat_Websites"
5125   },
5126   {
5127     "type": "get",
5128     "url": "/api/chat/websites/{id}/customer_avatar",
5129     "title": "Get Customer Avatar",
5130     "examples": [
5131       {
5132         "title": "Example usage:",
5133         "content": "curl https://{domain}/api/chat/websites/{id}/customer_avatar -v -u {name}:{password} -X GET",
5134         "type": "json"
5135       }
5136     ],
5137     "name": "getCustomerAvatar",
5138     "group": "Chat_Websites",
5139     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5140     "version": "0.0.0",
5141     "filename": "server/api/chatWebsite/index.js",
5142     "groupTitle": "Chat_Websites"
5143   },
5144   {
5145     "type": "get",
5146     "url": "/api/chat/websites/{id}/dispositions",
5147     "title": "Gets account dispositions",
5148     "examples": [
5149       {
5150         "title": "Example usage:",
5151         "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -v -u {name}:{password} -X GET",
5152         "type": "json"
5153       }
5154     ],
5155     "name": "getDispositions",
5156     "group": "Chat_Websites",
5157     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5158     "version": "0.0.0",
5159     "filename": "server/api/chatWebsite/index.js",
5160     "groupTitle": "Chat_Websites"
5161   },
5162   {
5163     "type": "get",
5164     "url": "/api/chat/websites/{id}/fields",
5165     "title": "Gets Website Fields",
5166     "examples": [
5167       {
5168         "title": "Example usage:",
5169         "content": "curl https://{domain}/api/chat/websites/{id}/fields -v -u {name}:{password} -X GET",
5170         "type": "json"
5171       }
5172     ],
5173     "name": "getFields",
5174     "group": "Chat_Websites",
5175     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5176     "version": "0.0.0",
5177     "filename": "server/api/chatWebsite/index.js",
5178     "groupTitle": "Chat_Websites"
5179   },
5180   {
5181     "type": "get",
5182     "url": "/api/chat/websites/{id}/interactions",
5183     "title": "Gets Website Interactions",
5184     "examples": [
5185       {
5186         "title": "Example usage:",
5187         "content": "curl https://{domain}/api/chat/websites/{id}/interactions -v -u {name}:{password} -X GET",
5188         "type": "json"
5189       }
5190     ],
5191     "name": "getInteraction",
5192     "group": "Chat_Websites",
5193     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5194     "version": "0.0.0",
5195     "filename": "server/api/chatWebsite/index.js",
5196     "groupTitle": "Chat_Websites"
5197   },
5198   {
5199     "type": "get",
5200     "url": "/api/chat/websites/{id}/logo",
5201     "title": "Get logo",
5202     "examples": [
5203       {
5204         "title": "Example usage:",
5205         "content": "curl https://{domain}/api/chat/websites/{id}/logo -v -u {name}:{password} -X GET",
5206         "type": "json"
5207       }
5208     ],
5209     "name": "getLogo",
5210     "group": "Chat_Websites",
5211     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5212     "version": "0.0.0",
5213     "filename": "server/api/chatWebsite/index.js",
5214     "groupTitle": "Chat_Websites"
5215   },
5216   {
5217     "type": "get",
5218     "url": "/api/chat/websites/{id}/offline_messages",
5219     "title": "Gets Website Offline Messages",
5220     "examples": [
5221       {
5222         "title": "Example usage:",
5223         "content": "curl https://{domain}/api/chat/websites/{id}/offline_messages -v -u {name}:{password} -X GET",
5224         "type": "json"
5225       }
5226     ],
5227     "name": "getOfflineMessages",
5228     "group": "Chat_Websites",
5229     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5230     "version": "0.0.0",
5231     "filename": "server/api/chatWebsite/index.js",
5232     "groupTitle": "Chat_Websites"
5233   },
5234   {
5235     "type": "get",
5236     "url": "/api/chat/websites/{id}/proactive_actions",
5237     "title": "Gets Website Proactive Actions",
5238     "examples": [
5239       {
5240         "title": "Example usage:",
5241         "content": "curl https://{domain}/api/chat/websites/{id}/proactive_actions -v -u {name}:{password} -X GET",
5242         "type": "json"
5243       }
5244     ],
5245     "name": "getProactiveActions",
5246     "group": "Chat_Websites",
5247     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5248     "version": "0.0.0",
5249     "filename": "server/api/chatWebsite/index.js",
5250     "groupTitle": "Chat_Websites"
5251   },
5252   {
5253     "type": "get",
5254     "url": "/api/chat/websites/{id}/snippet",
5255     "title": "Gets Website Snippet",
5256     "examples": [
5257       {
5258         "title": "Example usage:",
5259         "content": "curl https://{domain}/api/chat/websites/{id}/snippet -v -u {name}:{password} -X GET",
5260         "type": "json"
5261       }
5262     ],
5263     "name": "getSnippet",
5264     "group": "Chat_Websites",
5265     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5266     "version": "0.0.0",
5267     "filename": "server/api/chatWebsite/index.js",
5268     "groupTitle": "Chat_Websites"
5269   },
5270   {
5271     "type": "get",
5272     "url": "/api/chat/websites/{id}/system_avatar",
5273     "title": "Get System Avatar",
5274     "examples": [
5275       {
5276         "title": "Example usage:",
5277         "content": "curl https://{domain}/api/chat/websites/{id}/system_avatar -v -u {name}:{password} -X GET",
5278         "type": "json"
5279       }
5280     ],
5281     "name": "getSystemAvatar",
5282     "group": "Chat_Websites",
5283     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5284     "version": "0.0.0",
5285     "filename": "server/api/chatWebsite/index.js",
5286     "groupTitle": "Chat_Websites"
5287   },
5288   {
5289     "type": "post",
5290     "url": "/api/chat/websites/{id}/notify",
5291     "title": "Notify new message",
5292     "examples": [
5293       {
5294         "title": "Example usage:",
5295         "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",
5296         "type": "json"
5297       }
5298     ],
5299     "name": "notify",
5300     "group": "Chat_Websites",
5301     "description": "<p>Motion 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>",
5302     "version": "0.0.0",
5303     "filename": "server/api/chatWebsite/index.js",
5304     "groupTitle": "Chat_Websites"
5305   },
5306   {
5307     "type": "post",
5308     "url": "/api/chat/websites/{id}/offline",
5309     "title": "Offline message",
5310     "examples": [
5311       {
5312         "title": "Example usage:",
5313         "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",
5314         "type": "json"
5315       }
5316     ],
5317     "name": "offline",
5318     "group": "Chat_Websites",
5319     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5320     "version": "0.0.0",
5321     "filename": "server/api/chatWebsite/index.js",
5322     "groupTitle": "Chat_Websites"
5323   },
5324   {
5325     "type": "put",
5326     "url": "/api/chat/messages/{id}/reject",
5327     "title": "Rejects message",
5328     "examples": [
5329       {
5330         "title": "Example usage:",
5331         "content": "curl https://{domain}/api/chat/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
5332         "type": "json"
5333       }
5334     ],
5335     "name": "rejectMessage",
5336     "group": "Chat_Websites",
5337     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5338     "version": "0.0.0",
5339     "filename": "server/api/chatMessage/index.js",
5340     "groupTitle": "Chat_Websites"
5341   },
5342   {
5343     "type": "put",
5344     "url": "/api/chat/websites/{id}",
5345     "title": "Update an existing Website",
5346     "examples": [
5347       {
5348         "title": "Example usage:",
5349         "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",
5350         "type": "json"
5351       }
5352     ],
5353     "name": "updateWebsites",
5354     "group": "Chat_Websites",
5355     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5356     "version": "0.0.0",
5357     "filename": "server/api/chatWebsite/index.js",
5358     "groupTitle": "Chat_Websites"
5359   },
5360   {
5361     "type": "post",
5362     "url": "/api/cloudProviders",
5363     "title": "Creates a new CloudProvider",
5364     "examples": [
5365       {
5366         "title": "Example usage:",
5367         "content": "curl https://{domain}/api/cloudProviders -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5368         "type": "json"
5369       }
5370     ],
5371     "name": "CreateCloudProviders",
5372     "group": "CloudProviders",
5373     "parameter": {
5374       "fields": {
5375         "Body": [
5376           {
5377             "group": "Body",
5378             "type": "String",
5379             "optional": false,
5380             "field": "name",
5381             "description": ""
5382           },
5383           {
5384             "group": "Body",
5385             "type": "String",
5386             "allowedValues": [
5387               "\"AmazonAWS\"",
5388               "\"Google\""
5389             ],
5390             "optional": false,
5391             "field": "service",
5392             "description": ""
5393           },
5394           {
5395             "group": "Body",
5396             "type": "String",
5397             "optional": true,
5398             "field": "data1",
5399             "description": ""
5400           },
5401           {
5402             "group": "Body",
5403             "type": "String",
5404             "optional": true,
5405             "field": "data2",
5406             "description": ""
5407           }
5408         ]
5409       }
5410     },
5411     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5412     "version": "0.0.0",
5413     "filename": "server/api/cloudProvider/index.js",
5414     "groupTitle": "CloudProviders"
5415   },
5416   {
5417     "type": "delete",
5418     "url": "/api/cloudProviders/{id}",
5419     "title": "Deletes a CloudProvider",
5420     "examples": [
5421       {
5422         "title": "Example usage:",
5423         "content": "curl https://{domain}/api/cloudProviders/{id} -v -u {name}:{password} -X DELETE",
5424         "type": "json"
5425       }
5426     ],
5427     "name": "DeleteCloudProviders",
5428     "group": "CloudProviders",
5429     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5430     "version": "0.0.0",
5431     "filename": "server/api/cloudProvider/index.js",
5432     "groupTitle": "CloudProviders"
5433   },
5434   {
5435     "type": "get",
5436     "url": "/api/cloudProviders",
5437     "title": "Gets a list of CloudProviders",
5438     "examples": [
5439       {
5440         "title": "Example usage:",
5441         "content": "curl https://{domain}/api/cloudProviders -v -u {name}:{password}",
5442         "type": "json"
5443       }
5444     ],
5445     "name": "GetCloudProviders",
5446     "group": "CloudProviders",
5447     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
5448     "version": "0.0.0",
5449     "filename": "server/api/cloudProvider/index.js",
5450     "groupTitle": "CloudProviders"
5451   },
5452   {
5453     "type": "get",
5454     "url": "/api/cloudProviders/{id}",
5455     "title": "Gets a single CloudProvider",
5456     "examples": [
5457       {
5458         "title": "Example usage:",
5459         "content": "curl https://{domain}/api/cloudProviders/{id} -v -u {name}:{password}",
5460         "type": "json"
5461       }
5462     ],
5463     "name": "ShowCloudProviders",
5464     "group": "CloudProviders",
5465     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5466     "version": "0.0.0",
5467     "filename": "server/api/cloudProvider/index.js",
5468     "groupTitle": "CloudProviders"
5469   },
5470   {
5471     "type": "put",
5472     "url": "/api/cloudProviders/{id}",
5473     "title": "Update an existing CloudProvider",
5474     "examples": [
5475       {
5476         "title": "Example usage:",
5477         "content": "curl https://{domain}/api/cloudProviders/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
5478         "type": "json"
5479       }
5480     ],
5481     "name": "updateCloudProviders",
5482     "group": "CloudProviders",
5483     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5484     "version": "0.0.0",
5485     "filename": "server/api/cloudProvider/index.js",
5486     "groupTitle": "CloudProviders"
5487   },
5488   {
5489     "type": "post",
5490     "url": "/api/cm/companies",
5491     "title": "Creates a new Company",
5492     "examples": [
5493       {
5494         "title": "Example usage:",
5495         "content": "curl https://{domain}/api/cm/companies -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5496         "type": "json"
5497       }
5498     ],
5499     "name": "CreateCompanies",
5500     "group": "Cm_Companies",
5501     "parameter": {
5502       "fields": {
5503         "Body": [
5504           {
5505             "group": "Body",
5506             "type": "String",
5507             "optional": false,
5508             "field": "name",
5509             "description": ""
5510           },
5511           {
5512             "group": "Body",
5513             "type": "String",
5514             "optional": true,
5515             "field": "vat",
5516             "description": ""
5517           },
5518           {
5519             "group": "Body",
5520             "type": "String",
5521             "optional": true,
5522             "field": "companyId",
5523             "description": ""
5524           },
5525           {
5526             "group": "Body",
5527             "type": "String",
5528             "optional": true,
5529             "field": "website",
5530             "description": ""
5531           },
5532           {
5533             "group": "Body",
5534             "type": "String",
5535             "optional": true,
5536             "field": "phone",
5537             "description": ""
5538           },
5539           {
5540             "group": "Body",
5541             "type": "String",
5542             "optional": true,
5543             "field": "fax",
5544             "description": ""
5545           },
5546           {
5547             "group": "Body",
5548             "type": "String",
5549             "optional": true,
5550             "field": "type",
5551             "description": ""
5552           },
5553           {
5554             "group": "Body",
5555             "type": "String",
5556             "optional": true,
5557             "field": "street",
5558             "description": ""
5559           },
5560           {
5561             "group": "Body",
5562             "type": "String",
5563             "optional": true,
5564             "field": "postalCode",
5565             "description": ""
5566           },
5567           {
5568             "group": "Body",
5569             "type": "String",
5570             "optional": true,
5571             "field": "city",
5572             "description": ""
5573           },
5574           {
5575             "group": "Body",
5576             "type": "String",
5577             "optional": true,
5578             "field": "country",
5579             "description": ""
5580           },
5581           {
5582             "group": "Body",
5583             "type": "String",
5584             "optional": true,
5585             "field": "email",
5586             "description": ""
5587           },
5588           {
5589             "group": "Body",
5590             "type": "String",
5591             "optional": true,
5592             "field": "emailDomain",
5593             "description": ""
5594           },
5595           {
5596             "group": "Body",
5597             "type": "String",
5598             "optional": true,
5599             "field": "sStreet",
5600             "description": ""
5601           },
5602           {
5603             "group": "Body",
5604             "type": "String",
5605             "optional": true,
5606             "field": "sPostalCode",
5607             "description": ""
5608           },
5609           {
5610             "group": "Body",
5611             "type": "String",
5612             "optional": true,
5613             "field": "sCity",
5614             "description": ""
5615           },
5616           {
5617             "group": "Body",
5618             "type": "String",
5619             "optional": true,
5620             "field": "sCountry",
5621             "description": ""
5622           },
5623           {
5624             "group": "Body",
5625             "type": "String",
5626             "optional": true,
5627             "field": "description",
5628             "description": ""
5629           }
5630         ]
5631       }
5632     },
5633     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5634     "version": "0.0.0",
5635     "filename": "server/api/cmCompany/index.js",
5636     "groupTitle": "Cm_Companies"
5637   },
5638   {
5639     "type": "delete",
5640     "url": "/api/cm/companies/{id}",
5641     "title": "Deletes a Company",
5642     "examples": [
5643       {
5644         "title": "Example usage:",
5645         "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password} -X DELETE",
5646         "type": "json"
5647       }
5648     ],
5649     "name": "DeleteCompanies",
5650     "group": "Cm_Companies",
5651     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5652     "version": "0.0.0",
5653     "filename": "server/api/cmCompany/index.js",
5654     "groupTitle": "Cm_Companies"
5655   },
5656   {
5657     "type": "get",
5658     "url": "/api/cm/companies/describe",
5659     "title": "Gets table info about Companies",
5660     "examples": [
5661       {
5662         "title": "Example usage:",
5663         "content": "curl https://{domain}/api/cm/companies/describe -v -u {name}:{password}",
5664         "type": "json"
5665       }
5666     ],
5667     "name": "DescribeCompanies",
5668     "group": "Cm_Companies",
5669     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5670     "version": "0.0.0",
5671     "filename": "server/api/cmCompany/index.js",
5672     "groupTitle": "Cm_Companies"
5673   },
5674   {
5675     "type": "get",
5676     "url": "/api/cm/companies",
5677     "title": "Gets a list of Companies",
5678     "examples": [
5679       {
5680         "title": "Example usage:",
5681         "content": "curl https://{domain}/api/cm/companies -v -u {name}:{password}",
5682         "type": "json"
5683       }
5684     ],
5685     "name": "GetCompanies",
5686     "group": "Cm_Companies",
5687     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
5688     "version": "0.0.0",
5689     "filename": "server/api/cmCompany/index.js",
5690     "groupTitle": "Cm_Companies"
5691   },
5692   {
5693     "type": "get",
5694     "url": "/api/cm/companies/{id}",
5695     "title": "Gets a single Company",
5696     "examples": [
5697       {
5698         "title": "Example usage:",
5699         "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password}",
5700         "type": "json"
5701       }
5702     ],
5703     "name": "ShowCompanies",
5704     "group": "Cm_Companies",
5705     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5706     "version": "0.0.0",
5707     "filename": "server/api/cmCompany/index.js",
5708     "groupTitle": "Cm_Companies"
5709   },
5710   {
5711     "type": "post",
5712     "url": "/api/cm/companies/{id}/contacts",
5713     "title": "Creates new contacts",
5714     "examples": [
5715       {
5716         "title": "Example usage:",
5717         "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",
5718         "type": "json"
5719       }
5720     ],
5721     "name": "addContacts",
5722     "group": "Cm_Companies",
5723     "parameter": {
5724       "fields": {
5725         "Body": [
5726           {
5727             "group": "Body",
5728             "type": "String",
5729             "optional": false,
5730             "field": "firstName",
5731             "description": ""
5732           },
5733           {
5734             "group": "Body",
5735             "type": "String",
5736             "optional": true,
5737             "field": "lastName",
5738             "description": ""
5739           },
5740           {
5741             "group": "Body",
5742             "type": "String",
5743             "optional": true,
5744             "field": "street",
5745             "description": ""
5746           },
5747           {
5748             "group": "Body",
5749             "type": "String",
5750             "optional": true,
5751             "field": "postalCode",
5752             "description": ""
5753           },
5754           {
5755             "group": "Body",
5756             "type": "String",
5757             "optional": true,
5758             "field": "city",
5759             "description": ""
5760           },
5761           {
5762             "group": "Body",
5763             "type": "String",
5764             "optional": true,
5765             "field": "country",
5766             "description": ""
5767           },
5768           {
5769             "group": "Body",
5770             "type": "String",
5771             "optional": true,
5772             "field": "dateOfBirth",
5773             "description": ""
5774           },
5775           {
5776             "group": "Body",
5777             "type": "Text",
5778             "optional": true,
5779             "field": "description",
5780             "description": ""
5781           },
5782           {
5783             "group": "Body",
5784             "type": "String",
5785             "optional": true,
5786             "field": "phone",
5787             "description": ""
5788           },
5789           {
5790             "group": "Body",
5791             "type": "String",
5792             "optional": true,
5793             "field": "mobile",
5794             "description": ""
5795           },
5796           {
5797             "group": "Body",
5798             "type": "String",
5799             "optional": true,
5800             "field": "fax",
5801             "description": ""
5802           },
5803           {
5804             "group": "Body",
5805             "type": "String",
5806             "optional": true,
5807             "field": "email",
5808             "description": ""
5809           },
5810           {
5811             "group": "Body",
5812             "type": "String",
5813             "optional": true,
5814             "field": "url",
5815             "description": ""
5816           },
5817           {
5818             "group": "Body",
5819             "type": "String",
5820             "optional": true,
5821             "field": "facebook",
5822             "description": ""
5823           },
5824           {
5825             "group": "Body",
5826             "type": "String",
5827             "optional": true,
5828             "field": "fb_data",
5829             "description": ""
5830           },
5831           {
5832             "group": "Body",
5833             "type": "String",
5834             "optional": true,
5835             "field": "twitter",
5836             "description": ""
5837           },
5838           {
5839             "group": "Body",
5840             "type": "String",
5841             "optional": true,
5842             "field": "skype",
5843             "description": ""
5844           },
5845           {
5846             "group": "Body",
5847             "type": "String",
5848             "optional": true,
5849             "field": "teams",
5850             "description": ""
5851           },
5852           {
5853             "group": "Body",
5854             "type": "String",
5855             "optional": true,
5856             "field": "viber",
5857             "description": ""
5858           },
5859           {
5860             "group": "Body",
5861             "type": "String",
5862             "optional": true,
5863             "field": "line",
5864             "description": ""
5865           },
5866           {
5867             "group": "Body",
5868             "type": "String",
5869             "optional": true,
5870             "field": "wechat",
5871             "description": ""
5872           },
5873           {
5874             "group": "Body",
5875             "type": "String",
5876             "optional": true,
5877             "field": "telegram",
5878             "description": ""
5879           },
5880           {
5881             "group": "Body",
5882             "type": "Integer",
5883             "optional": true,
5884             "field": "UserId",
5885             "description": ""
5886           },
5887           {
5888             "group": "Body",
5889             "type": "Integer",
5890             "optional": true,
5891             "field": "priority",
5892             "description": ""
5893           },
5894           {
5895             "group": "Body",
5896             "type": "String",
5897             "optional": true,
5898             "field": "scheduledat",
5899             "description": ""
5900           }
5901         ]
5902       }
5903     },
5904     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5905     "version": "0.0.0",
5906     "filename": "server/api/cmCompany/index.js",
5907     "groupTitle": "Cm_Companies"
5908   },
5909   {
5910     "type": "get",
5911     "url": "/api/cm/companies/{id}/contacts",
5912     "title": "Gets List Contacts",
5913     "examples": [
5914       {
5915         "title": "Example usage:",
5916         "content": "curl https://{domain}/api/fax/companies/{id}/contacts -v -u {name}:{password} -X GET",
5917         "type": "json"
5918       }
5919     ],
5920     "name": "getContacts",
5921     "group": "Cm_Companies",
5922     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5923     "version": "0.0.0",
5924     "filename": "server/api/cmCompany/index.js",
5925     "groupTitle": "Cm_Companies"
5926   },
5927   {
5928     "type": "put",
5929     "url": "/api/cm/companies/{id}",
5930     "title": "Update an existing Company",
5931     "examples": [
5932       {
5933         "title": "Example usage:",
5934         "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",
5935         "type": "json"
5936       }
5937     ],
5938     "name": "updateCompanies",
5939     "group": "Cm_Companies",
5940     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5941     "version": "0.0.0",
5942     "filename": "server/api/cmCompany/index.js",
5943     "groupTitle": "Cm_Companies"
5944   },
5945   {
5946     "type": "delete",
5947     "url": "/api/cm/contacts/{id}",
5948     "title": "Deletes a Contact",
5949     "examples": [
5950       {
5951         "title": "Example usage:",
5952         "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X DELETE",
5953         "type": "json"
5954       }
5955     ],
5956     "name": "DeleteContacts",
5957     "group": "Cm_Contacts",
5958     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5959     "version": "0.0.0",
5960     "filename": "server/api/cmContact/index.js",
5961     "groupTitle": "Cm_Contacts"
5962   },
5963   {
5964     "type": "get",
5965     "url": "/api/cm/contacts/describe",
5966     "title": "Gets table info about Contacts",
5967     "examples": [
5968       {
5969         "title": "Example usage:",
5970         "content": "curl https://{domain}/api/cm/contacts/describe -v -u {name}:{password}",
5971         "type": "json"
5972       }
5973     ],
5974     "name": "DescribeContacts",
5975     "group": "Cm_Contacts",
5976     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5977     "version": "0.0.0",
5978     "filename": "server/api/cmContact/index.js",
5979     "groupTitle": "Cm_Contacts"
5980   },
5981   {
5982     "type": "get",
5983     "url": "/api/cm/contacts",
5984     "title": "Gets a list of Contacts",
5985     "examples": [
5986       {
5987         "title": "Example usage:",
5988         "content": "curl https://{domain}/api/cm/contacts -v -u {name}:{password}",
5989         "type": "json"
5990       }
5991     ],
5992     "name": "GetContacts",
5993     "group": "Cm_Contacts",
5994     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
5995     "version": "0.0.0",
5996     "filename": "server/api/cmContact/index.js",
5997     "groupTitle": "Cm_Contacts"
5998   },
5999   {
6000     "type": "get",
6001     "url": "/api/cm/contacts/{id}/finals",
6002     "title": "Gets contact hopper finals",
6003     "examples": [
6004       {
6005         "title": "Example usage:",
6006         "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_finals -v -u {name}:{password}  -X GET",
6007         "type": "json"
6008       }
6009     ],
6010     "name": "GetHopperFinals",
6011     "group": "Cm_Contacts",
6012     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6013     "version": "0.0.0",
6014     "filename": "server/api/cmContact/index.js",
6015     "groupTitle": "Cm_Contacts"
6016   },
6017   {
6018     "type": "get",
6019     "url": "/api/cm/contacts/{id}/hopper_histories",
6020     "title": "Gets contact hopper histories",
6021     "examples": [
6022       {
6023         "title": "Example usage:",
6024         "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_histories -v -u {name}:{password} -X GET",
6025         "type": "json"
6026       }
6027     ],
6028     "name": "GetHopperHistories",
6029     "group": "Cm_Contacts",
6030     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6031     "version": "0.0.0",
6032     "filename": "server/api/cmContact/index.js",
6033     "groupTitle": "Cm_Contacts"
6034   },
6035   {
6036     "type": "get",
6037     "url": "/api/cm/contacts/{id}/hoppers",
6038     "title": "Gets contact hoppers",
6039     "examples": [
6040       {
6041         "title": "Example usage:",
6042         "content": "curl https://{domain}/api/cm/contacts/{id}/hoppers -v -u {name}:{password} -X GET",
6043         "type": "json"
6044       }
6045     ],
6046     "name": "GetHoppers",
6047     "group": "Cm_Contacts",
6048     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6049     "version": "0.0.0",
6050     "filename": "server/api/cmContact/index.js",
6051     "groupTitle": "Cm_Contacts"
6052   },
6053   {
6054     "type": "post",
6055     "url": "/api/cm/contacts/create_many",
6056     "title": "Create Contacts",
6057     "examples": [
6058       {
6059         "title": "Example usage:",
6060         "content": "curl https://{domain}/api/cm/contacts/create_many -d '[{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",
6061         "type": "json"
6062       }
6063     ],
6064     "name": "bulkCreate",
6065     "group": "Cm_Contacts",
6066     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6067     "version": "0.0.0",
6068     "filename": "server/api/cmContact/index.js",
6069     "groupTitle": "Cm_Contacts"
6070   },
6071   {
6072     "type": "post",
6073     "url": "/api/cm/contacts",
6074     "title": "Create Contact",
6075     "examples": [
6076       {
6077         "title": "Example usage:",
6078         "content": "curl https://{domain}/api/cm/contacts -d '{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}' -v -u {name}:{password} -X POST",
6079         "type": "json"
6080       }
6081     ],
6082     "name": "create",
6083     "group": "Cm_Contacts",
6084     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6085     "version": "0.0.0",
6086     "filename": "server/api/cmContact/index.js",
6087     "groupTitle": "Cm_Contacts"
6088   },
6089   {
6090     "type": "get",
6091     "url": "/api/cm/contacts/{id}/journey",
6092     "title": "Gets customer journey",
6093     "examples": [
6094       {
6095         "title": "Example usage:",
6096         "content": "curl https://{domain}/api/cm/contacts/{id}/journey -v -u {name}:{password}  -X GET",
6097         "type": "json"
6098       }
6099     ],
6100     "name": "getJourney",
6101     "group": "Cm_Contacts",
6102     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6103     "version": "0.0.0",
6104     "filename": "server/api/cmContact/index.js",
6105     "groupTitle": "Cm_Contacts"
6106   },
6107   {
6108     "type": "get",
6109     "url": "/api/cm/contacts/{id}/jscripty_sessions",
6110     "title": "Gets contact hopper blacks",
6111     "examples": [
6112       {
6113         "title": "Example usage:",
6114         "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_black -v -u {name}:{password}  -X GET",
6115         "type": "json"
6116       }
6117     ],
6118     "name": "getJscriptySessions",
6119     "group": "Cm_Contacts",
6120     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6121     "version": "0.0.0",
6122     "filename": "server/api/cmContact/index.js",
6123     "groupTitle": "Cm_Contacts"
6124   },
6125   {
6126     "type": "get",
6127     "url": "/api/cm/contacts/{id}/tags",
6128     "title": "Gets configurations tags",
6129     "examples": [
6130       {
6131         "title": "Example usage:",
6132         "content": "curl https://{domain}/api/cm/contacts/{id}/tags -v -u {name}:{password} -X GET",
6133         "type": "json"
6134       }
6135     ],
6136     "name": "getTags",
6137     "group": "Cm_Contacts",
6138     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6139     "version": "0.0.0",
6140     "filename": "server/api/cmContact/index.js",
6141     "groupTitle": "Cm_Contacts"
6142   },
6143   {
6144     "type": "post",
6145     "url": "/api/cm/contacts/merge",
6146     "title": "Merge Contact",
6147     "examples": [
6148       {
6149         "title": "Example usage:",
6150         "content": "curl https://{domain}/api/cm/contacts/merge -d '{\"from\": 1, \"to\": 2}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6151         "type": "json"
6152       }
6153     ],
6154     "name": "merge",
6155     "group": "Cm_Contacts",
6156     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6157     "version": "0.0.0",
6158     "filename": "server/api/cmContact/index.js",
6159     "groupTitle": "Cm_Contacts"
6160   },
6161   {
6162     "type": "post",
6163     "url": "/api/cm/contacts/{id}/tags",
6164     "title": "Sets new tags",
6165     "examples": [
6166       {
6167         "title": "Example usage:",
6168         "content": "curl https://{domain}/api/cm/contacts/{id}/tags -d '{\"ids\": [1,12]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6169         "type": "json"
6170       }
6171     ],
6172     "name": "setTags",
6173     "group": "Cm_Contacts",
6174     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6175     "version": "0.0.0",
6176     "filename": "server/api/cmContact/index.js",
6177     "groupTitle": "Cm_Contacts"
6178   },
6179   {
6180     "type": "get",
6181     "url": "/api/cm/contacts/{id}",
6182     "title": "Gets a single Contact",
6183     "examples": [
6184       {
6185         "title": "Example usage:",
6186         "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X GET",
6187         "type": "json"
6188       }
6189     ],
6190     "name": "show",
6191     "group": "Cm_Contacts",
6192     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6193     "version": "0.0.0",
6194     "filename": "server/api/cmContact/index.js",
6195     "groupTitle": "Cm_Contacts"
6196   },
6197   {
6198     "type": "put",
6199     "url": "/api/cm/contacts/{id}",
6200     "title": "Update a single Contact",
6201     "examples": [
6202       {
6203         "title": "Example usage:",
6204         "content": "curl https://{domain}/api/cm/contacts/{id} -d '{\"firstName\": \"John\", \"lastName\": \"Doe\"}' -v -u {name}:{password} -X PUT",
6205         "type": "json"
6206       }
6207     ],
6208     "name": "update",
6209     "group": "Cm_Contacts",
6210     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6211     "version": "0.0.0",
6212     "filename": "server/api/cmContact/index.js",
6213     "groupTitle": "Cm_Contacts"
6214   },
6215   {
6216     "type": "delete",
6217     "url": "/api/cm/custom_fields/{id}",
6218     "title": "Deletes a Custom Field",
6219     "examples": [
6220       {
6221         "title": "Example usage:",
6222         "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password} -X DELETE",
6223         "type": "json"
6224       }
6225     ],
6226     "name": "DeleteCustom_Fields",
6227     "group": "Cm_Custom_Fields",
6228     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6229     "version": "0.0.0",
6230     "filename": "server/api/cmCustomField/index.js",
6231     "groupTitle": "Cm_Custom_Fields"
6232   },
6233   {
6234     "type": "get",
6235     "url": "/api/cm/custom_fields",
6236     "title": "Gets a list of Custom Fields",
6237     "examples": [
6238       {
6239         "title": "Example usage:",
6240         "content": "curl https://{domain}/api/cm/custom_fields -v -u {name}:{password}",
6241         "type": "json"
6242       }
6243     ],
6244     "name": "GetCustom_Fields",
6245     "group": "Cm_Custom_Fields",
6246     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6247     "version": "0.0.0",
6248     "filename": "server/api/cmCustomField/index.js",
6249     "groupTitle": "Cm_Custom_Fields"
6250   },
6251   {
6252     "type": "get",
6253     "url": "/api/cm/custom_fields/{id}",
6254     "title": "Gets a single Custom Field",
6255     "examples": [
6256       {
6257         "title": "Example usage:",
6258         "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password}",
6259         "type": "json"
6260       }
6261     ],
6262     "name": "ShowCustom_Fields",
6263     "group": "Cm_Custom_Fields",
6264     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6265     "version": "0.0.0",
6266     "filename": "server/api/cmCustomField/index.js",
6267     "groupTitle": "Cm_Custom_Fields"
6268   },
6269   {
6270     "type": "put",
6271     "url": "/api/cm/custom_fields/{id}",
6272     "title": "Update an existing Custom Field",
6273     "examples": [
6274       {
6275         "title": "Example usage:",
6276         "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",
6277         "type": "json"
6278       }
6279     ],
6280     "name": "updateCustom_Fields",
6281     "group": "Cm_Custom_Fields",
6282     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6283     "version": "0.0.0",
6284     "filename": "server/api/cmCustomField/index.js",
6285     "groupTitle": "Cm_Custom_Fields"
6286   },
6287   {
6288     "type": "post",
6289     "url": "/api/cm/hopper",
6290     "title": "Creates a new Hopper",
6291     "examples": [
6292       {
6293         "title": "Example usage:",
6294         "content": "curl https://{domain}/api/cm/hopper -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
6295         "type": "json"
6296       }
6297     ],
6298     "name": "CreateHopper",
6299     "group": "Cm_Hopper",
6300     "parameter": {
6301       "fields": {
6302         "Body": [
6303           {
6304             "group": "Body",
6305             "type": "String",
6306             "optional": false,
6307             "field": "phone",
6308             "description": ""
6309           },
6310           {
6311             "group": "Body",
6312             "type": "Boolean",
6313             "optional": true,
6314             "field": "active",
6315             "description": ""
6316           },
6317           {
6318             "group": "Body",
6319             "type": "String",
6320             "optional": true,
6321             "field": "scheduledat",
6322             "description": ""
6323           },
6324           {
6325             "group": "Body",
6326             "type": "Integer",
6327             "optional": true,
6328             "field": "countbusyretry",
6329             "description": ""
6330           },
6331           {
6332             "group": "Body",
6333             "type": "Integer",
6334             "optional": true,
6335             "field": "countcongestionretry",
6336             "description": ""
6337           },
6338           {
6339             "group": "Body",
6340             "type": "Integer",
6341             "optional": true,
6342             "field": "countnoanswerretry",
6343             "description": ""
6344           },
6345           {
6346             "group": "Body",
6347             "type": "Boolean",
6348             "optional": true,
6349             "field": "callback",
6350             "description": ""
6351           },
6352           {
6353             "group": "Body",
6354             "type": "String",
6355             "optional": true,
6356             "field": "callbackuniqueid",
6357             "description": ""
6358           },
6359           {
6360             "group": "Body",
6361             "type": "String",
6362             "optional": true,
6363             "field": "callbackat",
6364             "description": ""
6365           },
6366           {
6367             "group": "Body",
6368             "type": "Integer",
6369             "optional": true,
6370             "field": "priority",
6371             "description": ""
6372           },
6373           {
6374             "group": "Body",
6375             "type": "Boolean",
6376             "optional": true,
6377             "field": "recallme",
6378             "description": ""
6379           },
6380           {
6381             "group": "Body",
6382             "type": "Integer",
6383             "optional": true,
6384             "field": "ContactId",
6385             "description": ""
6386           },
6387           {
6388             "group": "Body",
6389             "type": "Integer",
6390             "optional": true,
6391             "field": "ListId",
6392             "description": ""
6393           },
6394           {
6395             "group": "Body",
6396             "type": "Integer",
6397             "optional": true,
6398             "field": "UserId",
6399             "description": ""
6400           },
6401           {
6402             "group": "Body",
6403             "type": "Integer",
6404             "optional": true,
6405             "field": "VoiceQueueId",
6406             "description": ""
6407           },
6408           {
6409             "group": "Body",
6410             "type": "Integer",
6411             "optional": true,
6412             "field": "CampaignId",
6413             "description": ""
6414           },
6415           {
6416             "group": "Body",
6417             "type": "Integer",
6418             "optional": true,
6419             "field": "countnosuchnumberretry",
6420             "description": ""
6421           },
6422           {
6423             "group": "Body",
6424             "type": "Integer",
6425             "optional": true,
6426             "field": "countdropretry",
6427             "description": ""
6428           },
6429           {
6430             "group": "Body",
6431             "type": "Integer",
6432             "optional": true,
6433             "field": "countabandonedretry",
6434             "description": ""
6435           },
6436           {
6437             "group": "Body",
6438             "type": "Integer",
6439             "optional": true,
6440             "field": "countmachineretry",
6441             "description": ""
6442           },
6443           {
6444             "group": "Body",
6445             "type": "Integer",
6446             "optional": true,
6447             "field": "countagentrejectretry",
6448             "description": ""
6449           }
6450         ]
6451       }
6452     },
6453     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6454     "version": "0.0.0",
6455     "filename": "server/api/cmHopper/index.js",
6456     "groupTitle": "Cm_Hopper"
6457   },
6458   {
6459     "type": "get",
6460     "url": "/api/cm/hopper/describe",
6461     "title": "Gets table info about Hopper",
6462     "examples": [
6463       {
6464         "title": "Example usage:",
6465         "content": "curl https://{domain}/api/cm/hopper/describe -v -u {name}:{password}",
6466         "type": "json"
6467       }
6468     ],
6469     "name": "DescribeHopper",
6470     "group": "Cm_Hopper",
6471     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6472     "version": "0.0.0",
6473     "filename": "server/api/cmHopper/index.js",
6474     "groupTitle": "Cm_Hopper"
6475   },
6476   {
6477     "type": "get",
6478     "url": "/api/cm/hopper",
6479     "title": "Gets a list of Hopper",
6480     "examples": [
6481       {
6482         "title": "Example usage:",
6483         "content": "curl https://{domain}/api/cm/hopper -v -u {name}:{password}",
6484         "type": "json"
6485       }
6486     ],
6487     "name": "GetHopper",
6488     "group": "Cm_Hopper",
6489     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6490     "version": "0.0.0",
6491     "filename": "server/api/cmHopper/index.js",
6492     "groupTitle": "Cm_Hopper"
6493   },
6494   {
6495     "type": "get",
6496     "url": "/api/cm/hopper/{id}",
6497     "title": "Gets a single Hopper",
6498     "examples": [
6499       {
6500         "title": "Example usage:",
6501         "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password}",
6502         "type": "json"
6503       }
6504     ],
6505     "name": "ShowHopper",
6506     "group": "Cm_Hopper",
6507     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6508     "version": "0.0.0",
6509     "filename": "server/api/cmHopper/index.js",
6510     "groupTitle": "Cm_Hopper"
6511   },
6512   {
6513     "type": "delete",
6514     "url": "/api/cm/hopper_black/{id}",
6515     "title": "Deletes a Hopper Black",
6516     "examples": [
6517       {
6518         "title": "Example usage:",
6519         "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password} -X DELETE",
6520         "type": "json"
6521       }
6522     ],
6523     "name": "DeleteHopper_Black",
6524     "group": "Cm_Hopper_Black",
6525     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6526     "version": "0.0.0",
6527     "filename": "server/api/cmHopperBlack/index.js",
6528     "groupTitle": "Cm_Hopper_Black"
6529   },
6530   {
6531     "type": "get",
6532     "url": "/api/cm/hopper_black/describe",
6533     "title": "Gets table info about Hopper Black",
6534     "examples": [
6535       {
6536         "title": "Example usage:",
6537         "content": "curl https://{domain}/api/cm/hopper_black/describe -v -u {name}:{password}",
6538         "type": "json"
6539       }
6540     ],
6541     "name": "DescribeHopper_Black",
6542     "group": "Cm_Hopper_Black",
6543     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6544     "version": "0.0.0",
6545     "filename": "server/api/cmHopperBlack/index.js",
6546     "groupTitle": "Cm_Hopper_Black"
6547   },
6548   {
6549     "type": "get",
6550     "url": "/api/cm/hopper_black",
6551     "title": "Gets a list of Hopper Black",
6552     "examples": [
6553       {
6554         "title": "Example usage:",
6555         "content": "curl https://{domain}/api/cm/hopper_black -v -u {name}:{password}",
6556         "type": "json"
6557       }
6558     ],
6559     "name": "GetHopper_Black",
6560     "group": "Cm_Hopper_Black",
6561     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6562     "version": "0.0.0",
6563     "filename": "server/api/cmHopperBlack/index.js",
6564     "groupTitle": "Cm_Hopper_Black"
6565   },
6566   {
6567     "type": "get",
6568     "url": "/api/cm/hopper_black/{id}",
6569     "title": "Gets a single Hopper Black",
6570     "examples": [
6571       {
6572         "title": "Example usage:",
6573         "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password}",
6574         "type": "json"
6575       }
6576     ],
6577     "name": "ShowHopper_Black",
6578     "group": "Cm_Hopper_Black",
6579     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6580     "version": "0.0.0",
6581     "filename": "server/api/cmHopperBlack/index.js",
6582     "groupTitle": "Cm_Hopper_Black"
6583   },
6584   {
6585     "type": "put",
6586     "url": "/api/cm/hopper_black/{id}",
6587     "title": "Update an existing Hopper Black",
6588     "examples": [
6589       {
6590         "title": "Example usage:",
6591         "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",
6592         "type": "json"
6593       }
6594     ],
6595     "name": "updateHopper_Black",
6596     "group": "Cm_Hopper_Black",
6597     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6598     "version": "0.0.0",
6599     "filename": "server/api/cmHopperBlack/index.js",
6600     "groupTitle": "Cm_Hopper_Black"
6601   },
6602   {
6603     "type": "post",
6604     "url": "/api/cm/hopper_final/checkContactHopper",
6605     "title": "Check if contact is in hopper",
6606     "examples": [
6607       {
6608         "title": "Example usage:",
6609         "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",
6610         "type": "json"
6611       }
6612     ],
6613     "name": "/checkContactHopper",
6614     "group": "Cm_Hopper_Final",
6615     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6616     "version": "0.0.0",
6617     "filename": "server/api/cmHopperFinal/index.js",
6618     "groupTitle": "Cm_Hopper_Final"
6619   },
6620   {
6621     "type": "get",
6622     "url": "/api/cm/hopper_final/describe",
6623     "title": "Gets table info about HopperFinal",
6624     "examples": [
6625       {
6626         "title": "Example usage:",
6627         "content": "curl https://{domain}/api/cm/hopper_final/describe -v -u {name}:{password}",
6628         "type": "json"
6629       }
6630     ],
6631     "name": "DescribeHopperFinal",
6632     "group": "Cm_Hopper_Final",
6633     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6634     "version": "0.0.0",
6635     "filename": "server/api/cmHopperFinal/index.js",
6636     "groupTitle": "Cm_Hopper_Final"
6637   },
6638   {
6639     "type": "get",
6640     "url": "/api/cm/hopper_final",
6641     "title": "Gets a list of HopperFinal",
6642     "examples": [
6643       {
6644         "title": "Example usage:",
6645         "content": "curl https://{domain}/api/cm/hopper_final -v -u {name}:{password}",
6646         "type": "json"
6647       }
6648     ],
6649     "name": "GetHopperFinal",
6650     "group": "Cm_Hopper_Final",
6651     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6652     "version": "0.0.0",
6653     "filename": "server/api/cmHopperFinal/index.js",
6654     "groupTitle": "Cm_Hopper_Final"
6655   },
6656   {
6657     "type": "get",
6658     "url": "/api/cm/hopper_final/{id}",
6659     "title": "Gets a single HopperFinal",
6660     "examples": [
6661       {
6662         "title": "Example usage:",
6663         "content": "curl https://{domain}/api/cm/hopper_final/{id} -v -u {name}:{password}",
6664         "type": "json"
6665       }
6666     ],
6667     "name": "ShowHopperFinal",
6668     "group": "Cm_Hopper_Final",
6669     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6670     "version": "0.0.0",
6671     "filename": "server/api/cmHopperFinal/index.js",
6672     "groupTitle": "Cm_Hopper_Final"
6673   },
6674   {
6675     "type": "get",
6676     "url": "/api/cm/hopper_final/campaign/countAttributes/{id}",
6677     "title": "Return number contacts for attributes",
6678     "examples": [
6679       {
6680         "title": "Example usage:",
6681         "content": "curl https://{domain}/api/hopper_final/campaign/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
6682         "type": "json"
6683       }
6684     ],
6685     "name": "countContactsIvrCampaignHopperFinal",
6686     "group": "Cm_Hopper_Final",
6687     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6688     "version": "0.0.0",
6689     "filename": "server/api/cmHopperFinal/index.js",
6690     "groupTitle": "Cm_Hopper_Final"
6691   },
6692   {
6693     "type": "get",
6694     "url": "/api/cm/hopper_final/voice/queue/countAttributes/{id}",
6695     "title": "Return number contacts for attributes",
6696     "examples": [
6697       {
6698         "title": "Example usage:",
6699         "content": "curl https://{domain}/api/hopper_final/voice/queue/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
6700         "type": "json"
6701       }
6702     ],
6703     "name": "countContactsQueueCampaignHopperFinal",
6704     "group": "Cm_Hopper_Final",
6705     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6706     "version": "0.0.0",
6707     "filename": "server/api/cmHopperFinal/index.js",
6708     "groupTitle": "Cm_Hopper_Final"
6709   },
6710   {
6711     "type": "post",
6712     "url": "/api/cm/hopper_final/campaign/{id}",
6713     "title": "Move contacts in hopper",
6714     "examples": [
6715       {
6716         "title": "Example usage:",
6717         "content": "curl https://{domain}/api/hopper_final/campaign/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6718         "type": "json"
6719       }
6720     ],
6721     "name": "moveContactsIvrCampaignHopperFinal",
6722     "group": "Cm_Hopper_Final",
6723     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6724     "version": "0.0.0",
6725     "filename": "server/api/cmHopperFinal/index.js",
6726     "groupTitle": "Cm_Hopper_Final"
6727   },
6728   {
6729     "type": "post",
6730     "url": "/api/cm/hopper_final/voice/queue/{id}",
6731     "title": "Move contacts in hopper",
6732     "examples": [
6733       {
6734         "title": "Example usage:",
6735         "content": "curl https://{domain}/api/hopper_final/voice/queue/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password}",
6736         "type": "json"
6737       }
6738     ],
6739     "name": "moveContactsQueueCampaignHopperFinal",
6740     "group": "Cm_Hopper_Final",
6741     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6742     "version": "0.0.0",
6743     "filename": "server/api/cmHopperFinal/index.js",
6744     "groupTitle": "Cm_Hopper_Final"
6745   },
6746   {
6747     "type": "put",
6748     "url": "/api/cm/hopper_final/{id}",
6749     "title": "Update a single hopper final",
6750     "examples": [
6751       {
6752         "title": "Example usage:",
6753         "content": "curl https://{domain}/api/hopper_final/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
6754         "type": "json"
6755       }
6756     ],
6757     "name": "update",
6758     "group": "Cm_Hopper_Final",
6759     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6760     "version": "0.0.0",
6761     "filename": "server/api/cmHopperFinal/index.js",
6762     "groupTitle": "Cm_Hopper_Final"
6763   },
6764   {
6765     "type": "post",
6766     "url": "/api/cm/hopper_history",
6767     "title": "Creates a new HopperHistory",
6768     "examples": [
6769       {
6770         "title": "Example usage:",
6771         "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",
6772         "type": "json"
6773       }
6774     ],
6775     "name": "CreateHopperHistory",
6776     "group": "Cm_Hopper_History",
6777     "parameter": {
6778       "fields": {
6779         "Body": [
6780           {
6781             "group": "Body",
6782             "type": "Integer",
6783             "optional": true,
6784             "field": "state",
6785             "description": ""
6786           },
6787           {
6788             "group": "Body",
6789             "type": "String",
6790             "optional": true,
6791             "field": "statedesc",
6792             "description": ""
6793           },
6794           {
6795             "group": "Body",
6796             "type": "String",
6797             "optional": true,
6798             "field": "scheduledat",
6799             "description": ""
6800           },
6801           {
6802             "group": "Body",
6803             "type": "Integer",
6804             "optional": true,
6805             "field": "countbusyretry",
6806             "description": ""
6807           },
6808           {
6809             "group": "Body",
6810             "type": "Integer",
6811             "optional": true,
6812             "field": "countcongestionretry",
6813             "description": ""
6814           },
6815           {
6816             "group": "Body",
6817             "type": "Integer",
6818             "optional": true,
6819             "field": "countnoanswerretry",
6820             "description": ""
6821           },
6822           {
6823             "group": "Body",
6824             "type": "Integer",
6825             "optional": true,
6826             "field": "countglobal",
6827             "description": ""
6828           },
6829           {
6830             "group": "Body",
6831             "type": "String",
6832             "optional": true,
6833             "field": "uniqueid",
6834             "description": ""
6835           },
6836           {
6837             "group": "Body",
6838             "type": "String",
6839             "optional": true,
6840             "field": "originatecalleridnum",
6841             "description": ""
6842           },
6843           {
6844             "group": "Body",
6845             "type": "String",
6846             "optional": true,
6847             "field": "originatecalleridname",
6848             "description": ""
6849           },
6850           {
6851             "group": "Body",
6852             "type": "String",
6853             "optional": true,
6854             "field": "calleridnum",
6855             "description": ""
6856           },
6857           {
6858             "group": "Body",
6859             "type": "String",
6860             "optional": true,
6861             "field": "calleridname",
6862             "description": ""
6863           },
6864           {
6865             "group": "Body",
6866             "type": "String",
6867             "optional": true,
6868             "field": "starttime",
6869             "description": ""
6870           },
6871           {
6872             "group": "Body",
6873             "type": "String",
6874             "optional": true,
6875             "field": "responsetime",
6876             "description": ""
6877           },
6878           {
6879             "group": "Body",
6880             "type": "String",
6881             "optional": true,
6882             "field": "answertime",
6883             "description": ""
6884           },
6885           {
6886             "group": "Body",
6887             "type": "String",
6888             "optional": true,
6889             "field": "droptime",
6890             "description": ""
6891           },
6892           {
6893             "group": "Body",
6894             "type": "String",
6895             "optional": true,
6896             "field": "endtime",
6897             "description": ""
6898           },
6899           {
6900             "group": "Body",
6901             "type": "Integer",
6902             "optional": true,
6903             "field": "ringtime",
6904             "description": ""
6905           },
6906           {
6907             "group": "Body",
6908             "type": "Integer",
6909             "optional": true,
6910             "field": "holdtime",
6911             "description": ""
6912           },
6913           {
6914             "group": "Body",
6915             "type": "Integer",
6916             "optional": true,
6917             "field": "talktime",
6918             "description": ""
6919           },
6920           {
6921             "group": "Body",
6922             "type": "Integer",
6923             "optional": true,
6924             "field": "followuptime",
6925             "description": ""
6926           },
6927           {
6928             "group": "Body",
6929             "type": "String",
6930             "optional": true,
6931             "field": "dropreason",
6932             "description": ""
6933           },
6934           {
6935             "group": "Body",
6936             "type": "String",
6937             "optional": true,
6938             "field": "campaign",
6939             "description": ""
6940           },
6941           {
6942             "group": "Body",
6943             "type": "String",
6944             "optional": true,
6945             "field": "campaigntype",
6946             "description": ""
6947           },
6948           {
6949             "group": "Body",
6950             "type": "String",
6951             "optional": true,
6952             "field": "membername",
6953             "description": ""
6954           },
6955           {
6956             "group": "Body",
6957             "type": "String",
6958             "optional": true,
6959             "field": "reason",
6960             "description": ""
6961           },
6962           {
6963             "group": "Body",
6964             "type": "Boolean",
6965             "optional": true,
6966             "field": "amd",
6967             "description": ""
6968           },
6969           {
6970             "group": "Body",
6971             "type": "Boolean",
6972             "optional": true,
6973             "field": "fax",
6974             "description": ""
6975           },
6976           {
6977             "group": "Body",
6978             "type": "Boolean",
6979             "optional": true,
6980             "field": "callback",
6981             "description": ""
6982           },
6983           {
6984             "group": "Body",
6985             "type": "String",
6986             "optional": true,
6987             "field": "callbackuniqueid",
6988             "description": ""
6989           },
6990           {
6991             "group": "Body",
6992             "type": "String",
6993             "optional": true,
6994             "field": "callbackat",
6995             "description": ""
6996           },
6997           {
6998             "group": "Body",
6999             "type": "Boolean",
7000             "optional": true,
7001             "field": "recallme",
7002             "description": ""
7003           },
7004           {
7005             "group": "Body",
7006             "type": "String",
7007             "optional": true,
7008             "field": "editedat",
7009             "description": ""
7010           },
7011           {
7012             "group": "Body",
7013             "type": "Boolean",
7014             "optional": true,
7015             "field": "edited",
7016             "description": ""
7017           },
7018           {
7019             "group": "Body",
7020             "type": "Integer",
7021             "optional": true,
7022             "field": "countnosuchnumberretry",
7023             "description": ""
7024           },
7025           {
7026             "group": "Body",
7027             "type": "Integer",
7028             "optional": true,
7029             "field": "countdropretry",
7030             "description": ""
7031           },
7032           {
7033             "group": "Body",
7034             "type": "Integer",
7035             "optional": true,
7036             "field": "countabandonedretry",
7037             "description": ""
7038           },
7039           {
7040             "group": "Body",
7041             "type": "Integer",
7042             "optional": true,
7043             "field": "countmachineretry",
7044             "description": ""
7045           },
7046           {
7047             "group": "Body",
7048             "type": "Integer",
7049             "optional": true,
7050             "field": "countagentrejectretry",
7051             "description": ""
7052           }
7053         ]
7054       }
7055     },
7056     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7057     "version": "0.0.0",
7058     "filename": "server/api/cmHopperHistory/index.js",
7059     "groupTitle": "Cm_Hopper_History"
7060   },
7061   {
7062     "type": "get",
7063     "url": "/api/cm/hopper_history/describe",
7064     "title": "Gets table info about HopperHistory",
7065     "examples": [
7066       {
7067         "title": "Example usage:",
7068         "content": "curl https://{domain}/api/cm/hopper_history/describe -v -u {name}:{password}",
7069         "type": "json"
7070       }
7071     ],
7072     "name": "DescribeHopperHistory",
7073     "group": "Cm_Hopper_History",
7074     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7075     "version": "0.0.0",
7076     "filename": "server/api/cmHopperHistory/index.js",
7077     "groupTitle": "Cm_Hopper_History"
7078   },
7079   {
7080     "type": "get",
7081     "url": "/api/cm/hopper_history",
7082     "title": "Gets a list of HopperHistory",
7083     "examples": [
7084       {
7085         "title": "Example usage:",
7086         "content": "curl https://{domain}/api/cm/hopper_history -v -u {name}:{password}",
7087         "type": "json"
7088       }
7089     ],
7090     "name": "GetHopperHistory",
7091     "group": "Cm_Hopper_History",
7092     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
7093     "version": "0.0.0",
7094     "filename": "server/api/cmHopperHistory/index.js",
7095     "groupTitle": "Cm_Hopper_History"
7096   },
7097   {
7098     "type": "get",
7099     "url": "/api/cm/hopper_history/{id}",
7100     "title": "Gets a single HopperHistory",
7101     "examples": [
7102       {
7103         "title": "Example usage:",
7104         "content": "curl https://{domain}/api/cm/hopper_history/{id} -v -u {name}:{password}",
7105         "type": "json"
7106       }
7107     ],
7108     "name": "ShowHopperHistory",
7109     "group": "Cm_Hopper_History",
7110     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7111     "version": "0.0.0",
7112     "filename": "server/api/cmHopperHistory/index.js",
7113     "groupTitle": "Cm_Hopper_History"
7114   },
7115   {
7116     "type": "put",
7117     "url": "/api/cm/hopper_history/{id}",
7118     "title": "Update a single hopper history",
7119     "examples": [
7120       {
7121         "title": "Example usage:",
7122         "content": "curl https://{domain}/api/hopper_history/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
7123         "type": "json"
7124       }
7125     ],
7126     "name": "update",
7127     "group": "Cm_Hopper_History",
7128     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7129     "version": "0.0.0",
7130     "filename": "server/api/cmHopperHistory/index.js",
7131     "groupTitle": "Cm_Hopper_History"
7132   },
7133   {
7134     "type": "delete",
7135     "url": "/api/cm/hopper/{id}",
7136     "title": "Delete Hopper",
7137     "examples": [
7138       {
7139         "title": "Example usage:",
7140         "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password} -X DELETE",
7141         "type": "json"
7142       }
7143     ],
7144     "name": "destroy",
7145     "group": "Cm_Hopper",
7146     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7147     "version": "0.0.0",
7148     "filename": "server/api/cmHopper/index.js",
7149     "groupTitle": "Cm_Hopper"
7150   },
7151   {
7152     "type": "get",
7153     "url": "/api/cm/hopper/opencontacts",
7154     "title": "Gets Open Contacts",
7155     "examples": [
7156       {
7157         "title": "Example usage:",
7158         "content": "curl https://{domain}/api/cm/hopper/opencontacts -v -u {name}:{password} -X GET",
7159         "type": "json"
7160       }
7161     ],
7162     "name": "getOpenContacts",
7163     "group": "Cm_Hopper",
7164     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7165     "version": "0.0.0",
7166     "filename": "server/api/cmHopper/index.js",
7167     "groupTitle": "Cm_Hopper"
7168   },
7169   {
7170     "type": "post",
7171     "url": "/api/cm/hopper/preview",
7172     "title": "Gets Preview Dialer Contacts",
7173     "examples": [
7174       {
7175         "title": "Example usage:",
7176         "content": "curl https://{domain}/api/cm/hopper/preview -d '{\"hopperIds\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
7177         "type": "json"
7178       }
7179     ],
7180     "name": "getPreview",
7181     "group": "Cm_Hopper",
7182     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7183     "version": "0.0.0",
7184     "filename": "server/api/cmHopper/index.js",
7185     "groupTitle": "Cm_Hopper"
7186   },
7187   {
7188     "type": "put",
7189     "url": "/api/cm/hopper/{id}",
7190     "title": "Update an existing Hopper",
7191     "examples": [
7192       {
7193         "title": "Example usage:",
7194         "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",
7195         "type": "json"
7196       }
7197     ],
7198     "name": "updateHopper",
7199     "group": "Cm_Hopper",
7200     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7201     "version": "0.0.0",
7202     "filename": "server/api/cmHopper/index.js",
7203     "groupTitle": "Cm_Hopper"
7204   },
7205   {
7206     "type": "post",
7207     "url": "/api/cm/lists",
7208     "title": "Creates a new List",
7209     "examples": [
7210       {
7211         "title": "Example usage:",
7212         "content": "curl https://{domain}/api/cm/lists -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7213         "type": "json"
7214       }
7215     ],
7216     "name": "CreateLists",
7217     "group": "Cm_Lists",
7218     "parameter": {
7219       "fields": {
7220         "Body": [
7221           {
7222             "group": "Body",
7223             "type": "String",
7224             "optional": false,
7225             "field": "name",
7226             "description": ""
7227           },
7228           {
7229             "group": "Body",
7230             "type": "String",
7231             "optional": true,
7232             "field": "description",
7233             "description": ""
7234           },
7235           {
7236             "group": "Body",
7237             "type": "String",
7238             "optional": true,
7239             "field": "dialPrefix",
7240             "description": ""
7241           }
7242         ]
7243       }
7244     },
7245     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7246     "version": "0.0.0",
7247     "filename": "server/api/cmList/index.js",
7248     "groupTitle": "Cm_Lists"
7249   },
7250   {
7251     "type": "delete",
7252     "url": "/api/cm/lists/{id}",
7253     "title": "Deletes a List",
7254     "examples": [
7255       {
7256         "title": "Example usage:",
7257         "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password} -X DELETE",
7258         "type": "json"
7259       }
7260     ],
7261     "name": "DeleteLists",
7262     "group": "Cm_Lists",
7263     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7264     "version": "0.0.0",
7265     "filename": "server/api/cmList/index.js",
7266     "groupTitle": "Cm_Lists"
7267   },
7268   {
7269     "type": "get",
7270     "url": "/api/cm/lists/describe",
7271     "title": "Gets table info about Lists",
7272     "examples": [
7273       {
7274         "title": "Example usage:",
7275         "content": "curl https://{domain}/api/cm/lists/describe -v -u {name}:{password}",
7276         "type": "json"
7277       }
7278     ],
7279     "name": "DescribeLists",
7280     "group": "Cm_Lists",
7281     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7282     "version": "0.0.0",
7283     "filename": "server/api/cmList/index.js",
7284     "groupTitle": "Cm_Lists"
7285   },
7286   {
7287     "type": "get",
7288     "url": "/api/cm/lists/{id}/users",
7289     "title": "Gets agents from list",
7290     "examples": [
7291       {
7292         "title": "Example usage:",
7293         "content": "curl https://{domain}/api/cm/lists/{id}/users -v -u {name}:{password} -X GET",
7294         "type": "json"
7295       }
7296     ],
7297     "name": "GetAgents",
7298     "group": "Cm_Lists",
7299     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7300     "version": "0.0.0",
7301     "filename": "server/api/cmList/index.js",
7302     "groupTitle": "Cm_Lists"
7303   },
7304   {
7305     "type": "get",
7306     "url": "/api/cm/lists",
7307     "title": "Gets a list of Lists",
7308     "examples": [
7309       {
7310         "title": "Example usage:",
7311         "content": "curl https://{domain}/api/cm/lists -v -u {name}:{password}",
7312         "type": "json"
7313       }
7314     ],
7315     "name": "GetLists",
7316     "group": "Cm_Lists",
7317     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
7318     "version": "0.0.0",
7319     "filename": "server/api/cmList/index.js",
7320     "groupTitle": "Cm_Lists"
7321   },
7322   {
7323     "type": "delete",
7324     "url": "/api/cm/lists/{id}/users",
7325     "title": "Removes agents from a list",
7326     "examples": [
7327       {
7328         "title": "Example usage:",
7329         "content": "curl https://{domain}/api/cm/lists/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
7330         "type": "json"
7331       }
7332     ],
7333     "name": "RemoveAgents",
7334     "group": "Cm_Lists",
7335     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7336     "version": "0.0.0",
7337     "filename": "server/api/cmList/index.js",
7338     "groupTitle": "Cm_Lists"
7339   },
7340   {
7341     "type": "delete",
7342     "url": "/api/cm/lists/{id}/dispositions",
7343     "title": "Removes dispositions from account",
7344     "examples": [
7345       {
7346         "title": "Example usage:",
7347         "content": "curl https://{domain}/api/cm/lists/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
7348         "type": "json"
7349       }
7350     ],
7351     "name": "RemoveDispositions",
7352     "group": "Cm_Lists",
7353     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7354     "version": "0.0.0",
7355     "filename": "server/api/cmList/index.js",
7356     "groupTitle": "Cm_Lists"
7357   },
7358   {
7359     "type": "get",
7360     "url": "/api/cm/lists/{id}",
7361     "title": "Gets a single List",
7362     "examples": [
7363       {
7364         "title": "Example usage:",
7365         "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password}",
7366         "type": "json"
7367       }
7368     ],
7369     "name": "ShowLists",
7370     "group": "Cm_Lists",
7371     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7372     "version": "0.0.0",
7373     "filename": "server/api/cmList/index.js",
7374     "groupTitle": "Cm_Lists"
7375   },
7376   {
7377     "type": "post",
7378     "url": "/api/cm/lists/{id}/users",
7379     "title": "Adds agents to a list",
7380     "examples": [
7381       {
7382         "title": "Example usage:",
7383         "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",
7384         "type": "json"
7385       }
7386     ],
7387     "name": "addAgents",
7388     "group": "Cm_Lists",
7389     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7390     "version": "0.0.0",
7391     "filename": "server/api/cmList/index.js",
7392     "groupTitle": "Cm_Lists"
7393   },
7394   {
7395     "type": "post",
7396     "url": "/api/cm/lists/{id}/contacts",
7397     "title": "Creates new contacts",
7398     "examples": [
7399       {
7400         "title": "Example usage:",
7401         "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",
7402         "type": "json"
7403       }
7404     ],
7405     "name": "addContacts",
7406     "group": "Cm_Lists",
7407     "parameter": {
7408       "fields": {
7409         "Body": [
7410           {
7411             "group": "Body",
7412             "type": "String",
7413             "optional": false,
7414             "field": "firstName",
7415             "description": ""
7416           },
7417           {
7418             "group": "Body",
7419             "type": "String",
7420             "optional": true,
7421             "field": "lastName",
7422             "description": ""
7423           },
7424           {
7425             "group": "Body",
7426             "type": "String",
7427             "optional": true,
7428             "field": "street",
7429             "description": ""
7430           },
7431           {
7432             "group": "Body",
7433             "type": "String",
7434             "optional": true,
7435             "field": "postalCode",
7436             "description": ""
7437           },
7438           {
7439             "group": "Body",
7440             "type": "String",
7441             "optional": true,
7442             "field": "city",
7443             "description": ""
7444           },
7445           {
7446             "group": "Body",
7447             "type": "String",
7448             "optional": true,
7449             "field": "country",
7450             "description": ""
7451           },
7452           {
7453             "group": "Body",
7454             "type": "String",
7455             "optional": true,
7456             "field": "dateOfBirth",
7457             "description": ""
7458           },
7459           {
7460             "group": "Body",
7461             "type": "Text",
7462             "optional": true,
7463             "field": "description",
7464             "description": ""
7465           },
7466           {
7467             "group": "Body",
7468             "type": "String",
7469             "optional": true,
7470             "field": "phone",
7471             "description": ""
7472           },
7473           {
7474             "group": "Body",
7475             "type": "String",
7476             "optional": true,
7477             "field": "mobile",
7478             "description": ""
7479           },
7480           {
7481             "group": "Body",
7482             "type": "String",
7483             "optional": true,
7484             "field": "fax",
7485             "description": ""
7486           },
7487           {
7488             "group": "Body",
7489             "type": "String",
7490             "optional": true,
7491             "field": "email",
7492             "description": ""
7493           },
7494           {
7495             "group": "Body",
7496             "type": "String",
7497             "optional": true,
7498             "field": "url",
7499             "description": ""
7500           },
7501           {
7502             "group": "Body",
7503             "type": "String",
7504             "optional": true,
7505             "field": "facebook",
7506             "description": ""
7507           },
7508           {
7509             "group": "Body",
7510             "type": "String",
7511             "optional": true,
7512             "field": "fb_data",
7513             "description": ""
7514           },
7515           {
7516             "group": "Body",
7517             "type": "String",
7518             "optional": true,
7519             "field": "twitter",
7520             "description": ""
7521           },
7522           {
7523             "group": "Body",
7524             "type": "String",
7525             "optional": true,
7526             "field": "skype",
7527             "description": ""
7528           },
7529           {
7530             "group": "Body",
7531             "type": "String",
7532             "optional": true,
7533             "field": "teams",
7534             "description": ""
7535           },
7536           {
7537             "group": "Body",
7538             "type": "String",
7539             "optional": true,
7540             "field": "viber",
7541             "description": ""
7542           },
7543           {
7544             "group": "Body",
7545             "type": "String",
7546             "optional": true,
7547             "field": "line",
7548             "description": ""
7549           },
7550           {
7551             "group": "Body",
7552             "type": "String",
7553             "optional": true,
7554             "field": "wechat",
7555             "description": ""
7556           },
7557           {
7558             "group": "Body",
7559             "type": "String",
7560             "optional": true,
7561             "field": "telegram",
7562             "description": ""
7563           },
7564           {
7565             "group": "Body",
7566             "type": "Integer",
7567             "optional": true,
7568             "field": "UserId",
7569             "description": ""
7570           },
7571           {
7572             "group": "Body",
7573             "type": "Integer",
7574             "optional": true,
7575             "field": "priority",
7576             "description": ""
7577           },
7578           {
7579             "group": "Body",
7580             "type": "String",
7581             "optional": true,
7582             "field": "scheduledat",
7583             "description": ""
7584           }
7585         ]
7586       }
7587     },
7588     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7589     "version": "0.0.0",
7590     "filename": "server/api/cmList/index.js",
7591     "groupTitle": "Cm_Lists"
7592   },
7593   {
7594     "type": "post",
7595     "url": "/api/cm/lists/{id}/fields",
7596     "title": "Creates a new custom field",
7597     "examples": [
7598       {
7599         "title": "Example usage:",
7600         "content": "curl https://{domain}/api/cm/lists/{id}/fields -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7601         "type": "json"
7602       }
7603     ],
7604     "name": "addCustomField",
7605     "group": "Cm_Lists",
7606     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7607     "version": "0.0.0",
7608     "filename": "server/api/cmList/index.js",
7609     "groupTitle": "Cm_Lists"
7610   },
7611   {
7612     "type": "post",
7613     "url": "/api/cm/lists/{id}/dispositions",
7614     "title": "Creates new disposition",
7615     "examples": [
7616       {
7617         "title": "Example usage:",
7618         "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7619         "type": "json"
7620       }
7621     ],
7622     "name": "addDisposition",
7623     "group": "Cm_Lists",
7624     "parameter": {
7625       "fields": {
7626         "Body": [
7627           {
7628             "group": "Body",
7629             "type": "String",
7630             "optional": false,
7631             "field": "name",
7632             "description": ""
7633           },
7634           {
7635             "group": "Body",
7636             "type": "String",
7637             "allowedValues": [
7638               "\"first\"",
7639               "\"second\"",
7640               "\"third\""
7641             ],
7642             "optional": false,
7643             "field": "level",
7644             "description": ""
7645           },
7646           {
7647             "group": "Body",
7648             "type": "String",
7649             "optional": true,
7650             "field": "description",
7651             "description": ""
7652           }
7653         ]
7654       }
7655     },
7656     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7657     "version": "0.0.0",
7658     "filename": "server/api/cmList/index.js",
7659     "groupTitle": "Cm_Lists"
7660   },
7661   {
7662     "type": "get",
7663     "url": "/api/cm/lists/{id}/contacts",
7664     "title": "Gets List Contacts",
7665     "examples": [
7666       {
7667         "title": "Example usage:",
7668         "content": "curl https://{domain}/api/cm/lists/{id}/contacts -v -u {name}:{password} -X GET",
7669         "type": "json"
7670       }
7671     ],
7672     "name": "getContacts",
7673     "group": "Cm_Lists",
7674     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7675     "version": "0.0.0",
7676     "filename": "server/api/cmList/index.js",
7677     "groupTitle": "Cm_Lists"
7678   },
7679   {
7680     "type": "get",
7681     "url": "/api/cm/lists/{id}/fields",
7682     "title": "Gets Custom Fields",
7683     "examples": [
7684       {
7685         "title": "Example usage:",
7686         "content": "curl https://{domain}/api/cm/lists/{id}/fields -v -u {name}:{password} -X GET",
7687         "type": "json"
7688       }
7689     ],
7690     "name": "getCustomFields",
7691     "group": "Cm_Lists",
7692     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7693     "version": "0.0.0",
7694     "filename": "server/api/cmList/index.js",
7695     "groupTitle": "Cm_Lists"
7696   },
7697   {
7698     "type": "get",
7699     "url": "/api/cm/lists/{id}/dispositions",
7700     "title": "Gets list dispositions",
7701     "examples": [
7702       {
7703         "title": "Example usage:",
7704         "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -v -u {name}:{password} -X GET",
7705         "type": "json"
7706       }
7707     ],
7708     "name": "getDispositions",
7709     "group": "Cm_Lists",
7710     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7711     "version": "0.0.0",
7712     "filename": "server/api/cmList/index.js",
7713     "groupTitle": "Cm_Lists"
7714   },
7715   {
7716     "type": "get",
7717     "url": "/api/cm/lists/{id}/contacts/csv",
7718     "title": "Gets CSV List Contacts",
7719     "examples": [
7720       {
7721         "title": "Example usage:",
7722         "content": "curl https://{domain}/api/cm/lists/{id}/contacts/csv -v -u {name}:{password} -X GET",
7723         "type": "json"
7724       }
7725     ],
7726     "name": "grunt",
7727     "group": "Cm_Lists",
7728     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7729     "version": "0.0.0",
7730     "filename": "server/api/cmList/index.js",
7731     "groupTitle": "Cm_Lists"
7732   },
7733   {
7734     "type": "put",
7735     "url": "/api/cm/lists/{id}",
7736     "title": "Update an existing List",
7737     "examples": [
7738       {
7739         "title": "Example usage:",
7740         "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",
7741         "type": "json"
7742       }
7743     ],
7744     "name": "updateLists",
7745     "group": "Cm_Lists",
7746     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7747     "version": "0.0.0",
7748     "filename": "server/api/cmList/index.js",
7749     "groupTitle": "Cm_Lists"
7750   },
7751   {
7752     "type": "post",
7753     "url": "/api/cm/contacts/upload/:id",
7754     "title": "Import new contacts by csv",
7755     "examples": [
7756       {
7757         "title": "Example usage:",
7758         "content": "curl https://{domain}/api/cm/contacts/upload/:id -v -u {name}:{password} -X POST",
7759         "type": "json"
7760       }
7761     ],
7762     "name": "import",
7763     "group": "Cm_contacts",
7764     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7765     "version": "0.0.0",
7766     "filename": "server/api/cmContact/index.js",
7767     "groupTitle": "Cm_contacts"
7768   },
7769   {
7770     "type": "post",
7771     "url": "/api/cm/contacts/upload",
7772     "title": "Upload csv",
7773     "examples": [
7774       {
7775         "title": "Example usage:",
7776         "content": "curl https://{domain}/api/cm/contacts/upload -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
7777         "type": "json"
7778       }
7779     ],
7780     "name": "upload",
7781     "group": "Cm_contacts",
7782     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7783     "version": "0.0.0",
7784     "filename": "server/api/cmContact/index.js",
7785     "groupTitle": "Cm_contacts"
7786   },
7787   {
7788     "type": "post",
7789     "url": "/api/cm/contacts/csv",
7790     "title": "Create new contacts by csv",
7791     "examples": [
7792       {
7793         "title": "Example usage:",
7794         "content": "curl https://{domain}/api/cm/contacts/csv -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
7795         "type": "json"
7796       }
7797     ],
7798     "name": "uploadCsv",
7799     "group": "Cm_contacts",
7800     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7801     "version": "0.0.0",
7802     "filename": "server/api/cmContact/index.js",
7803     "groupTitle": "Cm_contacts"
7804   },
7805   {
7806     "type": "delete",
7807     "url": "/api/conditions/{id}",
7808     "title": "Deletes a Condition",
7809     "examples": [
7810       {
7811         "title": "Example usage:",
7812         "content": "curl https://{domain}/api/conditions/{id} -v -u {name}:{password} -X DELETE",
7813         "type": "json"
7814       }
7815     ],
7816     "name": "DeleteConditions",
7817     "group": "Conditions",
7818     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7819     "version": "0.0.0",
7820     "filename": "server/api/condition/index.js",
7821     "groupTitle": "Conditions"
7822   },
7823   {
7824     "type": "put",
7825     "url": "/api/conditions/{id}",
7826     "title": "Update an existing Condition",
7827     "examples": [
7828       {
7829         "title": "Example usage:",
7830         "content": "curl https://{domain}/api/conditions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
7831         "type": "json"
7832       }
7833     ],
7834     "name": "updateConditions",
7835     "group": "Conditions",
7836     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7837     "version": "0.0.0",
7838     "filename": "server/api/condition/index.js",
7839     "groupTitle": "Conditions"
7840   },
7841   {
7842     "type": "post",
7843     "url": "/api/cm/custom_field",
7844     "title": "Create a new custom field",
7845     "examples": [
7846       {
7847         "title": "Example usage:",
7848         "content": "curl https://{domain}/api/cm/custom_field  -d '{\"name\": \"mycf\", \"type\": \"text\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7849         "type": "json"
7850       }
7851     ],
7852     "name": "CreateCustomField",
7853     "group": "Custom_Fields",
7854     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7855     "version": "0.0.0",
7856     "filename": "server/api/cmCustomField/index.js",
7857     "groupTitle": "Custom_Fields"
7858   },
7859   {
7860     "type": "post",
7861     "url": "/api/dashboards/items",
7862     "title": "Create dasboard item",
7863     "examples": [
7864       {
7865         "title": "Example usage:",
7866         "content": "curl https://{domain}/api/dashboards/items \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
7867         "type": "json"
7868       }
7869     ],
7870     "name": "Create",
7871     "group": "Dashboard_Items",
7872     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7873     "version": "0.0.0",
7874     "filename": "server/api/dashboardItem/index.js",
7875     "groupTitle": "Dashboard_Items"
7876   },
7877   {
7878     "type": "delete",
7879     "url": "/api/dashboards/items/{id}",
7880     "title": "Deletes a Dashboard Item",
7881     "examples": [
7882       {
7883         "title": "Example usage:",
7884         "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X DELETE",
7885         "type": "json"
7886       }
7887     ],
7888     "name": "DeleteDashboard_Items",
7889     "group": "Dashboard_Items",
7890     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7891     "version": "0.0.0",
7892     "filename": "server/api/dashboardItem/index.js",
7893     "groupTitle": "Dashboard_Items"
7894   },
7895   {
7896     "type": "get",
7897     "url": "/api/dashboards/items/{id}",
7898     "title": "Gets a single Dashboard Item",
7899     "examples": [
7900       {
7901         "title": "Example usage:",
7902         "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password}",
7903         "type": "json"
7904       }
7905     ],
7906     "name": "ShowDashboard_Items",
7907     "group": "Dashboard_Items",
7908     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7909     "version": "0.0.0",
7910     "filename": "server/api/dashboardItem/index.js",
7911     "groupTitle": "Dashboard_Items"
7912   },
7913   {
7914     "type": "put",
7915     "url": "/api/dashboards/items/{id}",
7916     "title": "Update an existing item",
7917     "examples": [
7918       {
7919         "title": "Example usage:",
7920         "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X PUT",
7921         "type": "json"
7922       }
7923     ],
7924     "name": "Update",
7925     "group": "Dashboard_Items",
7926     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7927     "version": "0.0.0",
7928     "filename": "server/api/dashboardItem/index.js",
7929     "groupTitle": "Dashboard_Items"
7930   },
7931   {
7932     "type": "post",
7933     "url": "/api/dashboards/clone",
7934     "title": "Clone an existing Dashboard",
7935     "examples": [
7936       {
7937         "title": "Example usage:",
7938         "content": "curl https://{domain}/api/dashboards/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7939         "type": "json"
7940       }
7941     ],
7942     "name": "CloneDashboards",
7943     "group": "Dashboards",
7944     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7945     "version": "0.0.0",
7946     "filename": "server/api/dashboard/index.js",
7947     "groupTitle": "Dashboards"
7948   },
7949   {
7950     "type": "post",
7951     "url": "/api/dashboards",
7952     "title": "Creates a new Dashboard",
7953     "examples": [
7954       {
7955         "title": "Example usage:",
7956         "content": "curl https://{domain}/api/dashboards -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7957         "type": "json"
7958       }
7959     ],
7960     "name": "CreateDashboards",
7961     "group": "Dashboards",
7962     "parameter": {
7963       "fields": {
7964         "Body": [
7965           {
7966             "group": "Body",
7967             "type": "String",
7968             "optional": false,
7969             "field": "name",
7970             "description": ""
7971           },
7972           {
7973             "group": "Body",
7974             "type": "String",
7975             "optional": true,
7976             "field": "description",
7977             "description": ""
7978           }
7979         ]
7980       }
7981     },
7982     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7983     "version": "0.0.0",
7984     "filename": "server/api/dashboard/index.js",
7985     "groupTitle": "Dashboards"
7986   },
7987   {
7988     "type": "delete",
7989     "url": "/api/dashboards/{id}",
7990     "title": "Deletes a Dashboard",
7991     "examples": [
7992       {
7993         "title": "Example usage:",
7994         "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password} -X DELETE",
7995         "type": "json"
7996       }
7997     ],
7998     "name": "DeleteDashboards",
7999     "group": "Dashboards",
8000     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8001     "version": "0.0.0",
8002     "filename": "server/api/dashboard/index.js",
8003     "groupTitle": "Dashboards"
8004   },
8005   {
8006     "type": "get",
8007     "url": "/api/dashboards",
8008     "title": "Gets a list of Dashboards",
8009     "examples": [
8010       {
8011         "title": "Example usage:",
8012         "content": "curl https://{domain}/api/dashboards -v -u {name}:{password}",
8013         "type": "json"
8014       }
8015     ],
8016     "name": "GetDashboards",
8017     "group": "Dashboards",
8018     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8019     "version": "0.0.0",
8020     "filename": "server/api/dashboard/index.js",
8021     "groupTitle": "Dashboards"
8022   },
8023   {
8024     "type": "get",
8025     "url": "/api/dashboards/{id}",
8026     "title": "Gets a single Dashboard",
8027     "examples": [
8028       {
8029         "title": "Example usage:",
8030         "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password}",
8031         "type": "json"
8032       }
8033     ],
8034     "name": "ShowDashboards",
8035     "group": "Dashboards",
8036     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8037     "version": "0.0.0",
8038     "filename": "server/api/dashboard/index.js",
8039     "groupTitle": "Dashboards"
8040   },
8041   {
8042     "type": "post",
8043     "url": "/api/dashboards/{id}/items",
8044     "title": "Creates new item",
8045     "examples": [
8046       {
8047         "title": "Example usage:",
8048         "content": "curl https://{domain}/api/dashboards/{id}/items -d '{\"type\": \"counter\", \"...\": \"...\"}]' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
8049         "type": "json"
8050       }
8051     ],
8052     "name": "addItem",
8053     "group": "Dashboards",
8054     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8055     "version": "0.0.0",
8056     "filename": "server/api/dashboard/index.js",
8057     "groupTitle": "Dashboards"
8058   },
8059   {
8060     "type": "get",
8061     "url": "/api/dashboards/{id}/items",
8062     "title": "Gets items",
8063     "examples": [
8064       {
8065         "title": "Example usage:",
8066         "content": "curl https://{domain}/api/dashboards/{id}/items -v -u {name}:{password} -X GET",
8067         "type": "json"
8068       }
8069     ],
8070     "name": "getItems",
8071     "group": "Dashboards",
8072     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8073     "version": "0.0.0",
8074     "filename": "server/api/dashboard/index.js",
8075     "groupTitle": "Dashboards"
8076   },
8077   {
8078     "type": "put",
8079     "url": "/api/dashboards/{id}",
8080     "title": "Update an existing Dashboard",
8081     "examples": [
8082       {
8083         "title": "Example usage:",
8084         "content": "curl https://{domain}/api/dashboards/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8085         "type": "json"
8086       }
8087     ],
8088     "name": "updateDashboards",
8089     "group": "Dashboards",
8090     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8091     "version": "0.0.0",
8092     "filename": "server/api/dashboard/index.js",
8093     "groupTitle": "Dashboards"
8094   },
8095   {
8096     "type": "post",
8097     "url": "/api/integrations/desk/accounts",
8098     "title": "Creates a new Desk Account",
8099     "examples": [
8100       {
8101         "title": "Example usage:",
8102         "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",
8103         "type": "json"
8104       }
8105     ],
8106     "name": "CreateDesk_Accounts",
8107     "group": "Desk_Accounts",
8108     "parameter": {
8109       "fields": {
8110         "Body": [
8111           {
8112             "group": "Body",
8113             "type": "String",
8114             "optional": true,
8115             "field": "name",
8116             "description": ""
8117           },
8118           {
8119             "group": "Body",
8120             "type": "String",
8121             "optional": true,
8122             "field": "description",
8123             "description": ""
8124           },
8125           {
8126             "group": "Body",
8127             "type": "String",
8128             "optional": true,
8129             "field": "username",
8130             "description": ""
8131           },
8132           {
8133             "group": "Body",
8134             "type": "String",
8135             "optional": true,
8136             "field": "remoteUri",
8137             "description": ""
8138           },
8139           {
8140             "group": "Body",
8141             "type": "String",
8142             "allowedValues": [
8143               "\"basic\""
8144             ],
8145             "optional": true,
8146             "field": "authType",
8147             "description": ""
8148           },
8149           {
8150             "group": "Body",
8151             "type": "String",
8152             "optional": true,
8153             "field": "password",
8154             "description": ""
8155           },
8156           {
8157             "group": "Body",
8158             "type": "String",
8159             "optional": true,
8160             "field": "consumerKey",
8161             "description": ""
8162           },
8163           {
8164             "group": "Body",
8165             "type": "String",
8166             "optional": true,
8167             "field": "consumerSecret",
8168             "description": ""
8169           },
8170           {
8171             "group": "Body",
8172             "type": "String",
8173             "optional": true,
8174             "field": "token",
8175             "description": ""
8176           },
8177           {
8178             "group": "Body",
8179             "type": "String",
8180             "optional": true,
8181             "field": "tokenSecret",
8182             "description": ""
8183           },
8184           {
8185             "group": "Body",
8186             "type": "String",
8187             "optional": false,
8188             "field": "serverUrl",
8189             "description": ""
8190           },
8191           {
8192             "group": "Body",
8193             "type": "String",
8194             "allowedValues": [
8195               "\"integrationTab\"",
8196               "\"newTab\""
8197             ],
8198             "optional": true,
8199             "field": "type",
8200             "description": ""
8201           }
8202         ]
8203       }
8204     },
8205     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8206     "version": "0.0.0",
8207     "filename": "server/api/intDeskAccount/index.js",
8208     "groupTitle": "Desk_Accounts"
8209   },
8210   {
8211     "type": "delete",
8212     "url": "/api/integrations/desk/accounts/{id}",
8213     "title": "Deletes a Desk Account",
8214     "examples": [
8215       {
8216         "title": "Example usage:",
8217         "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password} -X DELETE",
8218         "type": "json"
8219       }
8220     ],
8221     "name": "DeleteDesk_Accounts",
8222     "group": "Desk_Accounts",
8223     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8224     "version": "0.0.0",
8225     "filename": "server/api/intDeskAccount/index.js",
8226     "groupTitle": "Desk_Accounts"
8227   },
8228   {
8229     "type": "get",
8230     "url": "/api/integrations/desk/accounts",
8231     "title": "Gets a list of Desk Accounts",
8232     "examples": [
8233       {
8234         "title": "Example usage:",
8235         "content": "curl https://{domain}/api/integrations/desk/accounts -v -u {name}:{password}",
8236         "type": "json"
8237       }
8238     ],
8239     "name": "GetDesk_Accounts",
8240     "group": "Desk_Accounts",
8241     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8242     "version": "0.0.0",
8243     "filename": "server/api/intDeskAccount/index.js",
8244     "groupTitle": "Desk_Accounts"
8245   },
8246   {
8247     "type": "get",
8248     "url": "/api/integrations/desk/accounts/{id}",
8249     "title": "Gets a single Desk Account",
8250     "examples": [
8251       {
8252         "title": "Example usage:",
8253         "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password}",
8254         "type": "json"
8255       }
8256     ],
8257     "name": "ShowDesk_Accounts",
8258     "group": "Desk_Accounts",
8259     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8260     "version": "0.0.0",
8261     "filename": "server/api/intDeskAccount/index.js",
8262     "groupTitle": "Desk_Accounts"
8263   },
8264   {
8265     "type": "post",
8266     "url": "/api/integrations/desk/accounts/{id}/configurations",
8267     "title": "Creates new configuration",
8268     "examples": [
8269       {
8270         "title": "Example usage:",
8271         "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",
8272         "type": "json"
8273       }
8274     ],
8275     "name": "addConfiguration",
8276     "group": "Desk_Accounts",
8277     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8278     "version": "0.0.0",
8279     "filename": "server/api/intDeskAccount/index.js",
8280     "groupTitle": "Desk_Accounts"
8281   },
8282   {
8283     "type": "get",
8284     "url": "/api/integrations/desk/accounts/{id}/configurations",
8285     "title": "Gets account configurations",
8286     "examples": [
8287       {
8288         "title": "Example usage:",
8289         "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
8290         "type": "json"
8291       }
8292     ],
8293     "name": "getConfigurations",
8294     "group": "Desk_Accounts",
8295     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8296     "version": "0.0.0",
8297     "filename": "server/api/intDeskAccount/index.js",
8298     "groupTitle": "Desk_Accounts"
8299   },
8300   {
8301     "type": "get",
8302     "url": "/api/integrations/desk/accounts/{id}/fields",
8303     "title": "Gets account fields",
8304     "examples": [
8305       {
8306         "title": "Example usage:",
8307         "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/fields -v -u {name}:{password} -X GET",
8308         "type": "json"
8309       }
8310     ],
8311     "name": "getFields",
8312     "group": "Desk_Accounts",
8313     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8314     "version": "0.0.0",
8315     "filename": "server/api/intDeskAccount/index.js",
8316     "groupTitle": "Desk_Accounts"
8317   },
8318   {
8319     "type": "put",
8320     "url": "/api/integrations/desk/accounts/{id}",
8321     "title": "Update an existing Desk Account",
8322     "examples": [
8323       {
8324         "title": "Example usage:",
8325         "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",
8326         "type": "json"
8327       }
8328     ],
8329     "name": "updateDesk_Accounts",
8330     "group": "Desk_Accounts",
8331     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8332     "version": "0.0.0",
8333     "filename": "server/api/intDeskAccount/index.js",
8334     "groupTitle": "Desk_Accounts"
8335   },
8336   {
8337     "type": "post",
8338     "url": "/api/integrations/desk/configurations",
8339     "title": "Creates a new Desk Configuration",
8340     "examples": [
8341       {
8342         "title": "Example usage:",
8343         "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",
8344         "type": "json"
8345       }
8346     ],
8347     "name": "CreateDesk_Configurations",
8348     "group": "Desk_Configurations",
8349     "parameter": {
8350       "fields": {
8351         "Body": [
8352           {
8353             "group": "Body",
8354             "type": "String",
8355             "optional": true,
8356             "field": "name",
8357             "description": ""
8358           },
8359           {
8360             "group": "Body",
8361             "type": "String",
8362             "optional": true,
8363             "field": "description",
8364             "description": ""
8365           }
8366         ]
8367       }
8368     },
8369     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8370     "version": "0.0.0",
8371     "filename": "server/api/intDeskConfiguration/index.js",
8372     "groupTitle": "Desk_Configurations"
8373   },
8374   {
8375     "type": "delete",
8376     "url": "/api/integrations/desk/configurations/{id}",
8377     "title": "Deletes a Desk Configuration",
8378     "examples": [
8379       {
8380         "title": "Example usage:",
8381         "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password} -X DELETE",
8382         "type": "json"
8383       }
8384     ],
8385     "name": "DeleteDesk_Configurations",
8386     "group": "Desk_Configurations",
8387     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8388     "version": "0.0.0",
8389     "filename": "server/api/intDeskConfiguration/index.js",
8390     "groupTitle": "Desk_Configurations"
8391   },
8392   {
8393     "type": "get",
8394     "url": "/api/integrations/desk/configurations",
8395     "title": "Gets a list of Desk Configurations",
8396     "examples": [
8397       {
8398         "title": "Example usage:",
8399         "content": "curl https://{domain}/api/integrations/desk/configurations -v -u {name}:{password}",
8400         "type": "json"
8401       }
8402     ],
8403     "name": "GetDesk_Configurations",
8404     "group": "Desk_Configurations",
8405     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8406     "version": "0.0.0",
8407     "filename": "server/api/intDeskConfiguration/index.js",
8408     "groupTitle": "Desk_Configurations"
8409   },
8410   {
8411     "type": "get",
8412     "url": "/api/integrations/desk/configurations/{id}",
8413     "title": "Gets a single Desk Configuration",
8414     "examples": [
8415       {
8416         "title": "Example usage:",
8417         "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password}",
8418         "type": "json"
8419       }
8420     ],
8421     "name": "ShowDesk_Configurations",
8422     "group": "Desk_Configurations",
8423     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8424     "version": "0.0.0",
8425     "filename": "server/api/intDeskConfiguration/index.js",
8426     "groupTitle": "Desk_Configurations"
8427   },
8428   {
8429     "type": "get",
8430     "url": "/api/integrations/desk/configurations/{id}/descriptions",
8431     "title": "Gets configurations descriptions",
8432     "examples": [
8433       {
8434         "title": "Example usage:",
8435         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
8436         "type": "json"
8437       }
8438     ],
8439     "name": "getDescriptions",
8440     "group": "Desk_Configurations",
8441     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8442     "version": "0.0.0",
8443     "filename": "server/api/intDeskConfiguration/index.js",
8444     "groupTitle": "Desk_Configurations"
8445   },
8446   {
8447     "type": "get",
8448     "url": "/api/integrations/desk/configurations/{id}/fields",
8449     "title": "Gets configurations fields",
8450     "examples": [
8451       {
8452         "title": "Example usage:",
8453         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/fields -v -u {name}:{password} -X GET",
8454         "type": "json"
8455       }
8456     ],
8457     "name": "getFields",
8458     "group": "Desk_Configurations",
8459     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8460     "version": "0.0.0",
8461     "filename": "server/api/intDeskConfiguration/index.js",
8462     "groupTitle": "Desk_Configurations"
8463   },
8464   {
8465     "type": "get",
8466     "url": "/api/integrations/desk/configurations/{id}/subjects",
8467     "title": "Gets configurations subjects",
8468     "examples": [
8469       {
8470         "title": "Example usage:",
8471         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
8472         "type": "json"
8473       }
8474     ],
8475     "name": "getSubjects",
8476     "group": "Desk_Configurations",
8477     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8478     "version": "0.0.0",
8479     "filename": "server/api/intDeskConfiguration/index.js",
8480     "groupTitle": "Desk_Configurations"
8481   },
8482   {
8483     "type": "get",
8484     "url": "/api/integrations/desk/configurations/{id}/tags",
8485     "title": "Gets configurations tags",
8486     "examples": [
8487       {
8488         "title": "Example usage:",
8489         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/tags -v -u {name}:{password} -X GET",
8490         "type": "json"
8491       }
8492     ],
8493     "name": "getTags",
8494     "group": "Desk_Configurations",
8495     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8496     "version": "0.0.0",
8497     "filename": "server/api/intDeskConfiguration/index.js",
8498     "groupTitle": "Desk_Configurations"
8499   },
8500   {
8501     "type": "post",
8502     "url": "/api/integrations/desk/configurations/{id}/tags",
8503     "title": "Sets new tags",
8504     "examples": [
8505       {
8506         "title": "Example usage:",
8507         "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",
8508         "type": "json"
8509       }
8510     ],
8511     "name": "setTags",
8512     "group": "Desk_Configurations",
8513     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8514     "version": "0.0.0",
8515     "filename": "server/api/intDeskConfiguration/index.js",
8516     "groupTitle": "Desk_Configurations"
8517   },
8518   {
8519     "type": "put",
8520     "url": "/api/integrations/desk/configurations/{id}",
8521     "title": "Update an existing Desk Configuration",
8522     "examples": [
8523       {
8524         "title": "Example usage:",
8525         "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",
8526         "type": "json"
8527       }
8528     ],
8529     "name": "updateDesk_Configurations",
8530     "group": "Desk_Configurations",
8531     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8532     "version": "0.0.0",
8533     "filename": "server/api/intDeskConfiguration/index.js",
8534     "groupTitle": "Desk_Configurations"
8535   },
8536   {
8537     "type": "post",
8538     "url": "/api/integrations/desk/fields",
8539     "title": "Creates a new Desk Field",
8540     "examples": [
8541       {
8542         "title": "Example usage:",
8543         "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",
8544         "type": "json"
8545       }
8546     ],
8547     "name": "CreateDesk_Fields",
8548     "group": "Desk_Fields",
8549     "parameter": {
8550       "fields": {
8551         "Body": [
8552           {
8553             "group": "Body",
8554             "type": "String",
8555             "allowedValues": [
8556               "\"string\"",
8557               "\"variable\"",
8558               "\"customVariable\"",
8559               "\"keyValue\"",
8560               "\"picklist\""
8561             ],
8562             "optional": true,
8563             "field": "type",
8564             "description": ""
8565           },
8566           {
8567             "group": "Body",
8568             "type": "String",
8569             "optional": true,
8570             "field": "content",
8571             "description": ""
8572           },
8573           {
8574             "group": "Body",
8575             "type": "String",
8576             "optional": true,
8577             "field": "key",
8578             "description": ""
8579           },
8580           {
8581             "group": "Body",
8582             "type": "String",
8583             "allowedValues": [
8584               "\"string\"",
8585               "\"variable\"",
8586               "\"customVariable\""
8587             ],
8588             "optional": true,
8589             "field": "keyType",
8590             "description": ""
8591           },
8592           {
8593             "group": "Body",
8594             "type": "String",
8595             "optional": true,
8596             "field": "keyContent",
8597             "description": ""
8598           },
8599           {
8600             "group": "Body",
8601             "type": "String",
8602             "optional": true,
8603             "field": "idField",
8604             "description": ""
8605           },
8606           {
8607             "group": "Body",
8608             "type": "String",
8609             "optional": true,
8610             "field": "nameField",
8611             "description": ""
8612           },
8613           {
8614             "group": "Body",
8615             "type": "Boolean",
8616             "optional": true,
8617             "field": "customField",
8618             "description": ""
8619           },
8620           {
8621             "group": "Body",
8622             "type": "String",
8623             "optional": true,
8624             "field": "variableName",
8625             "description": ""
8626           }
8627         ]
8628       }
8629     },
8630     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8631     "version": "0.0.0",
8632     "filename": "server/api/intDeskField/index.js",
8633     "groupTitle": "Desk_Fields"
8634   },
8635   {
8636     "type": "delete",
8637     "url": "/api/integrations/desk/fields/{id}",
8638     "title": "Deletes a Desk Field",
8639     "examples": [
8640       {
8641         "title": "Example usage:",
8642         "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password} -X DELETE",
8643         "type": "json"
8644       }
8645     ],
8646     "name": "DeleteDesk_Fields",
8647     "group": "Desk_Fields",
8648     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8649     "version": "0.0.0",
8650     "filename": "server/api/intDeskField/index.js",
8651     "groupTitle": "Desk_Fields"
8652   },
8653   {
8654     "type": "get",
8655     "url": "/api/integrations/desk/fields",
8656     "title": "Gets a list of Desk Fields",
8657     "examples": [
8658       {
8659         "title": "Example usage:",
8660         "content": "curl https://{domain}/api/integrations/desk/fields -v -u {name}:{password}",
8661         "type": "json"
8662       }
8663     ],
8664     "name": "GetDesk_Fields",
8665     "group": "Desk_Fields",
8666     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8667     "version": "0.0.0",
8668     "filename": "server/api/intDeskField/index.js",
8669     "groupTitle": "Desk_Fields"
8670   },
8671   {
8672     "type": "get",
8673     "url": "/api/integrations/desk/fields/{id}",
8674     "title": "Gets a single Desk Field",
8675     "examples": [
8676       {
8677         "title": "Example usage:",
8678         "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password}",
8679         "type": "json"
8680       }
8681     ],
8682     "name": "ShowDesk_Fields",
8683     "group": "Desk_Fields",
8684     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8685     "version": "0.0.0",
8686     "filename": "server/api/intDeskField/index.js",
8687     "groupTitle": "Desk_Fields"
8688   },
8689   {
8690     "type": "put",
8691     "url": "/api/integrations/desk/fields/{id}",
8692     "title": "Update an existing Desk Field",
8693     "examples": [
8694       {
8695         "title": "Example usage:",
8696         "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",
8697         "type": "json"
8698       }
8699     ],
8700     "name": "updateDesk_Fields",
8701     "group": "Desk_Fields",
8702     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8703     "version": "0.0.0",
8704     "filename": "server/api/intDeskField/index.js",
8705     "groupTitle": "Desk_Fields"
8706   },
8707   {
8708     "type": "post",
8709     "url": "/api/dispositions",
8710     "title": "Creates a new Disposition",
8711     "examples": [
8712       {
8713         "title": "Example usage:",
8714         "content": "curl https://{domain}/api/dispositions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8715         "type": "json"
8716       }
8717     ],
8718     "name": "CreateDispositions",
8719     "group": "Dispositions",
8720     "parameter": {
8721       "fields": {
8722         "Body": [
8723           {
8724             "group": "Body",
8725             "type": "String",
8726             "optional": false,
8727             "field": "name",
8728             "description": ""
8729           },
8730           {
8731             "group": "Body",
8732             "type": "String",
8733             "allowedValues": [
8734               "\"first\"",
8735               "\"second\"",
8736               "\"third\""
8737             ],
8738             "optional": false,
8739             "field": "level",
8740             "description": ""
8741           },
8742           {
8743             "group": "Body",
8744             "type": "String",
8745             "optional": true,
8746             "field": "description",
8747             "description": ""
8748           }
8749         ]
8750       }
8751     },
8752     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8753     "version": "0.0.0",
8754     "filename": "server/api/disposition/index.js",
8755     "groupTitle": "Dispositions"
8756   },
8757   {
8758     "type": "delete",
8759     "url": "/api/dispositions/{id}",
8760     "title": "Deletes a Disposition",
8761     "examples": [
8762       {
8763         "title": "Example usage:",
8764         "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password} -X DELETE",
8765         "type": "json"
8766       }
8767     ],
8768     "name": "DeleteDispositions",
8769     "group": "Dispositions",
8770     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8771     "version": "0.0.0",
8772     "filename": "server/api/disposition/index.js",
8773     "groupTitle": "Dispositions"
8774   },
8775   {
8776     "type": "get",
8777     "url": "/api/dispositions",
8778     "title": "Gets a list of Dispositions",
8779     "examples": [
8780       {
8781         "title": "Example usage:",
8782         "content": "curl https://{domain}/api/dispositions -v -u {name}:{password}",
8783         "type": "json"
8784       }
8785     ],
8786     "name": "GetDispositions",
8787     "group": "Dispositions",
8788     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8789     "version": "0.0.0",
8790     "filename": "server/api/disposition/index.js",
8791     "groupTitle": "Dispositions"
8792   },
8793   {
8794     "type": "get",
8795     "url": "/api/dispositions/{id}",
8796     "title": "Gets a single Disposition",
8797     "examples": [
8798       {
8799         "title": "Example usage:",
8800         "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password}",
8801         "type": "json"
8802       }
8803     ],
8804     "name": "ShowDispositions",
8805     "group": "Dispositions",
8806     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8807     "version": "0.0.0",
8808     "filename": "server/api/disposition/index.js",
8809     "groupTitle": "Dispositions"
8810   },
8811   {
8812     "type": "put",
8813     "url": "/api/dispositions/{id}",
8814     "title": "Update an existing Disposition",
8815     "examples": [
8816       {
8817         "title": "Example usage:",
8818         "content": "curl https://{domain}/api/dispositions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8819         "type": "json"
8820       }
8821     ],
8822     "name": "updateDispositions",
8823     "group": "Dispositions",
8824     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8825     "version": "0.0.0",
8826     "filename": "server/api/disposition/index.js",
8827     "groupTitle": "Dispositions"
8828   },
8829   {
8830     "type": "post",
8831     "url": "/api/integrations/dynamics365/accounts",
8832     "title": "Creates a new Dynamics365 Account",
8833     "examples": [
8834       {
8835         "title": "Example usage:",
8836         "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",
8837         "type": "json"
8838       }
8839     ],
8840     "name": "CreateDynamics365_Accounts",
8841     "group": "Dynamics365_Accounts",
8842     "parameter": {
8843       "fields": {
8844         "Body": [
8845           {
8846             "group": "Body",
8847             "type": "String",
8848             "optional": true,
8849             "field": "name",
8850             "description": ""
8851           },
8852           {
8853             "group": "Body",
8854             "type": "String",
8855             "optional": true,
8856             "field": "username",
8857             "description": ""
8858           },
8859           {
8860             "group": "Body",
8861             "type": "String",
8862             "optional": true,
8863             "field": "password",
8864             "description": ""
8865           },
8866           {
8867             "group": "Body",
8868             "type": "String",
8869             "optional": true,
8870             "field": "remoteUri",
8871             "description": ""
8872           },
8873           {
8874             "group": "Body",
8875             "type": "String",
8876             "optional": true,
8877             "field": "tenantId",
8878             "description": ""
8879           },
8880           {
8881             "group": "Body",
8882             "type": "String",
8883             "optional": true,
8884             "field": "clientId",
8885             "description": ""
8886           },
8887           {
8888             "group": "Body",
8889             "type": "String",
8890             "optional": true,
8891             "field": "clientSecret",
8892             "description": ""
8893           },
8894           {
8895             "group": "Body",
8896             "type": "String",
8897             "optional": false,
8898             "field": "serverUrl",
8899             "description": ""
8900           },
8901           {
8902             "group": "Body",
8903             "type": "String",
8904             "optional": true,
8905             "field": "description",
8906             "description": ""
8907           }
8908         ]
8909       }
8910     },
8911     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8912     "version": "0.0.0",
8913     "filename": "server/api/intDynamics365Account/index.js",
8914     "groupTitle": "Dynamics365_Accounts"
8915   },
8916   {
8917     "type": "delete",
8918     "url": "/api/integrations/dynamics365/accounts/{id}",
8919     "title": "Deletes a Dynamics365 Account",
8920     "examples": [
8921       {
8922         "title": "Example usage:",
8923         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password} -X DELETE",
8924         "type": "json"
8925       }
8926     ],
8927     "name": "DeleteDynamics365_Accounts",
8928     "group": "Dynamics365_Accounts",
8929     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8930     "version": "0.0.0",
8931     "filename": "server/api/intDynamics365Account/index.js",
8932     "groupTitle": "Dynamics365_Accounts"
8933   },
8934   {
8935     "type": "get",
8936     "url": "/api/integrations/dynamics365/accounts",
8937     "title": "Gets a list of Dynamics365 Accounts",
8938     "examples": [
8939       {
8940         "title": "Example usage:",
8941         "content": "curl https://{domain}/api/integrations/dynamics365/accounts -v -u {name}:{password}",
8942         "type": "json"
8943       }
8944     ],
8945     "name": "GetDynamics365_Accounts",
8946     "group": "Dynamics365_Accounts",
8947     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8948     "version": "0.0.0",
8949     "filename": "server/api/intDynamics365Account/index.js",
8950     "groupTitle": "Dynamics365_Accounts"
8951   },
8952   {
8953     "type": "get",
8954     "url": "/api/integrations/dynamics365/accounts/{id}",
8955     "title": "Gets a single Dynamics365 Account",
8956     "examples": [
8957       {
8958         "title": "Example usage:",
8959         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password}",
8960         "type": "json"
8961       }
8962     ],
8963     "name": "ShowDynamics365_Accounts",
8964     "group": "Dynamics365_Accounts",
8965     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8966     "version": "0.0.0",
8967     "filename": "server/api/intDynamics365Account/index.js",
8968     "groupTitle": "Dynamics365_Accounts"
8969   },
8970   {
8971     "type": "post",
8972     "url": "/api/integrations/dynamics365/accounts/{id}/configurations",
8973     "title": "Creates new configuration",
8974     "examples": [
8975       {
8976         "title": "Example usage:",
8977         "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",
8978         "type": "json"
8979       }
8980     ],
8981     "name": "addConfiguration",
8982     "group": "Dynamics365_Accounts",
8983     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8984     "version": "0.0.0",
8985     "filename": "server/api/intDynamics365Account/index.js",
8986     "groupTitle": "Dynamics365_Accounts"
8987   },
8988   {
8989     "type": "get",
8990     "url": "/api/integrations/dynamics365/accounts/{id}/configurations",
8991     "title": "Gets account configurations",
8992     "examples": [
8993       {
8994         "title": "Example usage:",
8995         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/configurations -v -u {name}:{password} -X GET",
8996         "type": "json"
8997       }
8998     ],
8999     "name": "getConfigurations",
9000     "group": "Dynamics365_Accounts",
9001     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9002     "version": "0.0.0",
9003     "filename": "server/api/intDynamics365Account/index.js",
9004     "groupTitle": "Dynamics365_Accounts"
9005   },
9006   {
9007     "type": "get",
9008     "url": "/api/integrations/dynamics365/accounts/{id}/fields",
9009     "title": "Gets account fields",
9010     "examples": [
9011       {
9012         "title": "Example usage:",
9013         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/fields -v -u {name}:{password} -X GET",
9014         "type": "json"
9015       }
9016     ],
9017     "name": "getFields",
9018     "group": "Dynamics365_Accounts",
9019     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9020     "version": "0.0.0",
9021     "filename": "server/api/intDynamics365Account/index.js",
9022     "groupTitle": "Dynamics365_Accounts"
9023   },
9024   {
9025     "type": "put",
9026     "url": "/api/integrations/dynamics365/accounts/{id}",
9027     "title": "Update an existing Dynamics365 Account",
9028     "examples": [
9029       {
9030         "title": "Example usage:",
9031         "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",
9032         "type": "json"
9033       }
9034     ],
9035     "name": "updateDynamics365_Accounts",
9036     "group": "Dynamics365_Accounts",
9037     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9038     "version": "0.0.0",
9039     "filename": "server/api/intDynamics365Account/index.js",
9040     "groupTitle": "Dynamics365_Accounts"
9041   },
9042   {
9043     "type": "post",
9044     "url": "/api/integrations/dynamics365/configurations",
9045     "title": "Creates a new Dynamics365 Configuration",
9046     "examples": [
9047       {
9048         "title": "Example usage:",
9049         "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",
9050         "type": "json"
9051       }
9052     ],
9053     "name": "CreateDynamics365_Configurations",
9054     "group": "Dynamics365_Configurations",
9055     "parameter": {
9056       "fields": {
9057         "Body": [
9058           {
9059             "group": "Body",
9060             "type": "String",
9061             "optional": true,
9062             "field": "name",
9063             "description": ""
9064           },
9065           {
9066             "group": "Body",
9067             "type": "String",
9068             "optional": true,
9069             "field": "description",
9070             "description": ""
9071           },
9072           {
9073             "group": "Body",
9074             "type": "String",
9075             "allowedValues": [
9076               "\"incident\"",
9077               "\"phonecall\""
9078             ],
9079             "optional": true,
9080             "field": "ticketType",
9081             "description": ""
9082           }
9083         ]
9084       }
9085     },
9086     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9087     "version": "0.0.0",
9088     "filename": "server/api/intDynamics365Configuration/index.js",
9089     "groupTitle": "Dynamics365_Configurations"
9090   },
9091   {
9092     "type": "delete",
9093     "url": "/api/integrations/dynamics365/configurations/{id}",
9094     "title": "Deletes a Dynamics365 Configuration",
9095     "examples": [
9096       {
9097         "title": "Example usage:",
9098         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password} -X DELETE",
9099         "type": "json"
9100       }
9101     ],
9102     "name": "DeleteDynamics365_Configurations",
9103     "group": "Dynamics365_Configurations",
9104     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9105     "version": "0.0.0",
9106     "filename": "server/api/intDynamics365Configuration/index.js",
9107     "groupTitle": "Dynamics365_Configurations"
9108   },
9109   {
9110     "type": "get",
9111     "url": "/api/integrations/dynamics365/configurations",
9112     "title": "Gets a list of Dynamics365 Configurations",
9113     "examples": [
9114       {
9115         "title": "Example usage:",
9116         "content": "curl https://{domain}/api/integrations/dynamics365/configurations -v -u {name}:{password}",
9117         "type": "json"
9118       }
9119     ],
9120     "name": "GetDynamics365_Configurations",
9121     "group": "Dynamics365_Configurations",
9122     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9123     "version": "0.0.0",
9124     "filename": "server/api/intDynamics365Configuration/index.js",
9125     "groupTitle": "Dynamics365_Configurations"
9126   },
9127   {
9128     "type": "get",
9129     "url": "/api/integrations/dynamics365/configurations/{id}",
9130     "title": "Gets a single Dynamics365 Configuration",
9131     "examples": [
9132       {
9133         "title": "Example usage:",
9134         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password}",
9135         "type": "json"
9136       }
9137     ],
9138     "name": "ShowDynamics365_Configurations",
9139     "group": "Dynamics365_Configurations",
9140     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9141     "version": "0.0.0",
9142     "filename": "server/api/intDynamics365Configuration/index.js",
9143     "groupTitle": "Dynamics365_Configurations"
9144   },
9145   {
9146     "type": "get",
9147     "url": "/api/integrations/dynamics365/configurations/{id}/descriptions",
9148     "title": "Gets configurations descriptions",
9149     "examples": [
9150       {
9151         "title": "Example usage:",
9152         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
9153         "type": "json"
9154       }
9155     ],
9156     "name": "getDescriptions",
9157     "group": "Dynamics365_Configurations",
9158     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9159     "version": "0.0.0",
9160     "filename": "server/api/intDynamics365Configuration/index.js",
9161     "groupTitle": "Dynamics365_Configurations"
9162   },
9163   {
9164     "type": "get",
9165     "url": "/api/integrations/dynamics365/configurations/{id}/fields",
9166     "title": "Gets configurations fields",
9167     "examples": [
9168       {
9169         "title": "Example usage:",
9170         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
9171         "type": "json"
9172       }
9173     ],
9174     "name": "getFields",
9175     "group": "Dynamics365_Configurations",
9176     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9177     "version": "0.0.0",
9178     "filename": "server/api/intDynamics365Configuration/index.js",
9179     "groupTitle": "Dynamics365_Configurations"
9180   },
9181   {
9182     "type": "get",
9183     "url": "/api/integrations/zoho/configurations/{id}/subjects",
9184     "title": "Gets configurations subjects",
9185     "examples": [
9186       {
9187         "title": "Example usage:",
9188         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/subjects -v -u {name}:{password} -X GET",
9189         "type": "json"
9190       }
9191     ],
9192     "name": "getSubjects",
9193     "group": "Dynamics365_Configurations",
9194     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9195     "version": "0.0.0",
9196     "filename": "server/api/intDynamics365Configuration/index.js",
9197     "groupTitle": "Dynamics365_Configurations"
9198   },
9199   {
9200     "type": "put",
9201     "url": "/api/integrations/dynamics365/configurations/{id}",
9202     "title": "Update an existing Dynamics365 Configuration",
9203     "examples": [
9204       {
9205         "title": "Example usage:",
9206         "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",
9207         "type": "json"
9208       }
9209     ],
9210     "name": "updateDynamics365_Configurations",
9211     "group": "Dynamics365_Configurations",
9212     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9213     "version": "0.0.0",
9214     "filename": "server/api/intDynamics365Configuration/index.js",
9215     "groupTitle": "Dynamics365_Configurations"
9216   },
9217   {
9218     "type": "post",
9219     "url": "/api/integrations/dynamics365/fields",
9220     "title": "Creates a new Dynamics365 Field",
9221     "examples": [
9222       {
9223         "title": "Example usage:",
9224         "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",
9225         "type": "json"
9226       }
9227     ],
9228     "name": "CreateDynamics365_Fields",
9229     "group": "Dynamics365_Fields",
9230     "parameter": {
9231       "fields": {
9232         "Body": [
9233           {
9234             "group": "Body",
9235             "type": "String",
9236             "allowedValues": [
9237               "\"string\"",
9238               "\"variable\"",
9239               "\"customVariable\"",
9240               "\"keyValue\"",
9241               "\"picklist\""
9242             ],
9243             "optional": true,
9244             "field": "type",
9245             "description": ""
9246           },
9247           {
9248             "group": "Body",
9249             "type": "String",
9250             "optional": true,
9251             "field": "content",
9252             "description": ""
9253           },
9254           {
9255             "group": "Body",
9256             "type": "String",
9257             "optional": true,
9258             "field": "key",
9259             "description": ""
9260           },
9261           {
9262             "group": "Body",
9263             "type": "String",
9264             "allowedValues": [
9265               "\"string\"",
9266               "\"variable\"",
9267               "\"customVariable\""
9268             ],
9269             "optional": true,
9270             "field": "keyType",
9271             "description": ""
9272           },
9273           {
9274             "group": "Body",
9275             "type": "String",
9276             "optional": true,
9277             "field": "keyContent",
9278             "description": ""
9279           },
9280           {
9281             "group": "Body",
9282             "type": "String",
9283             "optional": true,
9284             "field": "idField",
9285             "description": ""
9286           },
9287           {
9288             "group": "Body",
9289             "type": "String",
9290             "optional": true,
9291             "field": "nameField",
9292             "description": ""
9293           },
9294           {
9295             "group": "Body",
9296             "type": "Boolean",
9297             "optional": true,
9298             "field": "customField",
9299             "description": ""
9300           },
9301           {
9302             "group": "Body",
9303             "type": "String",
9304             "optional": true,
9305             "field": "variableName",
9306             "description": ""
9307           }
9308         ]
9309       }
9310     },
9311     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9312     "version": "0.0.0",
9313     "filename": "server/api/intDynamics365Field/index.js",
9314     "groupTitle": "Dynamics365_Fields"
9315   },
9316   {
9317     "type": "delete",
9318     "url": "/api/integrations/dynamics365/fields/{id}",
9319     "title": "Deletes a Dynamics365 Field",
9320     "examples": [
9321       {
9322         "title": "Example usage:",
9323         "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password} -X DELETE",
9324         "type": "json"
9325       }
9326     ],
9327     "name": "DeleteDynamics365_Fields",
9328     "group": "Dynamics365_Fields",
9329     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9330     "version": "0.0.0",
9331     "filename": "server/api/intDynamics365Field/index.js",
9332     "groupTitle": "Dynamics365_Fields"
9333   },
9334   {
9335     "type": "get",
9336     "url": "/api/integrations/dynamics365/fields",
9337     "title": "Gets a list of Dynamics365 Fields",
9338     "examples": [
9339       {
9340         "title": "Example usage:",
9341         "content": "curl https://{domain}/api/integrations/dynamics365/fields -v -u {name}:{password}",
9342         "type": "json"
9343       }
9344     ],
9345     "name": "GetDynamics365_Fields",
9346     "group": "Dynamics365_Fields",
9347     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9348     "version": "0.0.0",
9349     "filename": "server/api/intDynamics365Field/index.js",
9350     "groupTitle": "Dynamics365_Fields"
9351   },
9352   {
9353     "type": "get",
9354     "url": "/api/integrations/dynamics365/fields/{id}",
9355     "title": "Gets a single Dynamics365 Field",
9356     "examples": [
9357       {
9358         "title": "Example usage:",
9359         "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password}",
9360         "type": "json"
9361       }
9362     ],
9363     "name": "ShowDynamics365_Fields",
9364     "group": "Dynamics365_Fields",
9365     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9366     "version": "0.0.0",
9367     "filename": "server/api/intDynamics365Field/index.js",
9368     "groupTitle": "Dynamics365_Fields"
9369   },
9370   {
9371     "type": "put",
9372     "url": "/api/integrations/dynamics365/fields/{id}",
9373     "title": "Update an existing Dynamics365 Field",
9374     "examples": [
9375       {
9376         "title": "Example usage:",
9377         "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",
9378         "type": "json"
9379       }
9380     ],
9381     "name": "updateDynamics365_Fields",
9382     "group": "Dynamics365_Fields",
9383     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9384     "version": "0.0.0",
9385     "filename": "server/api/intDynamics365Field/index.js",
9386     "groupTitle": "Dynamics365_Fields"
9387   },
9388   {
9389     "type": "post",
9390     "url": "/api/fax/accounts/{id}/users",
9391     "title": "Add agents to a fax account",
9392     "examples": [
9393       {
9394         "title": "Example usage:",
9395         "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",
9396         "type": "json"
9397       }
9398     ],
9399     "name": "AddAgents",
9400     "group": "Fax_Accounts",
9401     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9402     "version": "0.0.0",
9403     "filename": "server/api/faxAccount/index.js",
9404     "groupTitle": "Fax_Accounts"
9405   },
9406   {
9407     "type": "post",
9408     "url": "/api/fax/accounts",
9409     "title": "Creates a new Account",
9410     "examples": [
9411       {
9412         "title": "Example usage:",
9413         "content": "curl https://{domain}/api/fax/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
9414         "type": "json"
9415       }
9416     ],
9417     "name": "CreateAccounts",
9418     "group": "Fax_Accounts",
9419     "parameter": {
9420       "fields": {
9421         "Body": [
9422           {
9423             "group": "Body",
9424             "type": "String",
9425             "optional": false,
9426             "field": "name",
9427             "description": ""
9428           },
9429           {
9430             "group": "Body",
9431             "type": "String",
9432             "optional": true,
9433             "field": "description",
9434             "description": ""
9435           },
9436           {
9437             "group": "Body",
9438             "type": "String",
9439             "allowedValues": [
9440               "\"yes\"",
9441               "\"no\""
9442             ],
9443             "optional": true,
9444             "field": "ecm",
9445             "description": ""
9446           },
9447           {
9448             "group": "Body",
9449             "type": "String",
9450             "optional": true,
9451             "field": "headerinfo",
9452             "description": ""
9453           },
9454           {
9455             "group": "Body",
9456             "type": "String",
9457             "optional": true,
9458             "field": "localstationid",
9459             "description": ""
9460           },
9461           {
9462             "group": "Body",
9463             "type": "String",
9464             "allowedValues": [
9465               "\"2400\"",
9466               "\"4800\"",
9467               "\"7200\"",
9468               "\"9600\"",
9469               "\"12000\"",
9470               "\"14400\""
9471             ],
9472             "optional": true,
9473             "field": "minrate",
9474             "description": ""
9475           },
9476           {
9477             "group": "Body",
9478             "type": "String",
9479             "allowedValues": [
9480               "\"2400\"",
9481               "\"4800\"",
9482               "\"7200\"",
9483               "\"9600\"",
9484               "\"12000\"",
9485               "\"14400\""
9486             ],
9487             "optional": true,
9488             "field": "maxrate",
9489             "description": ""
9490           },
9491           {
9492             "group": "Body",
9493             "type": "String",
9494             "optional": true,
9495             "field": "modem",
9496             "description": ""
9497           },
9498           {
9499             "group": "Body",
9500             "type": "String",
9501             "optional": true,
9502             "field": "gateway",
9503             "description": ""
9504           },
9505           {
9506             "group": "Body",
9507             "type": "String",
9508             "optional": true,
9509             "field": "faxdetect",
9510             "description": ""
9511           },
9512           {
9513             "group": "Body",
9514             "type": "Integer",
9515             "optional": true,
9516             "field": "t38timeout",
9517             "description": ""
9518           },
9519           {
9520             "group": "Body",
9521             "type": "String",
9522             "allowedValues": [
9523               "\"SIP\"",
9524               "\"IAX\"",
9525               "\"DADHI\"",
9526               "\"KHOMP\""
9527             ],
9528             "optional": true,
9529             "field": "tech",
9530             "description": ""
9531           },
9532           {
9533             "group": "Body",
9534             "type": "String",
9535             "optional": false,
9536             "field": "key",
9537             "description": ""
9538           },
9539           {
9540             "group": "Body",
9541             "type": "Text",
9542             "optional": true,
9543             "field": "notificationTemplate",
9544             "description": ""
9545           },
9546           {
9547             "group": "Body",
9548             "type": "Boolean",
9549             "optional": true,
9550             "field": "notificationSound",
9551             "description": ""
9552           },
9553           {
9554             "group": "Body",
9555             "type": "Boolean",
9556             "optional": true,
9557             "field": "notificationShake",
9558             "description": ""
9559           },
9560           {
9561             "group": "Body",
9562             "type": "Integer",
9563             "optional": true,
9564             "field": "waitForTheAssignedAgent",
9565             "description": ""
9566           },
9567           {
9568             "group": "Body",
9569             "type": "Boolean",
9570             "optional": true,
9571             "field": "queueTransfer",
9572             "description": ""
9573           },
9574           {
9575             "group": "Body",
9576             "type": "Integer",
9577             "optional": true,
9578             "field": "queueTransferTimeout",
9579             "description": ""
9580           },
9581           {
9582             "group": "Body",
9583             "type": "Boolean",
9584             "optional": true,
9585             "field": "agentTransfer",
9586             "description": ""
9587           },
9588           {
9589             "group": "Body",
9590             "type": "Integer",
9591             "optional": true,
9592             "field": "agentTransferTimeout",
9593             "description": ""
9594           },
9595           {
9596             "group": "Body",
9597             "type": "Integer",
9598             "optional": true,
9599             "field": "mandatoryDispositionPauseId",
9600             "description": "<p>Status to put when mandatory disposition is enabled</p>"
9601           },
9602           {
9603             "group": "Body",
9604             "type": "Boolean",
9605             "optional": true,
9606             "field": "mandatoryDisposition",
9607             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
9608           }
9609         ]
9610       }
9611     },
9612     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9613     "version": "0.0.0",
9614     "filename": "server/api/faxAccount/index.js",
9615     "groupTitle": "Fax_Accounts"
9616   },
9617   {
9618     "type": "delete",
9619     "url": "/api/fax/accounts/{id}",
9620     "title": "Deletes a Account",
9621     "examples": [
9622       {
9623         "title": "Example usage:",
9624         "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password} -X DELETE",
9625         "type": "json"
9626       }
9627     ],
9628     "name": "DeleteAccounts",
9629     "group": "Fax_Accounts",
9630     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9631     "version": "0.0.0",
9632     "filename": "server/api/faxAccount/index.js",
9633     "groupTitle": "Fax_Accounts"
9634   },
9635   {
9636     "type": "get",
9637     "url": "/api/fax/accounts/describe",
9638     "title": "Gets table info about Accounts",
9639     "examples": [
9640       {
9641         "title": "Example usage:",
9642         "content": "curl https://{domain}/api/fax/accounts/describe -v -u {name}:{password}",
9643         "type": "json"
9644       }
9645     ],
9646     "name": "DescribeAccounts",
9647     "group": "Fax_Accounts",
9648     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9649     "version": "0.0.0",
9650     "filename": "server/api/faxAccount/index.js",
9651     "groupTitle": "Fax_Accounts"
9652   },
9653   {
9654     "type": "get",
9655     "url": "/api/fax/accounts",
9656     "title": "Gets a list of Accounts",
9657     "examples": [
9658       {
9659         "title": "Example usage:",
9660         "content": "curl https://{domain}/api/fax/accounts -v -u {name}:{password}",
9661         "type": "json"
9662       }
9663     ],
9664     "name": "GetAccounts",
9665     "group": "Fax_Accounts",
9666     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9667     "version": "0.0.0",
9668     "filename": "server/api/faxAccount/index.js",
9669     "groupTitle": "Fax_Accounts"
9670   },
9671   {
9672     "type": "get",
9673     "url": "/api/fax/accounts/{id}/users",
9674     "title": "Gets agents from fax account",
9675     "examples": [
9676       {
9677         "title": "Example usage:",
9678         "content": "curl https://{domain}/api/fax/accounts/{id}/users -v -u {name}:{password} -X GET",
9679         "type": "json"
9680       }
9681     ],
9682     "name": "GetAgents",
9683     "group": "Fax_Accounts",
9684     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9685     "version": "0.0.0",
9686     "filename": "server/api/faxAccount/index.js",
9687     "groupTitle": "Fax_Accounts"
9688   },
9689   {
9690     "type": "delete",
9691     "url": "/api/fax/accounts/{id}/users",
9692     "title": "Removes agents from a fax account",
9693     "examples": [
9694       {
9695         "title": "Example usage:",
9696         "content": "curl https://{domain}/api/fax/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9697         "type": "json"
9698       }
9699     ],
9700     "name": "RemoveAgents",
9701     "group": "Fax_Accounts",
9702     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9703     "version": "0.0.0",
9704     "filename": "server/api/faxAccount/index.js",
9705     "groupTitle": "Fax_Accounts"
9706   },
9707   {
9708     "type": "delete",
9709     "url": "/api/fax/accounts/{id}/canned_answers",
9710     "title": "Removes canned answers from account",
9711     "examples": [
9712       {
9713         "title": "Example usage:",
9714         "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9715         "type": "json"
9716       }
9717     ],
9718     "name": "RemoveAnswers",
9719     "group": "Fax_Accounts",
9720     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9721     "version": "0.0.0",
9722     "filename": "server/api/faxAccount/index.js",
9723     "groupTitle": "Fax_Accounts"
9724   },
9725   {
9726     "type": "delete",
9727     "url": "/api/fax/accounts/{id}/dispositions",
9728     "title": "Removes dispositions from account",
9729     "examples": [
9730       {
9731         "title": "Example usage:",
9732         "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9733         "type": "json"
9734       }
9735     ],
9736     "name": "RemoveDispositions",
9737     "group": "Fax_Accounts",
9738     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9739     "version": "0.0.0",
9740     "filename": "server/api/faxAccount/index.js",
9741     "groupTitle": "Fax_Accounts"
9742   },
9743   {
9744     "type": "get",
9745     "url": "/api/fax/accounts/{id}",
9746     "title": "Gets a single Account",
9747     "examples": [
9748       {
9749         "title": "Example usage:",
9750         "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password}",
9751         "type": "json"
9752       }
9753     ],
9754     "name": "ShowAccounts",
9755     "group": "Fax_Accounts",
9756     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9757     "version": "0.0.0",
9758     "filename": "server/api/faxAccount/index.js",
9759     "groupTitle": "Fax_Accounts"
9760   },
9761   {
9762     "type": "post",
9763     "url": "/api/fax/accounts/{id}/canned_answers",
9764     "title": "Creates new canned answer",
9765     "examples": [
9766       {
9767         "title": "Example usage:",
9768         "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",
9769         "type": "json"
9770       }
9771     ],
9772     "name": "addAnswer",
9773     "group": "Fax_Accounts",
9774     "parameter": {
9775       "fields": {
9776         "Body": [
9777           {
9778             "group": "Body",
9779             "type": "String",
9780             "optional": false,
9781             "field": "key",
9782             "description": ""
9783           },
9784           {
9785             "group": "Body",
9786             "type": "Text",
9787             "optional": false,
9788             "field": "value",
9789             "description": ""
9790           },
9791           {
9792             "group": "Body",
9793             "type": "String",
9794             "optional": true,
9795             "field": "description",
9796             "description": ""
9797           },
9798           {
9799             "group": "Body",
9800             "type": "Virtual",
9801             "optional": true,
9802             "field": "name",
9803             "description": ""
9804           }
9805         ]
9806       }
9807     },
9808     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9809     "version": "0.0.0",
9810     "filename": "server/api/faxAccount/index.js",
9811     "groupTitle": "Fax_Accounts"
9812   },
9813   {
9814     "type": "post",
9815     "url": "/api/fax/accounts/{id}/applications",
9816     "title": "Creates new applications",
9817     "examples": [
9818       {
9819         "title": "Example usage:",
9820         "content": "curl https://{domain}/api/fax/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9821         "type": "json"
9822       }
9823     ],
9824     "name": "addApplications",
9825     "group": "Fax_Accounts",
9826     "parameter": {
9827       "fields": {
9828         "Body": [
9829           {
9830             "group": "Body",
9831             "type": "Integer",
9832             "optional": false,
9833             "field": "priority",
9834             "description": ""
9835           },
9836           {
9837             "group": "Body",
9838             "type": "String",
9839             "optional": false,
9840             "field": "app",
9841             "description": ""
9842           },
9843           {
9844             "group": "Body",
9845             "type": "Text",
9846             "optional": true,
9847             "field": "appdata",
9848             "description": ""
9849           },
9850           {
9851             "group": "Body",
9852             "type": "String",
9853             "optional": true,
9854             "field": "description",
9855             "description": ""
9856           },
9857           {
9858             "group": "Body",
9859             "type": "String",
9860             "optional": true,
9861             "field": "interval",
9862             "description": ""
9863           }
9864         ]
9865       }
9866     },
9867     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9868     "version": "0.0.0",
9869     "filename": "server/api/faxAccount/index.js",
9870     "groupTitle": "Fax_Accounts"
9871   },
9872   {
9873     "type": "post",
9874     "url": "/api/fax/accounts/addaccountapplications",
9875     "title": "Creates new account and applications",
9876     "examples": [
9877       {
9878         "title": "Example usage:",
9879         "content": "curl https://{domain}/api/fax/accounts/addaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9880         "type": "json"
9881       }
9882     ],
9883     "name": "addApplications",
9884     "group": "Fax_Accounts",
9885     "parameter": {
9886       "fields": {
9887         "Body": [
9888           {
9889             "group": "Body",
9890             "type": "Integer",
9891             "optional": false,
9892             "field": "priority",
9893             "description": ""
9894           },
9895           {
9896             "group": "Body",
9897             "type": "String",
9898             "optional": false,
9899             "field": "app",
9900             "description": ""
9901           },
9902           {
9903             "group": "Body",
9904             "type": "Text",
9905             "optional": true,
9906             "field": "appdata",
9907             "description": ""
9908           },
9909           {
9910             "group": "Body",
9911             "type": "String",
9912             "optional": true,
9913             "field": "description",
9914             "description": ""
9915           },
9916           {
9917             "group": "Body",
9918             "type": "String",
9919             "optional": true,
9920             "field": "interval",
9921             "description": ""
9922           }
9923         ]
9924       }
9925     },
9926     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9927     "version": "0.0.0",
9928     "filename": "server/api/faxAccount/index.js",
9929     "groupTitle": "Fax_Accounts"
9930   },
9931   {
9932     "type": "post",
9933     "url": "/api/fax/accounts/{id}/dispositions",
9934     "title": "Creates new disposition",
9935     "examples": [
9936       {
9937         "title": "Example usage:",
9938         "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9939         "type": "json"
9940       }
9941     ],
9942     "name": "addDisposition",
9943     "group": "Fax_Accounts",
9944     "parameter": {
9945       "fields": {
9946         "Body": [
9947           {
9948             "group": "Body",
9949             "type": "String",
9950             "optional": false,
9951             "field": "name",
9952             "description": ""
9953           },
9954           {
9955             "group": "Body",
9956             "type": "String",
9957             "allowedValues": [
9958               "\"first\"",
9959               "\"second\"",
9960               "\"third\""
9961             ],
9962             "optional": false,
9963             "field": "level",
9964             "description": ""
9965           },
9966           {
9967             "group": "Body",
9968             "type": "String",
9969             "optional": true,
9970             "field": "description",
9971             "description": ""
9972           }
9973         ]
9974       }
9975     },
9976     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9977     "version": "0.0.0",
9978     "filename": "server/api/faxAccount/index.js",
9979     "groupTitle": "Fax_Accounts"
9980   },
9981   {
9982     "type": "post",
9983     "url": "/api/fax/accounts/{id}/interactions",
9984     "title": "Creates new interactions",
9985     "examples": [
9986       {
9987         "title": "Example usage:",
9988         "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",
9989         "type": "json"
9990       }
9991     ],
9992     "name": "addInteraction",
9993     "group": "Fax_Accounts",
9994     "parameter": {
9995       "fields": {
9996         "Body": [
9997           {
9998             "group": "Body",
9999             "type": "Boolean",
10000             "optional": true,
10001             "field": "closed",
10002             "description": ""
10003           },
10004           {
10005             "group": "Body",
10006             "type": "String",
10007             "optional": true,
10008             "field": "closedAt",
10009             "description": ""
10010           },
10011           {
10012             "group": "Body",
10013             "type": "String",
10014             "optional": true,
10015             "field": "disposition",
10016             "description": ""
10017           },
10018           {
10019             "group": "Body",
10020             "type": "String",
10021             "optional": true,
10022             "field": "secondDisposition",
10023             "description": ""
10024           },
10025           {
10026             "group": "Body",
10027             "type": "String",
10028             "optional": true,
10029             "field": "thirdDisposition",
10030             "description": ""
10031           },
10032           {
10033             "group": "Body",
10034             "type": "String",
10035             "optional": true,
10036             "field": "note",
10037             "description": ""
10038           },
10039           {
10040             "group": "Body",
10041             "type": "String",
10042             "optional": true,
10043             "field": "read1stAt",
10044             "description": ""
10045           },
10046           {
10047             "group": "Body",
10048             "type": "String",
10049             "optional": true,
10050             "field": "fax",
10051             "description": ""
10052           },
10053           {
10054             "group": "Body",
10055             "type": "String",
10056             "allowedValues": [
10057               "\"in\"",
10058               "\"out\""
10059             ],
10060             "optional": false,
10061             "field": "firstMsgDirection",
10062             "description": ""
10063           },
10064           {
10065             "group": "Body",
10066             "type": "String",
10067             "optional": true,
10068             "field": "lastMsgAt",
10069             "description": ""
10070           },
10071           {
10072             "group": "Body",
10073             "type": "String",
10074             "allowedValues": [
10075               "\"in\"",
10076               "\"out\""
10077             ],
10078             "optional": false,
10079             "field": "lastMsgDirection",
10080             "description": ""
10081           }
10082         ]
10083       }
10084     },
10085     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10086     "version": "0.0.0",
10087     "filename": "server/api/faxAccount/index.js",
10088     "groupTitle": "Fax_Accounts"
10089   },
10090   {
10091     "type": "get",
10092     "url": "/api/fax/accounts/{id}/canned_answers",
10093     "title": "Gets account canned answers",
10094     "examples": [
10095       {
10096         "title": "Example usage:",
10097         "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
10098         "type": "json"
10099       }
10100     ],
10101     "name": "getAnswers",
10102     "group": "Fax_Accounts",
10103     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10104     "version": "0.0.0",
10105     "filename": "server/api/faxAccount/index.js",
10106     "groupTitle": "Fax_Accounts"
10107   },
10108   {
10109     "type": "get",
10110     "url": "/api/fax/accounts/{id}/applications",
10111     "title": "Gets account pplications",
10112     "examples": [
10113       {
10114         "title": "Example usage:",
10115         "content": "curl https://{domain}/api/fax/accounts/{id}/applications -v -u {name}:{password} -X GET",
10116         "type": "json"
10117       }
10118     ],
10119     "name": "getApplications",
10120     "group": "Fax_Accounts",
10121     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10122     "version": "0.0.0",
10123     "filename": "server/api/faxAccount/index.js",
10124     "groupTitle": "Fax_Accounts"
10125   },
10126   {
10127     "type": "get",
10128     "url": "/api/fax/accounts/{id}/dispositions",
10129     "title": "Gets account dispositions",
10130     "examples": [
10131       {
10132         "title": "Example usage:",
10133         "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
10134         "type": "json"
10135       }
10136     ],
10137     "name": "getDispositions",
10138     "group": "Fax_Accounts",
10139     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10140     "version": "0.0.0",
10141     "filename": "server/api/faxAccount/index.js",
10142     "groupTitle": "Fax_Accounts"
10143   },
10144   {
10145     "type": "get",
10146     "url": "/api/fax/accounts/{id}/interactions",
10147     "title": "Gets account interactions",
10148     "examples": [
10149       {
10150         "title": "Example usage:",
10151         "content": "curl https://{domain}/api/fax/accounts/{id}/interactions -v -u {name}:{password} -X GET",
10152         "type": "json"
10153       }
10154     ],
10155     "name": "getInteraction",
10156     "group": "Fax_Accounts",
10157     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10158     "version": "0.0.0",
10159     "filename": "server/api/faxAccount/index.js",
10160     "groupTitle": "Fax_Accounts"
10161   },
10162   {
10163     "type": "get",
10164     "url": "/api/fax/accounts/{id}/messages",
10165     "title": "Gets account messages",
10166     "examples": [
10167       {
10168         "title": "Example usage:",
10169         "content": "curl https://{domain}/api/fax/accounts/{id}/messages -v -u {name}:{password} -X GET",
10170         "type": "json"
10171       }
10172     ],
10173     "name": "getMessages",
10174     "group": "Fax_Accounts",
10175     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10176     "version": "0.0.0",
10177     "filename": "server/api/faxAccount/index.js",
10178     "groupTitle": "Fax_Accounts"
10179   },
10180   {
10181     "type": "post",
10182     "url": "/api/fax/accounts/{id}/send",
10183     "title": "Send new fax",
10184     "examples": [
10185       {
10186         "title": "Example usage:",
10187         "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",
10188         "type": "json"
10189       }
10190     ],
10191     "name": "sendFax",
10192     "group": "Fax_Accounts",
10193     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10194     "version": "0.0.0",
10195     "filename": "server/api/faxAccount/index.js",
10196     "groupTitle": "Fax_Accounts"
10197   },
10198   {
10199     "type": "put",
10200     "url": "/api/fax/accounts/{id}",
10201     "title": "Update an existing Account",
10202     "examples": [
10203       {
10204         "title": "Example usage:",
10205         "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",
10206         "type": "json"
10207       }
10208     ],
10209     "name": "updateAccounts",
10210     "group": "Fax_Accounts",
10211     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10212     "version": "0.0.0",
10213     "filename": "server/api/faxAccount/index.js",
10214     "groupTitle": "Fax_Accounts"
10215   },
10216   {
10217     "type": "post",
10218     "url": "/api/fax/accounts/updateaccountapplications",
10219     "title": "Update account and applications",
10220     "examples": [
10221       {
10222         "title": "Example usage:",
10223         "content": "curl https://{domain}/api/fax/accounts/updateaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10224         "type": "json"
10225       }
10226     ],
10227     "name": "updateApplications",
10228     "group": "Fax_Accounts",
10229     "parameter": {
10230       "fields": {
10231         "Body": [
10232           {
10233             "group": "Body",
10234             "type": "Integer",
10235             "optional": false,
10236             "field": "priority",
10237             "description": ""
10238           },
10239           {
10240             "group": "Body",
10241             "type": "String",
10242             "optional": false,
10243             "field": "app",
10244             "description": ""
10245           },
10246           {
10247             "group": "Body",
10248             "type": "Text",
10249             "optional": true,
10250             "field": "appdata",
10251             "description": ""
10252           },
10253           {
10254             "group": "Body",
10255             "type": "String",
10256             "optional": true,
10257             "field": "description",
10258             "description": ""
10259           },
10260           {
10261             "group": "Body",
10262             "type": "String",
10263             "optional": true,
10264             "field": "interval",
10265             "description": ""
10266           }
10267         ]
10268       }
10269     },
10270     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10271     "version": "0.0.0",
10272     "filename": "server/api/faxAccount/index.js",
10273     "groupTitle": "Fax_Accounts"
10274   },
10275   {
10276     "type": "post",
10277     "url": "/api/fax/applications",
10278     "title": "Creates a new Application",
10279     "examples": [
10280       {
10281         "title": "Example usage:",
10282         "content": "curl https://{domain}/api/fax/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
10283         "type": "json"
10284       }
10285     ],
10286     "name": "CreateApplications",
10287     "group": "Fax_Applications",
10288     "parameter": {
10289       "fields": {
10290         "Body": [
10291           {
10292             "group": "Body",
10293             "type": "Integer",
10294             "optional": false,
10295             "field": "priority",
10296             "description": ""
10297           },
10298           {
10299             "group": "Body",
10300             "type": "String",
10301             "optional": false,
10302             "field": "app",
10303             "description": ""
10304           },
10305           {
10306             "group": "Body",
10307             "type": "Text",
10308             "optional": true,
10309             "field": "appdata",
10310             "description": ""
10311           },
10312           {
10313             "group": "Body",
10314             "type": "String",
10315             "optional": true,
10316             "field": "description",
10317             "description": ""
10318           },
10319           {
10320             "group": "Body",
10321             "type": "String",
10322             "optional": true,
10323             "field": "interval",
10324             "description": ""
10325           }
10326         ]
10327       }
10328     },
10329     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10330     "version": "0.0.0",
10331     "filename": "server/api/faxApplication/index.js",
10332     "groupTitle": "Fax_Applications"
10333   },
10334   {
10335     "type": "delete",
10336     "url": "/api/fax/applications/{id}",
10337     "title": "Deletes a Application",
10338     "examples": [
10339       {
10340         "title": "Example usage:",
10341         "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password} -X DELETE",
10342         "type": "json"
10343       }
10344     ],
10345     "name": "DeleteApplications",
10346     "group": "Fax_Applications",
10347     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10348     "version": "0.0.0",
10349     "filename": "server/api/faxApplication/index.js",
10350     "groupTitle": "Fax_Applications"
10351   },
10352   {
10353     "type": "get",
10354     "url": "/api/fax/applications",
10355     "title": "Gets a list of Applications",
10356     "examples": [
10357       {
10358         "title": "Example usage:",
10359         "content": "curl https://{domain}/api/fax/applications -v -u {name}:{password}",
10360         "type": "json"
10361       }
10362     ],
10363     "name": "GetApplications",
10364     "group": "Fax_Applications",
10365     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10366     "version": "0.0.0",
10367     "filename": "server/api/faxApplication/index.js",
10368     "groupTitle": "Fax_Applications"
10369   },
10370   {
10371     "type": "get",
10372     "url": "/api/fax/applications/{id}",
10373     "title": "Gets a single Application",
10374     "examples": [
10375       {
10376         "title": "Example usage:",
10377         "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password}",
10378         "type": "json"
10379       }
10380     ],
10381     "name": "ShowApplications",
10382     "group": "Fax_Applications",
10383     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10384     "version": "0.0.0",
10385     "filename": "server/api/faxApplication/index.js",
10386     "groupTitle": "Fax_Applications"
10387   },
10388   {
10389     "type": "put",
10390     "url": "/api/fax/applications/{id}",
10391     "title": "Update an existing Application",
10392     "examples": [
10393       {
10394         "title": "Example usage:",
10395         "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",
10396         "type": "json"
10397       }
10398     ],
10399     "name": "updateApplications",
10400     "group": "Fax_Applications",
10401     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10402     "version": "0.0.0",
10403     "filename": "server/api/faxApplication/index.js",
10404     "groupTitle": "Fax_Applications"
10405   },
10406   {
10407     "type": "post",
10408     "url": "/api/fax/interactions/{id}/tags",
10409     "title": "Add tags to the interaction",
10410     "examples": [
10411       {
10412         "title": "Example usage:",
10413         "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",
10414         "type": "json"
10415       }
10416     ],
10417     "name": "AddTags",
10418     "group": "Fax_Interactions",
10419     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10420     "version": "0.0.0",
10421     "filename": "server/api/faxInteraction/index.js",
10422     "groupTitle": "Fax_Interactions"
10423   },
10424   {
10425     "type": "post",
10426     "url": "/api/fax/interactions",
10427     "title": "Creates a new Interaction",
10428     "examples": [
10429       {
10430         "title": "Example usage:",
10431         "content": "curl https://{domain}/api/fax/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
10432         "type": "json"
10433       }
10434     ],
10435     "name": "CreateInteractions",
10436     "group": "Fax_Interactions",
10437     "parameter": {
10438       "fields": {
10439         "Body": [
10440           {
10441             "group": "Body",
10442             "type": "Boolean",
10443             "optional": true,
10444             "field": "closed",
10445             "description": ""
10446           },
10447           {
10448             "group": "Body",
10449             "type": "String",
10450             "optional": true,
10451             "field": "closedAt",
10452             "description": ""
10453           },
10454           {
10455             "group": "Body",
10456             "type": "String",
10457             "optional": true,
10458             "field": "disposition",
10459             "description": ""
10460           },
10461           {
10462             "group": "Body",
10463             "type": "String",
10464             "optional": true,
10465             "field": "secondDisposition",
10466             "description": ""
10467           },
10468           {
10469             "group": "Body",
10470             "type": "String",
10471             "optional": true,
10472             "field": "thirdDisposition",
10473             "description": ""
10474           },
10475           {
10476             "group": "Body",
10477             "type": "String",
10478             "optional": true,
10479             "field": "note",
10480             "description": ""
10481           },
10482           {
10483             "group": "Body",
10484             "type": "String",
10485             "optional": true,
10486             "field": "read1stAt",
10487             "description": ""
10488           },
10489           {
10490             "group": "Body",
10491             "type": "String",
10492             "optional": true,
10493             "field": "fax",
10494             "description": ""
10495           },
10496           {
10497             "group": "Body",
10498             "type": "String",
10499             "allowedValues": [
10500               "\"in\"",
10501               "\"out\""
10502             ],
10503             "optional": false,
10504             "field": "firstMsgDirection",
10505             "description": ""
10506           },
10507           {
10508             "group": "Body",
10509             "type": "String",
10510             "optional": true,
10511             "field": "lastMsgAt",
10512             "description": ""
10513           },
10514           {
10515             "group": "Body",
10516             "type": "String",
10517             "allowedValues": [
10518               "\"in\"",
10519               "\"out\""
10520             ],
10521             "optional": false,
10522             "field": "lastMsgDirection",
10523             "description": ""
10524           }
10525         ]
10526       }
10527     },
10528     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10529     "version": "0.0.0",
10530     "filename": "server/api/faxInteraction/index.js",
10531     "groupTitle": "Fax_Interactions"
10532   },
10533   {
10534     "type": "delete",
10535     "url": "/api/fax/interactions/{id}",
10536     "title": "Deletes a Interaction",
10537     "examples": [
10538       {
10539         "title": "Example usage:",
10540         "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password} -X DELETE",
10541         "type": "json"
10542       }
10543     ],
10544     "name": "DeleteInteractions",
10545     "group": "Fax_Interactions",
10546     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10547     "version": "0.0.0",
10548     "filename": "server/api/faxInteraction/index.js",
10549     "groupTitle": "Fax_Interactions"
10550   },
10551   {
10552     "type": "get",
10553     "url": "/api/fax/interactions/describe",
10554     "title": "Gets table info about Interactions",
10555     "examples": [
10556       {
10557         "title": "Example usage:",
10558         "content": "curl https://{domain}/api/fax/interactions/describe -v -u {name}:{password}",
10559         "type": "json"
10560       }
10561     ],
10562     "name": "DescribeInteractions",
10563     "group": "Fax_Interactions",
10564     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10565     "version": "0.0.0",
10566     "filename": "server/api/faxInteraction/index.js",
10567     "groupTitle": "Fax_Interactions"
10568   },
10569   {
10570     "type": "get",
10571     "url": "/api/fax/interactions",
10572     "title": "Gets a list of Interactions",
10573     "examples": [
10574       {
10575         "title": "Example usage:",
10576         "content": "curl https://{domain}/api/fax/interactions -v -u {name}:{password}",
10577         "type": "json"
10578       }
10579     ],
10580     "name": "GetInteractions",
10581     "group": "Fax_Interactions",
10582     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10583     "version": "0.0.0",
10584     "filename": "server/api/faxInteraction/index.js",
10585     "groupTitle": "Fax_Interactions"
10586   },
10587   {
10588     "type": "delete",
10589     "url": "/api/fax/interactions/{id}/tags",
10590     "title": "Removes tags from interaction",
10591     "examples": [
10592       {
10593         "title": "Example usage:",
10594         "content": "curl https://{domain}/api/fax/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
10595         "type": "json"
10596       }
10597     ],
10598     "name": "RemoveTags",
10599     "group": "Fax_Interactions",
10600     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10601     "version": "0.0.0",
10602     "filename": "server/api/faxInteraction/index.js",
10603     "groupTitle": "Fax_Interactions"
10604   },
10605   {
10606     "type": "get",
10607     "url": "/api/fax/interactions/{id}",
10608     "title": "Gets a single Interaction",
10609     "examples": [
10610       {
10611         "title": "Example usage:",
10612         "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password}",
10613         "type": "json"
10614       }
10615     ],
10616     "name": "ShowInteractions",
10617     "group": "Fax_Interactions",
10618     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10619     "version": "0.0.0",
10620     "filename": "server/api/faxInteraction/index.js",
10621     "groupTitle": "Fax_Interactions"
10622   },
10623   {
10624     "type": "post",
10625     "url": "/api/fax/interactions/{id}/messages",
10626     "title": "Creates new messages",
10627     "examples": [
10628       {
10629         "title": "Example usage:",
10630         "content": "curl https://{domain}/api/fax/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10631         "type": "json"
10632       }
10633     ],
10634     "name": "addMessage",
10635     "group": "Fax_Interactions",
10636     "parameter": {
10637       "fields": {
10638         "Body": [
10639           {
10640             "group": "Body",
10641             "type": "Text",
10642             "optional": false,
10643             "field": "body",
10644             "description": ""
10645           },
10646           {
10647             "group": "Body",
10648             "type": "Boolean",
10649             "optional": true,
10650             "field": "read",
10651             "description": ""
10652           },
10653           {
10654             "group": "Body",
10655             "type": "String",
10656             "allowedValues": [
10657               "\"in\"",
10658               "\"out\""
10659             ],
10660             "optional": false,
10661             "field": "direction",
10662             "description": ""
10663           },
10664           {
10665             "group": "Body",
10666             "type": "Text",
10667             "optional": true,
10668             "field": "failMessage",
10669             "description": ""
10670           },
10671           {
10672             "group": "Body",
10673             "type": "String",
10674             "optional": true,
10675             "field": "readAt",
10676             "description": ""
10677           }
10678         ]
10679       }
10680     },
10681     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10682     "version": "0.0.0",
10683     "filename": "server/api/faxInteraction/index.js",
10684     "groupTitle": "Fax_Interactions"
10685   },
10686   {
10687     "type": "get",
10688     "url": "/api/fax/interactions/{id}/download",
10689     "title": "Get interactions",
10690     "examples": [
10691       {
10692         "title": "Example usage:",
10693         "content": "curl https://{domain}/api/fax/interactions/{id}/download -v -u {name}:{password} -X GET",
10694         "type": "json"
10695       }
10696     ],
10697     "name": "download",
10698     "group": "Fax_Interactions",
10699     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10700     "version": "0.0.0",
10701     "filename": "server/api/faxInteraction/index.js",
10702     "groupTitle": "Fax_Interactions"
10703   },
10704   {
10705     "type": "get",
10706     "url": "/api/fax/interactions/{id}/messages",
10707     "title": "Gets interaction messages",
10708     "examples": [
10709       {
10710         "title": "Example usage:",
10711         "content": "curl https://{domain}/api/fax/interactions/{id}/messages -v -u {name}:{password} -X GET",
10712         "type": "json"
10713       }
10714     ],
10715     "name": "getMessages",
10716     "group": "Fax_Interactions",
10717     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10718     "version": "0.0.0",
10719     "filename": "server/api/faxInteraction/index.js",
10720     "groupTitle": "Fax_Interactions"
10721   },
10722   {
10723     "type": "put",
10724     "url": "/api/fax/interactions/{id}",
10725     "title": "Update an existing Interaction",
10726     "examples": [
10727       {
10728         "title": "Example usage:",
10729         "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",
10730         "type": "json"
10731       }
10732     ],
10733     "name": "updateInteractions",
10734     "group": "Fax_Interactions",
10735     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10736     "version": "0.0.0",
10737     "filename": "server/api/faxInteraction/index.js",
10738     "groupTitle": "Fax_Interactions"
10739   },
10740   {
10741     "type": "get",
10742     "url": "/api/fax/messages/{id}/download",
10743     "title": "Get message",
10744     "examples": [
10745       {
10746         "title": "Example usage:",
10747         "content": "curl https://{domain}/api/fax/messages/{id}/download -v -u {name}:{password} -X GET",
10748         "type": "json"
10749       }
10750     ],
10751     "name": "download",
10752     "group": "Fax_Message",
10753     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10754     "version": "0.0.0",
10755     "filename": "server/api/faxMessage/index.js",
10756     "groupTitle": "Fax_Message"
10757   },
10758   {
10759     "type": "delete",
10760     "url": "/api/fax/messages/{id}",
10761     "title": "Deletes a Message",
10762     "examples": [
10763       {
10764         "title": "Example usage:",
10765         "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password} -X DELETE",
10766         "type": "json"
10767       }
10768     ],
10769     "name": "DeleteMessages",
10770     "group": "Fax_Messages",
10771     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10772     "version": "0.0.0",
10773     "filename": "server/api/faxMessage/index.js",
10774     "groupTitle": "Fax_Messages"
10775   },
10776   {
10777     "type": "get",
10778     "url": "/api/fax/messages/describe",
10779     "title": "Gets table info about Messages",
10780     "examples": [
10781       {
10782         "title": "Example usage:",
10783         "content": "curl https://{domain}/api/fax/messages/describe -v -u {name}:{password}",
10784         "type": "json"
10785       }
10786     ],
10787     "name": "DescribeMessages",
10788     "group": "Fax_Messages",
10789     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10790     "version": "0.0.0",
10791     "filename": "server/api/faxMessage/index.js",
10792     "groupTitle": "Fax_Messages"
10793   },
10794   {
10795     "type": "get",
10796     "url": "/api/fax/messages",
10797     "title": "Gets a list of Messages",
10798     "examples": [
10799       {
10800         "title": "Example usage:",
10801         "content": "curl https://{domain}/api/fax/messages -v -u {name}:{password}",
10802         "type": "json"
10803       }
10804     ],
10805     "name": "GetMessages",
10806     "group": "Fax_Messages",
10807     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10808     "version": "0.0.0",
10809     "filename": "server/api/faxMessage/index.js",
10810     "groupTitle": "Fax_Messages"
10811   },
10812   {
10813     "type": "get",
10814     "url": "/api/fax/messages/{id}",
10815     "title": "Gets a single Message",
10816     "examples": [
10817       {
10818         "title": "Example usage:",
10819         "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password}",
10820         "type": "json"
10821       }
10822     ],
10823     "name": "ShowMessages",
10824     "group": "Fax_Messages",
10825     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10826     "version": "0.0.0",
10827     "filename": "server/api/faxMessage/index.js",
10828     "groupTitle": "Fax_Messages"
10829   },
10830   {
10831     "type": "put",
10832     "url": "/api/fax/messages/{id}/accept",
10833     "title": "Accepts message",
10834     "examples": [
10835       {
10836         "title": "Example usage:",
10837         "content": "curl https://{domain}/api/fax/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
10838         "type": "json"
10839       }
10840     ],
10841     "name": "acceptMessage",
10842     "group": "Fax_Messages",
10843     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10844     "version": "0.0.0",
10845     "filename": "server/api/faxMessage/index.js",
10846     "groupTitle": "Fax_Messages"
10847   },
10848   {
10849     "type": "post",
10850     "url": "/api/fax/messages",
10851     "title": "Create message and send Fax",
10852     "examples": [
10853       {
10854         "title": "Example usage:",
10855         "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
10856         "type": "json"
10857       }
10858     ],
10859     "name": "rejectMessage",
10860     "group": "Fax_Messages",
10861     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10862     "version": "0.0.0",
10863     "filename": "server/api/faxMessage/index.js",
10864     "groupTitle": "Fax_Messages"
10865   },
10866   {
10867     "type": "put",
10868     "url": "/api/fax/messages/{id}/reject",
10869     "title": "Rejects message",
10870     "examples": [
10871       {
10872         "title": "Example usage:",
10873         "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
10874         "type": "json"
10875       }
10876     ],
10877     "name": "rejectMessage",
10878     "group": "Fax_Messages",
10879     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10880     "version": "0.0.0",
10881     "filename": "server/api/faxMessage/index.js",
10882     "groupTitle": "Fax_Messages"
10883   },
10884   {
10885     "type": "put",
10886     "url": "/api/fax/messages/{id}",
10887     "title": "Update an existing Message",
10888     "examples": [
10889       {
10890         "title": "Example usage:",
10891         "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",
10892         "type": "json"
10893       }
10894     ],
10895     "name": "updateMessages",
10896     "group": "Fax_Messages",
10897     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10898     "version": "0.0.0",
10899     "filename": "server/api/faxMessage/index.js",
10900     "groupTitle": "Fax_Messages"
10901   },
10902   {
10903     "type": "post",
10904     "url": "/api/fax/reports/queue",
10905     "title": "Creates a new Fax Queue Report",
10906     "examples": [
10907       {
10908         "title": "Example usage:",
10909         "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",
10910         "type": "json"
10911       }
10912     ],
10913     "name": "CreateFax_Queue_Reports",
10914     "group": "Fax_Queue_Reports",
10915     "parameter": {
10916       "fields": {
10917         "Body": [
10918           {
10919             "group": "Body",
10920             "type": "String",
10921             "optional": false,
10922             "field": "uniqueid",
10923             "description": ""
10924           },
10925           {
10926             "group": "Body",
10927             "type": "String",
10928             "optional": true,
10929             "field": "from",
10930             "description": ""
10931           },
10932           {
10933             "group": "Body",
10934             "type": "String",
10935             "optional": true,
10936             "field": "joinAt",
10937             "description": ""
10938           },
10939           {
10940             "group": "Body",
10941             "type": "String",
10942             "optional": true,
10943             "field": "leaveAt",
10944             "description": ""
10945           },
10946           {
10947             "group": "Body",
10948             "type": "String",
10949             "optional": true,
10950             "field": "acceptAt",
10951             "description": ""
10952           },
10953           {
10954             "group": "Body",
10955             "type": "String",
10956             "optional": true,
10957             "field": "exitAt",
10958             "description": ""
10959           },
10960           {
10961             "group": "Body",
10962             "type": "String",
10963             "optional": true,
10964             "field": "reason",
10965             "description": ""
10966           }
10967         ]
10968       }
10969     },
10970     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10971     "version": "0.0.0",
10972     "filename": "server/api/faxQueueReport/index.js",
10973     "groupTitle": "Fax_Queue_Reports"
10974   },
10975   {
10976     "type": "delete",
10977     "url": "/api/fax/reports/queue/{id}",
10978     "title": "Deletes a Fax Queue Report",
10979     "examples": [
10980       {
10981         "title": "Example usage:",
10982         "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password} -X DELETE",
10983         "type": "json"
10984       }
10985     ],
10986     "name": "DeleteFax_Queue_Reports",
10987     "group": "Fax_Queue_Reports",
10988     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10989     "version": "0.0.0",
10990     "filename": "server/api/faxQueueReport/index.js",
10991     "groupTitle": "Fax_Queue_Reports"
10992   },
10993   {
10994     "type": "get",
10995     "url": "/api/fax/reports/queue/describe",
10996     "title": "Gets table info about Fax Queue Reports",
10997     "examples": [
10998       {
10999         "title": "Example usage:",
11000         "content": "curl https://{domain}/api/fax/reports/queue/describe -v -u {name}:{password}",
11001         "type": "json"
11002       }
11003     ],
11004     "name": "DescribeFax_Queue_Reports",
11005     "group": "Fax_Queue_Reports",
11006     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11007     "version": "0.0.0",
11008     "filename": "server/api/faxQueueReport/index.js",
11009     "groupTitle": "Fax_Queue_Reports"
11010   },
11011   {
11012     "type": "get",
11013     "url": "/api/fax/reports/queue",
11014     "title": "Gets a list of Fax Queue Reports",
11015     "examples": [
11016       {
11017         "title": "Example usage:",
11018         "content": "curl https://{domain}/api/fax/reports/queue -v -u {name}:{password}",
11019         "type": "json"
11020       }
11021     ],
11022     "name": "GetFax_Queue_Reports",
11023     "group": "Fax_Queue_Reports",
11024     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11025     "version": "0.0.0",
11026     "filename": "server/api/faxQueueReport/index.js",
11027     "groupTitle": "Fax_Queue_Reports"
11028   },
11029   {
11030     "type": "get",
11031     "url": "/api/fax/reports/queue/{id}",
11032     "title": "Gets a single Fax Queue Report",
11033     "examples": [
11034       {
11035         "title": "Example usage:",
11036         "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password}",
11037         "type": "json"
11038       }
11039     ],
11040     "name": "ShowFax_Queue_Reports",
11041     "group": "Fax_Queue_Reports",
11042     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11043     "version": "0.0.0",
11044     "filename": "server/api/faxQueueReport/index.js",
11045     "groupTitle": "Fax_Queue_Reports"
11046   },
11047   {
11048     "type": "put",
11049     "url": "/api/fax/reports/queue/{id}",
11050     "title": "Update an existing Fax Queue Report",
11051     "examples": [
11052       {
11053         "title": "Example usage:",
11054         "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",
11055         "type": "json"
11056       }
11057     ],
11058     "name": "updateFax_Queue_Reports",
11059     "group": "Fax_Queue_Reports",
11060     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11061     "version": "0.0.0",
11062     "filename": "server/api/faxQueueReport/index.js",
11063     "groupTitle": "Fax_Queue_Reports"
11064   },
11065   {
11066     "type": "post",
11067     "url": "/api/fax/queues/{id}/users",
11068     "title": "Add agents to a queue",
11069     "examples": [
11070       {
11071         "title": "Example usage:",
11072         "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",
11073         "type": "json"
11074       }
11075     ],
11076     "name": "AddAgents",
11077     "group": "Fax_Queues",
11078     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11079     "version": "0.0.0",
11080     "filename": "server/api/faxQueue/index.js",
11081     "groupTitle": "Fax_Queues"
11082   },
11083   {
11084     "type": "post",
11085     "url": "/api/fax/queues/{id}/teams",
11086     "title": "Add teams to a queue",
11087     "examples": [
11088       {
11089         "title": "Example usage:",
11090         "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",
11091         "type": "json"
11092       }
11093     ],
11094     "name": "AddTeams",
11095     "group": "Fax_Queues",
11096     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11097     "version": "0.0.0",
11098     "filename": "server/api/faxQueue/index.js",
11099     "groupTitle": "Fax_Queues"
11100   },
11101   {
11102     "type": "post",
11103     "url": "/api/fax/queues",
11104     "title": "Creates a new Queue",
11105     "examples": [
11106       {
11107         "title": "Example usage:",
11108         "content": "curl https://{domain}/api/fax/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
11109         "type": "json"
11110       }
11111     ],
11112     "name": "CreateQueues",
11113     "group": "Fax_Queues",
11114     "parameter": {
11115       "fields": {
11116         "Body": [
11117           {
11118             "group": "Body",
11119             "type": "String",
11120             "optional": false,
11121             "field": "name",
11122             "description": ""
11123           },
11124           {
11125             "group": "Body",
11126             "type": "String",
11127             "optional": true,
11128             "field": "description",
11129             "description": ""
11130           },
11131           {
11132             "group": "Body",
11133             "type": "Integer",
11134             "optional": false,
11135             "field": "timeout",
11136             "description": ""
11137           },
11138           {
11139             "group": "Body",
11140             "type": "String",
11141             "allowedValues": [
11142               "\"rrmemory\"",
11143               "\"beepall\"",
11144               "\"roundrobin\""
11145             ],
11146             "optional": false,
11147             "field": "strategy",
11148             "description": ""
11149           },
11150           {
11151             "group": "Body",
11152             "type": "Integer",
11153             "optional": true,
11154             "field": "lastAgent",
11155             "description": ""
11156           }
11157         ]
11158       }
11159     },
11160     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11161     "version": "0.0.0",
11162     "filename": "server/api/faxQueue/index.js",
11163     "groupTitle": "Fax_Queues"
11164   },
11165   {
11166     "type": "delete",
11167     "url": "/api/fax/queues/{id}",
11168     "title": "Deletes a Queue",
11169     "examples": [
11170       {
11171         "title": "Example usage:",
11172         "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password} -X DELETE",
11173         "type": "json"
11174       }
11175     ],
11176     "name": "DeleteQueues",
11177     "group": "Fax_Queues",
11178     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11179     "version": "0.0.0",
11180     "filename": "server/api/faxQueue/index.js",
11181     "groupTitle": "Fax_Queues"
11182   },
11183   {
11184     "type": "get",
11185     "url": "/api/fax/queues/describe",
11186     "title": "Gets table info about Queues",
11187     "examples": [
11188       {
11189         "title": "Example usage:",
11190         "content": "curl https://{domain}/api/fax/queues/describe -v -u {name}:{password}",
11191         "type": "json"
11192       }
11193     ],
11194     "name": "DescribeQueues",
11195     "group": "Fax_Queues",
11196     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11197     "version": "0.0.0",
11198     "filename": "server/api/faxQueue/index.js",
11199     "groupTitle": "Fax_Queues"
11200   },
11201   {
11202     "type": "get",
11203     "url": "/api/fax/queues/{id}/users",
11204     "title": "Gets queue agents",
11205     "examples": [
11206       {
11207         "title": "Example usage:",
11208         "content": "curl https://{domain}/api/fax/queues/{id}/users -v -u {name}:{password} -X POST",
11209         "type": "json"
11210       }
11211     ],
11212     "name": "GetAgents",
11213     "group": "Fax_Queues",
11214     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11215     "version": "0.0.0",
11216     "filename": "server/api/faxQueue/index.js",
11217     "groupTitle": "Fax_Queues"
11218   },
11219   {
11220     "type": "get",
11221     "url": "/api/fax/queues/{id}/members",
11222     "title": "GetMembers",
11223     "examples": [
11224       {
11225         "title": "Example usage:",
11226         "content": "curl https://{domain}/api/fax/queues/{id}/members  -v -u {name}:{password}",
11227         "type": "json"
11228       }
11229     ],
11230     "name": "GetMembers",
11231     "group": "Fax_Queues",
11232     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11233     "version": "0.0.0",
11234     "filename": "server/api/faxQueue/index.js",
11235     "groupTitle": "Fax_Queues"
11236   },
11237   {
11238     "type": "get",
11239     "url": "/api/fax/queues",
11240     "title": "Gets a list of Queues",
11241     "examples": [
11242       {
11243         "title": "Example usage:",
11244         "content": "curl https://{domain}/api/fax/queues -v -u {name}:{password}",
11245         "type": "json"
11246       }
11247     ],
11248     "name": "GetQueues",
11249     "group": "Fax_Queues",
11250     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11251     "version": "0.0.0",
11252     "filename": "server/api/faxQueue/index.js",
11253     "groupTitle": "Fax_Queues"
11254   },
11255   {
11256     "type": "get",
11257     "url": "/api/fax/queues/{id}/teams",
11258     "title": "Gets queues list",
11259     "examples": [
11260       {
11261         "title": "Example usage:",
11262         "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password}",
11263         "type": "json"
11264       }
11265     ],
11266     "name": "GetTeams",
11267     "group": "Fax_Queues",
11268     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11269     "version": "0.0.0",
11270     "filename": "server/api/faxQueue/index.js",
11271     "groupTitle": "Fax_Queues"
11272   },
11273   {
11274     "type": "delete",
11275     "url": "/api/fax/queues/{id}/users",
11276     "title": "Removes agents from a queue",
11277     "examples": [
11278       {
11279         "title": "Example usage:",
11280         "content": "curl https://{domain}/api/fax/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
11281         "type": "json"
11282       }
11283     ],
11284     "name": "RemoveAgents",
11285     "group": "Fax_Queues",
11286     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11287     "version": "0.0.0",
11288     "filename": "server/api/faxQueue/index.js",
11289     "groupTitle": "Fax_Queues"
11290   },
11291   {
11292     "type": "get",
11293     "url": "/api/fax/queues/{id}",
11294     "title": "Gets a single Queue",
11295     "examples": [
11296       {
11297         "title": "Example usage:",
11298         "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password}",
11299         "type": "json"
11300       }
11301     ],
11302     "name": "ShowQueues",
11303     "group": "Fax_Queues",
11304     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11305     "version": "0.0.0",
11306     "filename": "server/api/faxQueue/index.js",
11307     "groupTitle": "Fax_Queues"
11308   },
11309   {
11310     "type": "put",
11311     "url": "/api/fax/queues/{id}",
11312     "title": "Update an existing Queue",
11313     "examples": [
11314       {
11315         "title": "Example usage:",
11316         "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",
11317         "type": "json"
11318       }
11319     ],
11320     "name": "updateQueues",
11321     "group": "Fax_Queues",
11322     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11323     "version": "0.0.0",
11324     "filename": "server/api/faxQueue/index.js",
11325     "groupTitle": "Fax_Queues"
11326   },
11327   {
11328     "type": "post",
11329     "url": "/api/fax/reports/transfer",
11330     "title": "Creates a new Fax Transfer Report",
11331     "examples": [
11332       {
11333         "title": "Example usage:",
11334         "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",
11335         "type": "json"
11336       }
11337     ],
11338     "name": "CreateFax_Transfer_Reports",
11339     "group": "Fax_Transfer_Reports",
11340     "parameter": {
11341       "fields": {
11342         "Body": [
11343           {
11344             "group": "Body",
11345             "type": "String",
11346             "optional": false,
11347             "field": "uniqueid",
11348             "description": ""
11349           },
11350           {
11351             "group": "Body",
11352             "type": "String",
11353             "allowedValues": [
11354               "\"account\"",
11355               "\"agent\"",
11356               "\"queue\""
11357             ],
11358             "optional": false,
11359             "field": "type",
11360             "description": ""
11361           },
11362           {
11363             "group": "Body",
11364             "type": "String",
11365             "optional": false,
11366             "field": "transferredAt",
11367             "description": ""
11368           }
11369         ]
11370       }
11371     },
11372     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11373     "version": "0.0.0",
11374     "filename": "server/api/faxTransferReport/index.js",
11375     "groupTitle": "Fax_Transfer_Reports"
11376   },
11377   {
11378     "type": "delete",
11379     "url": "/api/fax/reports/transfer/{id}",
11380     "title": "Deletes a Fax Transfer Report",
11381     "examples": [
11382       {
11383         "title": "Example usage:",
11384         "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
11385         "type": "json"
11386       }
11387     ],
11388     "name": "DeleteFax_Transfer_Reports",
11389     "group": "Fax_Transfer_Reports",
11390     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11391     "version": "0.0.0",
11392     "filename": "server/api/faxTransferReport/index.js",
11393     "groupTitle": "Fax_Transfer_Reports"
11394   },
11395   {
11396     "type": "get",
11397     "url": "/api/fax/reports/transfer/describe",
11398     "title": "Gets table info about Fax Transfer Reports",
11399     "examples": [
11400       {
11401         "title": "Example usage:",
11402         "content": "curl https://{domain}/api/fax/reports/transfer/describe -v -u {name}:{password}",
11403         "type": "json"
11404       }
11405     ],
11406     "name": "DescribeFax_Transfer_Reports",
11407     "group": "Fax_Transfer_Reports",
11408     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11409     "version": "0.0.0",
11410     "filename": "server/api/faxTransferReport/index.js",
11411     "groupTitle": "Fax_Transfer_Reports"
11412   },
11413   {
11414     "type": "get",
11415     "url": "/api/fax/reports/transfer",
11416     "title": "Gets a list of Fax Transfer Reports",
11417     "examples": [
11418       {
11419         "title": "Example usage:",
11420         "content": "curl https://{domain}/api/fax/reports/transfer -v -u {name}:{password}",
11421         "type": "json"
11422       }
11423     ],
11424     "name": "GetFax_Transfer_Reports",
11425     "group": "Fax_Transfer_Reports",
11426     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/fax/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>",
11427     "version": "0.0.0",
11428     "filename": "server/api/faxTransferReport/index.js",
11429     "groupTitle": "Fax_Transfer_Reports"
11430   },
11431   {
11432     "type": "get",
11433     "url": "/api/fax/reports/transfer/{id}",
11434     "title": "Gets a single Fax Transfer Report",
11435     "examples": [
11436       {
11437         "title": "Example usage:",
11438         "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password}",
11439         "type": "json"
11440       }
11441     ],
11442     "name": "ShowFax_Transfer_Reports",
11443     "group": "Fax_Transfer_Reports",
11444     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11445     "version": "0.0.0",
11446     "filename": "server/api/faxTransferReport/index.js",
11447     "groupTitle": "Fax_Transfer_Reports"
11448   },
11449   {
11450     "type": "put",
11451     "url": "/api/fax/reports/transfer/{id}",
11452     "title": "Update an existing Fax Transfer Report",
11453     "examples": [
11454       {
11455         "title": "Example usage:",
11456         "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",
11457         "type": "json"
11458       }
11459     ],
11460     "name": "updateFax_Transfer_Reports",
11461     "group": "Fax_Transfer_Reports",
11462     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11463     "version": "0.0.0",
11464     "filename": "server/api/faxTransferReport/index.js",
11465     "groupTitle": "Fax_Transfer_Reports"
11466   },
11467   {
11468     "type": "post",
11469     "url": "/api/integrations/freshdesk/accounts",
11470     "title": "Creates a new Freshdesk Account",
11471     "examples": [
11472       {
11473         "title": "Example usage:",
11474         "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",
11475         "type": "json"
11476       }
11477     ],
11478     "name": "CreateFreshdesk_Accounts",
11479     "group": "Freshdesk_Accounts",
11480     "parameter": {
11481       "fields": {
11482         "Body": [
11483           {
11484             "group": "Body",
11485             "type": "String",
11486             "optional": true,
11487             "field": "name",
11488             "description": ""
11489           },
11490           {
11491             "group": "Body",
11492             "type": "String",
11493             "optional": true,
11494             "field": "description",
11495             "description": ""
11496           },
11497           {
11498             "group": "Body",
11499             "type": "String",
11500             "optional": true,
11501             "field": "username",
11502             "description": ""
11503           },
11504           {
11505             "group": "Body",
11506             "type": "String",
11507             "optional": true,
11508             "field": "apiKey",
11509             "description": ""
11510           },
11511           {
11512             "group": "Body",
11513             "type": "String",
11514             "optional": true,
11515             "field": "remoteUri",
11516             "description": ""
11517           },
11518           {
11519             "group": "Body",
11520             "type": "String",
11521             "optional": false,
11522             "field": "serverUrl",
11523             "description": ""
11524           }
11525         ]
11526       }
11527     },
11528     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11529     "version": "0.0.0",
11530     "filename": "server/api/intFreshdeskAccount/index.js",
11531     "groupTitle": "Freshdesk_Accounts"
11532   },
11533   {
11534     "type": "delete",
11535     "url": "/api/integrations/freshdesk/accounts/{id}",
11536     "title": "Deletes a Freshdesk Account",
11537     "examples": [
11538       {
11539         "title": "Example usage:",
11540         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password} -X DELETE",
11541         "type": "json"
11542       }
11543     ],
11544     "name": "DeleteFreshdesk_Accounts",
11545     "group": "Freshdesk_Accounts",
11546     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11547     "version": "0.0.0",
11548     "filename": "server/api/intFreshdeskAccount/index.js",
11549     "groupTitle": "Freshdesk_Accounts"
11550   },
11551   {
11552     "type": "get",
11553     "url": "/api/integrations/freshdesk/accounts",
11554     "title": "Gets a list of Freshdesk Accounts",
11555     "examples": [
11556       {
11557         "title": "Example usage:",
11558         "content": "curl https://{domain}/api/integrations/freshdesk/accounts -v -u {name}:{password}",
11559         "type": "json"
11560       }
11561     ],
11562     "name": "GetFreshdesk_Accounts",
11563     "group": "Freshdesk_Accounts",
11564     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11565     "version": "0.0.0",
11566     "filename": "server/api/intFreshdeskAccount/index.js",
11567     "groupTitle": "Freshdesk_Accounts"
11568   },
11569   {
11570     "type": "get",
11571     "url": "/api/integrations/freshdesk/accounts/{id}",
11572     "title": "Gets a single Freshdesk Account",
11573     "examples": [
11574       {
11575         "title": "Example usage:",
11576         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password}",
11577         "type": "json"
11578       }
11579     ],
11580     "name": "ShowFreshdesk_Accounts",
11581     "group": "Freshdesk_Accounts",
11582     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11583     "version": "0.0.0",
11584     "filename": "server/api/intFreshdeskAccount/index.js",
11585     "groupTitle": "Freshdesk_Accounts"
11586   },
11587   {
11588     "type": "post",
11589     "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
11590     "title": "Creates new configuration",
11591     "examples": [
11592       {
11593         "title": "Example usage:",
11594         "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",
11595         "type": "json"
11596       }
11597     ],
11598     "name": "addConfiguration",
11599     "group": "Freshdesk_Accounts",
11600     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11601     "version": "0.0.0",
11602     "filename": "server/api/intFreshdeskAccount/index.js",
11603     "groupTitle": "Freshdesk_Accounts"
11604   },
11605   {
11606     "type": "get",
11607     "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
11608     "title": "Gets account configurations",
11609     "examples": [
11610       {
11611         "title": "Example usage:",
11612         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
11613         "type": "json"
11614       }
11615     ],
11616     "name": "getConfigurations",
11617     "group": "Freshdesk_Accounts",
11618     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11619     "version": "0.0.0",
11620     "filename": "server/api/intFreshdeskAccount/index.js",
11621     "groupTitle": "Freshdesk_Accounts"
11622   },
11623   {
11624     "type": "get",
11625     "url": "/api/integrations/freshdesk/accounts/{id}/fields",
11626     "title": "Gets account fields",
11627     "examples": [
11628       {
11629         "title": "Example usage:",
11630         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
11631         "type": "json"
11632       }
11633     ],
11634     "name": "getFields",
11635     "group": "Freshdesk_Accounts",
11636     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11637     "version": "0.0.0",
11638     "filename": "server/api/intFreshdeskAccount/index.js",
11639     "groupTitle": "Freshdesk_Accounts"
11640   },
11641   {
11642     "type": "put",
11643     "url": "/api/integrations/freshdesk/accounts/{id}",
11644     "title": "Update an existing Freshdesk Account",
11645     "examples": [
11646       {
11647         "title": "Example usage:",
11648         "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",
11649         "type": "json"
11650       }
11651     ],
11652     "name": "updateFreshdesk_Accounts",
11653     "group": "Freshdesk_Accounts",
11654     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11655     "version": "0.0.0",
11656     "filename": "server/api/intFreshdeskAccount/index.js",
11657     "groupTitle": "Freshdesk_Accounts"
11658   },
11659   {
11660     "type": "post",
11661     "url": "/api/integrations/freshdesk/configurations",
11662     "title": "Creates a new Freshdesk Configuration",
11663     "examples": [
11664       {
11665         "title": "Example usage:",
11666         "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",
11667         "type": "json"
11668       }
11669     ],
11670     "name": "CreateFreshdesk_Configurations",
11671     "group": "Freshdesk_Configurations",
11672     "parameter": {
11673       "fields": {
11674         "Body": [
11675           {
11676             "group": "Body",
11677             "type": "String",
11678             "optional": true,
11679             "field": "name",
11680             "description": ""
11681           },
11682           {
11683             "group": "Body",
11684             "type": "String",
11685             "optional": true,
11686             "field": "description",
11687             "description": ""
11688           }
11689         ]
11690       }
11691     },
11692     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11693     "version": "0.0.0",
11694     "filename": "server/api/intFreshdeskConfiguration/index.js",
11695     "groupTitle": "Freshdesk_Configurations"
11696   },
11697   {
11698     "type": "delete",
11699     "url": "/api/integrations/freshdesk/configurations/{id}",
11700     "title": "Deletes a Freshdesk Configuration",
11701     "examples": [
11702       {
11703         "title": "Example usage:",
11704         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password} -X DELETE",
11705         "type": "json"
11706       }
11707     ],
11708     "name": "DeleteFreshdesk_Configurations",
11709     "group": "Freshdesk_Configurations",
11710     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11711     "version": "0.0.0",
11712     "filename": "server/api/intFreshdeskConfiguration/index.js",
11713     "groupTitle": "Freshdesk_Configurations"
11714   },
11715   {
11716     "type": "get",
11717     "url": "/api/integrations/freshdesk/configurations",
11718     "title": "Gets a list of Freshdesk Configurations",
11719     "examples": [
11720       {
11721         "title": "Example usage:",
11722         "content": "curl https://{domain}/api/integrations/freshdesk/configurations -v -u {name}:{password}",
11723         "type": "json"
11724       }
11725     ],
11726     "name": "GetFreshdesk_Configurations",
11727     "group": "Freshdesk_Configurations",
11728     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11729     "version": "0.0.0",
11730     "filename": "server/api/intFreshdeskConfiguration/index.js",
11731     "groupTitle": "Freshdesk_Configurations"
11732   },
11733   {
11734     "type": "get",
11735     "url": "/api/integrations/freshdesk/configurations/{id}",
11736     "title": "Gets a single Freshdesk Configuration",
11737     "examples": [
11738       {
11739         "title": "Example usage:",
11740         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password}",
11741         "type": "json"
11742       }
11743     ],
11744     "name": "ShowFreshdesk_Configurations",
11745     "group": "Freshdesk_Configurations",
11746     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11747     "version": "0.0.0",
11748     "filename": "server/api/intFreshdeskConfiguration/index.js",
11749     "groupTitle": "Freshdesk_Configurations"
11750   },
11751   {
11752     "type": "get",
11753     "url": "/api/integrations/freshdesk/configurations/{id}/descriptions",
11754     "title": "Gets configurations descriptions",
11755     "examples": [
11756       {
11757         "title": "Example usage:",
11758         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
11759         "type": "json"
11760       }
11761     ],
11762     "name": "getDescriptions",
11763     "group": "Freshdesk_Configurations",
11764     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11765     "version": "0.0.0",
11766     "filename": "server/api/intFreshdeskConfiguration/index.js",
11767     "groupTitle": "Freshdesk_Configurations"
11768   },
11769   {
11770     "type": "get",
11771     "url": "/api/integrations/freshdesk/configurations/{id}/fields",
11772     "title": "Gets configurations fields",
11773     "examples": [
11774       {
11775         "title": "Example usage:",
11776         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
11777         "type": "json"
11778       }
11779     ],
11780     "name": "getFields",
11781     "group": "Freshdesk_Configurations",
11782     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11783     "version": "0.0.0",
11784     "filename": "server/api/intFreshdeskConfiguration/index.js",
11785     "groupTitle": "Freshdesk_Configurations"
11786   },
11787   {
11788     "type": "get",
11789     "url": "/api/integrations/freshdesk/configurations/{id}/subjects",
11790     "title": "Gets configurations subjects",
11791     "examples": [
11792       {
11793         "title": "Example usage:",
11794         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
11795         "type": "json"
11796       }
11797     ],
11798     "name": "getSubjects",
11799     "group": "Freshdesk_Configurations",
11800     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11801     "version": "0.0.0",
11802     "filename": "server/api/intFreshdeskConfiguration/index.js",
11803     "groupTitle": "Freshdesk_Configurations"
11804   },
11805   {
11806     "type": "get",
11807     "url": "/api/integrations/freshdesk/configurations/{id}/tags",
11808     "title": "Gets configurations tags",
11809     "examples": [
11810       {
11811         "title": "Example usage:",
11812         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
11813         "type": "json"
11814       }
11815     ],
11816     "name": "getTags",
11817     "group": "Freshdesk_Configurations",
11818     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11819     "version": "0.0.0",
11820     "filename": "server/api/intFreshdeskConfiguration/index.js",
11821     "groupTitle": "Freshdesk_Configurations"
11822   },
11823   {
11824     "type": "post",
11825     "url": "/api/integrations/freshdesk/configurations/{id}/tags",
11826     "title": "Sets new tags",
11827     "examples": [
11828       {
11829         "title": "Example usage:",
11830         "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",
11831         "type": "json"
11832       }
11833     ],
11834     "name": "setTags",
11835     "group": "Freshdesk_Configurations",
11836     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11837     "version": "0.0.0",
11838     "filename": "server/api/intFreshdeskConfiguration/index.js",
11839     "groupTitle": "Freshdesk_Configurations"
11840   },
11841   {
11842     "type": "put",
11843     "url": "/api/integrations/freshdesk/configurations/{id}",
11844     "title": "Update an existing Freshdesk Configuration",
11845     "examples": [
11846       {
11847         "title": "Example usage:",
11848         "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",
11849         "type": "json"
11850       }
11851     ],
11852     "name": "updateFreshdesk_Configurations",
11853     "group": "Freshdesk_Configurations",
11854     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11855     "version": "0.0.0",
11856     "filename": "server/api/intFreshdeskConfiguration/index.js",
11857     "groupTitle": "Freshdesk_Configurations"
11858   },
11859   {
11860     "type": "post",
11861     "url": "/api/integrations/freshdesk/fields",
11862     "title": "Creates a new Freshdesk Field",
11863     "examples": [
11864       {
11865         "title": "Example usage:",
11866         "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",
11867         "type": "json"
11868       }
11869     ],
11870     "name": "CreateFreshdesk_Fields",
11871     "group": "Freshdesk_Fields",
11872     "parameter": {
11873       "fields": {
11874         "Body": [
11875           {
11876             "group": "Body",
11877             "type": "String",
11878             "allowedValues": [
11879               "\"string\"",
11880               "\"variable\"",
11881               "\"customVariable\"",
11882               "\"keyValue\"",
11883               "\"picklist\""
11884             ],
11885             "optional": true,
11886             "field": "type",
11887             "description": ""
11888           },
11889           {
11890             "group": "Body",
11891             "type": "String",
11892             "optional": true,
11893             "field": "content",
11894             "description": ""
11895           },
11896           {
11897             "group": "Body",
11898             "type": "String",
11899             "optional": true,
11900             "field": "key",
11901             "description": ""
11902           },
11903           {
11904             "group": "Body",
11905             "type": "String",
11906             "allowedValues": [
11907               "\"string\"",
11908               "\"variable\"",
11909               "\"customVariable\""
11910             ],
11911             "optional": true,
11912             "field": "keyType",
11913             "description": ""
11914           },
11915           {
11916             "group": "Body",
11917             "type": "String",
11918             "optional": true,
11919             "field": "keyContent",
11920             "description": ""
11921           },
11922           {
11923             "group": "Body",
11924             "type": "String",
11925             "optional": true,
11926             "field": "idField",
11927             "description": ""
11928           },
11929           {
11930             "group": "Body",
11931             "type": "String",
11932             "optional": true,
11933             "field": "nameField",
11934             "description": ""
11935           },
11936           {
11937             "group": "Body",
11938             "type": "Boolean",
11939             "optional": true,
11940             "field": "customField",
11941             "description": ""
11942           },
11943           {
11944             "group": "Body",
11945             "type": "String",
11946             "optional": true,
11947             "field": "variableName",
11948             "description": ""
11949           }
11950         ]
11951       }
11952     },
11953     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11954     "version": "0.0.0",
11955     "filename": "server/api/intFreshdeskField/index.js",
11956     "groupTitle": "Freshdesk_Fields"
11957   },
11958   {
11959     "type": "delete",
11960     "url": "/api/integrations/freshdesk/fields/{id}",
11961     "title": "Deletes a Freshdesk Field",
11962     "examples": [
11963       {
11964         "title": "Example usage:",
11965         "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password} -X DELETE",
11966         "type": "json"
11967       }
11968     ],
11969     "name": "DeleteFreshdesk_Fields",
11970     "group": "Freshdesk_Fields",
11971     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11972     "version": "0.0.0",
11973     "filename": "server/api/intFreshdeskField/index.js",
11974     "groupTitle": "Freshdesk_Fields"
11975   },
11976   {
11977     "type": "get",
11978     "url": "/api/integrations/freshdesk/fields",
11979     "title": "Gets a list of Freshdesk Fields",
11980     "examples": [
11981       {
11982         "title": "Example usage:",
11983         "content": "curl https://{domain}/api/integrations/freshdesk/fields -v -u {name}:{password}",
11984         "type": "json"
11985       }
11986     ],
11987     "name": "GetFreshdesk_Fields",
11988     "group": "Freshdesk_Fields",
11989     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11990     "version": "0.0.0",
11991     "filename": "server/api/intFreshdeskField/index.js",
11992     "groupTitle": "Freshdesk_Fields"
11993   },
11994   {
11995     "type": "get",
11996     "url": "/api/integrations/freshdesk/fields/{id}",
11997     "title": "Gets a single Freshdesk Field",
11998     "examples": [
11999       {
12000         "title": "Example usage:",
12001         "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password}",
12002         "type": "json"
12003       }
12004     ],
12005     "name": "ShowFreshdesk_Fields",
12006     "group": "Freshdesk_Fields",
12007     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12008     "version": "0.0.0",
12009     "filename": "server/api/intFreshdeskField/index.js",
12010     "groupTitle": "Freshdesk_Fields"
12011   },
12012   {
12013     "type": "put",
12014     "url": "/api/integrations/freshdesk/fields/{id}",
12015     "title": "Update an existing Freshdesk Field",
12016     "examples": [
12017       {
12018         "title": "Example usage:",
12019         "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",
12020         "type": "json"
12021       }
12022     ],
12023     "name": "updateFreshdesk_Fields",
12024     "group": "Freshdesk_Fields",
12025     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12026     "version": "0.0.0",
12027     "filename": "server/api/intFreshdeskField/index.js",
12028     "groupTitle": "Freshdesk_Fields"
12029   },
12030   {
12031     "type": "post",
12032     "url": "/api/integrations/freshsales/accounts",
12033     "title": "Creates a new Freshsales Account",
12034     "examples": [
12035       {
12036         "title": "Example usage:",
12037         "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",
12038         "type": "json"
12039       }
12040     ],
12041     "name": "CreateFreshsales_Accounts",
12042     "group": "Freshsales_Accounts",
12043     "parameter": {
12044       "fields": {
12045         "Body": [
12046           {
12047             "group": "Body",
12048             "type": "String",
12049             "optional": true,
12050             "field": "name",
12051             "description": ""
12052           },
12053           {
12054             "group": "Body",
12055             "type": "String",
12056             "optional": true,
12057             "field": "description",
12058             "description": ""
12059           },
12060           {
12061             "group": "Body",
12062             "type": "String",
12063             "optional": true,
12064             "field": "username",
12065             "description": ""
12066           },
12067           {
12068             "group": "Body",
12069             "type": "String",
12070             "optional": true,
12071             "field": "apiKey",
12072             "description": ""
12073           },
12074           {
12075             "group": "Body",
12076             "type": "String",
12077             "optional": true,
12078             "field": "remoteUri",
12079             "description": ""
12080           },
12081           {
12082             "group": "Body",
12083             "type": "String",
12084             "optional": false,
12085             "field": "serverUrl",
12086             "description": ""
12087           }
12088         ]
12089       }
12090     },
12091     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12092     "version": "0.0.0",
12093     "filename": "server/api/intFreshsalesAccount/index.js",
12094     "groupTitle": "Freshsales_Accounts"
12095   },
12096   {
12097     "type": "delete",
12098     "url": "/api/integrations/freshsales/accounts/{id}",
12099     "title": "Deletes a Freshsales Account",
12100     "examples": [
12101       {
12102         "title": "Example usage:",
12103         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password} -X DELETE",
12104         "type": "json"
12105       }
12106     ],
12107     "name": "DeleteFreshsales_Accounts",
12108     "group": "Freshsales_Accounts",
12109     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12110     "version": "0.0.0",
12111     "filename": "server/api/intFreshsalesAccount/index.js",
12112     "groupTitle": "Freshsales_Accounts"
12113   },
12114   {
12115     "type": "get",
12116     "url": "/api/integrations/freshsales/accounts",
12117     "title": "Gets a list of Freshsales Accounts",
12118     "examples": [
12119       {
12120         "title": "Example usage:",
12121         "content": "curl https://{domain}/api/integrations/freshsales/accounts -v -u {name}:{password}",
12122         "type": "json"
12123       }
12124     ],
12125     "name": "GetFreshsales_Accounts",
12126     "group": "Freshsales_Accounts",
12127     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12128     "version": "0.0.0",
12129     "filename": "server/api/intFreshsalesAccount/index.js",
12130     "groupTitle": "Freshsales_Accounts"
12131   },
12132   {
12133     "type": "get",
12134     "url": "/api/integrations/freshsales/accounts/{id}",
12135     "title": "Gets a single Freshsales Account",
12136     "examples": [
12137       {
12138         "title": "Example usage:",
12139         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password}",
12140         "type": "json"
12141       }
12142     ],
12143     "name": "ShowFreshsales_Accounts",
12144     "group": "Freshsales_Accounts",
12145     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12146     "version": "0.0.0",
12147     "filename": "server/api/intFreshsalesAccount/index.js",
12148     "groupTitle": "Freshsales_Accounts"
12149   },
12150   {
12151     "type": "post",
12152     "url": "/api/integrations/freshsales/accounts/{id}/configurations",
12153     "title": "Creates new configuration",
12154     "examples": [
12155       {
12156         "title": "Example usage:",
12157         "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",
12158         "type": "json"
12159       }
12160     ],
12161     "name": "addConfiguration",
12162     "group": "Freshsales_Accounts",
12163     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12164     "version": "0.0.0",
12165     "filename": "server/api/intFreshsalesAccount/index.js",
12166     "groupTitle": "Freshsales_Accounts"
12167   },
12168   {
12169     "type": "get",
12170     "url": "/api/integrations/freshsales/accounts/{id}/configurations",
12171     "title": "Gets account configurations",
12172     "examples": [
12173       {
12174         "title": "Example usage:",
12175         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/configurations -v -u {name}:{password} -X GET",
12176         "type": "json"
12177       }
12178     ],
12179     "name": "getConfigurations",
12180     "group": "Freshsales_Accounts",
12181     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12182     "version": "0.0.0",
12183     "filename": "server/api/intFreshsalesAccount/index.js",
12184     "groupTitle": "Freshsales_Accounts"
12185   },
12186   {
12187     "type": "get",
12188     "url": "/api/integrations/freshsales/accounts/{id}/fields",
12189     "title": "Gets account fields",
12190     "examples": [
12191       {
12192         "title": "Example usage:",
12193         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/fields -v -u {name}:{password} -X GET",
12194         "type": "json"
12195       }
12196     ],
12197     "name": "getFields",
12198     "group": "Freshsales_Accounts",
12199     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12200     "version": "0.0.0",
12201     "filename": "server/api/intFreshsalesAccount/index.js",
12202     "groupTitle": "Freshsales_Accounts"
12203   },
12204   {
12205     "type": "put",
12206     "url": "/api/integrations/freshsales/accounts/{id}",
12207     "title": "Update an existing Freshsales Account",
12208     "examples": [
12209       {
12210         "title": "Example usage:",
12211         "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",
12212         "type": "json"
12213       }
12214     ],
12215     "name": "updateFreshsales_Accounts",
12216     "group": "Freshsales_Accounts",
12217     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12218     "version": "0.0.0",
12219     "filename": "server/api/intFreshsalesAccount/index.js",
12220     "groupTitle": "Freshsales_Accounts"
12221   },
12222   {
12223     "type": "post",
12224     "url": "/api/integrations/freshsales/configurations",
12225     "title": "Creates a new Freshsales Configuration",
12226     "examples": [
12227       {
12228         "title": "Example usage:",
12229         "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",
12230         "type": "json"
12231       }
12232     ],
12233     "name": "CreateFreshsales_Configurations",
12234     "group": "Freshsales_Configurations",
12235     "parameter": {
12236       "fields": {
12237         "Body": [
12238           {
12239             "group": "Body",
12240             "type": "String",
12241             "optional": true,
12242             "field": "name",
12243             "description": ""
12244           },
12245           {
12246             "group": "Body",
12247             "type": "String",
12248             "optional": true,
12249             "field": "description",
12250             "description": ""
12251           }
12252         ]
12253       }
12254     },
12255     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12256     "version": "0.0.0",
12257     "filename": "server/api/intFreshsalesConfiguration/index.js",
12258     "groupTitle": "Freshsales_Configurations"
12259   },
12260   {
12261     "type": "delete",
12262     "url": "/api/integrations/freshsales/configurations/{id}",
12263     "title": "Deletes a Freshsales Configuration",
12264     "examples": [
12265       {
12266         "title": "Example usage:",
12267         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password} -X DELETE",
12268         "type": "json"
12269       }
12270     ],
12271     "name": "DeleteFreshsales_Configurations",
12272     "group": "Freshsales_Configurations",
12273     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12274     "version": "0.0.0",
12275     "filename": "server/api/intFreshsalesConfiguration/index.js",
12276     "groupTitle": "Freshsales_Configurations"
12277   },
12278   {
12279     "type": "get",
12280     "url": "/api/integrations/freshsales/configurations",
12281     "title": "Gets a list of Freshsales Configurations",
12282     "examples": [
12283       {
12284         "title": "Example usage:",
12285         "content": "curl https://{domain}/api/integrations/freshsales/configurations -v -u {name}:{password}",
12286         "type": "json"
12287       }
12288     ],
12289     "name": "GetFreshsales_Configurations",
12290     "group": "Freshsales_Configurations",
12291     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12292     "version": "0.0.0",
12293     "filename": "server/api/intFreshsalesConfiguration/index.js",
12294     "groupTitle": "Freshsales_Configurations"
12295   },
12296   {
12297     "type": "get",
12298     "url": "/api/integrations/freshsales/configurations/{id}",
12299     "title": "Gets a single Freshsales Configuration",
12300     "examples": [
12301       {
12302         "title": "Example usage:",
12303         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password}",
12304         "type": "json"
12305       }
12306     ],
12307     "name": "ShowFreshsales_Configurations",
12308     "group": "Freshsales_Configurations",
12309     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12310     "version": "0.0.0",
12311     "filename": "server/api/intFreshsalesConfiguration/index.js",
12312     "groupTitle": "Freshsales_Configurations"
12313   },
12314   {
12315     "type": "get",
12316     "url": "/api/integrations/freshsales/configurations/{id}/descriptions",
12317     "title": "Gets configurations descriptions",
12318     "examples": [
12319       {
12320         "title": "Example usage:",
12321         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
12322         "type": "json"
12323       }
12324     ],
12325     "name": "getDescriptions",
12326     "group": "Freshsales_Configurations",
12327     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12328     "version": "0.0.0",
12329     "filename": "server/api/intFreshsalesConfiguration/index.js",
12330     "groupTitle": "Freshsales_Configurations"
12331   },
12332   {
12333     "type": "get",
12334     "url": "/api/integrations/freshsales/configurations/{id}/fields",
12335     "title": "Gets configurations fields",
12336     "examples": [
12337       {
12338         "title": "Example usage:",
12339         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/fields -v -u {name}:{password} -X GET",
12340         "type": "json"
12341       }
12342     ],
12343     "name": "getFields",
12344     "group": "Freshsales_Configurations",
12345     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12346     "version": "0.0.0",
12347     "filename": "server/api/intFreshsalesConfiguration/index.js",
12348     "groupTitle": "Freshsales_Configurations"
12349   },
12350   {
12351     "type": "get",
12352     "url": "/api/integrations/freshsales/configurations/{id}/subjects",
12353     "title": "Gets configurations subjects",
12354     "examples": [
12355       {
12356         "title": "Example usage:",
12357         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/subjects -v -u {name}:{password} -X GET",
12358         "type": "json"
12359       }
12360     ],
12361     "name": "getSubjects",
12362     "group": "Freshsales_Configurations",
12363     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12364     "version": "0.0.0",
12365     "filename": "server/api/intFreshsalesConfiguration/index.js",
12366     "groupTitle": "Freshsales_Configurations"
12367   },
12368   {
12369     "type": "put",
12370     "url": "/api/integrations/freshsales/configurations/{id}",
12371     "title": "Update an existing Freshsales Configuration",
12372     "examples": [
12373       {
12374         "title": "Example usage:",
12375         "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",
12376         "type": "json"
12377       }
12378     ],
12379     "name": "updateFreshsales_Configurations",
12380     "group": "Freshsales_Configurations",
12381     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12382     "version": "0.0.0",
12383     "filename": "server/api/intFreshsalesConfiguration/index.js",
12384     "groupTitle": "Freshsales_Configurations"
12385   },
12386   {
12387     "type": "post",
12388     "url": "/api/integrations/freshsales/fields",
12389     "title": "Creates a new Freshsales Field",
12390     "examples": [
12391       {
12392         "title": "Example usage:",
12393         "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",
12394         "type": "json"
12395       }
12396     ],
12397     "name": "CreateFreshsales_Fields",
12398     "group": "Freshsales_Fields",
12399     "parameter": {
12400       "fields": {
12401         "Body": [
12402           {
12403             "group": "Body",
12404             "type": "String",
12405             "allowedValues": [
12406               "\"string\"",
12407               "\"variable\"",
12408               "\"customVariable\"",
12409               "\"keyValue\"",
12410               "\"picklist\""
12411             ],
12412             "optional": true,
12413             "field": "type",
12414             "description": ""
12415           },
12416           {
12417             "group": "Body",
12418             "type": "String",
12419             "optional": true,
12420             "field": "content",
12421             "description": ""
12422           },
12423           {
12424             "group": "Body",
12425             "type": "String",
12426             "optional": true,
12427             "field": "key",
12428             "description": ""
12429           },
12430           {
12431             "group": "Body",
12432             "type": "String",
12433             "allowedValues": [
12434               "\"string\"",
12435               "\"variable\"",
12436               "\"customVariable\""
12437             ],
12438             "optional": true,
12439             "field": "keyType",
12440             "description": ""
12441           },
12442           {
12443             "group": "Body",
12444             "type": "String",
12445             "optional": true,
12446             "field": "keyContent",
12447             "description": ""
12448           },
12449           {
12450             "group": "Body",
12451             "type": "String",
12452             "optional": true,
12453             "field": "idField",
12454             "description": ""
12455           },
12456           {
12457             "group": "Body",
12458             "type": "String",
12459             "optional": true,
12460             "field": "nameField",
12461             "description": ""
12462           },
12463           {
12464             "group": "Body",
12465             "type": "Boolean",
12466             "optional": true,
12467             "field": "customField",
12468             "description": ""
12469           },
12470           {
12471             "group": "Body",
12472             "type": "String",
12473             "optional": true,
12474             "field": "variableName",
12475             "description": ""
12476           }
12477         ]
12478       }
12479     },
12480     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12481     "version": "0.0.0",
12482     "filename": "server/api/intFreshsalesField/index.js",
12483     "groupTitle": "Freshsales_Fields"
12484   },
12485   {
12486     "type": "delete",
12487     "url": "/api/integrations/freshsales/fields/{id}",
12488     "title": "Deletes a Freshsales Field",
12489     "examples": [
12490       {
12491         "title": "Example usage:",
12492         "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password} -X DELETE",
12493         "type": "json"
12494       }
12495     ],
12496     "name": "DeleteFreshsales_Fields",
12497     "group": "Freshsales_Fields",
12498     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12499     "version": "0.0.0",
12500     "filename": "server/api/intFreshsalesField/index.js",
12501     "groupTitle": "Freshsales_Fields"
12502   },
12503   {
12504     "type": "get",
12505     "url": "/api/integrations/freshsales/fields",
12506     "title": "Gets a list of Freshsales Fields",
12507     "examples": [
12508       {
12509         "title": "Example usage:",
12510         "content": "curl https://{domain}/api/integrations/freshsales/fields -v -u {name}:{password}",
12511         "type": "json"
12512       }
12513     ],
12514     "name": "GetFreshsales_Fields",
12515     "group": "Freshsales_Fields",
12516     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12517     "version": "0.0.0",
12518     "filename": "server/api/intFreshsalesField/index.js",
12519     "groupTitle": "Freshsales_Fields"
12520   },
12521   {
12522     "type": "get",
12523     "url": "/api/integrations/freshsales/fields/{id}",
12524     "title": "Gets a single Freshsales Field",
12525     "examples": [
12526       {
12527         "title": "Example usage:",
12528         "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password}",
12529         "type": "json"
12530       }
12531     ],
12532     "name": "ShowFreshsales_Fields",
12533     "group": "Freshsales_Fields",
12534     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12535     "version": "0.0.0",
12536     "filename": "server/api/intFreshsalesField/index.js",
12537     "groupTitle": "Freshsales_Fields"
12538   },
12539   {
12540     "type": "put",
12541     "url": "/api/integrations/freshsales/fields/{id}",
12542     "title": "Update an existing Freshsales Field",
12543     "examples": [
12544       {
12545         "title": "Example usage:",
12546         "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",
12547         "type": "json"
12548       }
12549     ],
12550     "name": "updateFreshsales_Fields",
12551     "group": "Freshsales_Fields",
12552     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12553     "version": "0.0.0",
12554     "filename": "server/api/intFreshsalesField/index.js",
12555     "groupTitle": "Freshsales_Fields"
12556   },
12557   {
12558     "type": "post",
12559     "url": "/api/campaigns/{id}/blacklists",
12560     "title": "Add blacklists to an IVR campaign",
12561     "examples": [
12562       {
12563         "title": "Example usage:",
12564         "content": "curl https://{domain}/api/campaigns/{id}/blacklists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
12565         "type": "json"
12566       }
12567     ],
12568     "name": "AddBlackLists",
12569     "group": "IVR_Campaigns",
12570     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12571     "version": "0.0.0",
12572     "filename": "server/api/campaign/index.js",
12573     "groupTitle": "IVR_Campaigns"
12574   },
12575   {
12576     "type": "post",
12577     "url": "/api/campaigns/{id}/lists",
12578     "title": "Add lists to an IVR campaign",
12579     "examples": [
12580       {
12581         "title": "Example usage:",
12582         "content": "curl https://{domain}/api/campaigns/{id}/lists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
12583         "type": "json"
12584       }
12585     ],
12586     "name": "AddLists",
12587     "group": "IVR_Campaigns",
12588     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12589     "version": "0.0.0",
12590     "filename": "server/api/campaign/index.js",
12591     "groupTitle": "IVR_Campaigns"
12592   },
12593   {
12594     "type": "post",
12595     "url": "/api/campaigns/clone",
12596     "title": "Clone an existing IVR Campaign",
12597     "examples": [
12598       {
12599         "title": "Example usage:",
12600         "content": "curl https://{domain}/api/campaigns/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12601         "type": "json"
12602       }
12603     ],
12604     "name": "CloneIVR_Campaigns",
12605     "group": "IVR_Campaigns",
12606     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12607     "version": "0.0.0",
12608     "filename": "server/api/campaign/index.js",
12609     "groupTitle": "IVR_Campaigns"
12610   },
12611   {
12612     "type": "post",
12613     "url": "/api/campaigns",
12614     "title": "Creates a new IVR Campaign",
12615     "examples": [
12616       {
12617         "title": "Example usage:",
12618         "content": "curl https://{domain}/api/campaigns -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12619         "type": "json"
12620       }
12621     ],
12622     "name": "CreateIVR_Campaigns",
12623     "group": "IVR_Campaigns",
12624     "parameter": {
12625       "fields": {
12626         "Body": [
12627           {
12628             "group": "Body",
12629             "type": "String",
12630             "optional": false,
12631             "field": "name",
12632             "description": ""
12633           },
12634           {
12635             "group": "Body",
12636             "type": "String",
12637             "allowedValues": [
12638               "\"ivr\""
12639             ],
12640             "optional": false,
12641             "field": "type",
12642             "description": ""
12643           },
12644           {
12645             "group": "Body",
12646             "type": "String",
12647             "optional": true,
12648             "field": "description",
12649             "description": ""
12650           },
12651           {
12652             "group": "Body",
12653             "type": "Boolean",
12654             "optional": true,
12655             "field": "active",
12656             "description": "<p>Active/Disactive Campaign</p>"
12657           },
12658           {
12659             "group": "Body",
12660             "type": "Integer",
12661             "optional": true,
12662             "field": "limitCalls",
12663             "description": "<p>Max 200 calls.</p>"
12664           },
12665           {
12666             "group": "Body",
12667             "type": "String",
12668             "optional": true,
12669             "field": "dialOriginateCallerIdName",
12670             "description": ""
12671           },
12672           {
12673             "group": "Body",
12674             "type": "String",
12675             "optional": true,
12676             "field": "dialOriginateCallerIdNumber",
12677             "description": ""
12678           },
12679           {
12680             "group": "Body",
12681             "type": "Integer",
12682             "optional": true,
12683             "field": "dialOriginateTimeout",
12684             "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
12685           },
12686           {
12687             "group": "Body",
12688             "type": "Integer",
12689             "optional": true,
12690             "field": "dialCongestionMaxRetry",
12691             "description": "<p>#Congestion Retry (min:1, max:999)</p>"
12692           },
12693           {
12694             "group": "Body",
12695             "type": "Integer",
12696             "optional": true,
12697             "field": "dialCongestionRetryFrequency",
12698             "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
12699           },
12700           {
12701             "group": "Body",
12702             "type": "Integer",
12703             "optional": true,
12704             "field": "dialBusyMaxRetry",
12705             "description": "<p>#Busy Retry (min:1, max:999)</p>"
12706           },
12707           {
12708             "group": "Body",
12709             "type": "Integer",
12710             "optional": true,
12711             "field": "dialBusyRetryFrequency",
12712             "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
12713           },
12714           {
12715             "group": "Body",
12716             "type": "Integer",
12717             "optional": true,
12718             "field": "dialNoAnswerMaxRetry",
12719             "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
12720           },
12721           {
12722             "group": "Body",
12723             "type": "Integer",
12724             "optional": true,
12725             "field": "dialNoAnswerRetryFrequency",
12726             "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
12727           },
12728           {
12729             "group": "Body",
12730             "type": "Integer",
12731             "optional": true,
12732             "field": "dialGlobalMaxRetry",
12733             "description": "<p>#Global Max Retry (min:1, max:999)</p>"
12734           },
12735           {
12736             "group": "Body",
12737             "type": "String",
12738             "optional": true,
12739             "field": "dialTimezone",
12740             "description": ""
12741           },
12742           {
12743             "group": "Body",
12744             "type": "String",
12745             "optional": true,
12746             "field": "dialGlobalInterval",
12747             "description": ""
12748           },
12749           {
12750             "group": "Body",
12751             "type": "String",
12752             "allowedValues": [
12753               "\"always\"",
12754               "\"never\"",
12755               "\"onlyIfOpen\""
12756             ],
12757             "optional": true,
12758             "field": "dialCheckDuplicateType",
12759             "description": ""
12760           },
12761           {
12762             "group": "Body",
12763             "type": "Boolean",
12764             "optional": true,
12765             "field": "dialAMDActive",
12766             "description": "<p>Active/Disactive AMD</p>"
12767           },
12768           {
12769             "group": "Body",
12770             "type": "Integer",
12771             "optional": true,
12772             "field": "dialAMDInitialSilence",
12773             "description": "<p>#AMD Initial Silence</p>"
12774           },
12775           {
12776             "group": "Body",
12777             "type": "Integer",
12778             "optional": true,
12779             "field": "dialAMDGreeting",
12780             "description": "<p>#AMD Greeting</p>"
12781           },
12782           {
12783             "group": "Body",
12784             "type": "Integer",
12785             "optional": true,
12786             "field": "dialAMDAfterGreetingSilence",
12787             "description": "<p>#AMD After Greeting Silence</p>"
12788           },
12789           {
12790             "group": "Body",
12791             "type": "Integer",
12792             "optional": true,
12793             "field": "dialAMDTotalAnalysisTime",
12794             "description": "<p>#AMD Total Analysis Time</p>"
12795           },
12796           {
12797             "group": "Body",
12798             "type": "Integer",
12799             "optional": true,
12800             "field": "dialAMDMinWordLength",
12801             "description": "<p>#AMD Min Word Length</p>"
12802           },
12803           {
12804             "group": "Body",
12805             "type": "Integer",
12806             "optional": true,
12807             "field": "dialAMDBetweenWordsSilence",
12808             "description": "<p>#AMD Between Words Silence</p>"
12809           },
12810           {
12811             "group": "Body",
12812             "type": "Integer",
12813             "optional": true,
12814             "field": "dialAMDMaximumNumberOfWords",
12815             "description": "<p>#AMD Maximum Number Of Words</p>"
12816           },
12817           {
12818             "group": "Body",
12819             "type": "Integer",
12820             "optional": true,
12821             "field": "dialAMDSilenceThreshold",
12822             "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
12823           },
12824           {
12825             "group": "Body",
12826             "type": "Integer",
12827             "optional": true,
12828             "field": "dialAMDMaximumWordLength",
12829             "description": "<p>#AMD Maximum Word Length</p>"
12830           },
12831           {
12832             "group": "Body",
12833             "type": "String",
12834             "allowedValues": [
12835               "\"DESC\"",
12836               "\"ASC\""
12837             ],
12838             "optional": true,
12839             "field": "dialOrderByScheduledAt",
12840             "description": ""
12841           },
12842           {
12843             "group": "Body",
12844             "type": "String",
12845             "optional": true,
12846             "field": "dialPrefix",
12847             "description": ""
12848           },
12849           {
12850             "group": "Body",
12851             "type": "Integer",
12852             "optional": true,
12853             "field": "dialRandomLastDigitCallerIdNumber",
12854             "description": "<p>Random Last Digit (min:1, max:15)</p>"
12855           },
12856           {
12857             "group": "Body",
12858             "type": "Integer",
12859             "optional": true,
12860             "field": "dialCutDigit",
12861             "description": "<p>Cut Digit (min:1, max:15)</p>"
12862           },
12863           {
12864             "group": "Body",
12865             "type": "Integer",
12866             "optional": true,
12867             "field": "dialNoSuchNumberMaxRetry",
12868             "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
12869           },
12870           {
12871             "group": "Body",
12872             "type": "Integer",
12873             "optional": true,
12874             "field": "dialNoSuchNumberRetryFrequency",
12875             "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
12876           },
12877           {
12878             "group": "Body",
12879             "type": "Integer",
12880             "optional": true,
12881             "field": "dialDropMaxRetry",
12882             "description": "<p>#Drop Retry (min:1, max:999)</p>"
12883           },
12884           {
12885             "group": "Body",
12886             "type": "Integer",
12887             "optional": true,
12888             "field": "dialDropRetryFrequency",
12889             "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
12890           },
12891           {
12892             "group": "Body",
12893             "type": "Integer",
12894             "optional": true,
12895             "field": "dialAbandonedMaxRetry",
12896             "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
12897           },
12898           {
12899             "group": "Body",
12900             "type": "Integer",
12901             "optional": true,
12902             "field": "dialAbandonedRetryFrequency",
12903             "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
12904           },
12905           {
12906             "group": "Body",
12907             "type": "Integer",
12908             "optional": true,
12909             "field": "dialMachineMaxRetry",
12910             "description": "<p>#Machine Retry (min:1, max:999)</p>"
12911           },
12912           {
12913             "group": "Body",
12914             "type": "Integer",
12915             "optional": true,
12916             "field": "dialMachineRetryFrequency",
12917             "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
12918           },
12919           {
12920             "group": "Body",
12921             "type": "Integer",
12922             "optional": true,
12923             "field": "dialAgentRejectMaxRetry",
12924             "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
12925           },
12926           {
12927             "group": "Body",
12928             "type": "Integer",
12929             "optional": true,
12930             "field": "dialAgentRejectRetryFrequency",
12931             "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
12932           }
12933         ]
12934       }
12935     },
12936     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12937     "version": "0.0.0",
12938     "filename": "server/api/campaign/index.js",
12939     "groupTitle": "IVR_Campaigns"
12940   },
12941   {
12942     "type": "delete",
12943     "url": "/api/campaigns/{id}",
12944     "title": "Deletes a IVR Campaign",
12945     "examples": [
12946       {
12947         "title": "Example usage:",
12948         "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password} -X DELETE",
12949         "type": "json"
12950       }
12951     ],
12952     "name": "DeleteIVR_Campaigns",
12953     "group": "IVR_Campaigns",
12954     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12955     "version": "0.0.0",
12956     "filename": "server/api/campaign/index.js",
12957     "groupTitle": "IVR_Campaigns"
12958   },
12959   {
12960     "type": "get",
12961     "url": "/api/campaigns/{id}/blacklists",
12962     "title": "Get IVR campaign blacklists",
12963     "examples": [
12964       {
12965         "title": "Example usage:",
12966         "content": "curl https://{domain}/api/campaigns/{id}/blacklists -v -u {name}:{password} -X GET",
12967         "type": "json"
12968       }
12969     ],
12970     "name": "GetBlackLists",
12971     "group": "IVR_Campaigns",
12972     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12973     "version": "0.0.0",
12974     "filename": "server/api/campaign/index.js",
12975     "groupTitle": "IVR_Campaigns"
12976   },
12977   {
12978     "type": "get",
12979     "url": "/api/campaigns/{id}/finals",
12980     "title": "Gets IVR campaign hopper finals",
12981     "examples": [
12982       {
12983         "title": "Example usage:",
12984         "content": "curl https://{domain}/api/campaigns/{id}/hopper_finals -v -u {name}:{password}  -X GET",
12985         "type": "json"
12986       }
12987     ],
12988     "name": "GetHopperFinals",
12989     "group": "IVR_Campaigns",
12990     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12991     "version": "0.0.0",
12992     "filename": "server/api/campaign/index.js",
12993     "groupTitle": "IVR_Campaigns"
12994   },
12995   {
12996     "type": "get",
12997     "url": "/api/campaigns/{id}/hopper_histories",
12998     "title": "Gets IVR campaign hopper histories",
12999     "examples": [
13000       {
13001         "title": "Example usage:",
13002         "content": "curl https://{domain}/api/campaigns/{id}/hopper_histories -v -u {name}:{password} -X GET",
13003         "type": "json"
13004       }
13005     ],
13006     "name": "GetHopperHistories",
13007     "group": "IVR_Campaigns",
13008     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13009     "version": "0.0.0",
13010     "filename": "server/api/campaign/index.js",
13011     "groupTitle": "IVR_Campaigns"
13012   },
13013   {
13014     "type": "get",
13015     "url": "/api/campaigns/{id}/hoppers",
13016     "title": "Gets IVR campaign hoppers",
13017     "examples": [
13018       {
13019         "title": "Example usage:",
13020         "content": "curl https://{domain}/api/campaigns/{id}/hoppers -v -u {name}:{password} -X GET",
13021         "type": "json"
13022       }
13023     ],
13024     "name": "GetHoppers",
13025     "group": "IVR_Campaigns",
13026     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13027     "version": "0.0.0",
13028     "filename": "server/api/campaign/index.js",
13029     "groupTitle": "IVR_Campaigns"
13030   },
13031   {
13032     "type": "get",
13033     "url": "/api/campaigns",
13034     "title": "Gets a list of IVR Campaigns",
13035     "examples": [
13036       {
13037         "title": "Example usage:",
13038         "content": "curl https://{domain}/api/campaigns -v -u {name}:{password}",
13039         "type": "json"
13040       }
13041     ],
13042     "name": "GetIVR_Campaigns",
13043     "group": "IVR_Campaigns",
13044     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13045     "version": "0.0.0",
13046     "filename": "server/api/campaign/index.js",
13047     "groupTitle": "IVR_Campaigns"
13048   },
13049   {
13050     "type": "get",
13051     "url": "/api/campaigns/{id}/lists",
13052     "title": "Get IVR campaign lists",
13053     "examples": [
13054       {
13055         "title": "Example usage:",
13056         "content": "curl https://{domain}/api/campaigns/{id}/lists -v -u {name}:{password} -X GET",
13057         "type": "json"
13058       }
13059     ],
13060     "name": "GetLists",
13061     "group": "IVR_Campaigns",
13062     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13063     "version": "0.0.0",
13064     "filename": "server/api/campaign/index.js",
13065     "groupTitle": "IVR_Campaigns"
13066   },
13067   {
13068     "type": "delete",
13069     "url": "/api/campaigns/{id}/blacklists",
13070     "title": "Remove blacklists from an IVR Campaign",
13071     "examples": [
13072       {
13073         "title": "Example usage:",
13074         "content": "curl https://{domain}/api/campaigns/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
13075         "type": "json"
13076       }
13077     ],
13078     "name": "RemoveBlackLists",
13079     "group": "IVR_Campaigns",
13080     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13081     "version": "0.0.0",
13082     "filename": "server/api/campaign/index.js",
13083     "groupTitle": "IVR_Campaigns"
13084   },
13085   {
13086     "type": "delete",
13087     "url": "/api/campaigns/{id}/lists",
13088     "title": "Remove lists from an IVR Campaign",
13089     "examples": [
13090       {
13091         "title": "Example usage:",
13092         "content": "curl https://{domain}/api/campaigns/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
13093         "type": "json"
13094       }
13095     ],
13096     "name": "RemoveLists",
13097     "group": "IVR_Campaigns",
13098     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13099     "version": "0.0.0",
13100     "filename": "server/api/campaign/index.js",
13101     "groupTitle": "IVR_Campaigns"
13102   },
13103   {
13104     "type": "get",
13105     "url": "/api/campaigns/{id}",
13106     "title": "Gets a single IVR Campaign",
13107     "examples": [
13108       {
13109         "title": "Example usage:",
13110         "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password}",
13111         "type": "json"
13112       }
13113     ],
13114     "name": "ShowIVR_Campaigns",
13115     "group": "IVR_Campaigns",
13116     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13117     "version": "0.0.0",
13118     "filename": "server/api/campaign/index.js",
13119     "groupTitle": "IVR_Campaigns"
13120   },
13121   {
13122     "type": "get",
13123     "url": "/api/campaigns/{id}/blacks",
13124     "title": "Gets IVR campaign hopper blacks",
13125     "examples": [
13126       {
13127         "title": "Example usage:",
13128         "content": "curl https://{domain}/api/campaigns/{id}/hopper_black -v -u {name}:{password}  -X GET",
13129         "type": "json"
13130       }
13131     ],
13132     "name": "getHopperBlacks",
13133     "group": "IVR_Campaigns",
13134     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13135     "version": "0.0.0",
13136     "filename": "server/api/campaign/index.js",
13137     "groupTitle": "IVR_Campaigns"
13138   },
13139   {
13140     "type": "put",
13141     "url": "/api/campaigns/{id}",
13142     "title": "Update an existing IVR Campaign",
13143     "examples": [
13144       {
13145         "title": "Example usage:",
13146         "content": "curl https://{domain}/api/campaigns/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
13147         "type": "json"
13148       }
13149     ],
13150     "name": "updateIVR_Campaigns",
13151     "group": "IVR_Campaigns",
13152     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13153     "version": "0.0.0",
13154     "filename": "server/api/campaign/index.js",
13155     "groupTitle": "IVR_Campaigns"
13156   },
13157   {
13158     "type": "post",
13159     "url": "/api/integrations/reports",
13160     "title": "Creates a new Integration Report",
13161     "examples": [
13162       {
13163         "title": "Example usage:",
13164         "content": "curl https://{domain}/api/integrations/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13165         "type": "json"
13166       }
13167     ],
13168     "name": "CreateIntegration_Reports",
13169     "group": "Integration_Reports",
13170     "parameter": {
13171       "fields": {
13172         "Body": [
13173           {
13174             "group": "Body",
13175             "type": "String",
13176             "optional": true,
13177             "field": "integration",
13178             "description": ""
13179           },
13180           {
13181             "group": "Body",
13182             "type": "String",
13183             "optional": true,
13184             "field": "eventChannel",
13185             "description": ""
13186           },
13187           {
13188             "group": "Body",
13189             "type": "String",
13190             "optional": true,
13191             "field": "exitStatus",
13192             "description": ""
13193           },
13194           {
13195             "group": "Body",
13196             "type": "String",
13197             "optional": true,
13198             "field": "ticketId",
13199             "description": ""
13200           },
13201           {
13202             "group": "Body",
13203             "type": "Integer",
13204             "optional": true,
13205             "field": "integrationId",
13206             "description": ""
13207           },
13208           {
13209             "group": "Body",
13210             "type": "String",
13211             "optional": true,
13212             "field": "contacts",
13213             "description": ""
13214           },
13215           {
13216             "group": "Body",
13217             "type": "String",
13218             "optional": true,
13219             "field": "uniqueid",
13220             "description": ""
13221           },
13222           {
13223             "group": "Body",
13224             "type": "String",
13225             "optional": true,
13226             "field": "calleridnum",
13227             "description": ""
13228           },
13229           {
13230             "group": "Body",
13231             "type": "String",
13232             "optional": true,
13233             "field": "calleridname",
13234             "description": ""
13235           },
13236           {
13237             "group": "Body",
13238             "type": "String",
13239             "optional": true,
13240             "field": "queue",
13241             "description": ""
13242           },
13243           {
13244             "group": "Body",
13245             "type": "String",
13246             "optional": true,
13247             "field": "interface",
13248             "description": ""
13249           },
13250           {
13251             "group": "Body",
13252             "type": "String",
13253             "optional": true,
13254             "field": "membername",
13255             "description": ""
13256           },
13257           {
13258             "group": "Body",
13259             "type": "String",
13260             "optional": true,
13261             "field": "agentcalledAt",
13262             "description": ""
13263           },
13264           {
13265             "group": "Body",
13266             "type": "String",
13267             "optional": true,
13268             "field": "agentconnectAt",
13269             "description": ""
13270           },
13271           {
13272             "group": "Body",
13273             "type": "Integer",
13274             "optional": true,
13275             "field": "holdtime",
13276             "description": ""
13277           },
13278           {
13279             "group": "Body",
13280             "type": "Boolean",
13281             "optional": true,
13282             "field": "agentcomplete",
13283             "description": ""
13284           },
13285           {
13286             "group": "Body",
13287             "type": "String",
13288             "optional": true,
13289             "field": "agentcompleteAt",
13290             "description": ""
13291           },
13292           {
13293             "group": "Body",
13294             "type": "Integer",
13295             "optional": true,
13296             "field": "talktime",
13297             "description": ""
13298           },
13299           {
13300             "group": "Body",
13301             "type": "Boolean",
13302             "optional": true,
13303             "field": "agentacw",
13304             "description": ""
13305           },
13306           {
13307             "group": "Body",
13308             "type": "Integer",
13309             "optional": true,
13310             "field": "acwtime",
13311             "description": ""
13312           },
13313           {
13314             "group": "Body",
13315             "type": "String",
13316             "optional": true,
13317             "field": "reason",
13318             "description": ""
13319           },
13320           {
13321             "group": "Body",
13322             "type": "Boolean",
13323             "optional": true,
13324             "field": "agentringnoanswer",
13325             "description": ""
13326           },
13327           {
13328             "group": "Body",
13329             "type": "String",
13330             "optional": true,
13331             "field": "agentringnoanswerAt",
13332             "description": ""
13333           },
13334           {
13335             "group": "Body",
13336             "type": "Boolean",
13337             "optional": true,
13338             "field": "agentdump",
13339             "description": ""
13340           },
13341           {
13342             "group": "Body",
13343             "type": "String",
13344             "optional": true,
13345             "field": "agentdumpAt",
13346             "description": ""
13347           },
13348           {
13349             "group": "Body",
13350             "type": "String",
13351             "optional": true,
13352             "field": "lastevent",
13353             "description": ""
13354           },
13355           {
13356             "group": "Body",
13357             "type": "String",
13358             "optional": true,
13359             "field": "channel",
13360             "description": ""
13361           },
13362           {
13363             "group": "Body",
13364             "type": "Integer",
13365             "optional": true,
13366             "field": "channelstate",
13367             "description": ""
13368           },
13369           {
13370             "group": "Body",
13371             "type": "String",
13372             "optional": true,
13373             "field": "channelstatedesc",
13374             "description": ""
13375           },
13376           {
13377             "group": "Body",
13378             "type": "String",
13379             "optional": true,
13380             "field": "connectedlinenum",
13381             "description": ""
13382           },
13383           {
13384             "group": "Body",
13385             "type": "String",
13386             "optional": true,
13387             "field": "connectedlinename",
13388             "description": ""
13389           },
13390           {
13391             "group": "Body",
13392             "type": "String",
13393             "optional": true,
13394             "field": "language",
13395             "description": ""
13396           },
13397           {
13398             "group": "Body",
13399             "type": "String",
13400             "optional": true,
13401             "field": "accountcode",
13402             "description": ""
13403           },
13404           {
13405             "group": "Body",
13406             "type": "String",
13407             "optional": true,
13408             "field": "context",
13409             "description": ""
13410           },
13411           {
13412             "group": "Body",
13413             "type": "String",
13414             "optional": true,
13415             "field": "exten",
13416             "description": ""
13417           },
13418           {
13419             "group": "Body",
13420             "type": "String",
13421             "optional": true,
13422             "field": "priority",
13423             "description": ""
13424           },
13425           {
13426             "group": "Body",
13427             "type": "String",
13428             "optional": true,
13429             "field": "destchannel",
13430             "description": ""
13431           },
13432           {
13433             "group": "Body",
13434             "type": "Integer",
13435             "optional": true,
13436             "field": "destchannelstate",
13437             "description": ""
13438           },
13439           {
13440             "group": "Body",
13441             "type": "String",
13442             "optional": true,
13443             "field": "destchannelstatedesc",
13444             "description": ""
13445           },
13446           {
13447             "group": "Body",
13448             "type": "String",
13449             "optional": true,
13450             "field": "destcalleridnum",
13451             "description": ""
13452           },
13453           {
13454             "group": "Body",
13455             "type": "String",
13456             "optional": true,
13457             "field": "destcalleridname",
13458             "description": ""
13459           },
13460           {
13461             "group": "Body",
13462             "type": "String",
13463             "optional": true,
13464             "field": "destconnectedlinenum",
13465             "description": ""
13466           },
13467           {
13468             "group": "Body",
13469             "type": "String",
13470             "optional": true,
13471             "field": "destconnectedlinename",
13472             "description": ""
13473           },
13474           {
13475             "group": "Body",
13476             "type": "String",
13477             "optional": true,
13478             "field": "destlanguage",
13479             "description": ""
13480           },
13481           {
13482             "group": "Body",
13483             "type": "String",
13484             "optional": true,
13485             "field": "destaccountcode",
13486             "description": ""
13487           },
13488           {
13489             "group": "Body",
13490             "type": "String",
13491             "optional": true,
13492             "field": "destcontext",
13493             "description": ""
13494           },
13495           {
13496             "group": "Body",
13497             "type": "String",
13498             "optional": true,
13499             "field": "destexten",
13500             "description": ""
13501           },
13502           {
13503             "group": "Body",
13504             "type": "String",
13505             "optional": true,
13506             "field": "destpriority",
13507             "description": ""
13508           },
13509           {
13510             "group": "Body",
13511             "type": "String",
13512             "optional": true,
13513             "field": "destuniqueid",
13514             "description": ""
13515           },
13516           {
13517             "group": "Body",
13518             "type": "String",
13519             "optional": true,
13520             "field": "messageId",
13521             "description": ""
13522           },
13523           {
13524             "group": "Body",
13525             "type": "String",
13526             "optional": true,
13527             "field": "inReplyTo",
13528             "description": ""
13529           },
13530           {
13531             "group": "Body",
13532             "type": "String",
13533             "optional": true,
13534             "field": "subject",
13535             "description": ""
13536           },
13537           {
13538             "group": "Body",
13539             "type": "String",
13540             "optional": true,
13541             "field": "from",
13542             "description": ""
13543           },
13544           {
13545             "group": "Body",
13546             "type": "String",
13547             "optional": true,
13548             "field": "to",
13549             "description": ""
13550           },
13551           {
13552             "group": "Body",
13553             "type": "String",
13554             "optional": true,
13555             "field": "cc",
13556             "description": ""
13557           },
13558           {
13559             "group": "Body",
13560             "type": "Text",
13561             "optional": true,
13562             "field": "attachment",
13563             "description": ""
13564           },
13565           {
13566             "group": "Body",
13567             "type": "Text",
13568             "optional": true,
13569             "field": "html",
13570             "description": ""
13571           },
13572           {
13573             "group": "Body",
13574             "type": "Text",
13575             "optional": true,
13576             "field": "text",
13577             "description": ""
13578           },
13579           {
13580             "group": "Body",
13581             "type": "String",
13582             "allowedValues": [
13583               "\"SENT\"",
13584               "\"SENDING\"",
13585               "\"RECEIVED\"",
13586               "\"FAILED\""
13587             ],
13588             "optional": true,
13589             "field": "status",
13590             "description": ""
13591           },
13592           {
13593             "group": "Body",
13594             "type": "String",
13595             "optional": true,
13596             "field": "url",
13597             "description": ""
13598           },
13599           {
13600             "group": "Body",
13601             "type": "String",
13602             "optional": true,
13603             "field": "app",
13604             "description": ""
13605           },
13606           {
13607             "group": "Body",
13608             "type": "String",
13609             "optional": true,
13610             "field": "appdata",
13611             "description": ""
13612           },
13613           {
13614             "group": "Body",
13615             "type": "Integer",
13616             "optional": true,
13617             "field": "projectId",
13618             "description": ""
13619           }
13620         ]
13621       }
13622     },
13623     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13624     "version": "0.0.0",
13625     "filename": "server/api/integrationReport/index.js",
13626     "groupTitle": "Integration_Reports"
13627   },
13628   {
13629     "type": "delete",
13630     "url": "/api/integrations/reports/{id}",
13631     "title": "Deletes a Integration Report",
13632     "examples": [
13633       {
13634         "title": "Example usage:",
13635         "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password} -X DELETE",
13636         "type": "json"
13637       }
13638     ],
13639     "name": "DeleteIntegration_Reports",
13640     "group": "Integration_Reports",
13641     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13642     "version": "0.0.0",
13643     "filename": "server/api/integrationReport/index.js",
13644     "groupTitle": "Integration_Reports"
13645   },
13646   {
13647     "type": "get",
13648     "url": "/api/integrations/reports/describe",
13649     "title": "Gets table info about Integration Reports",
13650     "examples": [
13651       {
13652         "title": "Example usage:",
13653         "content": "curl https://{domain}/api/integrations/reports/describe -v -u {name}:{password}",
13654         "type": "json"
13655       }
13656     ],
13657     "name": "DescribeIntegration_Reports",
13658     "group": "Integration_Reports",
13659     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13660     "version": "0.0.0",
13661     "filename": "server/api/integrationReport/index.js",
13662     "groupTitle": "Integration_Reports"
13663   },
13664   {
13665     "type": "get",
13666     "url": "/api/integrations/reports",
13667     "title": "Gets a list of Integration Reports",
13668     "examples": [
13669       {
13670         "title": "Example usage:",
13671         "content": "curl https://{domain}/api/integrations/reports -v -u {name}:{password}",
13672         "type": "json"
13673       }
13674     ],
13675     "name": "GetIntegration_Reports",
13676     "group": "Integration_Reports",
13677     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13678     "version": "0.0.0",
13679     "filename": "server/api/integrationReport/index.js",
13680     "groupTitle": "Integration_Reports"
13681   },
13682   {
13683     "type": "get",
13684     "url": "/api/integrations/reports/{id}",
13685     "title": "Gets a single Integration Report",
13686     "examples": [
13687       {
13688         "title": "Example usage:",
13689         "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password}",
13690         "type": "json"
13691       }
13692     ],
13693     "name": "ShowIntegration_Reports",
13694     "group": "Integration_Reports",
13695     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13696     "version": "0.0.0",
13697     "filename": "server/api/integrationReport/index.js",
13698     "groupTitle": "Integration_Reports"
13699   },
13700   {
13701     "type": "put",
13702     "url": "/api/integrations/reports/{id}",
13703     "title": "Update an existing Integration Report",
13704     "examples": [
13705       {
13706         "title": "Example usage:",
13707         "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",
13708         "type": "json"
13709       }
13710     ],
13711     "name": "updateIntegration_Reports",
13712     "group": "Integration_Reports",
13713     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13714     "version": "0.0.0",
13715     "filename": "server/api/integrationReport/index.js",
13716     "groupTitle": "Integration_Reports"
13717   },
13718   {
13719     "type": "post",
13720     "url": "/api/intervals",
13721     "title": "Creates a new Interval",
13722     "examples": [
13723       {
13724         "title": "Example usage:",
13725         "content": "curl https://{domain}/api/intervals -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13726         "type": "json"
13727       }
13728     ],
13729     "name": "CreateIntervals",
13730     "group": "Intervals",
13731     "parameter": {
13732       "fields": {
13733         "Body": [
13734           {
13735             "group": "Body",
13736             "type": "String",
13737             "optional": true,
13738             "field": "name",
13739             "description": ""
13740           },
13741           {
13742             "group": "Body",
13743             "type": "String",
13744             "optional": true,
13745             "field": "description",
13746             "description": ""
13747           },
13748           {
13749             "group": "Body",
13750             "type": "String",
13751             "optional": true,
13752             "field": "interval",
13753             "description": ""
13754           }
13755         ]
13756       }
13757     },
13758     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13759     "version": "0.0.0",
13760     "filename": "server/api/interval/index.js",
13761     "groupTitle": "Intervals"
13762   },
13763   {
13764     "type": "delete",
13765     "url": "/api/intervals/{id}",
13766     "title": "Deletes a Interval",
13767     "examples": [
13768       {
13769         "title": "Example usage:",
13770         "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password} -X DELETE",
13771         "type": "json"
13772       }
13773     ],
13774     "name": "DeleteIntervals",
13775     "group": "Intervals",
13776     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13777     "version": "0.0.0",
13778     "filename": "server/api/interval/index.js",
13779     "groupTitle": "Intervals"
13780   },
13781   {
13782     "type": "get",
13783     "url": "/api/intervals",
13784     "title": "Gets a list of Intervals",
13785     "examples": [
13786       {
13787         "title": "Example usage:",
13788         "content": "curl https://{domain}/api/intervals -v -u {name}:{password}",
13789         "type": "json"
13790       }
13791     ],
13792     "name": "GetIntervals",
13793     "group": "Intervals",
13794     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13795     "version": "0.0.0",
13796     "filename": "server/api/interval/index.js",
13797     "groupTitle": "Intervals"
13798   },
13799   {
13800     "type": "get",
13801     "url": "/api/intervals/{id}",
13802     "title": "Gets a single Interval",
13803     "examples": [
13804       {
13805         "title": "Example usage:",
13806         "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password}",
13807         "type": "json"
13808       }
13809     ],
13810     "name": "ShowIntervals",
13811     "group": "Intervals",
13812     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13813     "version": "0.0.0",
13814     "filename": "server/api/interval/index.js",
13815     "groupTitle": "Intervals"
13816   },
13817   {
13818     "type": "post",
13819     "url": "/api/intervals/{id}/sub_intervals",
13820     "title": "Creates a new sub interval",
13821     "examples": [
13822       {
13823         "title": "Example usage:",
13824         "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",
13825         "type": "json"
13826       }
13827     ],
13828     "name": "addInterval",
13829     "group": "Intervals",
13830     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13831     "version": "0.0.0",
13832     "filename": "server/api/interval/index.js",
13833     "groupTitle": "Intervals"
13834   },
13835   {
13836     "type": "post",
13837     "url": "/api/intervals/{id}/sub_intervals/create_many",
13838     "title": "Create new sub intervals set",
13839     "examples": [
13840       {
13841         "title": "Example usage:",
13842         "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
13843         "type": "json"
13844       }
13845     ],
13846     "name": "addIntervals",
13847     "group": "Intervals",
13848     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13849     "version": "0.0.0",
13850     "filename": "server/api/interval/index.js",
13851     "groupTitle": "Intervals"
13852   },
13853   {
13854     "type": "get",
13855     "url": "/api/intervals/{id}/sub_intervals",
13856     "title": "Get sub intervals set",
13857     "examples": [
13858       {
13859         "title": "Example usage:",
13860         "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -v -u {name}:{password} -X GET",
13861         "type": "json"
13862       }
13863     ],
13864     "name": "getIntervals",
13865     "group": "Intervals",
13866     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13867     "version": "0.0.0",
13868     "filename": "server/api/interval/index.js",
13869     "groupTitle": "Intervals"
13870   },
13871   {
13872     "type": "put",
13873     "url": "/api/intervals/{id}",
13874     "title": "Update an existing Interval",
13875     "examples": [
13876       {
13877         "title": "Example usage:",
13878         "content": "curl https://{domain}/api/intervals/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
13879         "type": "json"
13880       }
13881     ],
13882     "name": "updateIntervals",
13883     "group": "Intervals",
13884     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13885     "version": "0.0.0",
13886     "filename": "server/api/interval/index.js",
13887     "groupTitle": "Intervals"
13888   },
13889   {
13890     "type": "post",
13891     "url": "/api/jira",
13892     "title": "Creates a new issue",
13893     "examples": [
13894       {
13895         "title": "Example usage:",
13896         "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}",
13897         "type": "json"
13898       }
13899     ],
13900     "name": "Creates_Issue",
13901     "group": "Issue",
13902     "parameter": {
13903       "fields": {
13904         "Body": [
13905           {
13906             "group": "Body",
13907             "type": "String",
13908             "allowedValues": [
13909               "\"Bug\""
13910             ],
13911             "optional": true,
13912             "field": "issuetype",
13913             "description": ""
13914           },
13915           {
13916             "group": "Body",
13917             "type": "String",
13918             "optional": false,
13919             "field": "summary",
13920             "description": ""
13921           },
13922           {
13923             "group": "Body",
13924             "type": "String",
13925             "optional": false,
13926             "field": "description",
13927             "description": ""
13928           }
13929         ]
13930       }
13931     },
13932     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13933     "version": "0.0.0",
13934     "filename": "server/api/jira/index.js",
13935     "groupTitle": "Issue"
13936   },
13937   {
13938     "type": "post",
13939     "url": "/api/jscripty/answers/reports",
13940     "title": "Creates a new Report",
13941     "examples": [
13942       {
13943         "title": "Example usage:",
13944         "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",
13945         "type": "json"
13946       }
13947     ],
13948     "name": "CreateReports",
13949     "group": "JscriptyAnswerReport",
13950     "parameter": {
13951       "fields": {
13952         "Body": [
13953           {
13954             "group": "Body",
13955             "type": "Text",
13956             "optional": true,
13957             "field": "question",
13958             "description": ""
13959           },
13960           {
13961             "group": "Body",
13962             "type": "Text",
13963             "optional": true,
13964             "field": "answer",
13965             "description": ""
13966           },
13967           {
13968             "group": "Body",
13969             "type": "String",
13970             "optional": true,
13971             "field": "membername",
13972             "description": ""
13973           },
13974           {
13975             "group": "Body",
13976             "type": "String",
13977             "optional": true,
13978             "field": "projectname",
13979             "description": ""
13980           },
13981           {
13982             "group": "Body",
13983             "type": "String",
13984             "optional": true,
13985             "field": "queue",
13986             "description": ""
13987           },
13988           {
13989             "group": "Body",
13990             "type": "String",
13991             "optional": true,
13992             "field": "uniqueid",
13993             "description": ""
13994           },
13995           {
13996             "group": "Body",
13997             "type": "String",
13998             "optional": true,
13999             "field": "calleridname",
14000             "description": ""
14001           },
14002           {
14003             "group": "Body",
14004             "type": "String",
14005             "optional": true,
14006             "field": "calleridnum",
14007             "description": ""
14008           },
14009           {
14010             "group": "Body",
14011             "type": "String",
14012             "optional": true,
14013             "field": "questionId",
14014             "description": ""
14015           }
14016         ]
14017       }
14018     },
14019     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14020     "version": "0.0.0",
14021     "filename": "server/api/jscriptyAnswerReport/index.js",
14022     "groupTitle": "JscriptyAnswerReport"
14023   },
14024   {
14025     "type": "delete",
14026     "url": "/api/jscripty/answers/reports/{id}",
14027     "title": "Deletes a Report",
14028     "examples": [
14029       {
14030         "title": "Example usage:",
14031         "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password} -X DELETE",
14032         "type": "json"
14033       }
14034     ],
14035     "name": "DeleteReports",
14036     "group": "JscriptyAnswerReport",
14037     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14038     "version": "0.0.0",
14039     "filename": "server/api/jscriptyAnswerReport/index.js",
14040     "groupTitle": "JscriptyAnswerReport"
14041   },
14042   {
14043     "type": "get",
14044     "url": "/api/jscripty/answers/reports/describe",
14045     "title": "Gets table info about Reports",
14046     "examples": [
14047       {
14048         "title": "Example usage:",
14049         "content": "curl https://{domain}/api/jscripty/answers/reports/describe -v -u {name}:{password}",
14050         "type": "json"
14051       }
14052     ],
14053     "name": "DescribeReports",
14054     "group": "JscriptyAnswerReport",
14055     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14056     "version": "0.0.0",
14057     "filename": "server/api/jscriptyAnswerReport/index.js",
14058     "groupTitle": "JscriptyAnswerReport"
14059   },
14060   {
14061     "type": "get",
14062     "url": "/api/jscripty/answers/reports",
14063     "title": "Gets a list of Reports",
14064     "examples": [
14065       {
14066         "title": "Example usage:",
14067         "content": "curl https://{domain}/api/jscripty/answers/reports -v -u {name}:{password}",
14068         "type": "json"
14069       }
14070     ],
14071     "name": "GetReports",
14072     "group": "JscriptyAnswerReport",
14073     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14074     "version": "0.0.0",
14075     "filename": "server/api/jscriptyAnswerReport/index.js",
14076     "groupTitle": "JscriptyAnswerReport"
14077   },
14078   {
14079     "type": "get",
14080     "url": "/api/jscripty/answers/reports/{id}",
14081     "title": "Gets a single Report",
14082     "examples": [
14083       {
14084         "title": "Example usage:",
14085         "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password}",
14086         "type": "json"
14087       }
14088     ],
14089     "name": "ShowReports",
14090     "group": "JscriptyAnswerReport",
14091     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14092     "version": "0.0.0",
14093     "filename": "server/api/jscriptyAnswerReport/index.js",
14094     "groupTitle": "JscriptyAnswerReport"
14095   },
14096   {
14097     "type": "put",
14098     "url": "/api/jscripty/answers/reports/{id}",
14099     "title": "Update an existing Report",
14100     "examples": [
14101       {
14102         "title": "Example usage:",
14103         "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",
14104         "type": "json"
14105       }
14106     ],
14107     "name": "updateReports",
14108     "group": "JscriptyAnswerReport",
14109     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14110     "version": "0.0.0",
14111     "filename": "server/api/jscriptyAnswerReport/index.js",
14112     "groupTitle": "JscriptyAnswerReport"
14113   },
14114   {
14115     "type": "post",
14116     "url": "/api/jscripty/questions/reports",
14117     "title": "Creates a new Report",
14118     "examples": [
14119       {
14120         "title": "Example usage:",
14121         "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",
14122         "type": "json"
14123       }
14124     ],
14125     "name": "CreateReports",
14126     "group": "JscriptyQuestionReport",
14127     "parameter": {
14128       "fields": {
14129         "Body": [
14130           {
14131             "group": "Body",
14132             "type": "Text",
14133             "optional": true,
14134             "field": "question",
14135             "description": ""
14136           },
14137           {
14138             "group": "Body",
14139             "type": "Text",
14140             "optional": true,
14141             "field": "answer",
14142             "description": ""
14143           },
14144           {
14145             "group": "Body",
14146             "type": "String",
14147             "optional": true,
14148             "field": "membername",
14149             "description": ""
14150           },
14151           {
14152             "group": "Body",
14153             "type": "String",
14154             "optional": true,
14155             "field": "projectname",
14156             "description": ""
14157           },
14158           {
14159             "group": "Body",
14160             "type": "String",
14161             "optional": true,
14162             "field": "queue",
14163             "description": ""
14164           },
14165           {
14166             "group": "Body",
14167             "type": "String",
14168             "optional": true,
14169             "field": "uniqueid",
14170             "description": ""
14171           },
14172           {
14173             "group": "Body",
14174             "type": "String",
14175             "optional": true,
14176             "field": "calleridname",
14177             "description": ""
14178           },
14179           {
14180             "group": "Body",
14181             "type": "String",
14182             "optional": true,
14183             "field": "calleridnum",
14184             "description": ""
14185           },
14186           {
14187             "group": "Body",
14188             "type": "String",
14189             "optional": true,
14190             "field": "questionId",
14191             "description": ""
14192           }
14193         ]
14194       }
14195     },
14196     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14197     "version": "0.0.0",
14198     "filename": "server/api/jscriptyQuestionReport/index.js",
14199     "groupTitle": "JscriptyQuestionReport"
14200   },
14201   {
14202     "type": "delete",
14203     "url": "/api/jscripty/questions/reports/{id}",
14204     "title": "Deletes a Report",
14205     "examples": [
14206       {
14207         "title": "Example usage:",
14208         "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password} -X DELETE",
14209         "type": "json"
14210       }
14211     ],
14212     "name": "DeleteReports",
14213     "group": "JscriptyQuestionReport",
14214     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14215     "version": "0.0.0",
14216     "filename": "server/api/jscriptyQuestionReport/index.js",
14217     "groupTitle": "JscriptyQuestionReport"
14218   },
14219   {
14220     "type": "get",
14221     "url": "/api/jscripty/questions/reports/describe",
14222     "title": "Gets table info about Reports",
14223     "examples": [
14224       {
14225         "title": "Example usage:",
14226         "content": "curl https://{domain}/api/jscripty/questions/reports/describe -v -u {name}:{password}",
14227         "type": "json"
14228       }
14229     ],
14230     "name": "DescribeReports",
14231     "group": "JscriptyQuestionReport",
14232     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14233     "version": "0.0.0",
14234     "filename": "server/api/jscriptyQuestionReport/index.js",
14235     "groupTitle": "JscriptyQuestionReport"
14236   },
14237   {
14238     "type": "get",
14239     "url": "/api/jscripty/questions/reports",
14240     "title": "Gets a list of Reports",
14241     "examples": [
14242       {
14243         "title": "Example usage:",
14244         "content": "curl https://{domain}/api/jscripty/questions/reports -v -u {name}:{password}",
14245         "type": "json"
14246       }
14247     ],
14248     "name": "GetReports",
14249     "group": "JscriptyQuestionReport",
14250     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/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>",
14251     "version": "0.0.0",
14252     "filename": "server/api/jscriptyQuestionReport/index.js",
14253     "groupTitle": "JscriptyQuestionReport"
14254   },
14255   {
14256     "type": "get",
14257     "url": "/api/jscripty/questions/reports/{id}",
14258     "title": "Gets a single Report",
14259     "examples": [
14260       {
14261         "title": "Example usage:",
14262         "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password}",
14263         "type": "json"
14264       }
14265     ],
14266     "name": "ShowReports",
14267     "group": "JscriptyQuestionReport",
14268     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14269     "version": "0.0.0",
14270     "filename": "server/api/jscriptyQuestionReport/index.js",
14271     "groupTitle": "JscriptyQuestionReport"
14272   },
14273   {
14274     "type": "put",
14275     "url": "/api/jscripty/questions/reports/{id}",
14276     "title": "Update an existing Report",
14277     "examples": [
14278       {
14279         "title": "Example usage:",
14280         "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",
14281         "type": "json"
14282       }
14283     ],
14284     "name": "updateReports",
14285     "group": "JscriptyQuestionReport",
14286     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14287     "version": "0.0.0",
14288     "filename": "server/api/jscriptyQuestionReport/index.js",
14289     "groupTitle": "JscriptyQuestionReport"
14290   },
14291   {
14292     "type": "post",
14293     "url": "/api/jscripty/sessions/reports",
14294     "title": "Creates a new Report",
14295     "examples": [
14296       {
14297         "title": "Example usage:",
14298         "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",
14299         "type": "json"
14300       }
14301     ],
14302     "name": "CreateReports",
14303     "group": "JscriptySessionReport",
14304     "parameter": {
14305       "fields": {
14306         "Body": [
14307           {
14308             "group": "Body",
14309             "type": "String",
14310             "optional": true,
14311             "field": "starttime",
14312             "description": ""
14313           },
14314           {
14315             "group": "Body",
14316             "type": "String",
14317             "optional": true,
14318             "field": "endtime",
14319             "description": ""
14320           },
14321           {
14322             "group": "Body",
14323             "type": "String",
14324             "optional": true,
14325             "field": "membername",
14326             "description": ""
14327           },
14328           {
14329             "group": "Body",
14330             "type": "String",
14331             "optional": true,
14332             "field": "projectname",
14333             "description": ""
14334           },
14335           {
14336             "group": "Body",
14337             "type": "String",
14338             "optional": true,
14339             "field": "queue",
14340             "description": ""
14341           },
14342           {
14343             "group": "Body",
14344             "type": "String",
14345             "optional": true,
14346             "field": "uniqueid",
14347             "description": ""
14348           },
14349           {
14350             "group": "Body",
14351             "type": "String",
14352             "optional": true,
14353             "field": "calleridname",
14354             "description": ""
14355           },
14356           {
14357             "group": "Body",
14358             "type": "String",
14359             "optional": true,
14360             "field": "calleridnum",
14361             "description": ""
14362           },
14363           {
14364             "group": "Body",
14365             "type": "Boolean",
14366             "optional": true,
14367             "field": "completed",
14368             "description": ""
14369           }
14370         ]
14371       }
14372     },
14373     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14374     "version": "0.0.0",
14375     "filename": "server/api/jscriptySessionReport/index.js",
14376     "groupTitle": "JscriptySessionReport"
14377   },
14378   {
14379     "type": "delete",
14380     "url": "/api/jscripty/sessions/reports/{id}",
14381     "title": "Deletes a Report",
14382     "examples": [
14383       {
14384         "title": "Example usage:",
14385         "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password} -X DELETE",
14386         "type": "json"
14387       }
14388     ],
14389     "name": "DeleteReports",
14390     "group": "JscriptySessionReport",
14391     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14392     "version": "0.0.0",
14393     "filename": "server/api/jscriptySessionReport/index.js",
14394     "groupTitle": "JscriptySessionReport"
14395   },
14396   {
14397     "type": "get",
14398     "url": "/api/jscripty/sessions/reports/describe",
14399     "title": "Gets table info about Reports",
14400     "examples": [
14401       {
14402         "title": "Example usage:",
14403         "content": "curl https://{domain}/api/jscripty/sessions/reports/describe -v -u {name}:{password}",
14404         "type": "json"
14405       }
14406     ],
14407     "name": "DescribeReports",
14408     "group": "JscriptySessionReport",
14409     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14410     "version": "0.0.0",
14411     "filename": "server/api/jscriptySessionReport/index.js",
14412     "groupTitle": "JscriptySessionReport"
14413   },
14414   {
14415     "type": "get",
14416     "url": "/api/jscripty/sessions/reports",
14417     "title": "Gets a list of Reports",
14418     "examples": [
14419       {
14420         "title": "Example usage:",
14421         "content": "curl https://{domain}/api/jscripty/sessions/reports -v -u {name}:{password}",
14422         "type": "json"
14423       }
14424     ],
14425     "name": "GetReports",
14426     "group": "JscriptySessionReport",
14427     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14428     "version": "0.0.0",
14429     "filename": "server/api/jscriptySessionReport/index.js",
14430     "groupTitle": "JscriptySessionReport"
14431   },
14432   {
14433     "type": "get",
14434     "url": "/api/jscripty/sessions/reports/{id}",
14435     "title": "Gets a single Report",
14436     "examples": [
14437       {
14438         "title": "Example usage:",
14439         "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password}",
14440         "type": "json"
14441       }
14442     ],
14443     "name": "ShowReports",
14444     "group": "JscriptySessionReport",
14445     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14446     "version": "0.0.0",
14447     "filename": "server/api/jscriptySessionReport/index.js",
14448     "groupTitle": "JscriptySessionReport"
14449   },
14450   {
14451     "type": "get",
14452     "url": "/api/jscripty/sessions/reports/{id}/questions",
14453     "title": "Gets Jscripty Session questions",
14454     "examples": [
14455       {
14456         "title": "Example usage:",
14457         "content": "curl https://{domain}/api/jscripty/sessions/reports/{id}/questions -v -u {name}:{password}  -X GET",
14458         "type": "json"
14459       }
14460     ],
14461     "name": "getQuestions",
14462     "group": "JscriptySessionReport",
14463     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14464     "version": "0.0.0",
14465     "filename": "server/api/jscriptySessionReport/index.js",
14466     "groupTitle": "JscriptySessionReport"
14467   },
14468   {
14469     "type": "put",
14470     "url": "/api/jscripty/sessions/reports/{id}",
14471     "title": "Update an existing Report",
14472     "examples": [
14473       {
14474         "title": "Example usage:",
14475         "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",
14476         "type": "json"
14477       }
14478     ],
14479     "name": "updateReports",
14480     "group": "JscriptySessionReport",
14481     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14482     "version": "0.0.0",
14483     "filename": "server/api/jscriptySessionReport/index.js",
14484     "groupTitle": "JscriptySessionReport"
14485   },
14486   {
14487     "type": "post",
14488     "url": "/api/jscripty/projects/clone",
14489     "title": "Clone an existing Project",
14490     "examples": [
14491       {
14492         "title": "Example usage:",
14493         "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",
14494         "type": "json"
14495       }
14496     ],
14497     "name": "CloneProjects",
14498     "group": "Jscripty_Projects",
14499     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14500     "version": "0.0.0",
14501     "filename": "server/api/jscriptyProject/index.js",
14502     "groupTitle": "Jscripty_Projects"
14503   },
14504   {
14505     "type": "post",
14506     "url": "/api/jscripty/projects",
14507     "title": "Creates a new Project",
14508     "examples": [
14509       {
14510         "title": "Example usage:",
14511         "content": "curl https://{domain}/api/jscripty/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
14512         "type": "json"
14513       }
14514     ],
14515     "name": "CreateProjects",
14516     "group": "Jscripty_Projects",
14517     "parameter": {
14518       "fields": {
14519         "Body": [
14520           {
14521             "group": "Body",
14522             "type": "String",
14523             "optional": true,
14524             "field": "name",
14525             "description": ""
14526           },
14527           {
14528             "group": "Body",
14529             "type": "String",
14530             "optional": true,
14531             "field": "description",
14532             "description": ""
14533           },
14534           {
14535             "group": "Body",
14536             "type": "Text",
14537             "optional": true,
14538             "field": "formData",
14539             "description": ""
14540           },
14541           {
14542             "group": "Body",
14543             "type": "Boolean",
14544             "optional": true,
14545             "field": "enableUncompleteSave",
14546             "description": ""
14547           },
14548           {
14549             "group": "Body",
14550             "type": "Boolean",
14551             "optional": true,
14552             "field": "sendUnpauseOnSubmit",
14553             "description": ""
14554           }
14555         ]
14556       }
14557     },
14558     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14559     "version": "0.0.0",
14560     "filename": "server/api/jscriptyProject/index.js",
14561     "groupTitle": "Jscripty_Projects"
14562   },
14563   {
14564     "type": "delete",
14565     "url": "/api/jscripty/projects/{id}",
14566     "title": "Deletes a Project",
14567     "examples": [
14568       {
14569         "title": "Example usage:",
14570         "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password} -X DELETE",
14571         "type": "json"
14572       }
14573     ],
14574     "name": "DeleteProjects",
14575     "group": "Jscripty_Projects",
14576     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14577     "version": "0.0.0",
14578     "filename": "server/api/jscriptyProject/index.js",
14579     "groupTitle": "Jscripty_Projects"
14580   },
14581   {
14582     "type": "get",
14583     "url": "/api/jscripty/projects",
14584     "title": "Gets a list of Projects",
14585     "examples": [
14586       {
14587         "title": "Example usage:",
14588         "content": "curl https://{domain}/api/jscripty/projects -v -u {name}:{password}",
14589         "type": "json"
14590       }
14591     ],
14592     "name": "GetProjects",
14593     "group": "Jscripty_Projects",
14594     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14595     "version": "0.0.0",
14596     "filename": "server/api/jscriptyProject/index.js",
14597     "groupTitle": "Jscripty_Projects"
14598   },
14599   {
14600     "type": "get",
14601     "url": "/api/jscripty/projects/{id}",
14602     "title": "Gets a single Project",
14603     "examples": [
14604       {
14605         "title": "Example usage:",
14606         "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password}",
14607         "type": "json"
14608       }
14609     ],
14610     "name": "ShowProjects",
14611     "group": "Jscripty_Projects",
14612     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14613     "version": "0.0.0",
14614     "filename": "server/api/jscriptyProject/index.js",
14615     "groupTitle": "Jscripty_Projects"
14616   },
14617   {
14618     "type": "get",
14619     "url": "/api/jscripty/projects/{id}/answers",
14620     "title": "Gets jscripty project answers",
14621     "examples": [
14622       {
14623         "title": "Example usage:",
14624         "content": "curl https://{domain}/api/jscripty/projects/{id}/answers -v -u {name}:{password}  -X GET",
14625         "type": "json"
14626       }
14627     ],
14628     "name": "getAnswers",
14629     "group": "Jscripty_Projects",
14630     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14631     "version": "0.0.0",
14632     "filename": "server/api/jscriptyProject/index.js",
14633     "groupTitle": "Jscripty_Projects"
14634   },
14635   {
14636     "type": "get",
14637     "url": "/api/jscripty/projects/{id}/sessions",
14638     "title": "Gets jscripty project sessions",
14639     "examples": [
14640       {
14641         "title": "Example usage:",
14642         "content": "curl https://{domain}/api/jscripty/projects/{id}/sessions -v -u {name}:{password}  -X GET",
14643         "type": "json"
14644       }
14645     ],
14646     "name": "getSessions",
14647     "group": "Jscripty_Projects",
14648     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14649     "version": "0.0.0",
14650     "filename": "server/api/jscriptyProject/index.js",
14651     "groupTitle": "Jscripty_Projects"
14652   },
14653   {
14654     "type": "get",
14655     "url": "/api/jscripty/projects/{id}/summary",
14656     "title": "Gets jscripty project summary",
14657     "examples": [
14658       {
14659         "title": "Example usage:",
14660         "content": "curl https://{domain}/api/jscripty/projects/{id}/summary -v -u {name}:{password}  -X GET",
14661         "type": "json"
14662       }
14663     ],
14664     "name": "getSummary",
14665     "group": "Jscripty_Projects",
14666     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14667     "version": "0.0.0",
14668     "filename": "server/api/jscriptyProject/index.js",
14669     "groupTitle": "Jscripty_Projects"
14670   },
14671   {
14672     "type": "put",
14673     "url": "/api/jscripty/projects/{id}",
14674     "title": "Update an existing Project",
14675     "examples": [
14676       {
14677         "title": "Example usage:",
14678         "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",
14679         "type": "json"
14680       }
14681     ],
14682     "name": "updateProjects",
14683     "group": "Jscripty_Projects",
14684     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14685     "version": "0.0.0",
14686     "filename": "server/api/jscriptyProject/index.js",
14687     "groupTitle": "Jscripty_Projects"
14688   },
14689   {
14690     "type": "get",
14691     "url": "/api/license",
14692     "title": "Gets License Info",
14693     "examples": [
14694       {
14695         "title": "Example usage:",
14696         "content": "curl https://{domain}/api/license -v -u {name}:{password} -X GET",
14697         "type": "json"
14698       }
14699     ],
14700     "name": "index",
14701     "group": "License",
14702     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14703     "version": "0.0.0",
14704     "filename": "server/api/license/index.js",
14705     "groupTitle": "License"
14706   },
14707   {
14708     "type": "put",
14709     "url": "/api/license/{id}",
14710     "title": "Update License Info",
14711     "examples": [
14712       {
14713         "title": "Example usage:",
14714         "content": "curl https://{domain}/api/license/{id} -v -u {name}:{password} -X PUT",
14715         "type": "json"
14716       }
14717     ],
14718     "name": "update",
14719     "group": "License",
14720     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14721     "version": "0.0.0",
14722     "filename": "server/api/license/index.js",
14723     "groupTitle": "License"
14724   },
14725   {
14726     "type": "post",
14727     "url": "/api/mail/accounts/{id}/users",
14728     "title": "Add agents to a mail account",
14729     "examples": [
14730       {
14731         "title": "Example usage:",
14732         "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",
14733         "type": "json"
14734       }
14735     ],
14736     "name": "AddAgents",
14737     "group": "Mail_Accounts",
14738     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14739     "version": "0.0.0",
14740     "filename": "server/api/mailAccount/index.js",
14741     "groupTitle": "Mail_Accounts"
14742   },
14743   {
14744     "type": "post",
14745     "url": "/api/mail/accounts/{id}/in_servers",
14746     "title": "Creates a new IMAP server",
14747     "examples": [
14748       {
14749         "title": "Example usage:",
14750         "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",
14751         "type": "json"
14752       }
14753     ],
14754     "name": "AddImap",
14755     "group": "Mail_Accounts",
14756     "parameter": {
14757       "fields": {
14758         "Body": [
14759           {
14760             "group": "Body",
14761             "type": "String",
14762             "optional": true,
14763             "field": "description",
14764             "description": ""
14765           },
14766           {
14767             "group": "Body",
14768             "type": "String",
14769             "optional": true,
14770             "field": "host",
14771             "description": ""
14772           },
14773           {
14774             "group": "Body",
14775             "type": "Boolean",
14776             "optional": true,
14777             "field": "authentication",
14778             "description": ""
14779           },
14780           {
14781             "group": "Body",
14782             "type": "String",
14783             "optional": true,
14784             "field": "user",
14785             "description": ""
14786           },
14787           {
14788             "group": "Body",
14789             "type": "String",
14790             "optional": true,
14791             "field": "password",
14792             "description": ""
14793           },
14794           {
14795             "group": "Body",
14796             "type": "Integer",
14797             "optional": true,
14798             "field": "port",
14799             "description": ""
14800           },
14801           {
14802             "group": "Body",
14803             "type": "Boolean",
14804             "optional": true,
14805             "field": "tls",
14806             "description": ""
14807           },
14808           {
14809             "group": "Body",
14810             "type": "String",
14811             "optional": true,
14812             "field": "mailbox",
14813             "description": ""
14814           },
14815           {
14816             "group": "Body",
14817             "type": "Integer",
14818             "optional": true,
14819             "field": "connTimeout",
14820             "description": ""
14821           },
14822           {
14823             "group": "Body",
14824             "type": "Integer",
14825             "optional": true,
14826             "field": "authTimeout",
14827             "description": ""
14828           },
14829           {
14830             "group": "Body",
14831             "type": "String",
14832             "optional": true,
14833             "field": "service",
14834             "description": ""
14835           }
14836         ]
14837       }
14838     },
14839     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14840     "version": "0.0.0",
14841     "filename": "server/api/mailAccount/index.js",
14842     "groupTitle": "Mail_Accounts"
14843   },
14844   {
14845     "type": "post",
14846     "url": "/api/mail/accounts/{id}/out_servers",
14847     "title": "Creates a new SMTP server",
14848     "examples": [
14849       {
14850         "title": "Example usage:",
14851         "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",
14852         "type": "json"
14853       }
14854     ],
14855     "name": "AddSmtp",
14856     "group": "Mail_Accounts",
14857     "parameter": {
14858       "fields": {
14859         "Body": [
14860           {
14861             "group": "Body",
14862             "type": "String",
14863             "optional": true,
14864             "field": "description",
14865             "description": ""
14866           },
14867           {
14868             "group": "Body",
14869             "type": "String",
14870             "optional": true,
14871             "field": "host",
14872             "description": ""
14873           },
14874           {
14875             "group": "Body",
14876             "type": "String",
14877             "optional": true,
14878             "field": "user",
14879             "description": ""
14880           },
14881           {
14882             "group": "Body",
14883             "type": "String",
14884             "optional": true,
14885             "field": "pass",
14886             "description": ""
14887           },
14888           {
14889             "group": "Body",
14890             "type": "Integer",
14891             "optional": true,
14892             "field": "port",
14893             "description": ""
14894           },
14895           {
14896             "group": "Body",
14897             "type": "Boolean",
14898             "optional": true,
14899             "field": "secure",
14900             "description": ""
14901           },
14902           {
14903             "group": "Body",
14904             "type": "String",
14905             "optional": true,
14906             "field": "service",
14907             "description": ""
14908           },
14909           {
14910             "group": "Body",
14911             "type": "Boolean",
14912             "optional": true,
14913             "field": "authentication",
14914             "description": ""
14915           }
14916         ]
14917       }
14918     },
14919     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14920     "version": "0.0.0",
14921     "filename": "server/api/mailAccount/index.js",
14922     "groupTitle": "Mail_Accounts"
14923   },
14924   {
14925     "type": "delete",
14926     "url": "/api/mail/accounts/{id}",
14927     "title": "Deletes a mail account",
14928     "examples": [
14929       {
14930         "title": "Example usage:",
14931         "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password} -X DELETE",
14932         "type": "json"
14933       }
14934     ],
14935     "name": "DeleteMailAccounts",
14936     "group": "Mail_Accounts",
14937     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14938     "version": "0.0.0",
14939     "filename": "server/api/mailAccount/index.js",
14940     "groupTitle": "Mail_Accounts"
14941   },
14942   {
14943     "type": "get",
14944     "url": "/api/mail/accounts/describe",
14945     "title": "Gets table info about Accounts",
14946     "examples": [
14947       {
14948         "title": "Example usage:",
14949         "content": "curl https://{domain}/api/mail/accounts/describe -v -u {name}:{password}",
14950         "type": "json"
14951       }
14952     ],
14953     "name": "DescribeAccounts",
14954     "group": "Mail_Accounts",
14955     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14956     "version": "0.0.0",
14957     "filename": "server/api/mailAccount/index.js",
14958     "groupTitle": "Mail_Accounts"
14959   },
14960   {
14961     "type": "get",
14962     "url": "/api/mail/accounts",
14963     "title": "Gets a list of Accounts",
14964     "examples": [
14965       {
14966         "title": "Example usage:",
14967         "content": "curl https://{domain}/api/mail/accounts -v -u {name}:{password}",
14968         "type": "json"
14969       }
14970     ],
14971     "name": "GetAccounts",
14972     "group": "Mail_Accounts",
14973     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14974     "version": "0.0.0",
14975     "filename": "server/api/mailAccount/index.js",
14976     "groupTitle": "Mail_Accounts"
14977   },
14978   {
14979     "type": "get",
14980     "url": "/api/mail/accounts/{id}/users",
14981     "title": "Gets agents from mail account",
14982     "examples": [
14983       {
14984         "title": "Example usage:",
14985         "content": "curl https://{domain}/api/mail/accounts/{id}/users -v -u {name}:{password} -X GET",
14986         "type": "json"
14987       }
14988     ],
14989     "name": "GetAgents",
14990     "group": "Mail_Accounts",
14991     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14992     "version": "0.0.0",
14993     "filename": "server/api/mailAccount/index.js",
14994     "groupTitle": "Mail_Accounts"
14995   },
14996   {
14997     "type": "get",
14998     "url": "/api/mail/accounts/{id}/in_servers",
14999     "title": "Gets account IMAP server",
15000     "examples": [
15001       {
15002         "title": "Example usage:",
15003         "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X GET",
15004         "type": "json"
15005       }
15006     ],
15007     "name": "GetImap",
15008     "group": "Mail_Accounts",
15009     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15010     "version": "0.0.0",
15011     "filename": "server/api/mailAccount/index.js",
15012     "groupTitle": "Mail_Accounts"
15013   },
15014   {
15015     "type": "get",
15016     "url": "/api/mail/accounts/{id}/out_servers",
15017     "title": "Gets account SMTP server",
15018     "examples": [
15019       {
15020         "title": "Example usage:",
15021         "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X GET",
15022         "type": "json"
15023       }
15024     ],
15025     "name": "GetSmtp",
15026     "group": "Mail_Accounts",
15027     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15028     "version": "0.0.0",
15029     "filename": "server/api/mailAccount/index.js",
15030     "groupTitle": "Mail_Accounts"
15031   },
15032   {
15033     "type": "delete",
15034     "url": "/api/mail/accounts/{id}/users",
15035     "title": "Removes agents from a mail account",
15036     "examples": [
15037       {
15038         "title": "Example usage:",
15039         "content": "curl https://{domain}/api/mail/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15040         "type": "json"
15041       }
15042     ],
15043     "name": "RemoveAgents",
15044     "group": "Mail_Accounts",
15045     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15046     "version": "0.0.0",
15047     "filename": "server/api/mailAccount/index.js",
15048     "groupTitle": "Mail_Accounts"
15049   },
15050   {
15051     "type": "delete",
15052     "url": "/api/mail/accounts/{id}/canned_answers",
15053     "title": "Removes canned answers from account",
15054     "examples": [
15055       {
15056         "title": "Example usage:",
15057         "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15058         "type": "json"
15059       }
15060     ],
15061     "name": "RemoveAnswers",
15062     "group": "Mail_Accounts",
15063     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15064     "version": "0.0.0",
15065     "filename": "server/api/mailAccount/index.js",
15066     "groupTitle": "Mail_Accounts"
15067   },
15068   {
15069     "type": "delete",
15070     "url": "/api/mail/accounts/{id}/dispositions",
15071     "title": "Removes dispositions from account",
15072     "examples": [
15073       {
15074         "title": "Example usage:",
15075         "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15076         "type": "json"
15077       }
15078     ],
15079     "name": "RemoveDispositions",
15080     "group": "Mail_Accounts",
15081     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15082     "version": "0.0.0",
15083     "filename": "server/api/mailAccount/index.js",
15084     "groupTitle": "Mail_Accounts"
15085   },
15086   {
15087     "type": "delete",
15088     "url": "/api/mail/accounts/{id}/in_servers",
15089     "title": "Removes IMAP server from an account",
15090     "examples": [
15091       {
15092         "title": "Example usage:",
15093         "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X DELETE",
15094         "type": "json"
15095       }
15096     ],
15097     "name": "RemoveImmap",
15098     "group": "Mail_Accounts",
15099     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15100     "version": "0.0.0",
15101     "filename": "server/api/mailAccount/index.js",
15102     "groupTitle": "Mail_Accounts"
15103   },
15104   {
15105     "type": "delete",
15106     "url": "/api/mail/accounts/{id}/out_servers",
15107     "title": "Removes SMTP server from an account",
15108     "examples": [
15109       {
15110         "title": "Example usage:",
15111         "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X DELETE",
15112         "type": "json"
15113       }
15114     ],
15115     "name": "RemoveSmtp",
15116     "group": "Mail_Accounts",
15117     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15118     "version": "0.0.0",
15119     "filename": "server/api/mailAccount/index.js",
15120     "groupTitle": "Mail_Accounts"
15121   },
15122   {
15123     "type": "get",
15124     "url": "/api/mail/accounts/{id}",
15125     "title": "Gets a single Account",
15126     "examples": [
15127       {
15128         "title": "Example usage:",
15129         "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password}",
15130         "type": "json"
15131       }
15132     ],
15133     "name": "ShowAccounts",
15134     "group": "Mail_Accounts",
15135     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15136     "version": "0.0.0",
15137     "filename": "server/api/mailAccount/index.js",
15138     "groupTitle": "Mail_Accounts"
15139   },
15140   {
15141     "type": "post",
15142     "url": "/api/mail/accounts/{id}/canned_answers",
15143     "title": "Creates new canned answer",
15144     "examples": [
15145       {
15146         "title": "Example usage:",
15147         "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",
15148         "type": "json"
15149       }
15150     ],
15151     "name": "addAnswer",
15152     "group": "Mail_Accounts",
15153     "parameter": {
15154       "fields": {
15155         "Body": [
15156           {
15157             "group": "Body",
15158             "type": "String",
15159             "optional": false,
15160             "field": "key",
15161             "description": ""
15162           },
15163           {
15164             "group": "Body",
15165             "type": "Text",
15166             "optional": false,
15167             "field": "value",
15168             "description": ""
15169           },
15170           {
15171             "group": "Body",
15172             "type": "String",
15173             "optional": true,
15174             "field": "description",
15175             "description": ""
15176           },
15177           {
15178             "group": "Body",
15179             "type": "Virtual",
15180             "optional": true,
15181             "field": "name",
15182             "description": ""
15183           }
15184         ]
15185       }
15186     },
15187     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15188     "version": "0.0.0",
15189     "filename": "server/api/mailAccount/index.js",
15190     "groupTitle": "Mail_Accounts"
15191   },
15192   {
15193     "type": "post",
15194     "url": "/api/mail/accounts/{id}/applications",
15195     "title": "Creates new applications",
15196     "examples": [
15197       {
15198         "title": "Example usage:",
15199         "content": "curl https://{domain}/api/mail/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15200         "type": "json"
15201       }
15202     ],
15203     "name": "addApplications",
15204     "group": "Mail_Accounts",
15205     "parameter": {
15206       "fields": {
15207         "Body": [
15208           {
15209             "group": "Body",
15210             "type": "Integer",
15211             "optional": false,
15212             "field": "priority",
15213             "description": ""
15214           },
15215           {
15216             "group": "Body",
15217             "type": "String",
15218             "optional": false,
15219             "field": "app",
15220             "description": ""
15221           },
15222           {
15223             "group": "Body",
15224             "type": "Text",
15225             "optional": true,
15226             "field": "appdata",
15227             "description": ""
15228           },
15229           {
15230             "group": "Body",
15231             "type": "String",
15232             "optional": true,
15233             "field": "description",
15234             "description": ""
15235           },
15236           {
15237             "group": "Body",
15238             "type": "String",
15239             "optional": true,
15240             "field": "interval",
15241             "description": ""
15242           }
15243         ]
15244       }
15245     },
15246     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15247     "version": "0.0.0",
15248     "filename": "server/api/mailAccount/index.js",
15249     "groupTitle": "Mail_Accounts"
15250   },
15251   {
15252     "type": "post",
15253     "url": "/api/mail/accounts/{id}/dispositions",
15254     "title": "Creates new disposition",
15255     "examples": [
15256       {
15257         "title": "Example usage:",
15258         "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15259         "type": "json"
15260       }
15261     ],
15262     "name": "addDisposition",
15263     "group": "Mail_Accounts",
15264     "parameter": {
15265       "fields": {
15266         "Body": [
15267           {
15268             "group": "Body",
15269             "type": "String",
15270             "optional": false,
15271             "field": "name",
15272             "description": ""
15273           },
15274           {
15275             "group": "Body",
15276             "type": "String",
15277             "allowedValues": [
15278               "\"first\"",
15279               "\"second\"",
15280               "\"third\""
15281             ],
15282             "optional": false,
15283             "field": "level",
15284             "description": ""
15285           },
15286           {
15287             "group": "Body",
15288             "type": "String",
15289             "optional": true,
15290             "field": "description",
15291             "description": ""
15292           }
15293         ]
15294       }
15295     },
15296     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15297     "version": "0.0.0",
15298     "filename": "server/api/mailAccount/index.js",
15299     "groupTitle": "Mail_Accounts"
15300   },
15301   {
15302     "type": "post",
15303     "url": "/api/mail/accounts/{id}/interactions",
15304     "title": "Creates new interactions",
15305     "examples": [
15306       {
15307         "title": "Example usage:",
15308         "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",
15309         "type": "json"
15310       }
15311     ],
15312     "name": "addInteraction",
15313     "group": "Mail_Accounts",
15314     "parameter": {
15315       "fields": {
15316         "Body": [
15317           {
15318             "group": "Body",
15319             "type": "Boolean",
15320             "optional": true,
15321             "field": "closed",
15322             "description": ""
15323           },
15324           {
15325             "group": "Body",
15326             "type": "String",
15327             "optional": true,
15328             "field": "closedAt",
15329             "description": ""
15330           },
15331           {
15332             "group": "Body",
15333             "type": "String",
15334             "optional": true,
15335             "field": "disposition",
15336             "description": ""
15337           },
15338           {
15339             "group": "Body",
15340             "type": "String",
15341             "optional": true,
15342             "field": "secondDisposition",
15343             "description": ""
15344           },
15345           {
15346             "group": "Body",
15347             "type": "String",
15348             "optional": true,
15349             "field": "thirdDisposition",
15350             "description": ""
15351           },
15352           {
15353             "group": "Body",
15354             "type": "String",
15355             "optional": true,
15356             "field": "note",
15357             "description": ""
15358           },
15359           {
15360             "group": "Body",
15361             "type": "String",
15362             "optional": true,
15363             "field": "inReplyTo",
15364             "description": ""
15365           },
15366           {
15367             "group": "Body",
15368             "type": "String",
15369             "optional": true,
15370             "field": "to",
15371             "description": ""
15372           },
15373           {
15374             "group": "Body",
15375             "type": "Text",
15376             "optional": true,
15377             "field": "cc",
15378             "description": ""
15379           },
15380           {
15381             "group": "Body",
15382             "type": "Text",
15383             "optional": true,
15384             "field": "subject",
15385             "description": ""
15386           },
15387           {
15388             "group": "Body",
15389             "type": "Boolean",
15390             "optional": true,
15391             "field": "attach",
15392             "description": ""
15393           },
15394           {
15395             "group": "Body",
15396             "type": "String",
15397             "optional": true,
15398             "field": "read1stAt",
15399             "description": ""
15400           },
15401           {
15402             "group": "Body",
15403             "type": "String",
15404             "optional": true,
15405             "field": "substatus",
15406             "description": ""
15407           },
15408           {
15409             "group": "Body",
15410             "type": "String",
15411             "optional": true,
15412             "field": "substatusAt",
15413             "description": ""
15414           },
15415           {
15416             "group": "Body",
15417             "type": "String",
15418             "allowedValues": [
15419               "\"in\"",
15420               "\"out\""
15421             ],
15422             "optional": false,
15423             "field": "firstMsgDirection",
15424             "description": ""
15425           },
15426           {
15427             "group": "Body",
15428             "type": "String",
15429             "optional": true,
15430             "field": "lastMsgAt",
15431             "description": ""
15432           },
15433           {
15434             "group": "Body",
15435             "type": "String",
15436             "allowedValues": [
15437               "\"in\"",
15438               "\"out\""
15439             ],
15440             "optional": false,
15441             "field": "lastMsgDirection",
15442             "description": ""
15443           }
15444         ]
15445       }
15446     },
15447     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15448     "version": "0.0.0",
15449     "filename": "server/api/mailAccount/index.js",
15450     "groupTitle": "Mail_Accounts"
15451   },
15452   {
15453     "type": "post",
15454     "url": "/api/mail/accounts",
15455     "title": "Create a mail account",
15456     "examples": [
15457       {
15458         "title": "Example usage:",
15459         "content": "curl https://{domain}/api/mail/accounts \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15460         "type": "json"
15461       }
15462     ],
15463     "name": "create",
15464     "group": "Mail_Accounts",
15465     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15466     "version": "0.0.0",
15467     "filename": "server/api/mailAccount/index.js",
15468     "groupTitle": "Mail_Accounts"
15469   },
15470   {
15471     "type": "get",
15472     "url": "/api/mail/accounts/{id}/canned_answers",
15473     "title": "Gets account canned answers",
15474     "examples": [
15475       {
15476         "title": "Example usage:",
15477         "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
15478         "type": "json"
15479       }
15480     ],
15481     "name": "getAnswers",
15482     "group": "Mail_Accounts",
15483     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15484     "version": "0.0.0",
15485     "filename": "server/api/mailAccount/index.js",
15486     "groupTitle": "Mail_Accounts"
15487   },
15488   {
15489     "type": "get",
15490     "url": "/api/mail/accounts/{id}/applications",
15491     "title": "Gets account applications",
15492     "examples": [
15493       {
15494         "title": "Example usage:",
15495         "content": "curl https://{domain}/api/mail/accounts/{id}/applications -v -u {name}:{password} -X GET",
15496         "type": "json"
15497       }
15498     ],
15499     "name": "getApplications",
15500     "group": "Mail_Accounts",
15501     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15502     "version": "0.0.0",
15503     "filename": "server/api/mailAccount/index.js",
15504     "groupTitle": "Mail_Accounts"
15505   },
15506   {
15507     "type": "get",
15508     "url": "/api/mail/accounts/{id}/dispositions",
15509     "title": "Gets account dispositions",
15510     "examples": [
15511       {
15512         "title": "Example usage:",
15513         "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
15514         "type": "json"
15515       }
15516     ],
15517     "name": "getDispositions",
15518     "group": "Mail_Accounts",
15519     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15520     "version": "0.0.0",
15521     "filename": "server/api/mailAccount/index.js",
15522     "groupTitle": "Mail_Accounts"
15523   },
15524   {
15525     "type": "get",
15526     "url": "/api/mail/accounts/{id}/interactions",
15527     "title": "Gets account interactions",
15528     "examples": [
15529       {
15530         "title": "Example usage:",
15531         "content": "curl https://{domain}/api/mail/accounts/{id}/interactions -v -u {name}:{password} -X GET",
15532         "type": "json"
15533       }
15534     ],
15535     "name": "getInteraction",
15536     "group": "Mail_Accounts",
15537     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15538     "version": "0.0.0",
15539     "filename": "server/api/mailAccount/index.js",
15540     "groupTitle": "Mail_Accounts"
15541   },
15542   {
15543     "type": "get",
15544     "url": "/api/mail/accounts/{id}/messages",
15545     "title": "Gets account messages",
15546     "examples": [
15547       {
15548         "title": "Example usage:",
15549         "content": "curl https://{domain}/api/mail/accounts/{id}/messages -v -u {name}:{password} -X GET",
15550         "type": "json"
15551       }
15552     ],
15553     "name": "getMessages",
15554     "group": "Mail_Accounts",
15555     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15556     "version": "0.0.0",
15557     "filename": "server/api/mailAccount/index.js",
15558     "groupTitle": "Mail_Accounts"
15559   },
15560   {
15561     "type": "post",
15562     "url": "/api/mail/accounts/{id}/send",
15563     "title": "Send new mail",
15564     "examples": [
15565       {
15566         "title": "Example usage:",
15567         "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",
15568         "type": "json"
15569       }
15570     ],
15571     "name": "sendMail",
15572     "group": "Mail_Accounts",
15573     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15574     "version": "0.0.0",
15575     "filename": "server/api/mailAccount/index.js",
15576     "groupTitle": "Mail_Accounts"
15577   },
15578   {
15579     "type": "put",
15580     "url": "/api/mail/accounts/{id}",
15581     "title": "Update an existing Account",
15582     "examples": [
15583       {
15584         "title": "Example usage:",
15585         "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",
15586         "type": "json"
15587       }
15588     ],
15589     "name": "updateAccounts",
15590     "group": "Mail_Accounts",
15591     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15592     "version": "0.0.0",
15593     "filename": "server/api/mailAccount/index.js",
15594     "groupTitle": "Mail_Accounts"
15595   },
15596   {
15597     "type": "get",
15598     "url": "/api/mail/accounts/{id}/verify",
15599     "title": "Verify mail account",
15600     "examples": [
15601       {
15602         "title": "Example usage:",
15603         "content": "curl https://{domain}/api/mail/accounts/{id}/verify -v -u {name}:{password} -X GET",
15604         "type": "json"
15605       }
15606     ],
15607     "name": "verifySmtp",
15608     "group": "Mail_Accounts",
15609     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15610     "version": "0.0.0",
15611     "filename": "server/api/mailAccount/index.js",
15612     "groupTitle": "Mail_Accounts"
15613   },
15614   {
15615     "type": "delete",
15616     "url": "/api/mail/applications/{id}",
15617     "title": "Deletes a Application",
15618     "examples": [
15619       {
15620         "title": "Example usage:",
15621         "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password} -X DELETE",
15622         "type": "json"
15623       }
15624     ],
15625     "name": "DeleteApplications",
15626     "group": "Mail_Applications",
15627     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15628     "version": "0.0.0",
15629     "filename": "server/api/mailApplication/index.js",
15630     "groupTitle": "Mail_Applications"
15631   },
15632   {
15633     "type": "get",
15634     "url": "/api/mail/applications/{id}",
15635     "title": "Gets a single Application",
15636     "examples": [
15637       {
15638         "title": "Example usage:",
15639         "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password}",
15640         "type": "json"
15641       }
15642     ],
15643     "name": "ShowApplications",
15644     "group": "Mail_Applications",
15645     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15646     "version": "0.0.0",
15647     "filename": "server/api/mailApplication/index.js",
15648     "groupTitle": "Mail_Applications"
15649   },
15650   {
15651     "type": "put",
15652     "url": "/api/mail/applications/{id}",
15653     "title": "Update an existing Application",
15654     "examples": [
15655       {
15656         "title": "Example usage:",
15657         "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",
15658         "type": "json"
15659       }
15660     ],
15661     "name": "updateApplications",
15662     "group": "Mail_Applications",
15663     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15664     "version": "0.0.0",
15665     "filename": "server/api/mailApplication/index.js",
15666     "groupTitle": "Mail_Applications"
15667   },
15668   {
15669     "type": "post",
15670     "url": "/api/mail/interactions/{id}/tags",
15671     "title": "Add tags to the interaction",
15672     "examples": [
15673       {
15674         "title": "Example usage:",
15675         "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",
15676         "type": "json"
15677       }
15678     ],
15679     "name": "AddTags",
15680     "group": "Mail_Interactions",
15681     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15682     "version": "0.0.0",
15683     "filename": "server/api/mailInteraction/index.js",
15684     "groupTitle": "Mail_Interactions"
15685   },
15686   {
15687     "type": "post",
15688     "url": "/api/mail/interactions",
15689     "title": "Creates a new Interaction",
15690     "examples": [
15691       {
15692         "title": "Example usage:",
15693         "content": "curl https://{domain}/api/mail/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
15694         "type": "json"
15695       }
15696     ],
15697     "name": "CreateInteractions",
15698     "group": "Mail_Interactions",
15699     "parameter": {
15700       "fields": {
15701         "Body": [
15702           {
15703             "group": "Body",
15704             "type": "Boolean",
15705             "optional": true,
15706             "field": "closed",
15707             "description": ""
15708           },
15709           {
15710             "group": "Body",
15711             "type": "String",
15712             "optional": true,
15713             "field": "closedAt",
15714             "description": ""
15715           },
15716           {
15717             "group": "Body",
15718             "type": "String",
15719             "optional": true,
15720             "field": "disposition",
15721             "description": ""
15722           },
15723           {
15724             "group": "Body",
15725             "type": "String",
15726             "optional": true,
15727             "field": "secondDisposition",
15728             "description": ""
15729           },
15730           {
15731             "group": "Body",
15732             "type": "String",
15733             "optional": true,
15734             "field": "thirdDisposition",
15735             "description": ""
15736           },
15737           {
15738             "group": "Body",
15739             "type": "String",
15740             "optional": true,
15741             "field": "note",
15742             "description": ""
15743           },
15744           {
15745             "group": "Body",
15746             "type": "String",
15747             "optional": true,
15748             "field": "inReplyTo",
15749             "description": ""
15750           },
15751           {
15752             "group": "Body",
15753             "type": "String",
15754             "optional": true,
15755             "field": "to",
15756             "description": ""
15757           },
15758           {
15759             "group": "Body",
15760             "type": "Text",
15761             "optional": true,
15762             "field": "cc",
15763             "description": ""
15764           },
15765           {
15766             "group": "Body",
15767             "type": "Text",
15768             "optional": true,
15769             "field": "subject",
15770             "description": ""
15771           },
15772           {
15773             "group": "Body",
15774             "type": "Boolean",
15775             "optional": true,
15776             "field": "attach",
15777             "description": ""
15778           },
15779           {
15780             "group": "Body",
15781             "type": "String",
15782             "optional": true,
15783             "field": "read1stAt",
15784             "description": ""
15785           },
15786           {
15787             "group": "Body",
15788             "type": "String",
15789             "optional": true,
15790             "field": "substatus",
15791             "description": ""
15792           },
15793           {
15794             "group": "Body",
15795             "type": "String",
15796             "optional": true,
15797             "field": "substatusAt",
15798             "description": ""
15799           },
15800           {
15801             "group": "Body",
15802             "type": "String",
15803             "allowedValues": [
15804               "\"in\"",
15805               "\"out\""
15806             ],
15807             "optional": false,
15808             "field": "firstMsgDirection",
15809             "description": ""
15810           },
15811           {
15812             "group": "Body",
15813             "type": "String",
15814             "optional": true,
15815             "field": "lastMsgAt",
15816             "description": ""
15817           },
15818           {
15819             "group": "Body",
15820             "type": "String",
15821             "allowedValues": [
15822               "\"in\"",
15823               "\"out\""
15824             ],
15825             "optional": false,
15826             "field": "lastMsgDirection",
15827             "description": ""
15828           }
15829         ]
15830       }
15831     },
15832     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15833     "version": "0.0.0",
15834     "filename": "server/api/mailInteraction/index.js",
15835     "groupTitle": "Mail_Interactions"
15836   },
15837   {
15838     "type": "delete",
15839     "url": "/api/mail/interactions/{id}",
15840     "title": "Deletes a Interaction",
15841     "examples": [
15842       {
15843         "title": "Example usage:",
15844         "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password} -X DELETE",
15845         "type": "json"
15846       }
15847     ],
15848     "name": "DeleteInteractions",
15849     "group": "Mail_Interactions",
15850     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15851     "version": "0.0.0",
15852     "filename": "server/api/mailInteraction/index.js",
15853     "groupTitle": "Mail_Interactions"
15854   },
15855   {
15856     "type": "get",
15857     "url": "/api/mail/interactions/describe",
15858     "title": "Gets table info about Interactions",
15859     "examples": [
15860       {
15861         "title": "Example usage:",
15862         "content": "curl https://{domain}/api/mail/interactions/describe -v -u {name}:{password}",
15863         "type": "json"
15864       }
15865     ],
15866     "name": "DescribeInteractions",
15867     "group": "Mail_Interactions",
15868     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15869     "version": "0.0.0",
15870     "filename": "server/api/mailInteraction/index.js",
15871     "groupTitle": "Mail_Interactions"
15872   },
15873   {
15874     "type": "get",
15875     "url": "/api/mail/interactions",
15876     "title": "Gets a list of Interactions",
15877     "examples": [
15878       {
15879         "title": "Example usage:",
15880         "content": "curl https://{domain}/api/mail/interactions -v -u {name}:{password}",
15881         "type": "json"
15882       }
15883     ],
15884     "name": "GetInteractions",
15885     "group": "Mail_Interactions",
15886     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
15887     "version": "0.0.0",
15888     "filename": "server/api/mailInteraction/index.js",
15889     "groupTitle": "Mail_Interactions"
15890   },
15891   {
15892     "type": "delete",
15893     "url": "/api/mail/interactions/{id}/tags",
15894     "title": "Removes tags from interaction",
15895     "examples": [
15896       {
15897         "title": "Example usage:",
15898         "content": "curl https://{domain}/api/mail/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15899         "type": "json"
15900       }
15901     ],
15902     "name": "RemoveTags",
15903     "group": "Mail_Interactions",
15904     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15905     "version": "0.0.0",
15906     "filename": "server/api/mailInteraction/index.js",
15907     "groupTitle": "Mail_Interactions"
15908   },
15909   {
15910     "type": "get",
15911     "url": "/api/mail/interactions/{id}",
15912     "title": "Gets a single Interaction",
15913     "examples": [
15914       {
15915         "title": "Example usage:",
15916         "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password}",
15917         "type": "json"
15918       }
15919     ],
15920     "name": "ShowInteractions",
15921     "group": "Mail_Interactions",
15922     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15923     "version": "0.0.0",
15924     "filename": "server/api/mailInteraction/index.js",
15925     "groupTitle": "Mail_Interactions"
15926   },
15927   {
15928     "type": "post",
15929     "url": "/api/mail/interactions/{id}/messages",
15930     "title": "Creates new message",
15931     "examples": [
15932       {
15933         "title": "Example usage:",
15934         "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",
15935         "type": "json"
15936       }
15937     ],
15938     "name": "addMessage",
15939     "group": "Mail_Interactions",
15940     "parameter": {
15941       "fields": {
15942         "Body": [
15943           {
15944             "group": "Body",
15945             "type": "Text",
15946             "optional": false,
15947             "field": "body",
15948             "description": ""
15949           },
15950           {
15951             "group": "Body",
15952             "type": "Text",
15953             "optional": true,
15954             "field": "plainBody",
15955             "description": ""
15956           },
15957           {
15958             "group": "Body",
15959             "type": "Boolean",
15960             "optional": true,
15961             "field": "read",
15962             "description": ""
15963           },
15964           {
15965             "group": "Body",
15966             "type": "String",
15967             "allowedValues": [
15968               "\"in\"",
15969               "\"out\""
15970             ],
15971             "optional": false,
15972             "field": "direction",
15973             "description": ""
15974           },
15975           {
15976             "group": "Body",
15977             "type": "String",
15978             "optional": true,
15979             "field": "messageId",
15980             "description": ""
15981           },
15982           {
15983             "group": "Body",
15984             "type": "String",
15985             "optional": true,
15986             "field": "from",
15987             "description": ""
15988           },
15989           {
15990             "group": "Body",
15991             "type": "Text",
15992             "optional": true,
15993             "field": "to",
15994             "description": ""
15995           },
15996           {
15997             "group": "Body",
15998             "type": "Text",
15999             "optional": true,
16000             "field": "cc",
16001             "description": ""
16002           },
16003           {
16004             "group": "Body",
16005             "type": "Text",
16006             "optional": true,
16007             "field": "bcc",
16008             "description": ""
16009           },
16010           {
16011             "group": "Body",
16012             "type": "Text",
16013             "optional": true,
16014             "field": "subject",
16015             "description": ""
16016           },
16017           {
16018             "group": "Body",
16019             "type": "String",
16020             "optional": true,
16021             "field": "sentAt",
16022             "description": ""
16023           },
16024           {
16025             "group": "Body",
16026             "type": "Integer",
16027             "optional": true,
16028             "field": "attach",
16029             "description": ""
16030           },
16031           {
16032             "group": "Body",
16033             "type": "Boolean",
16034             "optional": true,
16035             "field": "secret",
16036             "description": ""
16037           },
16038           {
16039             "group": "Body",
16040             "type": "String",
16041             "optional": true,
16042             "field": "readAt",
16043             "description": ""
16044           },
16045           {
16046             "group": "Body",
16047             "type": "Text",
16048             "optional": true,
16049             "field": "originTo",
16050             "description": ""
16051           },
16052           {
16053             "group": "Body",
16054             "type": "Text",
16055             "optional": true,
16056             "field": "originCc",
16057             "description": ""
16058           },
16059           {
16060             "group": "Body",
16061             "type": "String",
16062             "allowedValues": [
16063               "\"Email\"",
16064               "\"Chat\""
16065             ],
16066             "optional": false,
16067             "field": "originChannel",
16068             "description": ""
16069           }
16070         ]
16071       }
16072     },
16073     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16074     "version": "0.0.0",
16075     "filename": "server/api/mailInteraction/index.js",
16076     "groupTitle": "Mail_Interactions"
16077   },
16078   {
16079     "type": "get",
16080     "url": "/api/mail/interactions/{id}/download",
16081     "title": "Gets interaction",
16082     "examples": [
16083       {
16084         "title": "Example usage:",
16085         "content": "curl https://{domain}/api/mail/interactions/{id}/download -v -u {name}:{password} -X GET",
16086         "type": "json"
16087       }
16088     ],
16089     "name": "download",
16090     "group": "Mail_Interactions",
16091     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16092     "version": "0.0.0",
16093     "filename": "server/api/mailInteraction/index.js",
16094     "groupTitle": "Mail_Interactions"
16095   },
16096   {
16097     "type": "get",
16098     "url": "/api/mail/interactions/{id}/messages",
16099     "title": "Gets interaction messages",
16100     "examples": [
16101       {
16102         "title": "Example usage:",
16103         "content": "curl https://{domain}/api/mail/interactions/{id}/messages -v -u {name}:{password} -X GET",
16104         "type": "json"
16105       }
16106     ],
16107     "name": "getMessages",
16108     "group": "Mail_Interactions",
16109     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16110     "version": "0.0.0",
16111     "filename": "server/api/mailInteraction/index.js",
16112     "groupTitle": "Mail_Interactions"
16113   },
16114   {
16115     "type": "put",
16116     "url": "/api/mail/interactions/{id}",
16117     "title": "Update an existing Interaction",
16118     "examples": [
16119       {
16120         "title": "Example usage:",
16121         "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",
16122         "type": "json"
16123       }
16124     ],
16125     "name": "updateInteractions",
16126     "group": "Mail_Interactions",
16127     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16128     "version": "0.0.0",
16129     "filename": "server/api/mailInteraction/index.js",
16130     "groupTitle": "Mail_Interactions"
16131   },
16132   {
16133     "type": "delete",
16134     "url": "/api/mail/messages/{id}",
16135     "title": "Deletes a Message",
16136     "examples": [
16137       {
16138         "title": "Example usage:",
16139         "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password} -X DELETE",
16140         "type": "json"
16141       }
16142     ],
16143     "name": "DeleteMessages",
16144     "group": "Mail_Messages",
16145     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16146     "version": "0.0.0",
16147     "filename": "server/api/mailMessage/index.js",
16148     "groupTitle": "Mail_Messages"
16149   },
16150   {
16151     "type": "get",
16152     "url": "/api/mail/messages/describe",
16153     "title": "Gets table info about Messages",
16154     "examples": [
16155       {
16156         "title": "Example usage:",
16157         "content": "curl https://{domain}/api/mail/messages/describe -v -u {name}:{password}",
16158         "type": "json"
16159       }
16160     ],
16161     "name": "DescribeMessages",
16162     "group": "Mail_Messages",
16163     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16164     "version": "0.0.0",
16165     "filename": "server/api/mailMessage/index.js",
16166     "groupTitle": "Mail_Messages"
16167   },
16168   {
16169     "type": "get",
16170     "url": "/api/mail/messages",
16171     "title": "Gets a list of Messages",
16172     "examples": [
16173       {
16174         "title": "Example usage:",
16175         "content": "curl https://{domain}/api/mail/messages -v -u {name}:{password}",
16176         "type": "json"
16177       }
16178     ],
16179     "name": "GetMessages",
16180     "group": "Mail_Messages",
16181     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16182     "version": "0.0.0",
16183     "filename": "server/api/mailMessage/index.js",
16184     "groupTitle": "Mail_Messages"
16185   },
16186   {
16187     "type": "get",
16188     "url": "/api/mail/messages/{id}",
16189     "title": "Gets a single Message",
16190     "examples": [
16191       {
16192         "title": "Example usage:",
16193         "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password}",
16194         "type": "json"
16195       }
16196     ],
16197     "name": "ShowMessages",
16198     "group": "Mail_Messages",
16199     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16200     "version": "0.0.0",
16201     "filename": "server/api/mailMessage/index.js",
16202     "groupTitle": "Mail_Messages"
16203   },
16204   {
16205     "type": "put",
16206     "url": "/api/mail/messages/{id}/accept",
16207     "title": "Accepts message",
16208     "examples": [
16209       {
16210         "title": "Example usage:",
16211         "content": "curl https://{domain}/api/mail/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
16212         "type": "json"
16213       }
16214     ],
16215     "name": "acceptMessage",
16216     "group": "Mail_Messages",
16217     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16218     "version": "0.0.0",
16219     "filename": "server/api/mailMessage/index.js",
16220     "groupTitle": "Mail_Messages"
16221   },
16222   {
16223     "type": "post",
16224     "url": "/api/mail/messages",
16225     "title": "Create a message",
16226     "examples": [
16227       {
16228         "title": "Example usage:",
16229         "content": "curl https://{domain}/api/mail/messages \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
16230         "type": "json"
16231       }
16232     ],
16233     "name": "createMessage",
16234     "group": "Mail_Messages",
16235     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16236     "version": "0.0.0",
16237     "filename": "server/api/mailMessage/index.js",
16238     "groupTitle": "Mail_Messages"
16239   },
16240   {
16241     "type": "get",
16242     "url": "/api/mail/messages/{id}/download",
16243     "title": "Gets message",
16244     "examples": [
16245       {
16246         "title": "Example usage:",
16247         "content": "curl https://{domain}/api/mail/messages/{id}/download -v -u {name}:{password} -X GET",
16248         "type": "json"
16249       }
16250     ],
16251     "name": "download",
16252     "group": "Mail_Messages",
16253     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16254     "version": "0.0.0",
16255     "filename": "server/api/mailMessage/index.js",
16256     "groupTitle": "Mail_Messages"
16257   },
16258   {
16259     "type": "put",
16260     "url": "/api/mail/messages/{id}/reject",
16261     "title": "Rejects message",
16262     "examples": [
16263       {
16264         "title": "Example usage:",
16265         "content": "curl https://{domain}/api/mail/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
16266         "type": "json"
16267       }
16268     ],
16269     "name": "rejectMessage",
16270     "group": "Mail_Messages",
16271     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16272     "version": "0.0.0",
16273     "filename": "server/api/mailMessage/index.js",
16274     "groupTitle": "Mail_Messages"
16275   },
16276   {
16277     "type": "put",
16278     "url": "/api/mail/messages/{id}",
16279     "title": "Update an existing Message",
16280     "examples": [
16281       {
16282         "title": "Example usage:",
16283         "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",
16284         "type": "json"
16285       }
16286     ],
16287     "name": "updateMessages",
16288     "group": "Mail_Messages",
16289     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16290     "version": "0.0.0",
16291     "filename": "server/api/mailMessage/index.js",
16292     "groupTitle": "Mail_Messages"
16293   },
16294   {
16295     "type": "post",
16296     "url": "/api/mail/reports/queue",
16297     "title": "Creates a new Mail Queue Report",
16298     "examples": [
16299       {
16300         "title": "Example usage:",
16301         "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",
16302         "type": "json"
16303       }
16304     ],
16305     "name": "CreateMail_Queue_Reports",
16306     "group": "Mail_Queue_Reports",
16307     "parameter": {
16308       "fields": {
16309         "Body": [
16310           {
16311             "group": "Body",
16312             "type": "String",
16313             "optional": false,
16314             "field": "uniqueid",
16315             "description": ""
16316           },
16317           {
16318             "group": "Body",
16319             "type": "String",
16320             "optional": true,
16321             "field": "from",
16322             "description": ""
16323           },
16324           {
16325             "group": "Body",
16326             "type": "String",
16327             "optional": true,
16328             "field": "joinAt",
16329             "description": ""
16330           },
16331           {
16332             "group": "Body",
16333             "type": "String",
16334             "optional": true,
16335             "field": "leaveAt",
16336             "description": ""
16337           },
16338           {
16339             "group": "Body",
16340             "type": "String",
16341             "optional": true,
16342             "field": "acceptAt",
16343             "description": ""
16344           },
16345           {
16346             "group": "Body",
16347             "type": "String",
16348             "optional": true,
16349             "field": "exitAt",
16350             "description": ""
16351           },
16352           {
16353             "group": "Body",
16354             "type": "String",
16355             "optional": true,
16356             "field": "reason",
16357             "description": ""
16358           }
16359         ]
16360       }
16361     },
16362     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16363     "version": "0.0.0",
16364     "filename": "server/api/mailQueueReport/index.js",
16365     "groupTitle": "Mail_Queue_Reports"
16366   },
16367   {
16368     "type": "delete",
16369     "url": "/api/mail/reports/queue/{id}",
16370     "title": "Deletes a Mail Queue Report",
16371     "examples": [
16372       {
16373         "title": "Example usage:",
16374         "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password} -X DELETE",
16375         "type": "json"
16376       }
16377     ],
16378     "name": "DeleteMail_Queue_Reports",
16379     "group": "Mail_Queue_Reports",
16380     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16381     "version": "0.0.0",
16382     "filename": "server/api/mailQueueReport/index.js",
16383     "groupTitle": "Mail_Queue_Reports"
16384   },
16385   {
16386     "type": "get",
16387     "url": "/api/mail/reports/queue/describe",
16388     "title": "Gets table info about Mail Queue Reports",
16389     "examples": [
16390       {
16391         "title": "Example usage:",
16392         "content": "curl https://{domain}/api/mail/reports/queue/describe -v -u {name}:{password}",
16393         "type": "json"
16394       }
16395     ],
16396     "name": "DescribeMail_Queue_Reports",
16397     "group": "Mail_Queue_Reports",
16398     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16399     "version": "0.0.0",
16400     "filename": "server/api/mailQueueReport/index.js",
16401     "groupTitle": "Mail_Queue_Reports"
16402   },
16403   {
16404     "type": "get",
16405     "url": "/api/mail/reports/queue",
16406     "title": "Gets a list of Mail Queue Reports",
16407     "examples": [
16408       {
16409         "title": "Example usage:",
16410         "content": "curl https://{domain}/api/mail/reports/queue -v -u {name}:{password}",
16411         "type": "json"
16412       }
16413     ],
16414     "name": "GetMail_Queue_Reports",
16415     "group": "Mail_Queue_Reports",
16416     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/mail/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>",
16417     "version": "0.0.0",
16418     "filename": "server/api/mailQueueReport/index.js",
16419     "groupTitle": "Mail_Queue_Reports"
16420   },
16421   {
16422     "type": "get",
16423     "url": "/api/mail/reports/queue/{id}",
16424     "title": "Gets a single Mail Queue Report",
16425     "examples": [
16426       {
16427         "title": "Example usage:",
16428         "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password}",
16429         "type": "json"
16430       }
16431     ],
16432     "name": "ShowMail_Queue_Reports",
16433     "group": "Mail_Queue_Reports",
16434     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16435     "version": "0.0.0",
16436     "filename": "server/api/mailQueueReport/index.js",
16437     "groupTitle": "Mail_Queue_Reports"
16438   },
16439   {
16440     "type": "put",
16441     "url": "/api/mail/reports/queue/{id}",
16442     "title": "Update an existing Mail Queue Report",
16443     "examples": [
16444       {
16445         "title": "Example usage:",
16446         "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",
16447         "type": "json"
16448       }
16449     ],
16450     "name": "updateMail_Queue_Reports",
16451     "group": "Mail_Queue_Reports",
16452     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16453     "version": "0.0.0",
16454     "filename": "server/api/mailQueueReport/index.js",
16455     "groupTitle": "Mail_Queue_Reports"
16456   },
16457   {
16458     "type": "post",
16459     "url": "/api/mail/queues/{id}/users",
16460     "title": "Add agents to a queue",
16461     "examples": [
16462       {
16463         "title": "Example usage:",
16464         "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",
16465         "type": "json"
16466       }
16467     ],
16468     "name": "AddAgents",
16469     "group": "Mail_Queues",
16470     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16471     "version": "0.0.0",
16472     "filename": "server/api/mailQueue/index.js",
16473     "groupTitle": "Mail_Queues"
16474   },
16475   {
16476     "type": "post",
16477     "url": "/api/mail/queues/{id}/teams",
16478     "title": "Add teams to a queue",
16479     "examples": [
16480       {
16481         "title": "Example usage:",
16482         "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",
16483         "type": "json"
16484       }
16485     ],
16486     "name": "AddTeams",
16487     "group": "Mail_Queues",
16488     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16489     "version": "0.0.0",
16490     "filename": "server/api/mailQueue/index.js",
16491     "groupTitle": "Mail_Queues"
16492   },
16493   {
16494     "type": "post",
16495     "url": "/api/mail/queues",
16496     "title": "Creates a new Queue",
16497     "examples": [
16498       {
16499         "title": "Example usage:",
16500         "content": "curl https://{domain}/api/mail/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
16501         "type": "json"
16502       }
16503     ],
16504     "name": "CreateQueues",
16505     "group": "Mail_Queues",
16506     "parameter": {
16507       "fields": {
16508         "Body": [
16509           {
16510             "group": "Body",
16511             "type": "String",
16512             "optional": true,
16513             "field": "name",
16514             "description": ""
16515           },
16516           {
16517             "group": "Body",
16518             "type": "String",
16519             "optional": true,
16520             "field": "description",
16521             "description": ""
16522           },
16523           {
16524             "group": "Body",
16525             "type": "Integer",
16526             "optional": true,
16527             "field": "timeout",
16528             "description": ""
16529           },
16530           {
16531             "group": "Body",
16532             "type": "String",
16533             "allowedValues": [
16534               "\"rrmemory\"",
16535               "\"beepall\"",
16536               "\"roundrobin\""
16537             ],
16538             "optional": true,
16539             "field": "strategy",
16540             "description": ""
16541           }
16542         ]
16543       }
16544     },
16545     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16546     "version": "0.0.0",
16547     "filename": "server/api/mailQueue/index.js",
16548     "groupTitle": "Mail_Queues"
16549   },
16550   {
16551     "type": "delete",
16552     "url": "/api/mail/queues/{id}",
16553     "title": "Deletes a Queue",
16554     "examples": [
16555       {
16556         "title": "Example usage:",
16557         "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password} -X DELETE",
16558         "type": "json"
16559       }
16560     ],
16561     "name": "DeleteQueues",
16562     "group": "Mail_Queues",
16563     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16564     "version": "0.0.0",
16565     "filename": "server/api/mailQueue/index.js",
16566     "groupTitle": "Mail_Queues"
16567   },
16568   {
16569     "type": "get",
16570     "url": "/api/mail/queues/describe",
16571     "title": "Gets table info about Queues",
16572     "examples": [
16573       {
16574         "title": "Example usage:",
16575         "content": "curl https://{domain}/api/mail/queues/describe -v -u {name}:{password}",
16576         "type": "json"
16577       }
16578     ],
16579     "name": "DescribeQueues",
16580     "group": "Mail_Queues",
16581     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16582     "version": "0.0.0",
16583     "filename": "server/api/mailQueue/index.js",
16584     "groupTitle": "Mail_Queues"
16585   },
16586   {
16587     "type": "get",
16588     "url": "/api/mail/queues/{id}/users",
16589     "title": "Gets queue agents",
16590     "examples": [
16591       {
16592         "title": "Example usage:",
16593         "content": "curl https://{domain}/api/mail/queues/{id}/users -v -u {name}:{password} -X POST",
16594         "type": "json"
16595       }
16596     ],
16597     "name": "GetAgents",
16598     "group": "Mail_Queues",
16599     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16600     "version": "0.0.0",
16601     "filename": "server/api/mailQueue/index.js",
16602     "groupTitle": "Mail_Queues"
16603   },
16604   {
16605     "type": "get",
16606     "url": "/api/mail/queues/{id}/members",
16607     "title": "GetMembers",
16608     "examples": [
16609       {
16610         "title": "Example usage:",
16611         "content": "curl https://{domain}/api/mail/queues/{id}/members  -v -u {name}:{password}",
16612         "type": "json"
16613       }
16614     ],
16615     "name": "GetMembers",
16616     "group": "Mail_Queues",
16617     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16618     "version": "0.0.0",
16619     "filename": "server/api/mailQueue/index.js",
16620     "groupTitle": "Mail_Queues"
16621   },
16622   {
16623     "type": "get",
16624     "url": "/api/mail/queues",
16625     "title": "Gets a list of Queues",
16626     "examples": [
16627       {
16628         "title": "Example usage:",
16629         "content": "curl https://{domain}/api/mail/queues -v -u {name}:{password}",
16630         "type": "json"
16631       }
16632     ],
16633     "name": "GetQueues",
16634     "group": "Mail_Queues",
16635     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16636     "version": "0.0.0",
16637     "filename": "server/api/mailQueue/index.js",
16638     "groupTitle": "Mail_Queues"
16639   },
16640   {
16641     "type": "get",
16642     "url": "/api/mail/queues/{id}/teams",
16643     "title": "Gets queues list",
16644     "examples": [
16645       {
16646         "title": "Example usage:",
16647         "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password}",
16648         "type": "json"
16649       }
16650     ],
16651     "name": "GetTeams",
16652     "group": "Mail_Queues",
16653     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16654     "version": "0.0.0",
16655     "filename": "server/api/mailQueue/index.js",
16656     "groupTitle": "Mail_Queues"
16657   },
16658   {
16659     "type": "delete",
16660     "url": "/api/mail/queues/{id}/users",
16661     "title": "Removes agents from a queue",
16662     "examples": [
16663       {
16664         "title": "Example usage:",
16665         "content": "curl https://{domain}/api/mail/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
16666         "type": "json"
16667       }
16668     ],
16669     "name": "RemoveAgents",
16670     "group": "Mail_Queues",
16671     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16672     "version": "0.0.0",
16673     "filename": "server/api/mailQueue/index.js",
16674     "groupTitle": "Mail_Queues"
16675   },
16676   {
16677     "type": "get",
16678     "url": "/api/mail/queues/{id}",
16679     "title": "Gets a single Queue",
16680     "examples": [
16681       {
16682         "title": "Example usage:",
16683         "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password}",
16684         "type": "json"
16685       }
16686     ],
16687     "name": "ShowQueues",
16688     "group": "Mail_Queues",
16689     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16690     "version": "0.0.0",
16691     "filename": "server/api/mailQueue/index.js",
16692     "groupTitle": "Mail_Queues"
16693   },
16694   {
16695     "type": "put",
16696     "url": "/api/mail/queues/{id}",
16697     "title": "Update an existing Queue",
16698     "examples": [
16699       {
16700         "title": "Example usage:",
16701         "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",
16702         "type": "json"
16703       }
16704     ],
16705     "name": "updateQueues",
16706     "group": "Mail_Queues",
16707     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16708     "version": "0.0.0",
16709     "filename": "server/api/mailQueue/index.js",
16710     "groupTitle": "Mail_Queues"
16711   },
16712   {
16713     "type": "post",
16714     "url": "/api/mail/out_servers",
16715     "title": "Creates a new SMTP",
16716     "examples": [
16717       {
16718         "title": "Example usage:",
16719         "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",
16720         "type": "json"
16721       }
16722     ],
16723     "name": "CreateSMTPs",
16724     "group": "Mail_SMTP",
16725     "parameter": {
16726       "fields": {
16727         "Body": [
16728           {
16729             "group": "Body",
16730             "type": "String",
16731             "optional": true,
16732             "field": "description",
16733             "description": ""
16734           },
16735           {
16736             "group": "Body",
16737             "type": "String",
16738             "optional": true,
16739             "field": "host",
16740             "description": ""
16741           },
16742           {
16743             "group": "Body",
16744             "type": "String",
16745             "optional": true,
16746             "field": "user",
16747             "description": ""
16748           },
16749           {
16750             "group": "Body",
16751             "type": "String",
16752             "optional": true,
16753             "field": "pass",
16754             "description": ""
16755           },
16756           {
16757             "group": "Body",
16758             "type": "Integer",
16759             "optional": true,
16760             "field": "port",
16761             "description": ""
16762           },
16763           {
16764             "group": "Body",
16765             "type": "Boolean",
16766             "optional": true,
16767             "field": "secure",
16768             "description": ""
16769           },
16770           {
16771             "group": "Body",
16772             "type": "String",
16773             "optional": true,
16774             "field": "service",
16775             "description": ""
16776           },
16777           {
16778             "group": "Body",
16779             "type": "Boolean",
16780             "optional": true,
16781             "field": "authentication",
16782             "description": ""
16783           }
16784         ]
16785       }
16786     },
16787     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16788     "version": "0.0.0",
16789     "filename": "server/api/mailServerOut/index.js",
16790     "groupTitle": "Mail_SMTP"
16791   },
16792   {
16793     "type": "delete",
16794     "url": "/api/mail/out_servers/{id}",
16795     "title": "Deletes a SMTP",
16796     "examples": [
16797       {
16798         "title": "Example usage:",
16799         "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password} -X DELETE",
16800         "type": "json"
16801       }
16802     ],
16803     "name": "DeleteSMTPs",
16804     "group": "Mail_SMTP",
16805     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16806     "version": "0.0.0",
16807     "filename": "server/api/mailServerOut/index.js",
16808     "groupTitle": "Mail_SMTP"
16809   },
16810   {
16811     "type": "get",
16812     "url": "/api/mail/out_servers",
16813     "title": "Gets a list of SMTPs",
16814     "examples": [
16815       {
16816         "title": "Example usage:",
16817         "content": "curl https://{domain}/api/mail/out_servers -v -u {name}:{password}",
16818         "type": "json"
16819       }
16820     ],
16821     "name": "GetSMTPs",
16822     "group": "Mail_SMTP",
16823     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16824     "version": "0.0.0",
16825     "filename": "server/api/mailServerOut/index.js",
16826     "groupTitle": "Mail_SMTP"
16827   },
16828   {
16829     "type": "get",
16830     "url": "/api/mail/out_servers/{id}",
16831     "title": "Gets a single SMTP",
16832     "examples": [
16833       {
16834         "title": "Example usage:",
16835         "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password}",
16836         "type": "json"
16837       }
16838     ],
16839     "name": "ShowSMTPs",
16840     "group": "Mail_SMTP",
16841     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16842     "version": "0.0.0",
16843     "filename": "server/api/mailServerOut/index.js",
16844     "groupTitle": "Mail_SMTP"
16845   },
16846   {
16847     "type": "put",
16848     "url": "/api/mail/out_servers/{id}",
16849     "title": "Update an existing SMTP",
16850     "examples": [
16851       {
16852         "title": "Example usage:",
16853         "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",
16854         "type": "json"
16855       }
16856     ],
16857     "name": "updateSMTPs",
16858     "group": "Mail_SMTP",
16859     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16860     "version": "0.0.0",
16861     "filename": "server/api/mailServerOut/index.js",
16862     "groupTitle": "Mail_SMTP"
16863   },
16864   {
16865     "type": "post",
16866     "url": "/api/mail/substatuses",
16867     "title": "Creates a new Queue",
16868     "examples": [
16869       {
16870         "title": "Example usage:",
16871         "content": "curl https://{domain}/api/mail/substatuses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
16872         "type": "json"
16873       }
16874     ],
16875     "name": "CreateSubstatuses",
16876     "group": "Mail_Substatuses",
16877     "parameter": {
16878       "fields": {
16879         "Body": [
16880           {
16881             "group": "Body",
16882             "type": "String",
16883             "optional": false,
16884             "field": "name",
16885             "description": ""
16886           },
16887           {
16888             "group": "Body",
16889             "type": "String",
16890             "optional": true,
16891             "field": "description",
16892             "description": ""
16893           }
16894         ]
16895       }
16896     },
16897     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16898     "version": "0.0.0",
16899     "filename": "server/api/mailSubstatus/index.js",
16900     "groupTitle": "Mail_Substatuses"
16901   },
16902   {
16903     "type": "delete",
16904     "url": "/api/mail/substatuses/{id}",
16905     "title": "Deletes a Queue",
16906     "examples": [
16907       {
16908         "title": "Example usage:",
16909         "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password} -X DELETE",
16910         "type": "json"
16911       }
16912     ],
16913     "name": "DeleteSubstatuses",
16914     "group": "Mail_Substatuses",
16915     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16916     "version": "0.0.0",
16917     "filename": "server/api/mailSubstatus/index.js",
16918     "groupTitle": "Mail_Substatuses"
16919   },
16920   {
16921     "type": "get",
16922     "url": "/api/mail/substatuses/describe",
16923     "title": "Gets table info about Substatuses",
16924     "examples": [
16925       {
16926         "title": "Example usage:",
16927         "content": "curl https://{domain}/api/mail/substatuses/describe -v -u {name}:{password}",
16928         "type": "json"
16929       }
16930     ],
16931     "name": "DescribeSubstatuses",
16932     "group": "Mail_Substatuses",
16933     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16934     "version": "0.0.0",
16935     "filename": "server/api/mailSubstatus/index.js",
16936     "groupTitle": "Mail_Substatuses"
16937   },
16938   {
16939     "type": "get",
16940     "url": "/api/mail/substatuses",
16941     "title": "Gets a list of Substatuses",
16942     "examples": [
16943       {
16944         "title": "Example usage:",
16945         "content": "curl https://{domain}/api/mail/substatuses -v -u {name}:{password}",
16946         "type": "json"
16947       }
16948     ],
16949     "name": "GetSubstatuses",
16950     "group": "Mail_Substatuses",
16951     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16952     "version": "0.0.0",
16953     "filename": "server/api/mailSubstatus/index.js",
16954     "groupTitle": "Mail_Substatuses"
16955   },
16956   {
16957     "type": "get",
16958     "url": "/api/mail/substatuses/{id}",
16959     "title": "Gets a single Queue",
16960     "examples": [
16961       {
16962         "title": "Example usage:",
16963         "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password}",
16964         "type": "json"
16965       }
16966     ],
16967     "name": "ShowSubstatuses",
16968     "group": "Mail_Substatuses",
16969     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16970     "version": "0.0.0",
16971     "filename": "server/api/mailSubstatus/index.js",
16972     "groupTitle": "Mail_Substatuses"
16973   },
16974   {
16975     "type": "put",
16976     "url": "/api/mail/substatuses/{id}",
16977     "title": "Update an existing Queue",
16978     "examples": [
16979       {
16980         "title": "Example usage:",
16981         "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",
16982         "type": "json"
16983       }
16984     ],
16985     "name": "updateSubstatuses",
16986     "group": "Mail_Substatuses",
16987     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16988     "version": "0.0.0",
16989     "filename": "server/api/mailSubstatus/index.js",
16990     "groupTitle": "Mail_Substatuses"
16991   },
16992   {
16993     "type": "post",
16994     "url": "/api/mail/reports/transfer",
16995     "title": "Creates a new Mail Transfer Report",
16996     "examples": [
16997       {
16998         "title": "Example usage:",
16999         "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",
17000         "type": "json"
17001       }
17002     ],
17003     "name": "CreateMail_Transfer_Reports",
17004     "group": "Mail_Transfer_Reports",
17005     "parameter": {
17006       "fields": {
17007         "Body": [
17008           {
17009             "group": "Body",
17010             "type": "String",
17011             "optional": false,
17012             "field": "uniqueid",
17013             "description": ""
17014           },
17015           {
17016             "group": "Body",
17017             "type": "String",
17018             "allowedValues": [
17019               "\"account\"",
17020               "\"agent\"",
17021               "\"queue\""
17022             ],
17023             "optional": false,
17024             "field": "type",
17025             "description": ""
17026           },
17027           {
17028             "group": "Body",
17029             "type": "String",
17030             "optional": false,
17031             "field": "transferredAt",
17032             "description": ""
17033           }
17034         ]
17035       }
17036     },
17037     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17038     "version": "0.0.0",
17039     "filename": "server/api/mailTransferReport/index.js",
17040     "groupTitle": "Mail_Transfer_Reports"
17041   },
17042   {
17043     "type": "delete",
17044     "url": "/api/mail/reports/transfer/{id}",
17045     "title": "Deletes a Mail Transfer Report",
17046     "examples": [
17047       {
17048         "title": "Example usage:",
17049         "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
17050         "type": "json"
17051       }
17052     ],
17053     "name": "DeleteMail_Transfer_Reports",
17054     "group": "Mail_Transfer_Reports",
17055     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17056     "version": "0.0.0",
17057     "filename": "server/api/mailTransferReport/index.js",
17058     "groupTitle": "Mail_Transfer_Reports"
17059   },
17060   {
17061     "type": "get",
17062     "url": "/api/mail/reports/transfer/describe",
17063     "title": "Gets table info about Mail Transfer Reports",
17064     "examples": [
17065       {
17066         "title": "Example usage:",
17067         "content": "curl https://{domain}/api/mail/reports/transfer/describe -v -u {name}:{password}",
17068         "type": "json"
17069       }
17070     ],
17071     "name": "DescribeMail_Transfer_Reports",
17072     "group": "Mail_Transfer_Reports",
17073     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17074     "version": "0.0.0",
17075     "filename": "server/api/mailTransferReport/index.js",
17076     "groupTitle": "Mail_Transfer_Reports"
17077   },
17078   {
17079     "type": "get",
17080     "url": "/api/mail/reports/transfer",
17081     "title": "Gets a list of Mail Transfer Reports",
17082     "examples": [
17083       {
17084         "title": "Example usage:",
17085         "content": "curl https://{domain}/api/mail/reports/transfer -v -u {name}:{password}",
17086         "type": "json"
17087       }
17088     ],
17089     "name": "GetMail_Transfer_Reports",
17090     "group": "Mail_Transfer_Reports",
17091     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17092     "version": "0.0.0",
17093     "filename": "server/api/mailTransferReport/index.js",
17094     "groupTitle": "Mail_Transfer_Reports"
17095   },
17096   {
17097     "type": "get",
17098     "url": "/api/mail/reports/transfer/{id}",
17099     "title": "Gets a single Mail Transfer Report",
17100     "examples": [
17101       {
17102         "title": "Example usage:",
17103         "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password}",
17104         "type": "json"
17105       }
17106     ],
17107     "name": "ShowMail_Transfer_Reports",
17108     "group": "Mail_Transfer_Reports",
17109     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17110     "version": "0.0.0",
17111     "filename": "server/api/mailTransferReport/index.js",
17112     "groupTitle": "Mail_Transfer_Reports"
17113   },
17114   {
17115     "type": "put",
17116     "url": "/api/mail/reports/transfer/{id}",
17117     "title": "Update an existing Mail Transfer Report",
17118     "examples": [
17119       {
17120         "title": "Example usage:",
17121         "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",
17122         "type": "json"
17123       }
17124     ],
17125     "name": "updateMail_Transfer_Reports",
17126     "group": "Mail_Transfer_Reports",
17127     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17128     "version": "0.0.0",
17129     "filename": "server/api/mailTransferReport/index.js",
17130     "groupTitle": "Mail_Transfer_Reports"
17131   },
17132   {
17133     "type": "get",
17134     "url": "/api/members/reports/describe",
17135     "title": "Gets table info about Member Reports",
17136     "examples": [
17137       {
17138         "title": "Example usage:",
17139         "content": "curl https://{domain}/api/members/reports/describe -v -u {name}:{password}",
17140         "type": "json"
17141       }
17142     ],
17143     "name": "DescribeMember_Reports",
17144     "group": "Member_Reports",
17145     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17146     "version": "0.0.0",
17147     "filename": "server/api/memberReport/index.js",
17148     "groupTitle": "Member_Reports"
17149   },
17150   {
17151     "type": "get",
17152     "url": "/api/members/reports",
17153     "title": "Gets a list of Member Reports",
17154     "examples": [
17155       {
17156         "title": "Example usage:",
17157         "content": "curl https://{domain}/api/members/reports -v -u {name}:{password}",
17158         "type": "json"
17159       }
17160     ],
17161     "name": "GetMember_Reports",
17162     "group": "Member_Reports",
17163     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17164     "version": "0.0.0",
17165     "filename": "server/api/memberReport/index.js",
17166     "groupTitle": "Member_Reports"
17167   },
17168   {
17169     "type": "get",
17170     "url": "/api/members/reports/{id}",
17171     "title": "Gets a single Member Report",
17172     "examples": [
17173       {
17174         "title": "Example usage:",
17175         "content": "curl https://{domain}/api/members/reports/{id} -v -u {name}:{password}",
17176         "type": "json"
17177       }
17178     ],
17179     "name": "ShowMember_Reports",
17180     "group": "Member_Reports",
17181     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17182     "version": "0.0.0",
17183     "filename": "server/api/memberReport/index.js",
17184     "groupTitle": "Member_Reports"
17185   },
17186   {
17187     "type": "get",
17188     "url": "/api/migrations",
17189     "title": "Gets a list of Migrations",
17190     "examples": [
17191       {
17192         "title": "Example usage:",
17193         "content": "curl https://{domain}/api/migrations -v -u {name}:{password}",
17194         "type": "json"
17195       }
17196     ],
17197     "name": "GetMigrations",
17198     "group": "Migrations",
17199     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17200     "version": "0.0.0",
17201     "filename": "server/api/migration/index.js",
17202     "groupTitle": "Migrations"
17203   },
17204   {
17205     "type": "post",
17206     "url": "/api/voice/networks",
17207     "title": "Create a new network",
17208     "examples": [
17209       {
17210         "title": "Example usage:",
17211         "content": "curl https://{domain}/api/voice/networks -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17212         "type": "json"
17213       }
17214     ],
17215     "name": "Create",
17216     "group": "Networks",
17217     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17218     "version": "0.0.0",
17219     "filename": "server/api/network/index.js",
17220     "groupTitle": "Networks"
17221   },
17222   {
17223     "type": "delete",
17224     "url": "/api/voice/networks/{id}",
17225     "title": "Deletes a network",
17226     "examples": [
17227       {
17228         "title": "Example usage:",
17229         "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X DELETE",
17230         "type": "json"
17231       }
17232     ],
17233     "name": "Delete",
17234     "group": "Networks",
17235     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17236     "version": "0.0.0",
17237     "filename": "server/api/network/index.js",
17238     "groupTitle": "Networks"
17239   },
17240   {
17241     "type": "get",
17242     "url": "/api/networks",
17243     "title": "Gets a list of Networks",
17244     "examples": [
17245       {
17246         "title": "Example usage:",
17247         "content": "curl https://{domain}/api/networks -v -u {name}:{password}",
17248         "type": "json"
17249       }
17250     ],
17251     "name": "GetNetworks",
17252     "group": "Networks",
17253     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17254     "version": "0.0.0",
17255     "filename": "server/api/network/index.js",
17256     "groupTitle": "Networks"
17257   },
17258   {
17259     "type": "get",
17260     "url": "/api/networks/{id}",
17261     "title": "Gets a single Network",
17262     "examples": [
17263       {
17264         "title": "Example usage:",
17265         "content": "curl https://{domain}/api/networks/{id} -v -u {name}:{password}",
17266         "type": "json"
17267       }
17268     ],
17269     "name": "ShowNetworks",
17270     "group": "Networks",
17271     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17272     "version": "0.0.0",
17273     "filename": "server/api/network/index.js",
17274     "groupTitle": "Networks"
17275   },
17276   {
17277     "type": "put",
17278     "url": "/api/voice/networks/{id}",
17279     "title": "Update an existing network",
17280     "examples": [
17281       {
17282         "title": "Example usage:",
17283         "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X PUT",
17284         "type": "json"
17285       }
17286     ],
17287     "name": "Update",
17288     "group": "Networks",
17289     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17290     "version": "0.0.0",
17291     "filename": "server/api/network/index.js",
17292     "groupTitle": "Networks"
17293   },
17294   {
17295     "type": "post",
17296     "url": "/api/openchannel/accounts/{id}/users",
17297     "title": "Add agents to a openchannel account",
17298     "examples": [
17299       {
17300         "title": "Example usage:",
17301         "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",
17302         "type": "json"
17303       }
17304     ],
17305     "name": "AddAgents",
17306     "group": "Openchannel_Accounts",
17307     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17308     "version": "0.0.0",
17309     "filename": "server/api/openchannelAccount/index.js",
17310     "groupTitle": "Openchannel_Accounts"
17311   },
17312   {
17313     "type": "post",
17314     "url": "/api/openchannel/accounts",
17315     "title": "Creates a new Account",
17316     "examples": [
17317       {
17318         "title": "Example usage:",
17319         "content": "curl https://{domain}/api/openchannel/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17320         "type": "json"
17321       }
17322     ],
17323     "name": "CreateAccounts",
17324     "group": "Openchannel_Accounts",
17325     "parameter": {
17326       "fields": {
17327         "Body": [
17328           {
17329             "group": "Body",
17330             "type": "String",
17331             "optional": false,
17332             "field": "name",
17333             "description": ""
17334           },
17335           {
17336             "group": "Body",
17337             "type": "String",
17338             "optional": true,
17339             "field": "description",
17340             "description": ""
17341           },
17342           {
17343             "group": "Body",
17344             "type": "String",
17345             "optional": true,
17346             "field": "token",
17347             "description": ""
17348           },
17349           {
17350             "group": "Body",
17351             "type": "String",
17352             "optional": true,
17353             "field": "replyUri",
17354             "description": ""
17355           },
17356           {
17357             "group": "Body",
17358             "type": "String",
17359             "optional": false,
17360             "field": "key",
17361             "description": ""
17362           },
17363           {
17364             "group": "Body",
17365             "type": "Text",
17366             "optional": true,
17367             "field": "notificationTemplate",
17368             "description": ""
17369           },
17370           {
17371             "group": "Body",
17372             "type": "Boolean",
17373             "optional": true,
17374             "field": "notificationSound",
17375             "description": ""
17376           },
17377           {
17378             "group": "Body",
17379             "type": "Boolean",
17380             "optional": true,
17381             "field": "notificationShake",
17382             "description": ""
17383           },
17384           {
17385             "group": "Body",
17386             "type": "Integer",
17387             "optional": true,
17388             "field": "waitForTheAssignedAgent",
17389             "description": ""
17390           },
17391           {
17392             "group": "Body",
17393             "type": "String",
17394             "optional": true,
17395             "field": "mapKey",
17396             "description": ""
17397           },
17398           {
17399             "group": "Body",
17400             "type": "Boolean",
17401             "optional": true,
17402             "field": "queueTransfer",
17403             "description": ""
17404           },
17405           {
17406             "group": "Body",
17407             "type": "Integer",
17408             "optional": true,
17409             "field": "queueTransferTimeout",
17410             "description": ""
17411           },
17412           {
17413             "group": "Body",
17414             "type": "Boolean",
17415             "optional": true,
17416             "field": "agentTransfer",
17417             "description": ""
17418           },
17419           {
17420             "group": "Body",
17421             "type": "Integer",
17422             "optional": true,
17423             "field": "agentTransferTimeout",
17424             "description": ""
17425           },
17426           {
17427             "group": "Body",
17428             "type": "Integer",
17429             "optional": true,
17430             "field": "mandatoryDispositionPauseId",
17431             "description": "<p>Status to put when mandatory disposition is enabled</p>"
17432           },
17433           {
17434             "group": "Body",
17435             "type": "Boolean",
17436             "optional": true,
17437             "field": "mandatoryDisposition",
17438             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
17439           }
17440         ]
17441       }
17442     },
17443     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17444     "version": "0.0.0",
17445     "filename": "server/api/openchannelAccount/index.js",
17446     "groupTitle": "Openchannel_Accounts"
17447   },
17448   {
17449     "type": "delete",
17450     "url": "/api/openchannel/accounts/{id}",
17451     "title": "Deletes a Account",
17452     "examples": [
17453       {
17454         "title": "Example usage:",
17455         "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password} -X DELETE",
17456         "type": "json"
17457       }
17458     ],
17459     "name": "DeleteAccounts",
17460     "group": "Openchannel_Accounts",
17461     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17462     "version": "0.0.0",
17463     "filename": "server/api/openchannelAccount/index.js",
17464     "groupTitle": "Openchannel_Accounts"
17465   },
17466   {
17467     "type": "get",
17468     "url": "/api/openchannel/accounts/describe",
17469     "title": "Gets table info about Accounts",
17470     "examples": [
17471       {
17472         "title": "Example usage:",
17473         "content": "curl https://{domain}/api/openchannel/accounts/describe -v -u {name}:{password}",
17474         "type": "json"
17475       }
17476     ],
17477     "name": "DescribeAccounts",
17478     "group": "Openchannel_Accounts",
17479     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17480     "version": "0.0.0",
17481     "filename": "server/api/openchannelAccount/index.js",
17482     "groupTitle": "Openchannel_Accounts"
17483   },
17484   {
17485     "type": "get",
17486     "url": "/api/openchannel/accounts",
17487     "title": "Gets a list of Accounts",
17488     "examples": [
17489       {
17490         "title": "Example usage:",
17491         "content": "curl https://{domain}/api/openchannel/accounts -v -u {name}:{password}",
17492         "type": "json"
17493       }
17494     ],
17495     "name": "GetAccounts",
17496     "group": "Openchannel_Accounts",
17497     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17498     "version": "0.0.0",
17499     "filename": "server/api/openchannelAccount/index.js",
17500     "groupTitle": "Openchannel_Accounts"
17501   },
17502   {
17503     "type": "get",
17504     "url": "/api/openchannel/accounts/{id}/users",
17505     "title": "Gets agents from openchannel account",
17506     "examples": [
17507       {
17508         "title": "Example usage:",
17509         "content": "curl https://{domain}/api/openchannel/accounts/{id}/users -v -u {name}:{password} -X GET",
17510         "type": "json"
17511       }
17512     ],
17513     "name": "GetAgents",
17514     "group": "Openchannel_Accounts",
17515     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17516     "version": "0.0.0",
17517     "filename": "server/api/openchannelAccount/index.js",
17518     "groupTitle": "Openchannel_Accounts"
17519   },
17520   {
17521     "type": "delete",
17522     "url": "/api/openchannel/accounts/{id}/users",
17523     "title": "Removes agents from a openchannel account",
17524     "examples": [
17525       {
17526         "title": "Example usage:",
17527         "content": "curl https://{domain}/api/openchannel/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17528         "type": "json"
17529       }
17530     ],
17531     "name": "RemoveAgents",
17532     "group": "Openchannel_Accounts",
17533     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17534     "version": "0.0.0",
17535     "filename": "server/api/openchannelAccount/index.js",
17536     "groupTitle": "Openchannel_Accounts"
17537   },
17538   {
17539     "type": "delete",
17540     "url": "/api/openchannel/accounts/{id}/canned_answers",
17541     "title": "Removes canned answers from account",
17542     "examples": [
17543       {
17544         "title": "Example usage:",
17545         "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17546         "type": "json"
17547       }
17548     ],
17549     "name": "RemoveAnswers",
17550     "group": "Openchannel_Accounts",
17551     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17552     "version": "0.0.0",
17553     "filename": "server/api/openchannelAccount/index.js",
17554     "groupTitle": "Openchannel_Accounts"
17555   },
17556   {
17557     "type": "delete",
17558     "url": "/api/openchannel/accounts/{id}/dispositions",
17559     "title": "Removes dispositions from account",
17560     "examples": [
17561       {
17562         "title": "Example usage:",
17563         "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17564         "type": "json"
17565       }
17566     ],
17567     "name": "RemoveDispositions",
17568     "group": "Openchannel_Accounts",
17569     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17570     "version": "0.0.0",
17571     "filename": "server/api/openchannelAccount/index.js",
17572     "groupTitle": "Openchannel_Accounts"
17573   },
17574   {
17575     "type": "get",
17576     "url": "/api/openchannel/accounts/{id}",
17577     "title": "Gets a single Account",
17578     "examples": [
17579       {
17580         "title": "Example usage:",
17581         "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password}",
17582         "type": "json"
17583       }
17584     ],
17585     "name": "ShowAccounts",
17586     "group": "Openchannel_Accounts",
17587     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17588     "version": "0.0.0",
17589     "filename": "server/api/openchannelAccount/index.js",
17590     "groupTitle": "Openchannel_Accounts"
17591   },
17592   {
17593     "type": "post",
17594     "url": "/api/openchannel/accounts/{id}/canned_answers",
17595     "title": "Creates new canned answer",
17596     "examples": [
17597       {
17598         "title": "Example usage:",
17599         "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",
17600         "type": "json"
17601       }
17602     ],
17603     "name": "addAnswer",
17604     "group": "Openchannel_Accounts",
17605     "parameter": {
17606       "fields": {
17607         "Body": [
17608           {
17609             "group": "Body",
17610             "type": "String",
17611             "optional": false,
17612             "field": "key",
17613             "description": ""
17614           },
17615           {
17616             "group": "Body",
17617             "type": "Text",
17618             "optional": false,
17619             "field": "value",
17620             "description": ""
17621           },
17622           {
17623             "group": "Body",
17624             "type": "String",
17625             "optional": true,
17626             "field": "description",
17627             "description": ""
17628           },
17629           {
17630             "group": "Body",
17631             "type": "Virtual",
17632             "optional": true,
17633             "field": "name",
17634             "description": ""
17635           }
17636         ]
17637       }
17638     },
17639     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17640     "version": "0.0.0",
17641     "filename": "server/api/openchannelAccount/index.js",
17642     "groupTitle": "Openchannel_Accounts"
17643   },
17644   {
17645     "type": "post",
17646     "url": "/api/openchannel/accounts/{id}/applications",
17647     "title": "Creates new applications",
17648     "examples": [
17649       {
17650         "title": "Example usage:",
17651         "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17652         "type": "json"
17653       }
17654     ],
17655     "name": "addApplications",
17656     "group": "Openchannel_Accounts",
17657     "parameter": {
17658       "fields": {
17659         "Body": [
17660           {
17661             "group": "Body",
17662             "type": "Integer",
17663             "optional": false,
17664             "field": "priority",
17665             "description": ""
17666           },
17667           {
17668             "group": "Body",
17669             "type": "String",
17670             "optional": false,
17671             "field": "app",
17672             "description": ""
17673           },
17674           {
17675             "group": "Body",
17676             "type": "Text",
17677             "optional": true,
17678             "field": "appdata",
17679             "description": ""
17680           },
17681           {
17682             "group": "Body",
17683             "type": "String",
17684             "optional": true,
17685             "field": "description",
17686             "description": ""
17687           },
17688           {
17689             "group": "Body",
17690             "type": "String",
17691             "optional": true,
17692             "field": "interval",
17693             "description": ""
17694           }
17695         ]
17696       }
17697     },
17698     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17699     "version": "0.0.0",
17700     "filename": "server/api/openchannelAccount/index.js",
17701     "groupTitle": "Openchannel_Accounts"
17702   },
17703   {
17704     "type": "post",
17705     "url": "/api/openchannel/accounts/{id}/dispositions",
17706     "title": "Creates new disposition",
17707     "examples": [
17708       {
17709         "title": "Example usage:",
17710         "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17711         "type": "json"
17712       }
17713     ],
17714     "name": "addDisposition",
17715     "group": "Openchannel_Accounts",
17716     "parameter": {
17717       "fields": {
17718         "Body": [
17719           {
17720             "group": "Body",
17721             "type": "String",
17722             "optional": false,
17723             "field": "name",
17724             "description": ""
17725           },
17726           {
17727             "group": "Body",
17728             "type": "String",
17729             "allowedValues": [
17730               "\"first\"",
17731               "\"second\"",
17732               "\"third\""
17733             ],
17734             "optional": false,
17735             "field": "level",
17736             "description": ""
17737           },
17738           {
17739             "group": "Body",
17740             "type": "String",
17741             "optional": true,
17742             "field": "description",
17743             "description": ""
17744           }
17745         ]
17746       }
17747     },
17748     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17749     "version": "0.0.0",
17750     "filename": "server/api/openchannelAccount/index.js",
17751     "groupTitle": "Openchannel_Accounts"
17752   },
17753   {
17754     "type": "get",
17755     "url": "/api/openchannel/accounts/{id}/canned_answers",
17756     "title": "Gets account canned answers",
17757     "examples": [
17758       {
17759         "title": "Example usage:",
17760         "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
17761         "type": "json"
17762       }
17763     ],
17764     "name": "getAnswers",
17765     "group": "Openchannel_Accounts",
17766     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17767     "version": "0.0.0",
17768     "filename": "server/api/openchannelAccount/index.js",
17769     "groupTitle": "Openchannel_Accounts"
17770   },
17771   {
17772     "type": "get",
17773     "url": "/api/openchannel/accounts/{id}/applications",
17774     "title": "Gets account applications",
17775     "examples": [
17776       {
17777         "title": "Example usage:",
17778         "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -v -u {name}:{password} -X GET",
17779         "type": "json"
17780       }
17781     ],
17782     "name": "getApplications",
17783     "group": "Openchannel_Accounts",
17784     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17785     "version": "0.0.0",
17786     "filename": "server/api/openchannelAccount/index.js",
17787     "groupTitle": "Openchannel_Accounts"
17788   },
17789   {
17790     "type": "get",
17791     "url": "/api/openchannel/accounts/{id}/dispositions",
17792     "title": "Gets account dispositions",
17793     "examples": [
17794       {
17795         "title": "Example usage:",
17796         "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
17797         "type": "json"
17798       }
17799     ],
17800     "name": "getDispositions",
17801     "group": "Openchannel_Accounts",
17802     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17803     "version": "0.0.0",
17804     "filename": "server/api/openchannelAccount/index.js",
17805     "groupTitle": "Openchannel_Accounts"
17806   },
17807   {
17808     "type": "get",
17809     "url": "/api/openchannel/accounts/{id}/interactions",
17810     "title": "Gets Openchannel Account Interactions",
17811     "examples": [
17812       {
17813         "title": "Example usage:",
17814         "content": "curl https://{domain}/api/openchannel/accounts/{id}/interactions -v -u {name}:{password} -X GET",
17815         "type": "json"
17816       }
17817     ],
17818     "name": "getInteractions",
17819     "group": "Openchannel_Accounts",
17820     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17821     "version": "0.0.0",
17822     "filename": "server/api/openchannelAccount/index.js",
17823     "groupTitle": "Openchannel_Accounts"
17824   },
17825   {
17826     "type": "post",
17827     "url": "/api/openchannel/accounts/{id}/notify",
17828     "title": "Notify new message",
17829     "examples": [
17830       {
17831         "title": "Example usage:",
17832         "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",
17833         "type": "json"
17834       }
17835     ],
17836     "name": "notify",
17837     "group": "Openchannel_Accounts",
17838     "description": "<p>Motion 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>",
17839     "version": "0.0.0",
17840     "filename": "server/api/openchannelAccount/index.js",
17841     "groupTitle": "Openchannel_Accounts"
17842   },
17843   {
17844     "type": "post",
17845     "url": "/api/openchannel/accounts/{id}/send",
17846     "title": "Send new openchannel message",
17847     "examples": [
17848       {
17849         "title": "Example usage:",
17850         "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",
17851         "type": "json"
17852       }
17853     ],
17854     "name": "sendOpenchannel",
17855     "group": "Openchannel_Accounts",
17856     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17857     "version": "0.0.0",
17858     "filename": "server/api/openchannelAccount/index.js",
17859     "groupTitle": "Openchannel_Accounts"
17860   },
17861   {
17862     "type": "put",
17863     "url": "/api/openchannel/accounts/{id}",
17864     "title": "Update an existing Account",
17865     "examples": [
17866       {
17867         "title": "Example usage:",
17868         "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",
17869         "type": "json"
17870       }
17871     ],
17872     "name": "updateAccounts",
17873     "group": "Openchannel_Accounts",
17874     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17875     "version": "0.0.0",
17876     "filename": "server/api/openchannelAccount/index.js",
17877     "groupTitle": "Openchannel_Accounts"
17878   },
17879   {
17880     "type": "post",
17881     "url": "/api/openchannel/applications",
17882     "title": "Creates a new Application",
17883     "examples": [
17884       {
17885         "title": "Example usage:",
17886         "content": "curl https://{domain}/api/openchannel/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17887         "type": "json"
17888       }
17889     ],
17890     "name": "CreateApplications",
17891     "group": "Openchannel_Applications",
17892     "parameter": {
17893       "fields": {
17894         "Body": [
17895           {
17896             "group": "Body",
17897             "type": "Integer",
17898             "optional": false,
17899             "field": "priority",
17900             "description": ""
17901           },
17902           {
17903             "group": "Body",
17904             "type": "String",
17905             "optional": false,
17906             "field": "app",
17907             "description": ""
17908           },
17909           {
17910             "group": "Body",
17911             "type": "Text",
17912             "optional": true,
17913             "field": "appdata",
17914             "description": ""
17915           },
17916           {
17917             "group": "Body",
17918             "type": "String",
17919             "optional": true,
17920             "field": "description",
17921             "description": ""
17922           },
17923           {
17924             "group": "Body",
17925             "type": "String",
17926             "optional": true,
17927             "field": "interval",
17928             "description": ""
17929           }
17930         ]
17931       }
17932     },
17933     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17934     "version": "0.0.0",
17935     "filename": "server/api/openchannelApplication/index.js",
17936     "groupTitle": "Openchannel_Applications"
17937   },
17938   {
17939     "type": "delete",
17940     "url": "/api/openchannel/applications/{id}",
17941     "title": "Deletes a Application",
17942     "examples": [
17943       {
17944         "title": "Example usage:",
17945         "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password} -X DELETE",
17946         "type": "json"
17947       }
17948     ],
17949     "name": "DeleteApplications",
17950     "group": "Openchannel_Applications",
17951     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17952     "version": "0.0.0",
17953     "filename": "server/api/openchannelApplication/index.js",
17954     "groupTitle": "Openchannel_Applications"
17955   },
17956   {
17957     "type": "get",
17958     "url": "/api/openchannel/applications",
17959     "title": "Gets a list of Applications",
17960     "examples": [
17961       {
17962         "title": "Example usage:",
17963         "content": "curl https://{domain}/api/openchannel/applications -v -u {name}:{password}",
17964         "type": "json"
17965       }
17966     ],
17967     "name": "GetApplications",
17968     "group": "Openchannel_Applications",
17969     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17970     "version": "0.0.0",
17971     "filename": "server/api/openchannelApplication/index.js",
17972     "groupTitle": "Openchannel_Applications"
17973   },
17974   {
17975     "type": "get",
17976     "url": "/api/openchannel/applications/{id}",
17977     "title": "Gets a single Application",
17978     "examples": [
17979       {
17980         "title": "Example usage:",
17981         "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password}",
17982         "type": "json"
17983       }
17984     ],
17985     "name": "ShowApplications",
17986     "group": "Openchannel_Applications",
17987     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17988     "version": "0.0.0",
17989     "filename": "server/api/openchannelApplication/index.js",
17990     "groupTitle": "Openchannel_Applications"
17991   },
17992   {
17993     "type": "put",
17994     "url": "/api/openchannel/applications/{id}",
17995     "title": "Update an existing Application",
17996     "examples": [
17997       {
17998         "title": "Example usage:",
17999         "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",
18000         "type": "json"
18001       }
18002     ],
18003     "name": "updateApplications",
18004     "group": "Openchannel_Applications",
18005     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18006     "version": "0.0.0",
18007     "filename": "server/api/openchannelApplication/index.js",
18008     "groupTitle": "Openchannel_Applications"
18009   },
18010   {
18011     "type": "post",
18012     "url": "/api/openchannel/interactions/{id}/tags",
18013     "title": "Add tags to the interaction",
18014     "examples": [
18015       {
18016         "title": "Example usage:",
18017         "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",
18018         "type": "json"
18019       }
18020     ],
18021     "name": "AddTags",
18022     "group": "Openchannel_Interactions",
18023     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18024     "version": "0.0.0",
18025     "filename": "server/api/openchannelInteraction/index.js",
18026     "groupTitle": "Openchannel_Interactions"
18027   },
18028   {
18029     "type": "post",
18030     "url": "/api/openchannel/interactions",
18031     "title": "Creates a new Interaction",
18032     "examples": [
18033       {
18034         "title": "Example usage:",
18035         "content": "curl https://{domain}/api/openchannel/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18036         "type": "json"
18037       }
18038     ],
18039     "name": "CreateInteractions",
18040     "group": "Openchannel_Interactions",
18041     "parameter": {
18042       "fields": {
18043         "Body": [
18044           {
18045             "group": "Body",
18046             "type": "Boolean",
18047             "optional": true,
18048             "field": "closed",
18049             "description": ""
18050           },
18051           {
18052             "group": "Body",
18053             "type": "String",
18054             "optional": true,
18055             "field": "closedAt",
18056             "description": ""
18057           },
18058           {
18059             "group": "Body",
18060             "type": "String",
18061             "optional": true,
18062             "field": "disposition",
18063             "description": ""
18064           },
18065           {
18066             "group": "Body",
18067             "type": "String",
18068             "optional": true,
18069             "field": "secondDisposition",
18070             "description": ""
18071           },
18072           {
18073             "group": "Body",
18074             "type": "String",
18075             "optional": true,
18076             "field": "thirdDisposition",
18077             "description": ""
18078           },
18079           {
18080             "group": "Body",
18081             "type": "String",
18082             "optional": true,
18083             "field": "note",
18084             "description": ""
18085           },
18086           {
18087             "group": "Body",
18088             "type": "String",
18089             "optional": true,
18090             "field": "read1stAt",
18091             "description": ""
18092           },
18093           {
18094             "group": "Body",
18095             "type": "String",
18096             "optional": true,
18097             "field": "threadId",
18098             "description": ""
18099           },
18100           {
18101             "group": "Body",
18102             "type": "String",
18103             "optional": true,
18104             "field": "externalUrl",
18105             "description": ""
18106           },
18107           {
18108             "group": "Body",
18109             "type": "String",
18110             "optional": true,
18111             "field": "lastMsgAt",
18112             "description": ""
18113           },
18114           {
18115             "group": "Body",
18116             "type": "String",
18117             "allowedValues": [
18118               "\"in\"",
18119               "\"out\""
18120             ],
18121             "optional": false,
18122             "field": "lastMsgDirection",
18123             "description": ""
18124           },
18125           {
18126             "group": "Body",
18127             "type": "String",
18128             "optional": true,
18129             "field": "from",
18130             "description": ""
18131           }
18132         ]
18133       }
18134     },
18135     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18136     "version": "0.0.0",
18137     "filename": "server/api/openchannelInteraction/index.js",
18138     "groupTitle": "Openchannel_Interactions"
18139   },
18140   {
18141     "type": "delete",
18142     "url": "/api/openchannel/interactions/{id}",
18143     "title": "Deletes a Interaction",
18144     "examples": [
18145       {
18146         "title": "Example usage:",
18147         "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password} -X DELETE",
18148         "type": "json"
18149       }
18150     ],
18151     "name": "DeleteInteractions",
18152     "group": "Openchannel_Interactions",
18153     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18154     "version": "0.0.0",
18155     "filename": "server/api/openchannelInteraction/index.js",
18156     "groupTitle": "Openchannel_Interactions"
18157   },
18158   {
18159     "type": "get",
18160     "url": "/api/openchannel/interactions/describe",
18161     "title": "Gets table info about Interactions",
18162     "examples": [
18163       {
18164         "title": "Example usage:",
18165         "content": "curl https://{domain}/api/openchannel/interactions/describe -v -u {name}:{password}",
18166         "type": "json"
18167       }
18168     ],
18169     "name": "DescribeInteractions",
18170     "group": "Openchannel_Interactions",
18171     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18172     "version": "0.0.0",
18173     "filename": "server/api/openchannelInteraction/index.js",
18174     "groupTitle": "Openchannel_Interactions"
18175   },
18176   {
18177     "type": "get",
18178     "url": "/api/openchannel/interactions",
18179     "title": "Gets a list of Interactions",
18180     "examples": [
18181       {
18182         "title": "Example usage:",
18183         "content": "curl https://{domain}/api/openchannel/interactions -v -u {name}:{password}",
18184         "type": "json"
18185       }
18186     ],
18187     "name": "GetInteractions",
18188     "group": "Openchannel_Interactions",
18189     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18190     "version": "0.0.0",
18191     "filename": "server/api/openchannelInteraction/index.js",
18192     "groupTitle": "Openchannel_Interactions"
18193   },
18194   {
18195     "type": "delete",
18196     "url": "/api/openchannel/interactions/{id}/tags",
18197     "title": "Removes tags from interaction",
18198     "examples": [
18199       {
18200         "title": "Example usage:",
18201         "content": "curl https://{domain}/api/openchannel/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
18202         "type": "json"
18203       }
18204     ],
18205     "name": "RemoveTags",
18206     "group": "Openchannel_Interactions",
18207     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18208     "version": "0.0.0",
18209     "filename": "server/api/openchannelInteraction/index.js",
18210     "groupTitle": "Openchannel_Interactions"
18211   },
18212   {
18213     "type": "get",
18214     "url": "/api/openchannel/interactions/{id}",
18215     "title": "Gets a single Interaction",
18216     "examples": [
18217       {
18218         "title": "Example usage:",
18219         "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password}",
18220         "type": "json"
18221       }
18222     ],
18223     "name": "ShowInteractions",
18224     "group": "Openchannel_Interactions",
18225     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18226     "version": "0.0.0",
18227     "filename": "server/api/openchannelInteraction/index.js",
18228     "groupTitle": "Openchannel_Interactions"
18229   },
18230   {
18231     "type": "post",
18232     "url": "/api/openchannel/interactions/{id}/messages",
18233     "title": "Creates new messages",
18234     "examples": [
18235       {
18236         "title": "Example usage:",
18237         "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
18238         "type": "json"
18239       }
18240     ],
18241     "name": "addMessage",
18242     "group": "Openchannel_Interactions",
18243     "parameter": {
18244       "fields": {
18245         "Body": [
18246           {
18247             "group": "Body",
18248             "type": "Text",
18249             "optional": false,
18250             "field": "body",
18251             "description": ""
18252           },
18253           {
18254             "group": "Body",
18255             "type": "Boolean",
18256             "optional": true,
18257             "field": "read",
18258             "description": ""
18259           },
18260           {
18261             "group": "Body",
18262             "type": "Boolean",
18263             "optional": true,
18264             "field": "secret",
18265             "description": ""
18266           },
18267           {
18268             "group": "Body",
18269             "type": "String",
18270             "allowedValues": [
18271               "\"in\"",
18272               "\"out\""
18273             ],
18274             "optional": false,
18275             "field": "direction",
18276             "description": ""
18277           },
18278           {
18279             "group": "Body",
18280             "type": "String",
18281             "optional": true,
18282             "field": "readAt",
18283             "description": ""
18284           },
18285           {
18286             "group": "Body",
18287             "type": "String",
18288             "optional": true,
18289             "field": "providerName",
18290             "description": ""
18291           },
18292           {
18293             "group": "Body",
18294             "type": "Text",
18295             "optional": true,
18296             "field": "providerResponse",
18297             "description": ""
18298           }
18299         ]
18300       }
18301     },
18302     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18303     "version": "0.0.0",
18304     "filename": "server/api/openchannelInteraction/index.js",
18305     "groupTitle": "Openchannel_Interactions"
18306   },
18307   {
18308     "type": "get",
18309     "url": "/api/openchannel/interactions/{id}/download",
18310     "title": "Gets interaction",
18311     "examples": [
18312       {
18313         "title": "Example usage:",
18314         "content": "curl https://{domain}/api/openchannel/interactions/{id}/download -v -u {name}:{password} -X GET",
18315         "type": "json"
18316       }
18317     ],
18318     "name": "download",
18319     "group": "Openchannel_Interactions",
18320     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18321     "version": "0.0.0",
18322     "filename": "server/api/openchannelInteraction/index.js",
18323     "groupTitle": "Openchannel_Interactions"
18324   },
18325   {
18326     "type": "get",
18327     "url": "/api/openchannel/interactions/{id}/messages",
18328     "title": "Gets interaction messages",
18329     "examples": [
18330       {
18331         "title": "Example usage:",
18332         "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -v -u {name}:{password} -X GET",
18333         "type": "json"
18334       }
18335     ],
18336     "name": "getMessages",
18337     "group": "Openchannel_Interactions",
18338     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18339     "version": "0.0.0",
18340     "filename": "server/api/openchannelInteraction/index.js",
18341     "groupTitle": "Openchannel_Interactions"
18342   },
18343   {
18344     "type": "put",
18345     "url": "/api/openchannel/interactions/{id}",
18346     "title": "Update an existing Interaction",
18347     "examples": [
18348       {
18349         "title": "Example usage:",
18350         "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",
18351         "type": "json"
18352       }
18353     ],
18354     "name": "updateInteractions",
18355     "group": "Openchannel_Interactions",
18356     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18357     "version": "0.0.0",
18358     "filename": "server/api/openchannelInteraction/index.js",
18359     "groupTitle": "Openchannel_Interactions"
18360   },
18361   {
18362     "type": "post",
18363     "url": "/api/openchannel/messages",
18364     "title": "Creates a new Message",
18365     "examples": [
18366       {
18367         "title": "Example usage:",
18368         "content": "curl https://{domain}/api/openchannel/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18369         "type": "json"
18370       }
18371     ],
18372     "name": "CreateMessages",
18373     "group": "Openchannel_Messages",
18374     "parameter": {
18375       "fields": {
18376         "Body": [
18377           {
18378             "group": "Body",
18379             "type": "Text",
18380             "optional": false,
18381             "field": "body",
18382             "description": ""
18383           },
18384           {
18385             "group": "Body",
18386             "type": "Boolean",
18387             "optional": true,
18388             "field": "read",
18389             "description": ""
18390           },
18391           {
18392             "group": "Body",
18393             "type": "Boolean",
18394             "optional": true,
18395             "field": "secret",
18396             "description": ""
18397           },
18398           {
18399             "group": "Body",
18400             "type": "String",
18401             "allowedValues": [
18402               "\"in\"",
18403               "\"out\""
18404             ],
18405             "optional": false,
18406             "field": "direction",
18407             "description": ""
18408           },
18409           {
18410             "group": "Body",
18411             "type": "String",
18412             "optional": true,
18413             "field": "readAt",
18414             "description": ""
18415           },
18416           {
18417             "group": "Body",
18418             "type": "String",
18419             "optional": true,
18420             "field": "providerName",
18421             "description": ""
18422           },
18423           {
18424             "group": "Body",
18425             "type": "Text",
18426             "optional": true,
18427             "field": "providerResponse",
18428             "description": ""
18429           }
18430         ]
18431       }
18432     },
18433     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18434     "version": "0.0.0",
18435     "filename": "server/api/openchannelMessage/index.js",
18436     "groupTitle": "Openchannel_Messages"
18437   },
18438   {
18439     "type": "delete",
18440     "url": "/api/openchannel/messages/{id}",
18441     "title": "Deletes a Message",
18442     "examples": [
18443       {
18444         "title": "Example usage:",
18445         "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password} -X DELETE",
18446         "type": "json"
18447       }
18448     ],
18449     "name": "DeleteMessages",
18450     "group": "Openchannel_Messages",
18451     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18452     "version": "0.0.0",
18453     "filename": "server/api/openchannelMessage/index.js",
18454     "groupTitle": "Openchannel_Messages"
18455   },
18456   {
18457     "type": "get",
18458     "url": "/api/openchannel/messages/describe",
18459     "title": "Gets table info about Messages",
18460     "examples": [
18461       {
18462         "title": "Example usage:",
18463         "content": "curl https://{domain}/api/openchannel/messages/describe -v -u {name}:{password}",
18464         "type": "json"
18465       }
18466     ],
18467     "name": "DescribeMessages",
18468     "group": "Openchannel_Messages",
18469     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18470     "version": "0.0.0",
18471     "filename": "server/api/openchannelMessage/index.js",
18472     "groupTitle": "Openchannel_Messages"
18473   },
18474   {
18475     "type": "get",
18476     "url": "/api/openchannel/messages",
18477     "title": "Gets a list of Messages",
18478     "examples": [
18479       {
18480         "title": "Example usage:",
18481         "content": "curl https://{domain}/api/openchannel/messages -v -u {name}:{password}",
18482         "type": "json"
18483       }
18484     ],
18485     "name": "GetMessages",
18486     "group": "Openchannel_Messages",
18487     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18488     "version": "0.0.0",
18489     "filename": "server/api/openchannelMessage/index.js",
18490     "groupTitle": "Openchannel_Messages"
18491   },
18492   {
18493     "type": "get",
18494     "url": "/api/openchannel/messages/{id}",
18495     "title": "Gets a single Message",
18496     "examples": [
18497       {
18498         "title": "Example usage:",
18499         "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password}",
18500         "type": "json"
18501       }
18502     ],
18503     "name": "ShowMessages",
18504     "group": "Openchannel_Messages",
18505     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18506     "version": "0.0.0",
18507     "filename": "server/api/openchannelMessage/index.js",
18508     "groupTitle": "Openchannel_Messages"
18509   },
18510   {
18511     "type": "put",
18512     "url": "/api/openchannel/messages/{id}/accept",
18513     "title": "Accepts message",
18514     "examples": [
18515       {
18516         "title": "Example usage:",
18517         "content": "curl https://{domain}/api/openchannel/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
18518         "type": "json"
18519       }
18520     ],
18521     "name": "acceptMessage",
18522     "group": "Openchannel_Messages",
18523     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18524     "version": "0.0.0",
18525     "filename": "server/api/openchannelMessage/index.js",
18526     "groupTitle": "Openchannel_Messages"
18527   },
18528   {
18529     "type": "put",
18530     "url": "/api/openchannel/messages/{id}/reject",
18531     "title": "Rejects message",
18532     "examples": [
18533       {
18534         "title": "Example usage:",
18535         "content": "curl https://{domain}/api/openchannel/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
18536         "type": "json"
18537       }
18538     ],
18539     "name": "rejectMessage",
18540     "group": "Openchannel_Messages",
18541     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18542     "version": "0.0.0",
18543     "filename": "server/api/openchannelMessage/index.js",
18544     "groupTitle": "Openchannel_Messages"
18545   },
18546   {
18547     "type": "put",
18548     "url": "/api/openchannel/messages/{id}",
18549     "title": "Update an existing Message",
18550     "examples": [
18551       {
18552         "title": "Example usage:",
18553         "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",
18554         "type": "json"
18555       }
18556     ],
18557     "name": "updateMessages",
18558     "group": "Openchannel_Messages",
18559     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18560     "version": "0.0.0",
18561     "filename": "server/api/openchannelMessage/index.js",
18562     "groupTitle": "Openchannel_Messages"
18563   },
18564   {
18565     "type": "post",
18566     "url": "/api/openchannel/reports/queue",
18567     "title": "Creates a new Openchannel Queue Report",
18568     "examples": [
18569       {
18570         "title": "Example usage:",
18571         "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",
18572         "type": "json"
18573       }
18574     ],
18575     "name": "CreateOpenchannel_Queue_Reports",
18576     "group": "Openchannel_Queue_Reports",
18577     "parameter": {
18578       "fields": {
18579         "Body": [
18580           {
18581             "group": "Body",
18582             "type": "String",
18583             "optional": false,
18584             "field": "uniqueid",
18585             "description": ""
18586           },
18587           {
18588             "group": "Body",
18589             "type": "String",
18590             "optional": true,
18591             "field": "from",
18592             "description": ""
18593           },
18594           {
18595             "group": "Body",
18596             "type": "String",
18597             "optional": true,
18598             "field": "joinAt",
18599             "description": ""
18600           },
18601           {
18602             "group": "Body",
18603             "type": "String",
18604             "optional": true,
18605             "field": "leaveAt",
18606             "description": ""
18607           },
18608           {
18609             "group": "Body",
18610             "type": "String",
18611             "optional": true,
18612             "field": "acceptAt",
18613             "description": ""
18614           },
18615           {
18616             "group": "Body",
18617             "type": "String",
18618             "optional": true,
18619             "field": "exitAt",
18620             "description": ""
18621           },
18622           {
18623             "group": "Body",
18624             "type": "String",
18625             "optional": true,
18626             "field": "reason",
18627             "description": ""
18628           }
18629         ]
18630       }
18631     },
18632     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18633     "version": "0.0.0",
18634     "filename": "server/api/openchannelQueueReport/index.js",
18635     "groupTitle": "Openchannel_Queue_Reports"
18636   },
18637   {
18638     "type": "delete",
18639     "url": "/api/openchannel/reports/queue/{id}",
18640     "title": "Deletes a Openchannel Queue Report",
18641     "examples": [
18642       {
18643         "title": "Example usage:",
18644         "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password} -X DELETE",
18645         "type": "json"
18646       }
18647     ],
18648     "name": "DeleteOpenchannel_Queue_Reports",
18649     "group": "Openchannel_Queue_Reports",
18650     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18651     "version": "0.0.0",
18652     "filename": "server/api/openchannelQueueReport/index.js",
18653     "groupTitle": "Openchannel_Queue_Reports"
18654   },
18655   {
18656     "type": "get",
18657     "url": "/api/openchannel/reports/queue/describe",
18658     "title": "Gets table info about Openchannel Queue Reports",
18659     "examples": [
18660       {
18661         "title": "Example usage:",
18662         "content": "curl https://{domain}/api/openchannel/reports/queue/describe -v -u {name}:{password}",
18663         "type": "json"
18664       }
18665     ],
18666     "name": "DescribeOpenchannel_Queue_Reports",
18667     "group": "Openchannel_Queue_Reports",
18668     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18669     "version": "0.0.0",
18670     "filename": "server/api/openchannelQueueReport/index.js",
18671     "groupTitle": "Openchannel_Queue_Reports"
18672   },
18673   {
18674     "type": "get",
18675     "url": "/api/openchannel/reports/queue",
18676     "title": "Gets a list of Openchannel Queue Reports",
18677     "examples": [
18678       {
18679         "title": "Example usage:",
18680         "content": "curl https://{domain}/api/openchannel/reports/queue -v -u {name}:{password}",
18681         "type": "json"
18682       }
18683     ],
18684     "name": "GetOpenchannel_Queue_Reports",
18685     "group": "Openchannel_Queue_Reports",
18686     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18687     "version": "0.0.0",
18688     "filename": "server/api/openchannelQueueReport/index.js",
18689     "groupTitle": "Openchannel_Queue_Reports"
18690   },
18691   {
18692     "type": "get",
18693     "url": "/api/openchannel/reports/queue/{id}",
18694     "title": "Gets a single Openchannel Queue Report",
18695     "examples": [
18696       {
18697         "title": "Example usage:",
18698         "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password}",
18699         "type": "json"
18700       }
18701     ],
18702     "name": "ShowOpenchannel_Queue_Reports",
18703     "group": "Openchannel_Queue_Reports",
18704     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18705     "version": "0.0.0",
18706     "filename": "server/api/openchannelQueueReport/index.js",
18707     "groupTitle": "Openchannel_Queue_Reports"
18708   },
18709   {
18710     "type": "put",
18711     "url": "/api/openchannel/reports/queue/{id}",
18712     "title": "Update an existing Openchannel Queue Report",
18713     "examples": [
18714       {
18715         "title": "Example usage:",
18716         "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",
18717         "type": "json"
18718       }
18719     ],
18720     "name": "updateOpenchannel_Queue_Reports",
18721     "group": "Openchannel_Queue_Reports",
18722     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18723     "version": "0.0.0",
18724     "filename": "server/api/openchannelQueueReport/index.js",
18725     "groupTitle": "Openchannel_Queue_Reports"
18726   },
18727   {
18728     "type": "post",
18729     "url": "/api/openchannel/queues/{id}/users",
18730     "title": "Add agents to a queue",
18731     "examples": [
18732       {
18733         "title": "Example usage:",
18734         "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",
18735         "type": "json"
18736       }
18737     ],
18738     "name": "AddAgents",
18739     "group": "Openchannel_Queues",
18740     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18741     "version": "0.0.0",
18742     "filename": "server/api/openchannelQueue/index.js",
18743     "groupTitle": "Openchannel_Queues"
18744   },
18745   {
18746     "type": "post",
18747     "url": "/api/openchannel/queues/{id}/teams",
18748     "title": "Add teams to a queue",
18749     "examples": [
18750       {
18751         "title": "Example usage:",
18752         "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",
18753         "type": "json"
18754       }
18755     ],
18756     "name": "AddTeams",
18757     "group": "Openchannel_Queues",
18758     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18759     "version": "0.0.0",
18760     "filename": "server/api/openchannelQueue/index.js",
18761     "groupTitle": "Openchannel_Queues"
18762   },
18763   {
18764     "type": "post",
18765     "url": "/api/openchannel/queues",
18766     "title": "Creates a new Queue",
18767     "examples": [
18768       {
18769         "title": "Example usage:",
18770         "content": "curl https://{domain}/api/openchannel/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18771         "type": "json"
18772       }
18773     ],
18774     "name": "CreateQueues",
18775     "group": "Openchannel_Queues",
18776     "parameter": {
18777       "fields": {
18778         "Body": [
18779           {
18780             "group": "Body",
18781             "type": "String",
18782             "optional": true,
18783             "field": "name",
18784             "description": ""
18785           },
18786           {
18787             "group": "Body",
18788             "type": "String",
18789             "optional": true,
18790             "field": "description",
18791             "description": ""
18792           },
18793           {
18794             "group": "Body",
18795             "type": "Integer",
18796             "optional": true,
18797             "field": "timeout",
18798             "description": ""
18799           },
18800           {
18801             "group": "Body",
18802             "type": "String",
18803             "allowedValues": [
18804               "\"rrmemory\"",
18805               "\"beepall\"",
18806               "\"roundrobin\""
18807             ],
18808             "optional": true,
18809             "field": "strategy",
18810             "description": ""
18811           }
18812         ]
18813       }
18814     },
18815     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18816     "version": "0.0.0",
18817     "filename": "server/api/openchannelQueue/index.js",
18818     "groupTitle": "Openchannel_Queues"
18819   },
18820   {
18821     "type": "delete",
18822     "url": "/api/openchannel/queues/{id}",
18823     "title": "Deletes a Queue",
18824     "examples": [
18825       {
18826         "title": "Example usage:",
18827         "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password} -X DELETE",
18828         "type": "json"
18829       }
18830     ],
18831     "name": "DeleteQueues",
18832     "group": "Openchannel_Queues",
18833     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18834     "version": "0.0.0",
18835     "filename": "server/api/openchannelQueue/index.js",
18836     "groupTitle": "Openchannel_Queues"
18837   },
18838   {
18839     "type": "get",
18840     "url": "/api/openchannel/queues/describe",
18841     "title": "Gets table info about Queues",
18842     "examples": [
18843       {
18844         "title": "Example usage:",
18845         "content": "curl https://{domain}/api/openchannel/queues/describe -v -u {name}:{password}",
18846         "type": "json"
18847       }
18848     ],
18849     "name": "DescribeQueues",
18850     "group": "Openchannel_Queues",
18851     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18852     "version": "0.0.0",
18853     "filename": "server/api/openchannelQueue/index.js",
18854     "groupTitle": "Openchannel_Queues"
18855   },
18856   {
18857     "type": "get",
18858     "url": "/api/openchannel/queues/{id}/users",
18859     "title": "Gets queue agents",
18860     "examples": [
18861       {
18862         "title": "Example usage:",
18863         "content": "curl https://{domain}/api/openchannel/queues/{id}/users -v -u {name}:{password} -X POST",
18864         "type": "json"
18865       }
18866     ],
18867     "name": "GetAgents",
18868     "group": "Openchannel_Queues",
18869     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18870     "version": "0.0.0",
18871     "filename": "server/api/openchannelQueue/index.js",
18872     "groupTitle": "Openchannel_Queues"
18873   },
18874   {
18875     "type": "get",
18876     "url": "/api/openchannel/queues/{id}/members",
18877     "title": "GetMembers",
18878     "examples": [
18879       {
18880         "title": "Example usage:",
18881         "content": "curl https://{domain}/api/openchannel/queues/{id}/members  -v -u {name}:{password}",
18882         "type": "json"
18883       }
18884     ],
18885     "name": "GetMembers",
18886     "group": "Openchannel_Queues",
18887     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18888     "version": "0.0.0",
18889     "filename": "server/api/openchannelQueue/index.js",
18890     "groupTitle": "Openchannel_Queues"
18891   },
18892   {
18893     "type": "get",
18894     "url": "/api/openchannel/queues",
18895     "title": "Gets a list of Queues",
18896     "examples": [
18897       {
18898         "title": "Example usage:",
18899         "content": "curl https://{domain}/api/openchannel/queues -v -u {name}:{password}",
18900         "type": "json"
18901       }
18902     ],
18903     "name": "GetQueues",
18904     "group": "Openchannel_Queues",
18905     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18906     "version": "0.0.0",
18907     "filename": "server/api/openchannelQueue/index.js",
18908     "groupTitle": "Openchannel_Queues"
18909   },
18910   {
18911     "type": "get",
18912     "url": "/api/openchannel/queues/{id}/teams",
18913     "title": "Gets queues list",
18914     "examples": [
18915       {
18916         "title": "Example usage:",
18917         "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password}",
18918         "type": "json"
18919       }
18920     ],
18921     "name": "GetTeams",
18922     "group": "Openchannel_Queues",
18923     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18924     "version": "0.0.0",
18925     "filename": "server/api/openchannelQueue/index.js",
18926     "groupTitle": "Openchannel_Queues"
18927   },
18928   {
18929     "type": "delete",
18930     "url": "/api/openchannel/queues/{id}/users",
18931     "title": "Removes agents from a queue",
18932     "examples": [
18933       {
18934         "title": "Example usage:",
18935         "content": "curl https://{domain}/api/openchannel/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
18936         "type": "json"
18937       }
18938     ],
18939     "name": "RemoveAgents",
18940     "group": "Openchannel_Queues",
18941     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18942     "version": "0.0.0",
18943     "filename": "server/api/openchannelQueue/index.js",
18944     "groupTitle": "Openchannel_Queues"
18945   },
18946   {
18947     "type": "get",
18948     "url": "/api/openchannel/queues/{id}",
18949     "title": "Gets a single Queue",
18950     "examples": [
18951       {
18952         "title": "Example usage:",
18953         "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password}",
18954         "type": "json"
18955       }
18956     ],
18957     "name": "ShowQueues",
18958     "group": "Openchannel_Queues",
18959     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18960     "version": "0.0.0",
18961     "filename": "server/api/openchannelQueue/index.js",
18962     "groupTitle": "Openchannel_Queues"
18963   },
18964   {
18965     "type": "put",
18966     "url": "/api/openchannel/queues/{id}",
18967     "title": "Update an existing Queue",
18968     "examples": [
18969       {
18970         "title": "Example usage:",
18971         "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",
18972         "type": "json"
18973       }
18974     ],
18975     "name": "updateQueues",
18976     "group": "Openchannel_Queues",
18977     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18978     "version": "0.0.0",
18979     "filename": "server/api/openchannelQueue/index.js",
18980     "groupTitle": "Openchannel_Queues"
18981   },
18982   {
18983     "type": "post",
18984     "url": "/api/openchannel/reports/transfer",
18985     "title": "Creates a new Openchannel Transfer Report",
18986     "examples": [
18987       {
18988         "title": "Example usage:",
18989         "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",
18990         "type": "json"
18991       }
18992     ],
18993     "name": "CreateOpenchannel_Transfer_Reports",
18994     "group": "Openchannel_Transfer_Reports",
18995     "parameter": {
18996       "fields": {
18997         "Body": [
18998           {
18999             "group": "Body",
19000             "type": "String",
19001             "optional": false,
19002             "field": "uniqueid",
19003             "description": ""
19004           },
19005           {
19006             "group": "Body",
19007             "type": "String",
19008             "allowedValues": [
19009               "\"account\"",
19010               "\"agent\"",
19011               "\"queue\""
19012             ],
19013             "optional": false,
19014             "field": "type",
19015             "description": ""
19016           },
19017           {
19018             "group": "Body",
19019             "type": "String",
19020             "optional": false,
19021             "field": "transferredAt",
19022             "description": ""
19023           }
19024         ]
19025       }
19026     },
19027     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19028     "version": "0.0.0",
19029     "filename": "server/api/openchannelTransferReport/index.js",
19030     "groupTitle": "Openchannel_Transfer_Reports"
19031   },
19032   {
19033     "type": "delete",
19034     "url": "/api/openchannel/reports/transfer/{id}",
19035     "title": "Deletes a Openchannel Transfer Report",
19036     "examples": [
19037       {
19038         "title": "Example usage:",
19039         "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
19040         "type": "json"
19041       }
19042     ],
19043     "name": "DeleteOpenchannel_Transfer_Reports",
19044     "group": "Openchannel_Transfer_Reports",
19045     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19046     "version": "0.0.0",
19047     "filename": "server/api/openchannelTransferReport/index.js",
19048     "groupTitle": "Openchannel_Transfer_Reports"
19049   },
19050   {
19051     "type": "get",
19052     "url": "/api/openchannel/reports/transfer/describe",
19053     "title": "Gets table info about Openchannel Transfer Reports",
19054     "examples": [
19055       {
19056         "title": "Example usage:",
19057         "content": "curl https://{domain}/api/openchannel/reports/transfer/describe -v -u {name}:{password}",
19058         "type": "json"
19059       }
19060     ],
19061     "name": "DescribeOpenchannel_Transfer_Reports",
19062     "group": "Openchannel_Transfer_Reports",
19063     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19064     "version": "0.0.0",
19065     "filename": "server/api/openchannelTransferReport/index.js",
19066     "groupTitle": "Openchannel_Transfer_Reports"
19067   },
19068   {
19069     "type": "get",
19070     "url": "/api/openchannel/reports/transfer",
19071     "title": "Gets a list of Openchannel Transfer Reports",
19072     "examples": [
19073       {
19074         "title": "Example usage:",
19075         "content": "curl https://{domain}/api/openchannel/reports/transfer -v -u {name}:{password}",
19076         "type": "json"
19077       }
19078     ],
19079     "name": "GetOpenchannel_Transfer_Reports",
19080     "group": "Openchannel_Transfer_Reports",
19081     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19082     "version": "0.0.0",
19083     "filename": "server/api/openchannelTransferReport/index.js",
19084     "groupTitle": "Openchannel_Transfer_Reports"
19085   },
19086   {
19087     "type": "get",
19088     "url": "/api/openchannel/reports/transfer/{id}",
19089     "title": "Gets a single Openchannel Transfer Report",
19090     "examples": [
19091       {
19092         "title": "Example usage:",
19093         "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password}",
19094         "type": "json"
19095       }
19096     ],
19097     "name": "ShowOpenchannel_Transfer_Reports",
19098     "group": "Openchannel_Transfer_Reports",
19099     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19100     "version": "0.0.0",
19101     "filename": "server/api/openchannelTransferReport/index.js",
19102     "groupTitle": "Openchannel_Transfer_Reports"
19103   },
19104   {
19105     "type": "put",
19106     "url": "/api/openchannel/reports/transfer/{id}",
19107     "title": "Update an existing Openchannel Transfer Report",
19108     "examples": [
19109       {
19110         "title": "Example usage:",
19111         "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",
19112         "type": "json"
19113       }
19114     ],
19115     "name": "updateOpenchannel_Transfer_Reports",
19116     "group": "Openchannel_Transfer_Reports",
19117     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19118     "version": "0.0.0",
19119     "filename": "server/api/openchannelTransferReport/index.js",
19120     "groupTitle": "Openchannel_Transfer_Reports"
19121   },
19122   {
19123     "type": "post",
19124     "url": "/api/pauses",
19125     "title": "Creates a new Pause",
19126     "examples": [
19127       {
19128         "title": "Example usage:",
19129         "content": "curl https://{domain}/api/pauses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
19130         "type": "json"
19131       }
19132     ],
19133     "name": "CreatePauses",
19134     "group": "Pauses",
19135     "parameter": {
19136       "fields": {
19137         "Body": [
19138           {
19139             "group": "Body",
19140             "type": "String",
19141             "optional": false,
19142             "field": "name",
19143             "description": ""
19144           },
19145           {
19146             "group": "Body",
19147             "type": "String",
19148             "optional": true,
19149             "field": "description",
19150             "description": ""
19151           }
19152         ]
19153       }
19154     },
19155     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19156     "version": "0.0.0",
19157     "filename": "server/api/pause/index.js",
19158     "groupTitle": "Pauses"
19159   },
19160   {
19161     "type": "delete",
19162     "url": "/api/pauses/{id}",
19163     "title": "Deletes a Pause",
19164     "examples": [
19165       {
19166         "title": "Example usage:",
19167         "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password} -X DELETE",
19168         "type": "json"
19169       }
19170     ],
19171     "name": "DeletePauses",
19172     "group": "Pauses",
19173     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19174     "version": "0.0.0",
19175     "filename": "server/api/pause/index.js",
19176     "groupTitle": "Pauses"
19177   },
19178   {
19179     "type": "get",
19180     "url": "/api/pauses",
19181     "title": "Gets a list of Pauses",
19182     "examples": [
19183       {
19184         "title": "Example usage:",
19185         "content": "curl https://{domain}/api/pauses -v -u {name}:{password}",
19186         "type": "json"
19187       }
19188     ],
19189     "name": "GetPauses",
19190     "group": "Pauses",
19191     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19192     "version": "0.0.0",
19193     "filename": "server/api/pause/index.js",
19194     "groupTitle": "Pauses"
19195   },
19196   {
19197     "type": "get",
19198     "url": "/api/pauses/{id}",
19199     "title": "Gets a single Pause",
19200     "examples": [
19201       {
19202         "title": "Example usage:",
19203         "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password}",
19204         "type": "json"
19205       }
19206     ],
19207     "name": "ShowPauses",
19208     "group": "Pauses",
19209     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19210     "version": "0.0.0",
19211     "filename": "server/api/pause/index.js",
19212     "groupTitle": "Pauses"
19213   },
19214   {
19215     "type": "put",
19216     "url": "/api/pauses/{id}",
19217     "title": "Update an existing Pause",
19218     "examples": [
19219       {
19220         "title": "Example usage:",
19221         "content": "curl https://{domain}/api/pauses/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
19222         "type": "json"
19223       }
19224     ],
19225     "name": "updatePauses",
19226     "group": "Pauses",
19227     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19228     "version": "0.0.0",
19229     "filename": "server/api/pause/index.js",
19230     "groupTitle": "Pauses"
19231   },
19232   {
19233     "type": "get",
19234     "url": "/api/plugins",
19235     "title": "Gets a list of Plugins",
19236     "examples": [
19237       {
19238         "title": "Example usage:",
19239         "content": "curl https://{domain}/api/plugins -v -u {name}:{password}",
19240         "type": "json"
19241       }
19242     ],
19243     "name": "GetPlugins",
19244     "group": "Plugins",
19245     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19246     "version": "0.0.0",
19247     "filename": "server/api/plugin/index.js",
19248     "groupTitle": "Plugins"
19249   },
19250   {
19251     "type": "get",
19252     "url": "/api/plugins/{id}",
19253     "title": "Gets a single Plugin",
19254     "examples": [
19255       {
19256         "title": "Example usage:",
19257         "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password}",
19258         "type": "json"
19259       }
19260     ],
19261     "name": "ShowPlugins",
19262     "group": "Plugins",
19263     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19264     "version": "0.0.0",
19265     "filename": "server/api/plugin/index.js",
19266     "groupTitle": "Plugins"
19267   },
19268   {
19269     "type": "delete",
19270     "url": "/api/plugins/{id}",
19271     "title": "Delete a plugin",
19272     "examples": [
19273       {
19274         "title": "Example usage:",
19275         "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X DELETE",
19276         "type": "json"
19277       }
19278     ],
19279     "name": "destroyPlugin",
19280     "group": "Plugins",
19281     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19282     "version": "0.0.0",
19283     "filename": "server/api/plugin/index.js",
19284     "groupTitle": "Plugins"
19285   },
19286   {
19287     "type": "get",
19288     "url": "/api/plugins/{id}/download",
19289     "title": "Download plugin source code",
19290     "examples": [
19291       {
19292         "title": "Example usage:",
19293         "content": "curl https://{domain}/api/plugins/{id}/download -v -u {name}:{password} -X GET",
19294         "type": "json"
19295       }
19296     ],
19297     "name": "download",
19298     "group": "Plugins",
19299     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19300     "version": "0.0.0",
19301     "filename": "server/api/plugin/index.js",
19302     "groupTitle": "Plugins"
19303   },
19304   {
19305     "type": "put",
19306     "url": "/api/plugins/{id}",
19307     "title": "Update an existing plugin",
19308     "examples": [
19309       {
19310         "title": "Example usage:",
19311         "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X PUT",
19312         "type": "json"
19313       }
19314     ],
19315     "name": "updatePlugin",
19316     "group": "Plugins",
19317     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19318     "version": "0.0.0",
19319     "filename": "server/api/plugin/index.js",
19320     "groupTitle": "Plugins"
19321   },
19322   {
19323     "type": "post",
19324     "url": "/api/plugins",
19325     "title": "Upload new plugin",
19326     "examples": [
19327       {
19328         "title": "Example usage:",
19329         "content": "curl https://{domain}/api/plugins -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
19330         "type": "json"
19331       }
19332     ],
19333     "name": "uploadPlugin",
19334     "group": "Plugins",
19335     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19336     "version": "0.0.0",
19337     "filename": "server/api/plugin/index.js",
19338     "groupTitle": "Plugins"
19339   },
19340   {
19341     "type": "post",
19342     "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
19343     "title": "Redirect a plugin request to the specified path",
19344     "examples": [
19345       {
19346         "title": "Example usage:",
19347         "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -H 'Content-Type: application/json' -X POST",
19348         "type": "json"
19349       }
19350     ],
19351     "name": "webhookPlugin",
19352     "group": "Plugins",
19353     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19354     "version": "0.0.0",
19355     "filename": "server/api/plugin/index.js",
19356     "groupTitle": "Plugins"
19357   },
19358   {
19359     "type": "get",
19360     "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
19361     "title": "Redirect a plugin request to the specified path",
19362     "examples": [
19363       {
19364         "title": "Example usage:",
19365         "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -v -u {name}:{password} -X GET",
19366         "type": "json"
19367       }
19368     ],
19369     "name": "webhookPlugin",
19370     "group": "Plugins",
19371     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19372     "version": "0.0.0",
19373     "filename": "server/api/plugin/index.js",
19374     "groupTitle": "Plugins"
19375   },
19376   {
19377     "type": "delete",
19378     "url": "/api/pm2/{id}",
19379     "title": "Deletes an existing process",
19380     "examples": [
19381       {
19382         "title": "Example usage:",
19383         "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password} -X DELETE",
19384         "type": "json"
19385       }
19386     ],
19387     "name": "DeletePm2Process",
19388     "group": "Pm2",
19389     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19390     "version": "0.0.0",
19391     "filename": "server/api/pm2/index.js",
19392     "groupTitle": "Pm2"
19393   },
19394   {
19395     "type": "get",
19396     "url": "/api/pm2/{id}",
19397     "title": "Gets a single pm2 process",
19398     "examples": [
19399       {
19400         "title": "Example usage:",
19401         "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password}",
19402         "type": "json"
19403       }
19404     ],
19405     "name": "GetPm2Process",
19406     "group": "Pm2",
19407     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19408     "version": "0.0.0",
19409     "filename": "server/api/pm2/index.js",
19410     "groupTitle": "Pm2"
19411   },
19412   {
19413     "type": "get",
19414     "url": "/api/pm2",
19415     "title": "Gets pm2 processes",
19416     "examples": [
19417       {
19418         "title": "Example usage:",
19419         "content": "curl https://{domain}/api/pm2 -v -u {name}:{password}",
19420         "type": "json"
19421       }
19422     ],
19423     "name": "GetPm2Processes",
19424     "group": "Pm2",
19425     "description": "<p>Motion returns the pm2 processes list.</p>",
19426     "version": "0.0.0",
19427     "filename": "server/api/pm2/index.js",
19428     "groupTitle": "Pm2"
19429   },
19430   {
19431     "type": "post",
19432     "url": "/api/pm2",
19433     "title": "Start a single pm2 process",
19434     "examples": [
19435       {
19436         "title": "Example usage:",
19437         "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",
19438         "type": "json"
19439       }
19440     ],
19441     "name": "StartPm2Process",
19442     "group": "Pm2",
19443     "parameter": {
19444       "fields": {
19445         "Body": [
19446           {
19447             "group": "Body",
19448             "type": "String",
19449             "optional": false,
19450             "field": "name",
19451             "description": ""
19452           },
19453           {
19454             "group": "Body",
19455             "type": "String",
19456             "optional": false,
19457             "field": "script",
19458             "description": ""
19459           }
19460         ]
19461       }
19462     },
19463     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19464     "version": "0.0.0",
19465     "filename": "server/api/pm2/index.js",
19466     "groupTitle": "Pm2"
19467   },
19468   {
19469     "type": "put",
19470     "url": "/api/pm2/{id}",
19471     "title": "Update an existing process",
19472     "examples": [
19473       {
19474         "title": "Example usage:",
19475         "content": "curl https://{domain}/api/pm2/{id} -d '{\"status\": \"online\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
19476         "type": "json"
19477       }
19478     ],
19479     "name": "UpdatePm2Process",
19480     "group": "Pm2",
19481     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19482     "version": "0.0.0",
19483     "filename": "server/api/pm2/index.js",
19484     "groupTitle": "Pm2"
19485   },
19486   {
19487     "type": "get",
19488     "url": "/api/rpc/campaigns/",
19489     "title": "Gets a list of campaigns",
19490     "examples": [
19491       {
19492         "title": "Example usage:",
19493         "content": "curl https://{domain}/api/rpc/campaigns -v -u {name}:{password}",
19494         "type": "json"
19495       }
19496     ],
19497     "name": "Campaigns",
19498     "group": "RPC_Realtime",
19499     "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>",
19500     "version": "0.0.0",
19501     "filename": "server/api/rpc/index.js",
19502     "groupTitle": "RPC_Realtime"
19503   },
19504   {
19505     "type": "get",
19506     "url": "/api/rpc/fax/accounts",
19507     "title": "Gets a list of FaxAccounts",
19508     "examples": [
19509       {
19510         "title": "Example usage:",
19511         "content": "curl https://{domain}/api/rpc/fax/accounts -v -u {name}:{password}",
19512         "type": "json"
19513       }
19514     ],
19515     "name": "FaxAccounts",
19516     "group": "RPC_Realtime",
19517     "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>",
19518     "version": "0.0.0",
19519     "filename": "server/api/rpc/index.js",
19520     "groupTitle": "RPC_Realtime"
19521   },
19522   {
19523     "type": "put",
19524     "url": "/api/rpc/agents/:id/capacity",
19525     "title": "Sets agent capacity",
19526     "examples": [
19527       {
19528         "title": "Example usage:",
19529         "content": "curl https://{domain}/api/rpc/agents/:id/capacity -v -u {name}:{password}",
19530         "type": "json"
19531       }
19532     ],
19533     "name": "RTAgentCapacity",
19534     "group": "RPC_Realtime",
19535     "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>",
19536     "version": "0.0.0",
19537     "filename": "server/api/rpc/index.js",
19538     "groupTitle": "RPC_Realtime"
19539   },
19540   {
19541     "type": "get",
19542     "url": "/api/rpc/agents",
19543     "title": "Gets a list of RTAgents",
19544     "examples": [
19545       {
19546         "title": "Example usage:",
19547         "content": "curl https://{domain}/api/rpc/agents -v -u {name}:{password}",
19548         "type": "json"
19549       }
19550     ],
19551     "name": "RTAgents",
19552     "group": "RPC_Realtime",
19553     "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>",
19554     "version": "0.0.0",
19555     "filename": "server/api/rpc/index.js",
19556     "groupTitle": "RPC_Realtime"
19557   },
19558   {
19559     "type": "get",
19560     "url": "/api/rpc/chat/queues",
19561     "title": "Gets a list of RTChatQueues",
19562     "examples": [
19563       {
19564         "title": "Example usage:",
19565         "content": "curl https://{domain}/api/rpc/chat/queues -v -u {name}:{password}",
19566         "type": "json"
19567       }
19568     ],
19569     "name": "RTChatQueues",
19570     "group": "RPC_Realtime",
19571     "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>",
19572     "version": "0.0.0",
19573     "filename": "server/api/rpc/index.js",
19574     "groupTitle": "RPC_Realtime"
19575   },
19576   {
19577     "type": "get",
19578     "url": "/api/rpc/fax/queues",
19579     "title": "Gets a list of RTFaxQueues",
19580     "examples": [
19581       {
19582         "title": "Example usage:",
19583         "content": "curl https://{domain}/api/rpc/fax/queues -v -u {name}:{password}",
19584         "type": "json"
19585       }
19586     ],
19587     "name": "RTFaxQueues",
19588     "group": "RPC_Realtime",
19589     "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>",
19590     "version": "0.0.0",
19591     "filename": "server/api/rpc/index.js",
19592     "groupTitle": "RPC_Realtime"
19593   },
19594   {
19595     "type": "get",
19596     "url": "/api/rpc/mail/accounts",
19597     "title": "Gets a list of RTMailAccounts",
19598     "examples": [
19599       {
19600         "title": "Example usage:",
19601         "content": "curl https://{domain}/api/rpc/mail/accounts -v -u {name}:{password}",
19602         "type": "json"
19603       }
19604     ],
19605     "name": "RTMailAccounts",
19606     "group": "RPC_Realtime",
19607     "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>",
19608     "version": "0.0.0",
19609     "filename": "server/api/rpc/index.js",
19610     "groupTitle": "RPC_Realtime"
19611   },
19612   {
19613     "type": "get",
19614     "url": "/api/rpc/mail/queues",
19615     "title": "Gets a list of RTMailQueues",
19616     "examples": [
19617       {
19618         "title": "Example usage:",
19619         "content": "curl https://{domain}/api/rpc/mail/queues -v -u {name}:{password}",
19620         "type": "json"
19621       }
19622     ],
19623     "name": "RTMailQueues",
19624     "group": "RPC_Realtime",
19625     "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>",
19626     "version": "0.0.0",
19627     "filename": "server/api/rpc/index.js",
19628     "groupTitle": "RPC_Realtime"
19629   },
19630   {
19631     "type": "get",
19632     "url": "/api/rpc/openchannel/queues",
19633     "title": "Gets a list of RTOpenchannelQueues",
19634     "examples": [
19635       {
19636         "title": "Example usage:",
19637         "content": "curl https://{domain}/api/rpc/openchannel/queues -v -u {name}:{password}",
19638         "type": "json"
19639       }
19640     ],
19641     "name": "RTOpenchannelQueues",
19642     "group": "RPC_Realtime",
19643     "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>",
19644     "version": "0.0.0",
19645     "filename": "server/api/rpc/index.js",
19646     "groupTitle": "RPC_Realtime"
19647   },
19648   {
19649     "type": "get",
19650     "url": "/api/rpc/outbound/channels",
19651     "title": "Gets a list of RTOutboundChannels",
19652     "examples": [
19653       {
19654         "title": "Example usage:",
19655         "content": "curl https://{domain}/api/rpc/outbound/channels -v -u {name}:{password}",
19656         "type": "json"
19657       }
19658     ],
19659     "name": "RTOutboundChannels",
19660     "group": "RPC_Realtime",
19661     "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>",
19662     "version": "0.0.0",
19663     "filename": "server/api/rpc/index.js",
19664     "groupTitle": "RPC_Realtime"
19665   },
19666   {
19667     "type": "get",
19668     "url": "/api/rpc/sms/queues",
19669     "title": "Gets a list of RTSmsQueues",
19670     "examples": [
19671       {
19672         "title": "Example usage:",
19673         "content": "curl https://{domain}/api/rpc/sms/queues -v -u {name}:{password}",
19674         "type": "json"
19675       }
19676     ],
19677     "name": "RTSmsQueues",
19678     "group": "RPC_Realtime",
19679     "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>",
19680     "version": "0.0.0",
19681     "filename": "server/api/rpc/index.js",
19682     "groupTitle": "RPC_Realtime"
19683   },
19684   {
19685     "type": "get",
19686     "url": "/api/rpc/telephones",
19687     "title": "Gets a list of RTTelephones",
19688     "examples": [
19689       {
19690         "title": "Example usage:",
19691         "content": "curl https://{domain}/api/rpc/telephones -v -u {name}:{password}",
19692         "type": "json"
19693       }
19694     ],
19695     "name": "RTTelephones",
19696     "group": "RPC_Realtime",
19697     "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>",
19698     "version": "0.0.0",
19699     "filename": "server/api/rpc/index.js",
19700     "groupTitle": "RPC_Realtime"
19701   },
19702   {
19703     "type": "get",
19704     "url": "/api/rpc/trunks",
19705     "title": "Gets a list of RTTrunks",
19706     "examples": [
19707       {
19708         "title": "Example usage:",
19709         "content": "curl https://{domain}/api/rpc/trunks -v -u {name}:{password}",
19710         "type": "json"
19711       }
19712     ],
19713     "name": "RTTrunks",
19714     "group": "RPC_Realtime",
19715     "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>",
19716     "version": "0.0.0",
19717     "filename": "server/api/rpc/index.js",
19718     "groupTitle": "RPC_Realtime"
19719   },
19720   {
19721     "type": "get",
19722     "url": "/api/rpc/voice/channels",
19723     "title": "Gets a list of RTVoiceChannelMixMonitor",
19724     "examples": [
19725       {
19726         "title": "Example usage:",
19727         "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/mixmonitor -v -u {name}:{password}",
19728         "type": "json"
19729       }
19730     ],
19731     "name": "RTVoiceChannelMixMonitor",
19732     "group": "RPC_Realtime",
19733     "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>",
19734     "version": "0.0.0",
19735     "filename": "server/api/rpc/index.js",
19736     "groupTitle": "RPC_Realtime"
19737   },
19738   {
19739     "type": "get",
19740     "url": "/api/rpc/voice/channels",
19741     "title": "Gets a list of RTVoiceChannelStopMixMonitor",
19742     "examples": [
19743       {
19744         "title": "Example usage:",
19745         "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/stopmixmonitor -v -u {name}:{password}",
19746         "type": "json"
19747       }
19748     ],
19749     "name": "RTVoiceChannelStopMixMonitor",
19750     "group": "RPC_Realtime",
19751     "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>",
19752     "version": "0.0.0",
19753     "filename": "server/api/rpc/index.js",
19754     "groupTitle": "RPC_Realtime"
19755   },
19756   {
19757     "type": "get",
19758     "url": "/api/rpc/voice/channels",
19759     "title": "Gets a list of RTVoiceChannels",
19760     "examples": [
19761       {
19762         "title": "Example usage:",
19763         "content": "curl https://{domain}/api/rpc/voice/channels -v -u {name}:{password}",
19764         "type": "json"
19765       }
19766     ],
19767     "name": "RTVoiceChannels",
19768     "group": "RPC_Realtime",
19769     "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>",
19770     "version": "0.0.0",
19771     "filename": "server/api/rpc/index.js",
19772     "groupTitle": "RPC_Realtime"
19773   },
19774   {
19775     "type": "get",
19776     "url": "/api/rpc/voice/queues/channels/{uniqueid}",
19777     "title": "Gets a single RTVoiceQueueChannel",
19778     "examples": [
19779       {
19780         "title": "Example usage:",
19781         "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid} -v -u {name}:{password}",
19782         "type": "json"
19783       }
19784     ],
19785     "name": "RTVoiceQueueChannel",
19786     "group": "RPC_Realtime",
19787     "description": "<p>Motion will return a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19788     "version": "0.0.0",
19789     "filename": "server/api/rpc/index.js",
19790     "groupTitle": "RPC_Realtime"
19791   },
19792   {
19793     "type": "get",
19794     "url": "/api/rpc/voice/queues/channels/{uniqueid}/hangup",
19795     "title": "Hangup a single RTVoiceQueueChannel",
19796     "examples": [
19797       {
19798         "title": "Example usage:",
19799         "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/hangup -v -u {name}:{password}",
19800         "type": "json"
19801       }
19802     ],
19803     "name": "RTVoiceQueueChannelHangup",
19804     "group": "RPC_Realtime",
19805     "description": "<p>Motion will hangup a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19806     "version": "0.0.0",
19807     "filename": "server/api/rpc/index.js",
19808     "groupTitle": "RPC_Realtime"
19809   },
19810   {
19811     "type": "get",
19812     "url": "/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten}",
19813     "title": "Hangup a single RTVoiceQueueChannel",
19814     "examples": [
19815       {
19816         "title": "Example usage:",
19817         "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten} -v -u {name}:{password}",
19818         "type": "json"
19819       }
19820     ],
19821     "name": "RTVoiceQueueChannelRedirect",
19822     "group": "RPC_Realtime",
19823     "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>",
19824     "version": "0.0.0",
19825     "filename": "server/api/rpc/index.js",
19826     "groupTitle": "RPC_Realtime"
19827   },
19828   {
19829     "type": "get",
19830     "url": "/api/rpc/voice/queues/preview/{id}",
19831     "title": "Gets a single preview contact",
19832     "examples": [
19833       {
19834         "title": "Example usage:",
19835         "content": "curl https://{domain}/api/rpc/voice/queues/preview/{id} -v -u {name}:{password}",
19836         "type": "json"
19837       }
19838     ],
19839     "name": "RTVoiceQueuePreview",
19840     "group": "RPC_Realtime",
19841     "description": "<p>Motion will return a specific preview contact.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19842     "version": "0.0.0",
19843     "filename": "server/api/rpc/index.js",
19844     "groupTitle": "RPC_Realtime"
19845   },
19846   {
19847     "type": "get",
19848     "url": "/api/rpc/outbound",
19849     "title": "Gets a list of RTOutbound",
19850     "examples": [
19851       {
19852         "title": "Example usage:",
19853         "content": "curl https://{domain}/api/rpc/outbound -v -u {name}:{password}",
19854         "type": "json"
19855       }
19856     ],
19857     "name": "RTVoiceQueues",
19858     "group": "RPC_Realtime",
19859     "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>",
19860     "version": "0.0.0",
19861     "filename": "server/api/rpc/index.js",
19862     "groupTitle": "RPC_Realtime"
19863   },
19864   {
19865     "type": "get",
19866     "url": "/api/rpc/voice/queues",
19867     "title": "Gets a list of RTVoiceQueues",
19868     "examples": [
19869       {
19870         "title": "Example usage:",
19871         "content": "curl https://{domain}/api/rpc/voice/queues -v -u {name}:{password}",
19872         "type": "json"
19873       }
19874     ],
19875     "name": "RTVoiceQueues",
19876     "group": "RPC_Realtime",
19877     "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>",
19878     "version": "0.0.0",
19879     "filename": "server/api/rpc/index.js",
19880     "groupTitle": "RPC_Realtime"
19881   },
19882   {
19883     "type": "get",
19884     "url": "/api/rpc/voice/queues/channels",
19885     "title": "Gets a list of RTVoiceQueuesChannels",
19886     "examples": [
19887       {
19888         "title": "Example usage:",
19889         "content": "curl https://{domain}/api/rpc/voice/queues/channels -v -u {name}:{password}",
19890         "type": "json"
19891       }
19892     ],
19893     "name": "RTVoiceQueuesChannels",
19894     "group": "RPC_Realtime",
19895     "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>",
19896     "version": "0.0.0",
19897     "filename": "server/api/rpc/index.js",
19898     "groupTitle": "RPC_Realtime"
19899   },
19900   {
19901     "type": "get",
19902     "url": "/api/rpc/chat/queues/{id}",
19903     "title": "Gets a single RTChatQueue",
19904     "examples": [
19905       {
19906         "title": "Example usage:",
19907         "content": "curl https://{domain}/api/rpc/chat/queues/{id} -v -u {name}:{password}",
19908         "type": "json"
19909       }
19910     ],
19911     "name": "ShowRTChatQueues",
19912     "group": "RPC_Realtime",
19913     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19914     "version": "0.0.0",
19915     "filename": "server/api/rpc/index.js",
19916     "groupTitle": "RPC_Realtime"
19917   },
19918   {
19919     "type": "get",
19920     "url": "/api/rpc/fax/queues/{id}",
19921     "title": "Gets a single RTFaxQueue",
19922     "examples": [
19923       {
19924         "title": "Example usage:",
19925         "content": "curl https://{domain}/api/rpc/fax/queues/{id} -v -u {name}:{password}",
19926         "type": "json"
19927       }
19928     ],
19929     "name": "ShowRTFaxQueues",
19930     "group": "RPC_Realtime",
19931     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19932     "version": "0.0.0",
19933     "filename": "server/api/rpc/index.js",
19934     "groupTitle": "RPC_Realtime"
19935   },
19936   {
19937     "type": "get",
19938     "url": "/api/rpc/mail/queues/{id}",
19939     "title": "Gets a single RTMailQueue",
19940     "examples": [
19941       {
19942         "title": "Example usage:",
19943         "content": "curl https://{domain}/api/rpc/mail/queues/{id} -v -u {name}:{password}",
19944         "type": "json"
19945       }
19946     ],
19947     "name": "ShowRTMailQueues",
19948     "group": "RPC_Realtime",
19949     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19950     "version": "0.0.0",
19951     "filename": "server/api/rpc/index.js",
19952     "groupTitle": "RPC_Realtime"
19953   },
19954   {
19955     "type": "get",
19956     "url": "/api/rpc/openchannel/queues/{id}",
19957     "title": "Gets a single RTOpenchannelQueue",
19958     "examples": [
19959       {
19960         "title": "Example usage:",
19961         "content": "curl https://{domain}/api/rpc/openchannel/queues/{id} -v -u {name}:{password}",
19962         "type": "json"
19963       }
19964     ],
19965     "name": "ShowRTOpenchannelQueues",
19966     "group": "RPC_Realtime",
19967     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19968     "version": "0.0.0",
19969     "filename": "server/api/rpc/index.js",
19970     "groupTitle": "RPC_Realtime"
19971   },
19972   {
19973     "type": "get",
19974     "url": "/api/rpc/sms/queues/{id}",
19975     "title": "Gets a single RTSmsQueue",
19976     "examples": [
19977       {
19978         "title": "Example usage:",
19979         "content": "curl https://{domain}/api/rpc/sms/queues/{id} -v -u {name}:{password}",
19980         "type": "json"
19981       }
19982     ],
19983     "name": "ShowRTSmsQueues",
19984     "group": "RPC_Realtime",
19985     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19986     "version": "0.0.0",
19987     "filename": "server/api/rpc/index.js",
19988     "groupTitle": "RPC_Realtime"
19989   },
19990   {
19991     "type": "get",
19992     "url": "/api/rpc/voice/queues/{id}",
19993     "title": "Gets a single RTVoiceQueue",
19994     "examples": [
19995       {
19996         "title": "Example usage:",
19997         "content": "curl https://{domain}/api/rpc/voice/queues/{id} -v -u {name}:{password}",
19998         "type": "json"
19999       }
20000     ],
20001     "name": "ShowRTVoiceQueues",
20002     "group": "RPC_Realtime",
20003     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20004     "version": "0.0.0",
20005     "filename": "server/api/rpc/index.js",
20006     "groupTitle": "RPC_Realtime"
20007   },
20008   {
20009     "type": "put",
20010     "url": "/api/rpc/voice/{id}/queues",
20011     "title": "Updates a single VoiceQueue",
20012     "examples": [
20013       {
20014         "title": "Example usage:",
20015         "content": "curl https://{domain}/api/rpc/voice/queues/{id} -v -u {name}:{password}",
20016         "type": "json"
20017       }
20018     ],
20019     "name": "UpdateVoiceQueues",
20020     "group": "RPC_Realtime",
20021     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20022     "version": "0.0.0",
20023     "filename": "server/api/rpc/index.js",
20024     "groupTitle": "RPC_Realtime"
20025   },
20026   {
20027     "type": "post",
20028     "url": "/api/rpc/agents/:id/notify",
20029     "title": "Notify message to a specific agent",
20030     "examples": [
20031       {
20032         "title": "Example usage:",
20033         "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",
20034         "type": "json"
20035       }
20036     ],
20037     "name": "agentNotify",
20038     "group": "RPC_Realtime",
20039     "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>",
20040     "version": "0.0.0",
20041     "filename": "server/api/rpc/index.js",
20042     "groupTitle": "RPC_Realtime"
20043   },
20044   {
20045     "type": "post",
20046     "url": "/api/rpc/chat/queues/:id/notify",
20047     "title": "Notify message to a specific queue",
20048     "examples": [
20049       {
20050         "title": "Example usage:",
20051         "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",
20052         "type": "json"
20053       }
20054     ],
20055     "name": "chatQueueNotify",
20056     "group": "RPC_Realtime",
20057     "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>",
20058     "version": "0.0.0",
20059     "filename": "server/api/rpc/index.js",
20060     "groupTitle": "RPC_Realtime"
20061   },
20062   {
20063     "type": "get",
20064     "url": "/api/rpc/chat/queues/waitinginteractions",
20065     "title": "Gets a list of chatQueuesWaitingInteractions",
20066     "examples": [
20067       {
20068         "title": "Example usage:",
20069         "content": "curl https://{domain}/api/rpc/chat/queues/waitinginteractions -v -u {name}:{password}",
20070         "type": "json"
20071       }
20072     ],
20073     "name": "chatQueuesWaitingInteractions",
20074     "group": "RPC_Realtime",
20075     "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>",
20076     "version": "0.0.0",
20077     "filename": "server/api/rpc/index.js",
20078     "groupTitle": "RPC_Realtime"
20079   },
20080   {
20081     "type": "post",
20082     "url": "/api/rpc/fax/queues/:id/notify",
20083     "title": "Notify message to a specific queue",
20084     "examples": [
20085       {
20086         "title": "Example usage:",
20087         "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",
20088         "type": "json"
20089       }
20090     ],
20091     "name": "faxQueueNotify",
20092     "group": "RPC_Realtime",
20093     "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>",
20094     "version": "0.0.0",
20095     "filename": "server/api/rpc/index.js",
20096     "groupTitle": "RPC_Realtime"
20097   },
20098   {
20099     "type": "get",
20100     "url": "/api/rpc/fax/queues/waitinginteractions",
20101     "title": "Gets a list of faxQueuesWaitingInteractions",
20102     "examples": [
20103       {
20104         "title": "Example usage:",
20105         "content": "curl https://{domain}/api/rpc/fax/queues/waitinginteractions -v -u {name}:{password}",
20106         "type": "json"
20107       }
20108     ],
20109     "name": "faxQueuesWaitingInteractions",
20110     "group": "RPC_Realtime",
20111     "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>",
20112     "version": "0.0.0",
20113     "filename": "server/api/rpc/index.js",
20114     "groupTitle": "RPC_Realtime"
20115   },
20116   {
20117     "type": "post",
20118     "url": "/api/rpc/mail/queues/:id/notify",
20119     "title": "Notify message to a specific queue",
20120     "examples": [
20121       {
20122         "title": "Example usage:",
20123         "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",
20124         "type": "json"
20125       }
20126     ],
20127     "name": "mailQueueNotify",
20128     "group": "RPC_Realtime",
20129     "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>",
20130     "version": "0.0.0",
20131     "filename": "server/api/rpc/index.js",
20132     "groupTitle": "RPC_Realtime"
20133   },
20134   {
20135     "type": "get",
20136     "url": "/api/rpc/mail/queues/waitinginteractions",
20137     "title": "Gets a list of mailQueuesWaitingInteractions",
20138     "examples": [
20139       {
20140         "title": "Example usage:",
20141         "content": "curl https://{domain}/api/rpc/mail/queues/waitinginteractions -v -u {name}:{password}",
20142         "type": "json"
20143       }
20144     ],
20145     "name": "mailQueuesWaitingInteractions",
20146     "group": "RPC_Realtime",
20147     "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>",
20148     "version": "0.0.0",
20149     "filename": "server/api/rpc/index.js",
20150     "groupTitle": "RPC_Realtime"
20151   },
20152   {
20153     "type": "post",
20154     "url": "/api/rpc/openchannel/queues/:id/notify",
20155     "title": "Notify message to a specific queue",
20156     "examples": [
20157       {
20158         "title": "Example usage:",
20159         "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",
20160         "type": "json"
20161       }
20162     ],
20163     "name": "openchannelQueueNotify",
20164     "group": "RPC_Realtime",
20165     "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>",
20166     "version": "0.0.0",
20167     "filename": "server/api/rpc/index.js",
20168     "groupTitle": "RPC_Realtime"
20169   },
20170   {
20171     "type": "get",
20172     "url": "/api/rpc/openchannel/queues/:id/waitinginteractions",
20173     "title": "Gets a list of openchannelQueuesIdWaitingInteractions",
20174     "examples": [
20175       {
20176         "title": "Example usage:",
20177         "content": "curl https://{domain}/api/rpc/openchannel/queues/:id/waitinginteractions -v -u {name}:{password}",
20178         "type": "json"
20179       }
20180     ],
20181     "name": "openchannelQueuesIdWaitingInteractions",
20182     "group": "RPC_Realtime",
20183     "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>",
20184     "version": "0.0.0",
20185     "filename": "server/api/rpc/index.js",
20186     "groupTitle": "RPC_Realtime"
20187   },
20188   {
20189     "type": "get",
20190     "url": "/api/rpc/openchannel/queues/waitinginteractions",
20191     "title": "Gets a list of openchannelQueuesWaitingInteractions",
20192     "examples": [
20193       {
20194         "title": "Example usage:",
20195         "content": "curl https://{domain}/api/rpc/openchannel/queues/waitinginteractions -v -u {name}:{password}",
20196         "type": "json"
20197       }
20198     ],
20199     "name": "openchannelQueuesWaitingInteractions",
20200     "group": "RPC_Realtime",
20201     "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>",
20202     "version": "0.0.0",
20203     "filename": "server/api/rpc/index.js",
20204     "groupTitle": "RPC_Realtime"
20205   },
20206   {
20207     "type": "post",
20208     "url": "/api/rpc/sms/queues/:id/notify",
20209     "title": "Notify message to a specific queue",
20210     "examples": [
20211       {
20212         "title": "Example usage:",
20213         "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",
20214         "type": "json"
20215       }
20216     ],
20217     "name": "smsQueueNotify",
20218     "group": "RPC_Realtime",
20219     "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>",
20220     "version": "0.0.0",
20221     "filename": "server/api/rpc/index.js",
20222     "groupTitle": "RPC_Realtime"
20223   },
20224   {
20225     "type": "get",
20226     "url": "/api/rpc/sms/queues/waitinginteractions",
20227     "title": "Gets a list of smsQueuesWaitingInteractions",
20228     "examples": [
20229       {
20230         "title": "Example usage:",
20231         "content": "curl https://{domain}/api/rpc/sms/queues/waitinginteractions -v -u {name}:{password}",
20232         "type": "json"
20233       }
20234     ],
20235     "name": "smsQueuesWaitingInteractions",
20236     "group": "RPC_Realtime",
20237     "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>",
20238     "version": "0.0.0",
20239     "filename": "server/api/rpc/index.js",
20240     "groupTitle": "RPC_Realtime"
20241   },
20242   {
20243     "type": "post",
20244     "url": "/api/integrations/salesforce/accounts",
20245     "title": "Creates a new Salesforce Account",
20246     "examples": [
20247       {
20248         "title": "Example usage:",
20249         "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",
20250         "type": "json"
20251       }
20252     ],
20253     "name": "CreateSalesforce_Accounts",
20254     "group": "Salesforce_Accounts",
20255     "parameter": {
20256       "fields": {
20257         "Body": [
20258           {
20259             "group": "Body",
20260             "type": "String",
20261             "optional": true,
20262             "field": "name",
20263             "description": ""
20264           },
20265           {
20266             "group": "Body",
20267             "type": "String",
20268             "optional": true,
20269             "field": "description",
20270             "description": ""
20271           },
20272           {
20273             "group": "Body",
20274             "type": "String",
20275             "optional": true,
20276             "field": "username",
20277             "description": ""
20278           },
20279           {
20280             "group": "Body",
20281             "type": "String",
20282             "optional": true,
20283             "field": "remoteUri",
20284             "description": ""
20285           },
20286           {
20287             "group": "Body",
20288             "type": "String",
20289             "optional": true,
20290             "field": "password",
20291             "description": ""
20292           },
20293           {
20294             "group": "Body",
20295             "type": "String",
20296             "optional": true,
20297             "field": "clientId",
20298             "description": ""
20299           },
20300           {
20301             "group": "Body",
20302             "type": "String",
20303             "optional": true,
20304             "field": "clientSecret",
20305             "description": ""
20306           },
20307           {
20308             "group": "Body",
20309             "type": "String",
20310             "optional": true,
20311             "field": "securityToken",
20312             "description": ""
20313           },
20314           {
20315             "group": "Body",
20316             "type": "String",
20317             "optional": false,
20318             "field": "serverUrl",
20319             "description": ""
20320           },
20321           {
20322             "group": "Body",
20323             "type": "String",
20324             "allowedValues": [
20325               "\"integrationTab\"",
20326               "\"newTab\""
20327             ],
20328             "optional": true,
20329             "field": "type",
20330             "description": ""
20331           }
20332         ]
20333       }
20334     },
20335     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20336     "version": "0.0.0",
20337     "filename": "server/api/intSalesforceAccount/index.js",
20338     "groupTitle": "Salesforce_Accounts"
20339   },
20340   {
20341     "type": "delete",
20342     "url": "/api/integrations/salesforce/accounts/{id}",
20343     "title": "Deletes a Salesforce Account",
20344     "examples": [
20345       {
20346         "title": "Example usage:",
20347         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password} -X DELETE",
20348         "type": "json"
20349       }
20350     ],
20351     "name": "DeleteSalesforce_Accounts",
20352     "group": "Salesforce_Accounts",
20353     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20354     "version": "0.0.0",
20355     "filename": "server/api/intSalesforceAccount/index.js",
20356     "groupTitle": "Salesforce_Accounts"
20357   },
20358   {
20359     "type": "get",
20360     "url": "/api/integrations/salesforce/accounts",
20361     "title": "Gets a list of Salesforce Accounts",
20362     "examples": [
20363       {
20364         "title": "Example usage:",
20365         "content": "curl https://{domain}/api/integrations/salesforce/accounts -v -u {name}:{password}",
20366         "type": "json"
20367       }
20368     ],
20369     "name": "GetSalesforce_Accounts",
20370     "group": "Salesforce_Accounts",
20371     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20372     "version": "0.0.0",
20373     "filename": "server/api/intSalesforceAccount/index.js",
20374     "groupTitle": "Salesforce_Accounts"
20375   },
20376   {
20377     "type": "get",
20378     "url": "/api/integrations/salesforce/accounts/{id}",
20379     "title": "Gets a single Salesforce Account",
20380     "examples": [
20381       {
20382         "title": "Example usage:",
20383         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password}",
20384         "type": "json"
20385       }
20386     ],
20387     "name": "ShowSalesforce_Accounts",
20388     "group": "Salesforce_Accounts",
20389     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20390     "version": "0.0.0",
20391     "filename": "server/api/intSalesforceAccount/index.js",
20392     "groupTitle": "Salesforce_Accounts"
20393   },
20394   {
20395     "type": "post",
20396     "url": "/api/integrations/salesforce/accounts/{id}/configurations",
20397     "title": "Creates new configuration",
20398     "examples": [
20399       {
20400         "title": "Example usage:",
20401         "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",
20402         "type": "json"
20403       }
20404     ],
20405     "name": "addConfiguration",
20406     "group": "Salesforce_Accounts",
20407     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20408     "version": "0.0.0",
20409     "filename": "server/api/intSalesforceAccount/index.js",
20410     "groupTitle": "Salesforce_Accounts"
20411   },
20412   {
20413     "type": "get",
20414     "url": "/api/integrations/salesforce/accounts/{id}/configurations",
20415     "title": "Gets account configurations",
20416     "examples": [
20417       {
20418         "title": "Example usage:",
20419         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/configurations -v -u {name}:{password} -X GET",
20420         "type": "json"
20421       }
20422     ],
20423     "name": "getConfigurations",
20424     "group": "Salesforce_Accounts",
20425     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20426     "version": "0.0.0",
20427     "filename": "server/api/intSalesforceAccount/index.js",
20428     "groupTitle": "Salesforce_Accounts"
20429   },
20430   {
20431     "type": "get",
20432     "url": "/api/integrations/salesforce/accounts/{id}/fields",
20433     "title": "Gets account fields",
20434     "examples": [
20435       {
20436         "title": "Example usage:",
20437         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/fields -v -u {name}:{password} -X GET",
20438         "type": "json"
20439       }
20440     ],
20441     "name": "getFields",
20442     "group": "Salesforce_Accounts",
20443     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20444     "version": "0.0.0",
20445     "filename": "server/api/intSalesforceAccount/index.js",
20446     "groupTitle": "Salesforce_Accounts"
20447   },
20448   {
20449     "type": "put",
20450     "url": "/api/integrations/salesforce/accounts/{id}",
20451     "title": "Update an existing Salesforce Account",
20452     "examples": [
20453       {
20454         "title": "Example usage:",
20455         "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",
20456         "type": "json"
20457       }
20458     ],
20459     "name": "updateSalesforce_Accounts",
20460     "group": "Salesforce_Accounts",
20461     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20462     "version": "0.0.0",
20463     "filename": "server/api/intSalesforceAccount/index.js",
20464     "groupTitle": "Salesforce_Accounts"
20465   },
20466   {
20467     "type": "post",
20468     "url": "/api/integrations/salesforce/configurations",
20469     "title": "Creates a new Salesforce Configuration",
20470     "examples": [
20471       {
20472         "title": "Example usage:",
20473         "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",
20474         "type": "json"
20475       }
20476     ],
20477     "name": "CreateSalesforce_Configurations",
20478     "group": "Salesforce_Configurations",
20479     "parameter": {
20480       "fields": {
20481         "Body": [
20482           {
20483             "group": "Body",
20484             "type": "String",
20485             "optional": true,
20486             "field": "name",
20487             "description": ""
20488           },
20489           {
20490             "group": "Body",
20491             "type": "String",
20492             "optional": true,
20493             "field": "description",
20494             "description": ""
20495           },
20496           {
20497             "group": "Body",
20498             "type": "String",
20499             "allowedValues": [
20500               "\"Task\"",
20501               "\"Case\""
20502             ],
20503             "optional": true,
20504             "field": "ticketType",
20505             "description": ""
20506           },
20507           {
20508             "group": "Body",
20509             "type": "String",
20510             "allowedValues": [
20511               "\"contact_lead\"",
20512               "\"contact\"",
20513               "\"lead\"",
20514               "\"account_contact_lead\"",
20515               "\"account\""
20516             ],
20517             "optional": true,
20518             "field": "moduleSearch",
20519             "description": ""
20520           },
20521           {
20522             "group": "Body",
20523             "type": "String",
20524             "allowedValues": [
20525               "\"nothing\"",
20526               "\"contact\"",
20527               "\"lead\"",
20528               "\"account\""
20529             ],
20530             "optional": true,
20531             "field": "moduleCreate",
20532             "description": ""
20533           },
20534           {
20535             "group": "Body",
20536             "type": "String",
20537             "optional": true,
20538             "field": "leadId",
20539             "description": ""
20540           },
20541           {
20542             "group": "Body",
20543             "type": "String",
20544             "optional": true,
20545             "field": "additionalSearchAccount",
20546             "description": ""
20547           },
20548           {
20549             "group": "Body",
20550             "type": "String",
20551             "optional": true,
20552             "field": "additionalSearchContact",
20553             "description": ""
20554           },
20555           {
20556             "group": "Body",
20557             "type": "String",
20558             "optional": true,
20559             "field": "additionalSearchLead",
20560             "description": ""
20561           }
20562         ]
20563       }
20564     },
20565     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20566     "version": "0.0.0",
20567     "filename": "server/api/intSalesforceConfiguration/index.js",
20568     "groupTitle": "Salesforce_Configurations"
20569   },
20570   {
20571     "type": "delete",
20572     "url": "/api/integrations/salesforce/configurations/{id}",
20573     "title": "Deletes a Salesforce Configuration",
20574     "examples": [
20575       {
20576         "title": "Example usage:",
20577         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password} -X DELETE",
20578         "type": "json"
20579       }
20580     ],
20581     "name": "DeleteSalesforce_Configurations",
20582     "group": "Salesforce_Configurations",
20583     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20584     "version": "0.0.0",
20585     "filename": "server/api/intSalesforceConfiguration/index.js",
20586     "groupTitle": "Salesforce_Configurations"
20587   },
20588   {
20589     "type": "get",
20590     "url": "/api/integrations/salesforce/configurations",
20591     "title": "Gets a list of Salesforce Configurations",
20592     "examples": [
20593       {
20594         "title": "Example usage:",
20595         "content": "curl https://{domain}/api/integrations/salesforce/configurations -v -u {name}:{password}",
20596         "type": "json"
20597       }
20598     ],
20599     "name": "GetSalesforce_Configurations",
20600     "group": "Salesforce_Configurations",
20601     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20602     "version": "0.0.0",
20603     "filename": "server/api/intSalesforceConfiguration/index.js",
20604     "groupTitle": "Salesforce_Configurations"
20605   },
20606   {
20607     "type": "get",
20608     "url": "/api/integrations/salesforce/configurations/{id}",
20609     "title": "Gets a single Salesforce Configuration",
20610     "examples": [
20611       {
20612         "title": "Example usage:",
20613         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password}",
20614         "type": "json"
20615       }
20616     ],
20617     "name": "ShowSalesforce_Configurations",
20618     "group": "Salesforce_Configurations",
20619     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20620     "version": "0.0.0",
20621     "filename": "server/api/intSalesforceConfiguration/index.js",
20622     "groupTitle": "Salesforce_Configurations"
20623   },
20624   {
20625     "type": "get",
20626     "url": "/api/integrations/salesforce/configurations/{id}/descriptions",
20627     "title": "Gets configurations descriptions",
20628     "examples": [
20629       {
20630         "title": "Example usage:",
20631         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
20632         "type": "json"
20633       }
20634     ],
20635     "name": "getDescriptions",
20636     "group": "Salesforce_Configurations",
20637     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20638     "version": "0.0.0",
20639     "filename": "server/api/intSalesforceConfiguration/index.js",
20640     "groupTitle": "Salesforce_Configurations"
20641   },
20642   {
20643     "type": "get",
20644     "url": "/api/integrations/salesforce/configurations/{id}/fields",
20645     "title": "Gets configurations fields",
20646     "examples": [
20647       {
20648         "title": "Example usage:",
20649         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/fields -v -u {name}:{password} -X GET",
20650         "type": "json"
20651       }
20652     ],
20653     "name": "getFields",
20654     "group": "Salesforce_Configurations",
20655     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20656     "version": "0.0.0",
20657     "filename": "server/api/intSalesforceConfiguration/index.js",
20658     "groupTitle": "Salesforce_Configurations"
20659   },
20660   {
20661     "type": "get",
20662     "url": "/api/integrations/salesforce/configurations/{id}/subjects",
20663     "title": "Gets configurations subjects",
20664     "examples": [
20665       {
20666         "title": "Example usage:",
20667         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/subjects -v -u {name}:{password} -X GET",
20668         "type": "json"
20669       }
20670     ],
20671     "name": "getSubjects",
20672     "group": "Salesforce_Configurations",
20673     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20674     "version": "0.0.0",
20675     "filename": "server/api/intSalesforceConfiguration/index.js",
20676     "groupTitle": "Salesforce_Configurations"
20677   },
20678   {
20679     "type": "put",
20680     "url": "/api/integrations/salesforce/configurations/{id}",
20681     "title": "Update an existing Salesforce Configuration",
20682     "examples": [
20683       {
20684         "title": "Example usage:",
20685         "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",
20686         "type": "json"
20687       }
20688     ],
20689     "name": "updateSalesforce_Configurations",
20690     "group": "Salesforce_Configurations",
20691     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20692     "version": "0.0.0",
20693     "filename": "server/api/intSalesforceConfiguration/index.js",
20694     "groupTitle": "Salesforce_Configurations"
20695   },
20696   {
20697     "type": "post",
20698     "url": "/api/integrations/salesforce/fields",
20699     "title": "Creates a new Salesforce Field",
20700     "examples": [
20701       {
20702         "title": "Example usage:",
20703         "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",
20704         "type": "json"
20705       }
20706     ],
20707     "name": "CreateSalesforce_Fields",
20708     "group": "Salesforce_Fields",
20709     "parameter": {
20710       "fields": {
20711         "Body": [
20712           {
20713             "group": "Body",
20714             "type": "String",
20715             "allowedValues": [
20716               "\"string\"",
20717               "\"variable\"",
20718               "\"customVariable\"",
20719               "\"keyValue\"",
20720               "\"picklist\""
20721             ],
20722             "optional": true,
20723             "field": "type",
20724             "description": ""
20725           },
20726           {
20727             "group": "Body",
20728             "type": "String",
20729             "optional": true,
20730             "field": "content",
20731             "description": ""
20732           },
20733           {
20734             "group": "Body",
20735             "type": "String",
20736             "optional": true,
20737             "field": "key",
20738             "description": ""
20739           },
20740           {
20741             "group": "Body",
20742             "type": "String",
20743             "allowedValues": [
20744               "\"string\"",
20745               "\"variable\"",
20746               "\"customVariable\""
20747             ],
20748             "optional": true,
20749             "field": "keyType",
20750             "description": ""
20751           },
20752           {
20753             "group": "Body",
20754             "type": "String",
20755             "optional": true,
20756             "field": "keyContent",
20757             "description": ""
20758           },
20759           {
20760             "group": "Body",
20761             "type": "String",
20762             "optional": true,
20763             "field": "idField",
20764             "description": ""
20765           },
20766           {
20767             "group": "Body",
20768             "type": "String",
20769             "optional": true,
20770             "field": "variableName",
20771             "description": ""
20772           }
20773         ]
20774       }
20775     },
20776     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20777     "version": "0.0.0",
20778     "filename": "server/api/intSalesforceField/index.js",
20779     "groupTitle": "Salesforce_Fields"
20780   },
20781   {
20782     "type": "delete",
20783     "url": "/api/integrations/salesforce/fields/{id}",
20784     "title": "Deletes a Salesforce Field",
20785     "examples": [
20786       {
20787         "title": "Example usage:",
20788         "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password} -X DELETE",
20789         "type": "json"
20790       }
20791     ],
20792     "name": "DeleteSalesforce_Fields",
20793     "group": "Salesforce_Fields",
20794     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20795     "version": "0.0.0",
20796     "filename": "server/api/intSalesforceField/index.js",
20797     "groupTitle": "Salesforce_Fields"
20798   },
20799   {
20800     "type": "get",
20801     "url": "/api/integrations/salesforce/fields",
20802     "title": "Gets a list of Salesforce Fields",
20803     "examples": [
20804       {
20805         "title": "Example usage:",
20806         "content": "curl https://{domain}/api/integrations/salesforce/fields -v -u {name}:{password}",
20807         "type": "json"
20808       }
20809     ],
20810     "name": "GetSalesforce_Fields",
20811     "group": "Salesforce_Fields",
20812     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20813     "version": "0.0.0",
20814     "filename": "server/api/intSalesforceField/index.js",
20815     "groupTitle": "Salesforce_Fields"
20816   },
20817   {
20818     "type": "get",
20819     "url": "/api/integrations/salesforce/fields/{id}",
20820     "title": "Gets a single Salesforce Field",
20821     "examples": [
20822       {
20823         "title": "Example usage:",
20824         "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password}",
20825         "type": "json"
20826       }
20827     ],
20828     "name": "ShowSalesforce_Fields",
20829     "group": "Salesforce_Fields",
20830     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20831     "version": "0.0.0",
20832     "filename": "server/api/intSalesforceField/index.js",
20833     "groupTitle": "Salesforce_Fields"
20834   },
20835   {
20836     "type": "put",
20837     "url": "/api/integrations/salesforce/fields/{id}",
20838     "title": "Update an existing Salesforce Field",
20839     "examples": [
20840       {
20841         "title": "Example usage:",
20842         "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",
20843         "type": "json"
20844       }
20845     ],
20846     "name": "updateSalesforce_Fields",
20847     "group": "Salesforce_Fields",
20848     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20849     "version": "0.0.0",
20850     "filename": "server/api/intSalesforceField/index.js",
20851     "groupTitle": "Salesforce_Fields"
20852   },
20853   {
20854     "type": "post",
20855     "url": "/api/schedules",
20856     "title": "Creates a new Schedule",
20857     "examples": [
20858       {
20859         "title": "Example usage:",
20860         "content": "curl https://{domain}/api/schedules -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
20861         "type": "json"
20862       }
20863     ],
20864     "name": "CreateSchedules",
20865     "group": "Schedules",
20866     "parameter": {
20867       "fields": {
20868         "Body": [
20869           {
20870             "group": "Body",
20871             "type": "String",
20872             "optional": false,
20873             "field": "name",
20874             "description": ""
20875           },
20876           {
20877             "group": "Body",
20878             "type": "String",
20879             "optional": true,
20880             "field": "description",
20881             "description": ""
20882           },
20883           {
20884             "group": "Body",
20885             "type": "Boolean",
20886             "optional": false,
20887             "field": "active",
20888             "description": ""
20889           },
20890           {
20891             "group": "Body",
20892             "type": "String",
20893             "optional": false,
20894             "field": "cron",
20895             "description": ""
20896           },
20897           {
20898             "group": "Body",
20899             "type": "String",
20900             "optional": false,
20901             "field": "startAt",
20902             "description": ""
20903           },
20904           {
20905             "group": "Body",
20906             "type": "String",
20907             "optional": false,
20908             "field": "endAt",
20909             "description": ""
20910           },
20911           {
20912             "group": "Body",
20913             "type": "Integer",
20914             "optional": false,
20915             "field": "subtractNumber",
20916             "description": ""
20917           },
20918           {
20919             "group": "Body",
20920             "type": "String",
20921             "allowedValues": [
20922               "\"years\"",
20923               "\"quarters\"",
20924               "\"months\"",
20925               "\"weeks\"",
20926               "\"days\"",
20927               "\"hours\"",
20928               "\"minutes\""
20929             ],
20930             "optional": false,
20931             "field": "subtractUnit",
20932             "description": ""
20933           },
20934           {
20935             "group": "Body",
20936             "type": "String",
20937             "allowedValues": [
20938               "\"csv\"",
20939               "\"pdf\"",
20940               "\"xlsx\""
20941             ],
20942             "optional": false,
20943             "field": "output",
20944             "description": ""
20945           },
20946           {
20947             "group": "Body",
20948             "type": "String",
20949             "allowedValues": [
20950               "\"custom\"",
20951               "\"default\""
20952             ],
20953             "optional": false,
20954             "field": "type",
20955             "description": ""
20956           },
20957           {
20958             "group": "Body",
20959             "type": "Boolean",
20960             "optional": true,
20961             "field": "sendMail",
20962             "description": ""
20963           },
20964           {
20965             "group": "Body",
20966             "type": "String",
20967             "optional": true,
20968             "field": "email",
20969             "description": ""
20970           },
20971           {
20972             "group": "Body",
20973             "type": "Text",
20974             "optional": true,
20975             "field": "cc",
20976             "description": ""
20977           },
20978           {
20979             "group": "Body",
20980             "type": "Text",
20981             "optional": true,
20982             "field": "bcc",
20983             "description": ""
20984           },
20985           {
20986             "group": "Body",
20987             "type": "Boolean",
20988             "optional": true,
20989             "field": "sendIfEmpty",
20990             "description": ""
20991           }
20992         ]
20993       }
20994     },
20995     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20996     "version": "0.0.0",
20997     "filename": "server/api/schedule/index.js",
20998     "groupTitle": "Schedules"
20999   },
21000   {
21001     "type": "delete",
21002     "url": "/api/schedules/{id}",
21003     "title": "Deletes a Schedule",
21004     "examples": [
21005       {
21006         "title": "Example usage:",
21007         "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password} -X DELETE",
21008         "type": "json"
21009       }
21010     ],
21011     "name": "DeleteSchedules",
21012     "group": "Schedules",
21013     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21014     "version": "0.0.0",
21015     "filename": "server/api/schedule/index.js",
21016     "groupTitle": "Schedules"
21017   },
21018   {
21019     "type": "get",
21020     "url": "/api/schedules",
21021     "title": "Gets a list of Schedules",
21022     "examples": [
21023       {
21024         "title": "Example usage:",
21025         "content": "curl https://{domain}/api/schedules -v -u {name}:{password}",
21026         "type": "json"
21027       }
21028     ],
21029     "name": "GetSchedules",
21030     "group": "Schedules",
21031     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21032     "version": "0.0.0",
21033     "filename": "server/api/schedule/index.js",
21034     "groupTitle": "Schedules"
21035   },
21036   {
21037     "type": "get",
21038     "url": "/api/schedules/{id}",
21039     "title": "Gets a single Schedule",
21040     "examples": [
21041       {
21042         "title": "Example usage:",
21043         "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password}",
21044         "type": "json"
21045       }
21046     ],
21047     "name": "ShowSchedules",
21048     "group": "Schedules",
21049     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21050     "version": "0.0.0",
21051     "filename": "server/api/schedule/index.js",
21052     "groupTitle": "Schedules"
21053   },
21054   {
21055     "type": "get",
21056     "url": "/api/schedules/{id}/run",
21057     "title": "Run Scheduler",
21058     "examples": [
21059       {
21060         "title": "Example usage:",
21061         "content": "curl https://{domain}/api/schedules/{id}/run -v -u {name}:{password} -X GET",
21062         "type": "json"
21063       }
21064     ],
21065     "name": "run",
21066     "group": "Schedules",
21067     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21068     "version": "0.0.0",
21069     "filename": "server/api/schedule/index.js",
21070     "groupTitle": "Schedules"
21071   },
21072   {
21073     "type": "put",
21074     "url": "/api/schedules/{id}",
21075     "title": "Update an existing Schedule",
21076     "examples": [
21077       {
21078         "title": "Example usage:",
21079         "content": "curl https://{domain}/api/schedules/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
21080         "type": "json"
21081       }
21082     ],
21083     "name": "updateSchedules",
21084     "group": "Schedules",
21085     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21086     "version": "0.0.0",
21087     "filename": "server/api/schedule/index.js",
21088     "groupTitle": "Schedules"
21089   },
21090   {
21091     "type": "post",
21092     "url": "/api/screen/recordings",
21093     "title": "Creates a new Recording",
21094     "examples": [
21095       {
21096         "title": "Example usage:",
21097         "content": "curl https://{domain}/api/screen/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
21098         "type": "json"
21099       }
21100     ],
21101     "name": "CreateRecordings",
21102     "group": "Screen_Recordings",
21103     "parameter": {
21104       "fields": {
21105         "Body": [
21106           {
21107             "group": "Body",
21108             "type": "Virtual",
21109             "optional": true,
21110             "field": "format",
21111             "description": ""
21112           },
21113           {
21114             "group": "Body",
21115             "type": "String",
21116             "optional": true,
21117             "field": "interactionid",
21118             "description": ""
21119           },
21120           {
21121             "group": "Body",
21122             "type": "String",
21123             "optional": true,
21124             "field": "channel",
21125             "description": ""
21126           },
21127           {
21128             "group": "Body",
21129             "type": "String",
21130             "optional": true,
21131             "field": "value",
21132             "description": ""
21133           },
21134           {
21135             "group": "Body",
21136             "type": "Integer",
21137             "optional": true,
21138             "field": "rating",
21139             "description": ""
21140           },
21141           {
21142             "group": "Body",
21143             "type": "Integer",
21144             "optional": true,
21145             "field": "duration",
21146             "description": ""
21147           },
21148           {
21149             "group": "Body",
21150             "type": "String",
21151             "optional": true,
21152             "field": "startedAt",
21153             "description": ""
21154           },
21155           {
21156             "group": "Body",
21157             "type": "String",
21158             "optional": true,
21159             "field": "closedAt",
21160             "description": ""
21161           },
21162           {
21163             "group": "Body",
21164             "type": "String",
21165             "optional": true,
21166             "field": "createdAt",
21167             "description": ""
21168           },
21169           {
21170             "group": "Body",
21171             "type": "String",
21172             "optional": true,
21173             "field": "updatedAt",
21174             "description": ""
21175           }
21176         ]
21177       }
21178     },
21179     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21180     "version": "0.0.0",
21181     "filename": "server/api/screenRecording/index.js",
21182     "groupTitle": "Screen_Recordings"
21183   },
21184   {
21185     "type": "get",
21186     "url": "/api/screen/recordings/describe",
21187     "title": "Gets table info about Recordings",
21188     "examples": [
21189       {
21190         "title": "Example usage:",
21191         "content": "curl https://{domain}/api/screen/recordings/describe -v -u {name}:{password}",
21192         "type": "json"
21193       }
21194     ],
21195     "name": "DescribeRecordings",
21196     "group": "Screen_Recordings",
21197     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21198     "version": "0.0.0",
21199     "filename": "server/api/screenRecording/index.js",
21200     "groupTitle": "Screen_Recordings"
21201   },
21202   {
21203     "type": "get",
21204     "url": "/api/screen/recordings",
21205     "title": "Gets a list of Recordings",
21206     "examples": [
21207       {
21208         "title": "Example usage:",
21209         "content": "curl https://{domain}/api/screen/recordings -v -u {name}:{password}",
21210         "type": "json"
21211       }
21212     ],
21213     "name": "GetRecordings",
21214     "group": "Screen_Recordings",
21215     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21216     "version": "0.0.0",
21217     "filename": "server/api/screenRecording/index.js",
21218     "groupTitle": "Screen_Recordings"
21219   },
21220   {
21221     "type": "get",
21222     "url": "/api/screen/recordings/{id}",
21223     "title": "Gets a single Recording",
21224     "examples": [
21225       {
21226         "title": "Example usage:",
21227         "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password}",
21228         "type": "json"
21229       }
21230     ],
21231     "name": "ShowRecordings",
21232     "group": "Screen_Recordings",
21233     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21234     "version": "0.0.0",
21235     "filename": "server/api/screenRecording/index.js",
21236     "groupTitle": "Screen_Recordings"
21237   },
21238   {
21239     "type": "delete",
21240     "url": "/api/screen/recordings/{id}",
21241     "title": "Delete screen recording",
21242     "examples": [
21243       {
21244         "title": "Example usage:",
21245         "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password} -X DELETE",
21246         "type": "json"
21247       }
21248     ],
21249     "name": "destroy",
21250     "group": "Screen_Recordings",
21251     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21252     "version": "0.0.0",
21253     "filename": "server/api/screenRecording/index.js",
21254     "groupTitle": "Screen_Recordings"
21255   },
21256   {
21257     "type": "get",
21258     "url": "/api/screen/recordings/{id}/download",
21259     "title": "Download Recording",
21260     "examples": [
21261       {
21262         "title": "Example usage:",
21263         "content": "curl https://{domain}/api/screen/recordings/{id}/download -v -u {name}:{password} -X GET",
21264         "type": "json"
21265       }
21266     ],
21267     "name": "download",
21268     "group": "Screen_Recordings",
21269     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21270     "version": "0.0.0",
21271     "filename": "server/api/screenRecording/index.js",
21272     "groupTitle": "Screen_Recordings"
21273   },
21274   {
21275     "type": "put",
21276     "url": "/api/screen/recordings/{id}",
21277     "title": "Update an existing Recording",
21278     "examples": [
21279       {
21280         "title": "Example usage:",
21281         "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",
21282         "type": "json"
21283       }
21284     ],
21285     "name": "updateRecordings",
21286     "group": "Screen_Recordings",
21287     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21288     "version": "0.0.0",
21289     "filename": "server/api/screenRecording/index.js",
21290     "groupTitle": "Screen_Recordings"
21291   },
21292   {
21293     "type": "post",
21294     "url": "/api/integrations/servicenow/accounts",
21295     "title": "Creates a new Servicenow Account",
21296     "examples": [
21297       {
21298         "title": "Example usage:",
21299         "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",
21300         "type": "json"
21301       }
21302     ],
21303     "name": "CreateServicenow_Accounts",
21304     "group": "Servicenow_Accounts",
21305     "parameter": {
21306       "fields": {
21307         "Body": [
21308           {
21309             "group": "Body",
21310             "type": "String",
21311             "optional": true,
21312             "field": "name",
21313             "description": ""
21314           },
21315           {
21316             "group": "Body",
21317             "type": "String",
21318             "optional": true,
21319             "field": "description",
21320             "description": ""
21321           },
21322           {
21323             "group": "Body",
21324             "type": "String",
21325             "optional": true,
21326             "field": "username",
21327             "description": ""
21328           },
21329           {
21330             "group": "Body",
21331             "type": "String",
21332             "optional": true,
21333             "field": "password",
21334             "description": ""
21335           },
21336           {
21337             "group": "Body",
21338             "type": "String",
21339             "optional": true,
21340             "field": "email",
21341             "description": ""
21342           },
21343           {
21344             "group": "Body",
21345             "type": "String",
21346             "optional": true,
21347             "field": "remoteUri",
21348             "description": ""
21349           },
21350           {
21351             "group": "Body",
21352             "type": "String",
21353             "optional": false,
21354             "field": "serverUrl",
21355             "description": ""
21356           }
21357         ]
21358       }
21359     },
21360     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21361     "version": "0.0.0",
21362     "filename": "server/api/intServicenowAccount/index.js",
21363     "groupTitle": "Servicenow_Accounts"
21364   },
21365   {
21366     "type": "delete",
21367     "url": "/api/integrations/servicenow/accounts/{id}",
21368     "title": "Deletes a Servicenow Account",
21369     "examples": [
21370       {
21371         "title": "Example usage:",
21372         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password} -X DELETE",
21373         "type": "json"
21374       }
21375     ],
21376     "name": "DeleteServicenow_Accounts",
21377     "group": "Servicenow_Accounts",
21378     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21379     "version": "0.0.0",
21380     "filename": "server/api/intServicenowAccount/index.js",
21381     "groupTitle": "Servicenow_Accounts"
21382   },
21383   {
21384     "type": "get",
21385     "url": "/api/integrations/servicenow/accounts",
21386     "title": "Gets a list of Servicenow Accounts",
21387     "examples": [
21388       {
21389         "title": "Example usage:",
21390         "content": "curl https://{domain}/api/integrations/servicenow/accounts -v -u {name}:{password}",
21391         "type": "json"
21392       }
21393     ],
21394     "name": "GetServicenow_Accounts",
21395     "group": "Servicenow_Accounts",
21396     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21397     "version": "0.0.0",
21398     "filename": "server/api/intServicenowAccount/index.js",
21399     "groupTitle": "Servicenow_Accounts"
21400   },
21401   {
21402     "type": "get",
21403     "url": "/api/integrations/servicenow/accounts/{id}",
21404     "title": "Gets a single Servicenow Account",
21405     "examples": [
21406       {
21407         "title": "Example usage:",
21408         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password}",
21409         "type": "json"
21410       }
21411     ],
21412     "name": "ShowServicenow_Accounts",
21413     "group": "Servicenow_Accounts",
21414     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21415     "version": "0.0.0",
21416     "filename": "server/api/intServicenowAccount/index.js",
21417     "groupTitle": "Servicenow_Accounts"
21418   },
21419   {
21420     "type": "post",
21421     "url": "/api/integrations/servicenow/accounts/{id}/configurations",
21422     "title": "Creates new configuration",
21423     "examples": [
21424       {
21425         "title": "Example usage:",
21426         "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",
21427         "type": "json"
21428       }
21429     ],
21430     "name": "addConfiguration",
21431     "group": "Servicenow_Accounts",
21432     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21433     "version": "0.0.0",
21434     "filename": "server/api/intServicenowAccount/index.js",
21435     "groupTitle": "Servicenow_Accounts"
21436   },
21437   {
21438     "type": "get",
21439     "url": "/api/integrations/servicenow/accounts/{id}/configurations",
21440     "title": "Gets account configurations",
21441     "examples": [
21442       {
21443         "title": "Example usage:",
21444         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/configurations -v -u {name}:{password} -X GET",
21445         "type": "json"
21446       }
21447     ],
21448     "name": "getConfigurations",
21449     "group": "Servicenow_Accounts",
21450     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21451     "version": "0.0.0",
21452     "filename": "server/api/intServicenowAccount/index.js",
21453     "groupTitle": "Servicenow_Accounts"
21454   },
21455   {
21456     "type": "get",
21457     "url": "/api/integrations/servicenow/accounts/{id}/fields",
21458     "title": "Gets account fields",
21459     "examples": [
21460       {
21461         "title": "Example usage:",
21462         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/fields -v -u {name}:{password} -X GET",
21463         "type": "json"
21464       }
21465     ],
21466     "name": "getFields",
21467     "group": "Servicenow_Accounts",
21468     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21469     "version": "0.0.0",
21470     "filename": "server/api/intServicenowAccount/index.js",
21471     "groupTitle": "Servicenow_Accounts"
21472   },
21473   {
21474     "type": "put",
21475     "url": "/api/integrations/servicenow/accounts/{id}",
21476     "title": "Update an existing Servicenow Account",
21477     "examples": [
21478       {
21479         "title": "Example usage:",
21480         "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",
21481         "type": "json"
21482       }
21483     ],
21484     "name": "updateServicenow_Accounts",
21485     "group": "Servicenow_Accounts",
21486     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21487     "version": "0.0.0",
21488     "filename": "server/api/intServicenowAccount/index.js",
21489     "groupTitle": "Servicenow_Accounts"
21490   },
21491   {
21492     "type": "post",
21493     "url": "/api/integrations/servicenow/configurations",
21494     "title": "Creates a new Servicenow Configuration",
21495     "examples": [
21496       {
21497         "title": "Example usage:",
21498         "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",
21499         "type": "json"
21500       }
21501     ],
21502     "name": "CreateServicenow_Configurations",
21503     "group": "Servicenow_Configurations",
21504     "parameter": {
21505       "fields": {
21506         "Body": [
21507           {
21508             "group": "Body",
21509             "type": "String",
21510             "optional": true,
21511             "field": "name",
21512             "description": ""
21513           },
21514           {
21515             "group": "Body",
21516             "type": "String",
21517             "optional": true,
21518             "field": "description",
21519             "description": ""
21520           }
21521         ]
21522       }
21523     },
21524     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21525     "version": "0.0.0",
21526     "filename": "server/api/intServicenowConfiguration/index.js",
21527     "groupTitle": "Servicenow_Configurations"
21528   },
21529   {
21530     "type": "delete",
21531     "url": "/api/integrations/servicenow/configurations/{id}",
21532     "title": "Deletes a Servicenow Configuration",
21533     "examples": [
21534       {
21535         "title": "Example usage:",
21536         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password} -X DELETE",
21537         "type": "json"
21538       }
21539     ],
21540     "name": "DeleteServicenow_Configurations",
21541     "group": "Servicenow_Configurations",
21542     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21543     "version": "0.0.0",
21544     "filename": "server/api/intServicenowConfiguration/index.js",
21545     "groupTitle": "Servicenow_Configurations"
21546   },
21547   {
21548     "type": "get",
21549     "url": "/api/integrations/servicenow/configurations",
21550     "title": "Gets a list of Servicenow Configurations",
21551     "examples": [
21552       {
21553         "title": "Example usage:",
21554         "content": "curl https://{domain}/api/integrations/servicenow/configurations -v -u {name}:{password}",
21555         "type": "json"
21556       }
21557     ],
21558     "name": "GetServicenow_Configurations",
21559     "group": "Servicenow_Configurations",
21560     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21561     "version": "0.0.0",
21562     "filename": "server/api/intServicenowConfiguration/index.js",
21563     "groupTitle": "Servicenow_Configurations"
21564   },
21565   {
21566     "type": "get",
21567     "url": "/api/integrations/servicenow/configurations/{id}",
21568     "title": "Gets a single Servicenow Configuration",
21569     "examples": [
21570       {
21571         "title": "Example usage:",
21572         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password}",
21573         "type": "json"
21574       }
21575     ],
21576     "name": "ShowServicenow_Configurations",
21577     "group": "Servicenow_Configurations",
21578     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21579     "version": "0.0.0",
21580     "filename": "server/api/intServicenowConfiguration/index.js",
21581     "groupTitle": "Servicenow_Configurations"
21582   },
21583   {
21584     "type": "get",
21585     "url": "/api/integrations/servicenow/configurations/{id}/descriptions",
21586     "title": "Gets configurations descriptions",
21587     "examples": [
21588       {
21589         "title": "Example usage:",
21590         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
21591         "type": "json"
21592       }
21593     ],
21594     "name": "getDescriptions",
21595     "group": "Servicenow_Configurations",
21596     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21597     "version": "0.0.0",
21598     "filename": "server/api/intServicenowConfiguration/index.js",
21599     "groupTitle": "Servicenow_Configurations"
21600   },
21601   {
21602     "type": "get",
21603     "url": "/api/integrations/servicenow/configurations/{id}/fields",
21604     "title": "Gets configurations fields",
21605     "examples": [
21606       {
21607         "title": "Example usage:",
21608         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/fields -v -u {name}:{password} -X GET",
21609         "type": "json"
21610       }
21611     ],
21612     "name": "getFields",
21613     "group": "Servicenow_Configurations",
21614     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21615     "version": "0.0.0",
21616     "filename": "server/api/intServicenowConfiguration/index.js",
21617     "groupTitle": "Servicenow_Configurations"
21618   },
21619   {
21620     "type": "get",
21621     "url": "/api/integrations/servicenow/configurations/{id}/subjects",
21622     "title": "Gets configurations subjects",
21623     "examples": [
21624       {
21625         "title": "Example usage:",
21626         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/subjects -v -u {name}:{password} -X GET",
21627         "type": "json"
21628       }
21629     ],
21630     "name": "getSubjects",
21631     "group": "Servicenow_Configurations",
21632     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21633     "version": "0.0.0",
21634     "filename": "server/api/intServicenowConfiguration/index.js",
21635     "groupTitle": "Servicenow_Configurations"
21636   },
21637   {
21638     "type": "put",
21639     "url": "/api/integrations/servicenow/configurations/{id}",
21640     "title": "Update an existing Servicenow Configuration",
21641     "examples": [
21642       {
21643         "title": "Example usage:",
21644         "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",
21645         "type": "json"
21646       }
21647     ],
21648     "name": "updateServicenow_Configurations",
21649     "group": "Servicenow_Configurations",
21650     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21651     "version": "0.0.0",
21652     "filename": "server/api/intServicenowConfiguration/index.js",
21653     "groupTitle": "Servicenow_Configurations"
21654   },
21655   {
21656     "type": "post",
21657     "url": "/api/integrations/servicenow/fields",
21658     "title": "Creates a new Servicenow Field",
21659     "examples": [
21660       {
21661         "title": "Example usage:",
21662         "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",
21663         "type": "json"
21664       }
21665     ],
21666     "name": "CreateServicenow_Fields",
21667     "group": "Servicenow_Fields",
21668     "parameter": {
21669       "fields": {
21670         "Body": [
21671           {
21672             "group": "Body",
21673             "type": "String",
21674             "allowedValues": [
21675               "\"string\"",
21676               "\"variable\"",
21677               "\"customVariable\"",
21678               "\"keyValue\"",
21679               "\"picklist\""
21680             ],
21681             "optional": true,
21682             "field": "type",
21683             "description": ""
21684           },
21685           {
21686             "group": "Body",
21687             "type": "String",
21688             "optional": true,
21689             "field": "content",
21690             "description": ""
21691           },
21692           {
21693             "group": "Body",
21694             "type": "String",
21695             "optional": true,
21696             "field": "key",
21697             "description": ""
21698           },
21699           {
21700             "group": "Body",
21701             "type": "String",
21702             "allowedValues": [
21703               "\"string\"",
21704               "\"variable\"",
21705               "\"customVariable\""
21706             ],
21707             "optional": true,
21708             "field": "keyType",
21709             "description": ""
21710           },
21711           {
21712             "group": "Body",
21713             "type": "String",
21714             "optional": true,
21715             "field": "keyContent",
21716             "description": ""
21717           },
21718           {
21719             "group": "Body",
21720             "type": "String",
21721             "optional": true,
21722             "field": "idField",
21723             "description": ""
21724           },
21725           {
21726             "group": "Body",
21727             "type": "String",
21728             "optional": true,
21729             "field": "nameField",
21730             "description": ""
21731           },
21732           {
21733             "group": "Body",
21734             "type": "Boolean",
21735             "optional": true,
21736             "field": "customField",
21737             "description": ""
21738           },
21739           {
21740             "group": "Body",
21741             "type": "String",
21742             "optional": true,
21743             "field": "variableName",
21744             "description": ""
21745           }
21746         ]
21747       }
21748     },
21749     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21750     "version": "0.0.0",
21751     "filename": "server/api/intServicenowField/index.js",
21752     "groupTitle": "Servicenow_Fields"
21753   },
21754   {
21755     "type": "delete",
21756     "url": "/api/integrations/servicenow/fields/{id}",
21757     "title": "Deletes a Servicenow Field",
21758     "examples": [
21759       {
21760         "title": "Example usage:",
21761         "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password} -X DELETE",
21762         "type": "json"
21763       }
21764     ],
21765     "name": "DeleteServicenow_Fields",
21766     "group": "Servicenow_Fields",
21767     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21768     "version": "0.0.0",
21769     "filename": "server/api/intServicenowField/index.js",
21770     "groupTitle": "Servicenow_Fields"
21771   },
21772   {
21773     "type": "get",
21774     "url": "/api/integrations/servicenow/fields",
21775     "title": "Gets a list of Servicenow Fields",
21776     "examples": [
21777       {
21778         "title": "Example usage:",
21779         "content": "curl https://{domain}/api/integrations/servicenow/fields -v -u {name}:{password}",
21780         "type": "json"
21781       }
21782     ],
21783     "name": "GetServicenow_Fields",
21784     "group": "Servicenow_Fields",
21785     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21786     "version": "0.0.0",
21787     "filename": "server/api/intServicenowField/index.js",
21788     "groupTitle": "Servicenow_Fields"
21789   },
21790   {
21791     "type": "get",
21792     "url": "/api/integrations/servicenow/fields/{id}",
21793     "title": "Gets a single Servicenow Field",
21794     "examples": [
21795       {
21796         "title": "Example usage:",
21797         "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password}",
21798         "type": "json"
21799       }
21800     ],
21801     "name": "ShowServicenow_Fields",
21802     "group": "Servicenow_Fields",
21803     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21804     "version": "0.0.0",
21805     "filename": "server/api/intServicenowField/index.js",
21806     "groupTitle": "Servicenow_Fields"
21807   },
21808   {
21809     "type": "put",
21810     "url": "/api/integrations/servicenow/fields/{id}",
21811     "title": "Update an existing Servicenow Field",
21812     "examples": [
21813       {
21814         "title": "Example usage:",
21815         "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",
21816         "type": "json"
21817       }
21818     ],
21819     "name": "updateServicenow_Fields",
21820     "group": "Servicenow_Fields",
21821     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21822     "version": "0.0.0",
21823     "filename": "server/api/intServicenowField/index.js",
21824     "groupTitle": "Servicenow_Fields"
21825   },
21826   {
21827     "type": "get",
21828     "url": "/api/settings",
21829     "title": "Gets a list of Settings",
21830     "examples": [
21831       {
21832         "title": "Example usage:",
21833         "content": "curl https://{domain}/api/settings -v -u {name}:{password}",
21834         "type": "json"
21835       }
21836     ],
21837     "name": "GetSettings",
21838     "group": "Settings",
21839     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21840     "version": "0.0.0",
21841     "filename": "server/api/setting/index.js",
21842     "groupTitle": "Settings"
21843   },
21844   {
21845     "type": "get",
21846     "url": "/api/settings/{id}",
21847     "title": "Gets a single Setting",
21848     "examples": [
21849       {
21850         "title": "Example usage:",
21851         "content": "curl https://{domain}/api/settings/{id} -v -u {name}:{password}",
21852         "type": "json"
21853       }
21854     ],
21855     "name": "ShowSettings",
21856     "group": "Settings",
21857     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21858     "version": "0.0.0",
21859     "filename": "server/api/setting/index.js",
21860     "groupTitle": "Settings"
21861   },
21862   {
21863     "type": "post",
21864     "url": "/api/settings/{id}/favicon",
21865     "title": "Add Favicon",
21866     "examples": [
21867       {
21868         "title": "Example usage:",
21869         "content": "curl https://{domain}/api/settings/{id}/favicon -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21870         "type": "json"
21871       }
21872     ],
21873     "name": "addFavicon",
21874     "group": "Settings",
21875     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21876     "version": "0.0.0",
21877     "filename": "server/api/setting/index.js",
21878     "groupTitle": "Settings"
21879   },
21880   {
21881     "type": "post",
21882     "url": "/api/settings/{id}/logo",
21883     "title": "Add logo",
21884     "examples": [
21885       {
21886         "title": "Example usage:",
21887         "content": "curl https://{domain}/api/settings/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21888         "type": "json"
21889       }
21890     ],
21891     "name": "addLogo",
21892     "group": "Settings",
21893     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21894     "version": "0.0.0",
21895     "filename": "server/api/setting/index.js",
21896     "groupTitle": "Settings"
21897   },
21898   {
21899     "type": "post",
21900     "url": "/api/settings/{id}/logo_login",
21901     "title": "Add logo login",
21902     "examples": [
21903       {
21904         "title": "Example usage:",
21905         "content": "curl https://{domain}/api/settings/{id}/logo_login -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21906         "type": "json"
21907       }
21908     ],
21909     "name": "addLogoLogin",
21910     "group": "Settings",
21911     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21912     "version": "0.0.0",
21913     "filename": "server/api/setting/index.js",
21914     "groupTitle": "Settings"
21915   },
21916   {
21917     "type": "post",
21918     "url": "/api/settings/{id}/preferred",
21919     "title": "Add Preferred",
21920     "examples": [
21921       {
21922         "title": "Example usage:",
21923         "content": "curl https://{domain}/api/settings/{id}/preferred -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21924         "type": "json"
21925       }
21926     ],
21927     "name": "addPreferred",
21928     "group": "Settings",
21929     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21930     "version": "0.0.0",
21931     "filename": "server/api/setting/index.js",
21932     "groupTitle": "Settings"
21933   },
21934   {
21935     "type": "get",
21936     "url": "/api/settings/now",
21937     "title": "Get Server Current Date",
21938     "examples": [
21939       {
21940         "title": "Example usage:",
21941         "content": "curl https://{domain}/api/settings/now -v -X GET",
21942         "type": "json"
21943       }
21944     ],
21945     "name": "getDate",
21946     "group": "Settings",
21947     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21948     "version": "0.0.0",
21949     "filename": "server/api/setting/index.js",
21950     "groupTitle": "Settings"
21951   },
21952   {
21953     "type": "get",
21954     "url": "/api/settings/{id}/favicon",
21955     "title": "Get Favicon",
21956     "examples": [
21957       {
21958         "title": "Example usage:",
21959         "content": "curl https://{domain}/api/settings/{id}/favicon -v -X GET",
21960         "type": "json"
21961       }
21962     ],
21963     "name": "getFavicon",
21964     "group": "Settings",
21965     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21966     "version": "0.0.0",
21967     "filename": "server/api/setting/index.js",
21968     "groupTitle": "Settings"
21969   },
21970   {
21971     "type": "get",
21972     "url": "/api/settings/{id}/gdpr",
21973     "title": "Get gdpr settings",
21974     "examples": [
21975       {
21976         "title": "Example usage:",
21977         "content": "curl https://{domain}/api/settings/{id}/gdpr -v -u {name}:{password} -X GET",
21978         "type": "json"
21979       }
21980     ],
21981     "name": "getGdpr",
21982     "group": "Settings",
21983     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21984     "version": "0.0.0",
21985     "filename": "server/api/setting/index.js",
21986     "groupTitle": "Settings"
21987   },
21988   {
21989     "type": "get",
21990     "url": "/api/settings/{id}/logo",
21991     "title": "Get logo",
21992     "examples": [
21993       {
21994         "title": "Example usage:",
21995         "content": "curl https://{domain}/api/settings/{id}/logo -v -X GET",
21996         "type": "json"
21997       }
21998     ],
21999     "name": "getLogo",
22000     "group": "Settings",
22001     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22002     "version": "0.0.0",
22003     "filename": "server/api/setting/index.js",
22004     "groupTitle": "Settings"
22005   },
22006   {
22007     "type": "get",
22008     "url": "/api/settings/{id}/logo_login",
22009     "title": "Get logo login",
22010     "examples": [
22011       {
22012         "title": "Example usage:",
22013         "content": "curl https://{domain}/api/settings/{id}/logo_login -v -X GET",
22014         "type": "json"
22015       }
22016     ],
22017     "name": "getLogoLogin",
22018     "group": "Settings",
22019     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22020     "version": "0.0.0",
22021     "filename": "server/api/setting/index.js",
22022     "groupTitle": "Settings"
22023   },
22024   {
22025     "type": "get",
22026     "url": "/api/settings/{id}/preferred",
22027     "title": "Get Preferred",
22028     "examples": [
22029       {
22030         "title": "Example usage:",
22031         "content": "curl https://{domain}/api/settings/{id}/preferred -v -X GET",
22032         "type": "json"
22033       }
22034     ],
22035     "name": "getPreferred",
22036     "group": "Settings",
22037     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22038     "version": "0.0.0",
22039     "filename": "server/api/setting/index.js",
22040     "groupTitle": "Settings"
22041   },
22042   {
22043     "type": "put",
22044     "url": "/api/settings/{id}",
22045     "title": "Update an existing Setting",
22046     "examples": [
22047       {
22048         "title": "Example usage:",
22049         "content": "curl https://{domain}/api/settings/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
22050         "type": "json"
22051       }
22052     ],
22053     "name": "updateSettings",
22054     "group": "Settings",
22055     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22056     "version": "0.0.0",
22057     "filename": "server/api/setting/index.js",
22058     "groupTitle": "Settings"
22059   },
22060   {
22061     "type": "post",
22062     "url": "/api/sms/accounts/{id}/users",
22063     "title": "Add agents to a sms account",
22064     "examples": [
22065       {
22066         "title": "Example usage:",
22067         "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",
22068         "type": "json"
22069       }
22070     ],
22071     "name": "AddAgents",
22072     "group": "Sms_Accounts",
22073     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22074     "version": "0.0.0",
22075     "filename": "server/api/smsAccount/index.js",
22076     "groupTitle": "Sms_Accounts"
22077   },
22078   {
22079     "type": "post",
22080     "url": "/api/sms/accounts",
22081     "title": "Creates a new Account",
22082     "examples": [
22083       {
22084         "title": "Example usage:",
22085         "content": "curl https://{domain}/api/sms/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22086         "type": "json"
22087       }
22088     ],
22089     "name": "CreateAccounts",
22090     "group": "Sms_Accounts",
22091     "parameter": {
22092       "fields": {
22093         "Body": [
22094           {
22095             "group": "Body",
22096             "type": "String",
22097             "optional": false,
22098             "field": "name",
22099             "description": ""
22100           },
22101           {
22102             "group": "Body",
22103             "type": "String",
22104             "optional": false,
22105             "field": "key",
22106             "description": ""
22107           },
22108           {
22109             "group": "Body",
22110             "type": "String",
22111             "optional": false,
22112             "field": "remote",
22113             "description": ""
22114           },
22115           {
22116             "group": "Body",
22117             "type": "String",
22118             "optional": true,
22119             "field": "token",
22120             "description": ""
22121           },
22122           {
22123             "group": "Body",
22124             "type": "String",
22125             "optional": true,
22126             "field": "phone",
22127             "description": ""
22128           },
22129           {
22130             "group": "Body",
22131             "type": "String",
22132             "allowedValues": [
22133               "\"twilio\"",
22134               "\"skebby\"",
22135               "\"connectel\"",
22136               "\"clicksend\"",
22137               "\"plivo\"",
22138               "\"clickatell\"",
22139               "\"bandwidth\"",
22140               "\"csc\"",
22141               "\"infobip\"",
22142               "\"intelepeer\""
22143             ],
22144             "optional": true,
22145             "field": "type",
22146             "description": ""
22147           },
22148           {
22149             "group": "Body",
22150             "type": "String",
22151             "optional": true,
22152             "field": "accountSid",
22153             "description": ""
22154           },
22155           {
22156             "group": "Body",
22157             "type": "String",
22158             "optional": true,
22159             "field": "authId",
22160             "description": ""
22161           },
22162           {
22163             "group": "Body",
22164             "type": "String",
22165             "optional": true,
22166             "field": "authToken",
22167             "description": ""
22168           },
22169           {
22170             "group": "Body",
22171             "type": "String",
22172             "allowedValues": [
22173               "\"SI\"",
22174               "\"TI\"",
22175               "\"GP\""
22176             ],
22177             "optional": true,
22178             "field": "smsMethod",
22179             "description": ""
22180           },
22181           {
22182             "group": "Body",
22183             "type": "String",
22184             "optional": true,
22185             "field": "username",
22186             "description": ""
22187           },
22188           {
22189             "group": "Body",
22190             "type": "String",
22191             "optional": true,
22192             "field": "password",
22193             "description": ""
22194           },
22195           {
22196             "group": "Body",
22197             "type": "String",
22198             "optional": true,
22199             "field": "apiKey",
22200             "description": ""
22201           },
22202           {
22203             "group": "Body",
22204             "type": "String",
22205             "optional": true,
22206             "field": "applicationId",
22207             "description": ""
22208           },
22209           {
22210             "group": "Body",
22211             "type": "String",
22212             "optional": true,
22213             "field": "accountId",
22214             "description": ""
22215           },
22216           {
22217             "group": "Body",
22218             "type": "String",
22219             "optional": true,
22220             "field": "senderString",
22221             "description": ""
22222           },
22223           {
22224             "group": "Body",
22225             "type": "Boolean",
22226             "optional": true,
22227             "field": "deliveryReport",
22228             "description": ""
22229           },
22230           {
22231             "group": "Body",
22232             "type": "String",
22233             "optional": true,
22234             "field": "description",
22235             "description": ""
22236           },
22237           {
22238             "group": "Body",
22239             "type": "Text",
22240             "optional": true,
22241             "field": "notificationTemplate",
22242             "description": ""
22243           },
22244           {
22245             "group": "Body",
22246             "type": "Boolean",
22247             "optional": true,
22248             "field": "notificationSound",
22249             "description": ""
22250           },
22251           {
22252             "group": "Body",
22253             "type": "Boolean",
22254             "optional": true,
22255             "field": "notificationShake",
22256             "description": ""
22257           },
22258           {
22259             "group": "Body",
22260             "type": "Integer",
22261             "optional": true,
22262             "field": "waitForTheAssignedAgent",
22263             "description": ""
22264           },
22265           {
22266             "group": "Body",
22267             "type": "Boolean",
22268             "optional": true,
22269             "field": "queueTransfer",
22270             "description": ""
22271           },
22272           {
22273             "group": "Body",
22274             "type": "Integer",
22275             "optional": true,
22276             "field": "queueTransferTimeout",
22277             "description": ""
22278           },
22279           {
22280             "group": "Body",
22281             "type": "Boolean",
22282             "optional": true,
22283             "field": "agentTransfer",
22284             "description": ""
22285           },
22286           {
22287             "group": "Body",
22288             "type": "Integer",
22289             "optional": true,
22290             "field": "agentTransferTimeout",
22291             "description": ""
22292           },
22293           {
22294             "group": "Body",
22295             "type": "String",
22296             "optional": true,
22297             "field": "baseUrl",
22298             "description": ""
22299           },
22300           {
22301             "group": "Body",
22302             "type": "Integer",
22303             "optional": true,
22304             "field": "mandatoryDispositionPauseId",
22305             "description": "<p>Status to put when mandatory disposition is enabled</p>"
22306           },
22307           {
22308             "group": "Body",
22309             "type": "Boolean",
22310             "optional": true,
22311             "field": "mandatoryDisposition",
22312             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
22313           }
22314         ]
22315       }
22316     },
22317     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22318     "version": "0.0.0",
22319     "filename": "server/api/smsAccount/index.js",
22320     "groupTitle": "Sms_Accounts"
22321   },
22322   {
22323     "type": "delete",
22324     "url": "/api/sms/accounts/{id}",
22325     "title": "Deletes a Account",
22326     "examples": [
22327       {
22328         "title": "Example usage:",
22329         "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password} -X DELETE",
22330         "type": "json"
22331       }
22332     ],
22333     "name": "DeleteAccounts",
22334     "group": "Sms_Accounts",
22335     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22336     "version": "0.0.0",
22337     "filename": "server/api/smsAccount/index.js",
22338     "groupTitle": "Sms_Accounts"
22339   },
22340   {
22341     "type": "get",
22342     "url": "/api/sms/accounts/describe",
22343     "title": "Gets table info about Accounts",
22344     "examples": [
22345       {
22346         "title": "Example usage:",
22347         "content": "curl https://{domain}/api/sms/accounts/describe -v -u {name}:{password}",
22348         "type": "json"
22349       }
22350     ],
22351     "name": "DescribeAccounts",
22352     "group": "Sms_Accounts",
22353     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22354     "version": "0.0.0",
22355     "filename": "server/api/smsAccount/index.js",
22356     "groupTitle": "Sms_Accounts"
22357   },
22358   {
22359     "type": "get",
22360     "url": "/api/sms/accounts",
22361     "title": "Gets a list of Accounts",
22362     "examples": [
22363       {
22364         "title": "Example usage:",
22365         "content": "curl https://{domain}/api/sms/accounts -v -u {name}:{password}",
22366         "type": "json"
22367       }
22368     ],
22369     "name": "GetAccounts",
22370     "group": "Sms_Accounts",
22371     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22372     "version": "0.0.0",
22373     "filename": "server/api/smsAccount/index.js",
22374     "groupTitle": "Sms_Accounts"
22375   },
22376   {
22377     "type": "get",
22378     "url": "/api/sms/accounts/{id}/users",
22379     "title": "Gets agents from sms account",
22380     "examples": [
22381       {
22382         "title": "Example usage:",
22383         "content": "curl https://{domain}/api/sms/accounts/{id}/users -v -u {name}:{password} -X GET",
22384         "type": "json"
22385       }
22386     ],
22387     "name": "GetAgents",
22388     "group": "Sms_Accounts",
22389     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22390     "version": "0.0.0",
22391     "filename": "server/api/smsAccount/index.js",
22392     "groupTitle": "Sms_Accounts"
22393   },
22394   {
22395     "type": "delete",
22396     "url": "/api/sms/accounts/{id}/users",
22397     "title": "Removes agents from a sms account",
22398     "examples": [
22399       {
22400         "title": "Example usage:",
22401         "content": "curl https://{domain}/api/sms/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22402         "type": "json"
22403       }
22404     ],
22405     "name": "RemoveAgents",
22406     "group": "Sms_Accounts",
22407     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22408     "version": "0.0.0",
22409     "filename": "server/api/smsAccount/index.js",
22410     "groupTitle": "Sms_Accounts"
22411   },
22412   {
22413     "type": "delete",
22414     "url": "/api/sms/accounts/{id}/canned_answers",
22415     "title": "Removes canned answers from account",
22416     "examples": [
22417       {
22418         "title": "Example usage:",
22419         "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22420         "type": "json"
22421       }
22422     ],
22423     "name": "RemoveAnswers",
22424     "group": "Sms_Accounts",
22425     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22426     "version": "0.0.0",
22427     "filename": "server/api/smsAccount/index.js",
22428     "groupTitle": "Sms_Accounts"
22429   },
22430   {
22431     "type": "delete",
22432     "url": "/api/sms/accounts/{id}/dispositions",
22433     "title": "Removes dispositions from account",
22434     "examples": [
22435       {
22436         "title": "Example usage:",
22437         "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22438         "type": "json"
22439       }
22440     ],
22441     "name": "RemoveDispositions",
22442     "group": "Sms_Accounts",
22443     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22444     "version": "0.0.0",
22445     "filename": "server/api/smsAccount/index.js",
22446     "groupTitle": "Sms_Accounts"
22447   },
22448   {
22449     "type": "get",
22450     "url": "/api/sms/accounts/{id}",
22451     "title": "Gets a single Account",
22452     "examples": [
22453       {
22454         "title": "Example usage:",
22455         "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password}",
22456         "type": "json"
22457       }
22458     ],
22459     "name": "ShowAccounts",
22460     "group": "Sms_Accounts",
22461     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22462     "version": "0.0.0",
22463     "filename": "server/api/smsAccount/index.js",
22464     "groupTitle": "Sms_Accounts"
22465   },
22466   {
22467     "type": "put",
22468     "url": "/api/sms/messages/{id}/accept",
22469     "title": "Accepts message",
22470     "examples": [
22471       {
22472         "title": "Example usage:",
22473         "content": "curl https://{domain}/api/sms/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
22474         "type": "json"
22475       }
22476     ],
22477     "name": "acceptMessage",
22478     "group": "Sms_Accounts",
22479     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22480     "version": "0.0.0",
22481     "filename": "server/api/smsMessage/index.js",
22482     "groupTitle": "Sms_Accounts"
22483   },
22484   {
22485     "type": "post",
22486     "url": "/api/sms/accounts/{id}/canned_answers",
22487     "title": "Creates new canned answer",
22488     "examples": [
22489       {
22490         "title": "Example usage:",
22491         "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",
22492         "type": "json"
22493       }
22494     ],
22495     "name": "addAnswer",
22496     "group": "Sms_Accounts",
22497     "parameter": {
22498       "fields": {
22499         "Body": [
22500           {
22501             "group": "Body",
22502             "type": "String",
22503             "optional": false,
22504             "field": "key",
22505             "description": ""
22506           },
22507           {
22508             "group": "Body",
22509             "type": "Text",
22510             "optional": false,
22511             "field": "value",
22512             "description": ""
22513           },
22514           {
22515             "group": "Body",
22516             "type": "String",
22517             "optional": true,
22518             "field": "description",
22519             "description": ""
22520           },
22521           {
22522             "group": "Body",
22523             "type": "Virtual",
22524             "optional": true,
22525             "field": "name",
22526             "description": ""
22527           }
22528         ]
22529       }
22530     },
22531     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22532     "version": "0.0.0",
22533     "filename": "server/api/smsAccount/index.js",
22534     "groupTitle": "Sms_Accounts"
22535   },
22536   {
22537     "type": "post",
22538     "url": "/api/sms/accounts/{id}/applications",
22539     "title": "Creates new applications",
22540     "examples": [
22541       {
22542         "title": "Example usage:",
22543         "content": "curl https://{domain}/api/sms/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
22544         "type": "json"
22545       }
22546     ],
22547     "name": "addApplications",
22548     "group": "Sms_Accounts",
22549     "parameter": {
22550       "fields": {
22551         "Body": [
22552           {
22553             "group": "Body",
22554             "type": "Integer",
22555             "optional": false,
22556             "field": "priority",
22557             "description": ""
22558           },
22559           {
22560             "group": "Body",
22561             "type": "String",
22562             "optional": false,
22563             "field": "app",
22564             "description": ""
22565           },
22566           {
22567             "group": "Body",
22568             "type": "Text",
22569             "optional": true,
22570             "field": "appdata",
22571             "description": ""
22572           },
22573           {
22574             "group": "Body",
22575             "type": "String",
22576             "optional": true,
22577             "field": "description",
22578             "description": ""
22579           },
22580           {
22581             "group": "Body",
22582             "type": "String",
22583             "optional": true,
22584             "field": "interval",
22585             "description": ""
22586           }
22587         ]
22588       }
22589     },
22590     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22591     "version": "0.0.0",
22592     "filename": "server/api/smsAccount/index.js",
22593     "groupTitle": "Sms_Accounts"
22594   },
22595   {
22596     "type": "post",
22597     "url": "/api/sms/accounts/{id}/dispositions",
22598     "title": "Creates new disposition",
22599     "examples": [
22600       {
22601         "title": "Example usage:",
22602         "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
22603         "type": "json"
22604       }
22605     ],
22606     "name": "addDisposition",
22607     "group": "Sms_Accounts",
22608     "parameter": {
22609       "fields": {
22610         "Body": [
22611           {
22612             "group": "Body",
22613             "type": "String",
22614             "optional": false,
22615             "field": "name",
22616             "description": ""
22617           },
22618           {
22619             "group": "Body",
22620             "type": "String",
22621             "allowedValues": [
22622               "\"first\"",
22623               "\"second\"",
22624               "\"third\""
22625             ],
22626             "optional": false,
22627             "field": "level",
22628             "description": ""
22629           },
22630           {
22631             "group": "Body",
22632             "type": "String",
22633             "optional": true,
22634             "field": "description",
22635             "description": ""
22636           }
22637         ]
22638       }
22639     },
22640     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22641     "version": "0.0.0",
22642     "filename": "server/api/smsAccount/index.js",
22643     "groupTitle": "Sms_Accounts"
22644   },
22645   {
22646     "type": "get",
22647     "url": "/api/sms/accounts/{id}/canned_answers",
22648     "title": "Gets account canned answers",
22649     "examples": [
22650       {
22651         "title": "Example usage:",
22652         "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
22653         "type": "json"
22654       }
22655     ],
22656     "name": "getAnswers",
22657     "group": "Sms_Accounts",
22658     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22659     "version": "0.0.0",
22660     "filename": "server/api/smsAccount/index.js",
22661     "groupTitle": "Sms_Accounts"
22662   },
22663   {
22664     "type": "get",
22665     "url": "/api/sms/accounts/{id}/applications",
22666     "title": "Gets account applications",
22667     "examples": [
22668       {
22669         "title": "Example usage:",
22670         "content": "curl https://{domain}/api/sms/accounts/{id}/applications -v -u {name}:{password} -X GET",
22671         "type": "json"
22672       }
22673     ],
22674     "name": "getApplications",
22675     "group": "Sms_Accounts",
22676     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22677     "version": "0.0.0",
22678     "filename": "server/api/smsAccount/index.js",
22679     "groupTitle": "Sms_Accounts"
22680   },
22681   {
22682     "type": "get",
22683     "url": "/api/sms/accounts/{id}/dispositions",
22684     "title": "Gets account dispositions",
22685     "examples": [
22686       {
22687         "title": "Example usage:",
22688         "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
22689         "type": "json"
22690       }
22691     ],
22692     "name": "getDispositions",
22693     "group": "Sms_Accounts",
22694     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22695     "version": "0.0.0",
22696     "filename": "server/api/smsAccount/index.js",
22697     "groupTitle": "Sms_Accounts"
22698   },
22699   {
22700     "type": "get",
22701     "url": "/api/sms/accounts/{id}/interactions",
22702     "title": "Gets Sms Account interactions",
22703     "examples": [
22704       {
22705         "title": "Example usage:",
22706         "content": "curl https://{domain}/api/sms/accounts/{id}/interactions -v -u {name}:{password} -X GET",
22707         "type": "json"
22708       }
22709     ],
22710     "name": "getInteractions",
22711     "group": "Sms_Accounts",
22712     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22713     "version": "0.0.0",
22714     "filename": "server/api/smsAccount/index.js",
22715     "groupTitle": "Sms_Accounts"
22716   },
22717   {
22718     "type": "post",
22719     "url": "/api/sms/accounts/{id}/notify",
22720     "title": "Notify new message",
22721     "examples": [
22722       {
22723         "title": "Example usage:",
22724         "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",
22725         "type": "json"
22726       }
22727     ],
22728     "name": "notify",
22729     "group": "Sms_Accounts",
22730     "description": "<p>Motion 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>",
22731     "version": "0.0.0",
22732     "filename": "server/api/smsAccount/index.js",
22733     "groupTitle": "Sms_Accounts"
22734   },
22735   {
22736     "type": "put",
22737     "url": "/api/sms/messages/{id}/reject",
22738     "title": "Rejects message",
22739     "examples": [
22740       {
22741         "title": "Example usage:",
22742         "content": "curl https://{domain}/api/sms/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
22743         "type": "json"
22744       }
22745     ],
22746     "name": "rejectMessage",
22747     "group": "Sms_Accounts",
22748     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22749     "version": "0.0.0",
22750     "filename": "server/api/smsMessage/index.js",
22751     "groupTitle": "Sms_Accounts"
22752   },
22753   {
22754     "type": "post",
22755     "url": "/api/sms/accounts/{id}/send",
22756     "title": "Send new sms message",
22757     "examples": [
22758       {
22759         "title": "Example usage:",
22760         "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",
22761         "type": "json"
22762       }
22763     ],
22764     "name": "sendSms",
22765     "group": "Sms_Accounts",
22766     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22767     "version": "0.0.0",
22768     "filename": "server/api/smsAccount/index.js",
22769     "groupTitle": "Sms_Accounts"
22770   },
22771   {
22772     "type": "get",
22773     "url": "/api/sms/accounts/{id}/status",
22774     "title": "Receive message status as get request",
22775     "examples": [
22776       {
22777         "title": "Example usage:",
22778         "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X GET",
22779         "type": "json"
22780       }
22781     ],
22782     "name": "statusMessage",
22783     "group": "Sms_Accounts",
22784     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22785     "version": "0.0.0",
22786     "filename": "server/api/smsAccount/index.js",
22787     "groupTitle": "Sms_Accounts"
22788   },
22789   {
22790     "type": "post",
22791     "url": "/api/sms/accounts/{id}/status",
22792     "title": "Receive message status",
22793     "examples": [
22794       {
22795         "title": "Example usage:",
22796         "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X POST",
22797         "type": "json"
22798       }
22799     ],
22800     "name": "statusMessage",
22801     "group": "Sms_Accounts",
22802     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22803     "version": "0.0.0",
22804     "filename": "server/api/smsAccount/index.js",
22805     "groupTitle": "Sms_Accounts"
22806   },
22807   {
22808     "type": "post",
22809     "url": "/api/sms/messages/{id}/status",
22810     "title": "Receive message status",
22811     "examples": [
22812       {
22813         "title": "Example usage:",
22814         "content": "curl https://{domain}/api/sms/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
22815         "type": "json"
22816       }
22817     ],
22818     "name": "statusMessage",
22819     "group": "Sms_Accounts",
22820     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22821     "version": "0.0.0",
22822     "filename": "server/api/smsMessage/index.js",
22823     "groupTitle": "Sms_Accounts"
22824   },
22825   {
22826     "type": "put",
22827     "url": "/api/sms/accounts/{id}",
22828     "title": "Update an existing Account",
22829     "examples": [
22830       {
22831         "title": "Example usage:",
22832         "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",
22833         "type": "json"
22834       }
22835     ],
22836     "name": "updateAccounts",
22837     "group": "Sms_Accounts",
22838     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22839     "version": "0.0.0",
22840     "filename": "server/api/smsAccount/index.js",
22841     "groupTitle": "Sms_Accounts"
22842   },
22843   {
22844     "type": "post",
22845     "url": "/api/sms/applications",
22846     "title": "Creates a new Application",
22847     "examples": [
22848       {
22849         "title": "Example usage:",
22850         "content": "curl https://{domain}/api/sms/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22851         "type": "json"
22852       }
22853     ],
22854     "name": "CreateApplications",
22855     "group": "Sms_Applications",
22856     "parameter": {
22857       "fields": {
22858         "Body": [
22859           {
22860             "group": "Body",
22861             "type": "Integer",
22862             "optional": false,
22863             "field": "priority",
22864             "description": ""
22865           },
22866           {
22867             "group": "Body",
22868             "type": "String",
22869             "optional": false,
22870             "field": "app",
22871             "description": ""
22872           },
22873           {
22874             "group": "Body",
22875             "type": "Text",
22876             "optional": true,
22877             "field": "appdata",
22878             "description": ""
22879           },
22880           {
22881             "group": "Body",
22882             "type": "String",
22883             "optional": true,
22884             "field": "description",
22885             "description": ""
22886           },
22887           {
22888             "group": "Body",
22889             "type": "String",
22890             "optional": true,
22891             "field": "interval",
22892             "description": ""
22893           }
22894         ]
22895       }
22896     },
22897     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22898     "version": "0.0.0",
22899     "filename": "server/api/smsApplication/index.js",
22900     "groupTitle": "Sms_Applications"
22901   },
22902   {
22903     "type": "delete",
22904     "url": "/api/sms/applications/{id}",
22905     "title": "Deletes a Application",
22906     "examples": [
22907       {
22908         "title": "Example usage:",
22909         "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password} -X DELETE",
22910         "type": "json"
22911       }
22912     ],
22913     "name": "DeleteApplications",
22914     "group": "Sms_Applications",
22915     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22916     "version": "0.0.0",
22917     "filename": "server/api/smsApplication/index.js",
22918     "groupTitle": "Sms_Applications"
22919   },
22920   {
22921     "type": "get",
22922     "url": "/api/sms/applications",
22923     "title": "Gets a list of Applications",
22924     "examples": [
22925       {
22926         "title": "Example usage:",
22927         "content": "curl https://{domain}/api/sms/applications -v -u {name}:{password}",
22928         "type": "json"
22929       }
22930     ],
22931     "name": "GetApplications",
22932     "group": "Sms_Applications",
22933     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22934     "version": "0.0.0",
22935     "filename": "server/api/smsApplication/index.js",
22936     "groupTitle": "Sms_Applications"
22937   },
22938   {
22939     "type": "get",
22940     "url": "/api/sms/applications/{id}",
22941     "title": "Gets a single Application",
22942     "examples": [
22943       {
22944         "title": "Example usage:",
22945         "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password}",
22946         "type": "json"
22947       }
22948     ],
22949     "name": "ShowApplications",
22950     "group": "Sms_Applications",
22951     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22952     "version": "0.0.0",
22953     "filename": "server/api/smsApplication/index.js",
22954     "groupTitle": "Sms_Applications"
22955   },
22956   {
22957     "type": "put",
22958     "url": "/api/sms/applications/{id}",
22959     "title": "Update an existing Application",
22960     "examples": [
22961       {
22962         "title": "Example usage:",
22963         "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",
22964         "type": "json"
22965       }
22966     ],
22967     "name": "updateApplications",
22968     "group": "Sms_Applications",
22969     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22970     "version": "0.0.0",
22971     "filename": "server/api/smsApplication/index.js",
22972     "groupTitle": "Sms_Applications"
22973   },
22974   {
22975     "type": "post",
22976     "url": "/api/sms/interactions/{id}/tags",
22977     "title": "Add tags to the interaction",
22978     "examples": [
22979       {
22980         "title": "Example usage:",
22981         "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",
22982         "type": "json"
22983       }
22984     ],
22985     "name": "AddTags",
22986     "group": "Sms_Interactions",
22987     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22988     "version": "0.0.0",
22989     "filename": "server/api/smsInteraction/index.js",
22990     "groupTitle": "Sms_Interactions"
22991   },
22992   {
22993     "type": "post",
22994     "url": "/api/sms/interactions",
22995     "title": "Creates a new Interaction",
22996     "examples": [
22997       {
22998         "title": "Example usage:",
22999         "content": "curl https://{domain}/api/sms/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23000         "type": "json"
23001       }
23002     ],
23003     "name": "CreateInteractions",
23004     "group": "Sms_Interactions",
23005     "parameter": {
23006       "fields": {
23007         "Body": [
23008           {
23009             "group": "Body",
23010             "type": "Boolean",
23011             "optional": true,
23012             "field": "closed",
23013             "description": ""
23014           },
23015           {
23016             "group": "Body",
23017             "type": "String",
23018             "optional": true,
23019             "field": "closedAt",
23020             "description": ""
23021           },
23022           {
23023             "group": "Body",
23024             "type": "String",
23025             "optional": true,
23026             "field": "disposition",
23027             "description": ""
23028           },
23029           {
23030             "group": "Body",
23031             "type": "String",
23032             "optional": true,
23033             "field": "secondDisposition",
23034             "description": ""
23035           },
23036           {
23037             "group": "Body",
23038             "type": "String",
23039             "optional": true,
23040             "field": "thirdDisposition",
23041             "description": ""
23042           },
23043           {
23044             "group": "Body",
23045             "type": "String",
23046             "optional": true,
23047             "field": "note",
23048             "description": ""
23049           },
23050           {
23051             "group": "Body",
23052             "type": "String",
23053             "optional": true,
23054             "field": "phone",
23055             "description": ""
23056           },
23057           {
23058             "group": "Body",
23059             "type": "String",
23060             "optional": true,
23061             "field": "read1stAt",
23062             "description": ""
23063           },
23064           {
23065             "group": "Body",
23066             "type": "String",
23067             "allowedValues": [
23068               "\"in\"",
23069               "\"out\""
23070             ],
23071             "optional": false,
23072             "field": "firstMsgDirection",
23073             "description": ""
23074           },
23075           {
23076             "group": "Body",
23077             "type": "String",
23078             "optional": true,
23079             "field": "lastMsgAt",
23080             "description": ""
23081           },
23082           {
23083             "group": "Body",
23084             "type": "String",
23085             "allowedValues": [
23086               "\"in\"",
23087               "\"out\""
23088             ],
23089             "optional": false,
23090             "field": "lastMsgDirection",
23091             "description": ""
23092           }
23093         ]
23094       }
23095     },
23096     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23097     "version": "0.0.0",
23098     "filename": "server/api/smsInteraction/index.js",
23099     "groupTitle": "Sms_Interactions"
23100   },
23101   {
23102     "type": "delete",
23103     "url": "/api/sms/interactions/{id}",
23104     "title": "Deletes a Interaction",
23105     "examples": [
23106       {
23107         "title": "Example usage:",
23108         "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password} -X DELETE",
23109         "type": "json"
23110       }
23111     ],
23112     "name": "DeleteInteractions",
23113     "group": "Sms_Interactions",
23114     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23115     "version": "0.0.0",
23116     "filename": "server/api/smsInteraction/index.js",
23117     "groupTitle": "Sms_Interactions"
23118   },
23119   {
23120     "type": "get",
23121     "url": "/api/sms/interactions/describe",
23122     "title": "Gets table info about Interactions",
23123     "examples": [
23124       {
23125         "title": "Example usage:",
23126         "content": "curl https://{domain}/api/sms/interactions/describe -v -u {name}:{password}",
23127         "type": "json"
23128       }
23129     ],
23130     "name": "DescribeInteractions",
23131     "group": "Sms_Interactions",
23132     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23133     "version": "0.0.0",
23134     "filename": "server/api/smsInteraction/index.js",
23135     "groupTitle": "Sms_Interactions"
23136   },
23137   {
23138     "type": "get",
23139     "url": "/api/sms/interactions",
23140     "title": "Gets a list of Interactions",
23141     "examples": [
23142       {
23143         "title": "Example usage:",
23144         "content": "curl https://{domain}/api/sms/interactions -v -u {name}:{password}",
23145         "type": "json"
23146       }
23147     ],
23148     "name": "GetInteractions",
23149     "group": "Sms_Interactions",
23150     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23151     "version": "0.0.0",
23152     "filename": "server/api/smsInteraction/index.js",
23153     "groupTitle": "Sms_Interactions"
23154   },
23155   {
23156     "type": "delete",
23157     "url": "/api/sms/interactions/{id}/tags",
23158     "title": "Removes tags from interaction",
23159     "examples": [
23160       {
23161         "title": "Example usage:",
23162         "content": "curl https://{domain}/api/sms/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
23163         "type": "json"
23164       }
23165     ],
23166     "name": "RemoveTags",
23167     "group": "Sms_Interactions",
23168     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23169     "version": "0.0.0",
23170     "filename": "server/api/smsInteraction/index.js",
23171     "groupTitle": "Sms_Interactions"
23172   },
23173   {
23174     "type": "get",
23175     "url": "/api/sms/interactions/{id}",
23176     "title": "Gets a single Interaction",
23177     "examples": [
23178       {
23179         "title": "Example usage:",
23180         "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password}",
23181         "type": "json"
23182       }
23183     ],
23184     "name": "ShowInteractions",
23185     "group": "Sms_Interactions",
23186     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23187     "version": "0.0.0",
23188     "filename": "server/api/smsInteraction/index.js",
23189     "groupTitle": "Sms_Interactions"
23190   },
23191   {
23192     "type": "post",
23193     "url": "/api/sms/interactions/{id}/messages",
23194     "title": "Creates new messages",
23195     "examples": [
23196       {
23197         "title": "Example usage:",
23198         "content": "curl https://{domain}/api/sms/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
23199         "type": "json"
23200       }
23201     ],
23202     "name": "addMessage",
23203     "group": "Sms_Interactions",
23204     "parameter": {
23205       "fields": {
23206         "Body": [
23207           {
23208             "group": "Body",
23209             "type": "Text",
23210             "optional": false,
23211             "field": "body",
23212             "description": ""
23213           },
23214           {
23215             "group": "Body",
23216             "type": "Boolean",
23217             "optional": true,
23218             "field": "read",
23219             "description": ""
23220           },
23221           {
23222             "group": "Body",
23223             "type": "String",
23224             "allowedValues": [
23225               "\"in\"",
23226               "\"out\""
23227             ],
23228             "optional": false,
23229             "field": "direction",
23230             "description": ""
23231           },
23232           {
23233             "group": "Body",
23234             "type": "String",
23235             "optional": true,
23236             "field": "messageId",
23237             "description": ""
23238           },
23239           {
23240             "group": "Body",
23241             "type": "String",
23242             "optional": true,
23243             "field": "phone",
23244             "description": ""
23245           },
23246           {
23247             "group": "Body",
23248             "type": "String",
23249             "optional": true,
23250             "field": "readAt",
23251             "description": ""
23252           },
23253           {
23254             "group": "Body",
23255             "type": "Boolean",
23256             "optional": true,
23257             "field": "secret",
23258             "description": ""
23259           },
23260           {
23261             "group": "Body",
23262             "type": "String",
23263             "optional": true,
23264             "field": "providerName",
23265             "description": ""
23266           },
23267           {
23268             "group": "Body",
23269             "type": "Text",
23270             "optional": true,
23271             "field": "providerResponse",
23272             "description": ""
23273           }
23274         ]
23275       }
23276     },
23277     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23278     "version": "0.0.0",
23279     "filename": "server/api/smsInteraction/index.js",
23280     "groupTitle": "Sms_Interactions"
23281   },
23282   {
23283     "type": "get",
23284     "url": "/api/sms/interactions/{id}/download",
23285     "title": "Gets interaction",
23286     "examples": [
23287       {
23288         "title": "Example usage:",
23289         "content": "curl https://{domain}/api/sms/interactions/{id}/download -v -u {name}:{password} -X GET",
23290         "type": "json"
23291       }
23292     ],
23293     "name": "download",
23294     "group": "Sms_Interactions",
23295     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23296     "version": "0.0.0",
23297     "filename": "server/api/smsInteraction/index.js",
23298     "groupTitle": "Sms_Interactions"
23299   },
23300   {
23301     "type": "get",
23302     "url": "/api/sms/interactions/{id}/messages",
23303     "title": "Gets interaction messages",
23304     "examples": [
23305       {
23306         "title": "Example usage:",
23307         "content": "curl https://{domain}/api/sms/interactions/{id}/messages -v -u {name}:{password} -X GET",
23308         "type": "json"
23309       }
23310     ],
23311     "name": "getMessages",
23312     "group": "Sms_Interactions",
23313     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23314     "version": "0.0.0",
23315     "filename": "server/api/smsInteraction/index.js",
23316     "groupTitle": "Sms_Interactions"
23317   },
23318   {
23319     "type": "put",
23320     "url": "/api/sms/interactions/{id}",
23321     "title": "Update an existing Interaction",
23322     "examples": [
23323       {
23324         "title": "Example usage:",
23325         "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",
23326         "type": "json"
23327       }
23328     ],
23329     "name": "updateInteractions",
23330     "group": "Sms_Interactions",
23331     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23332     "version": "0.0.0",
23333     "filename": "server/api/smsInteraction/index.js",
23334     "groupTitle": "Sms_Interactions"
23335   },
23336   {
23337     "type": "post",
23338     "url": "/api/sms/messages",
23339     "title": "Creates a new Message",
23340     "examples": [
23341       {
23342         "title": "Example usage:",
23343         "content": "curl https://{domain}/api/sms/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23344         "type": "json"
23345       }
23346     ],
23347     "name": "CreateMessages",
23348     "group": "Sms_Messages",
23349     "parameter": {
23350       "fields": {
23351         "Body": [
23352           {
23353             "group": "Body",
23354             "type": "Text",
23355             "optional": false,
23356             "field": "body",
23357             "description": ""
23358           },
23359           {
23360             "group": "Body",
23361             "type": "Boolean",
23362             "optional": true,
23363             "field": "read",
23364             "description": ""
23365           },
23366           {
23367             "group": "Body",
23368             "type": "String",
23369             "allowedValues": [
23370               "\"in\"",
23371               "\"out\""
23372             ],
23373             "optional": false,
23374             "field": "direction",
23375             "description": ""
23376           },
23377           {
23378             "group": "Body",
23379             "type": "String",
23380             "optional": true,
23381             "field": "messageId",
23382             "description": ""
23383           },
23384           {
23385             "group": "Body",
23386             "type": "String",
23387             "optional": true,
23388             "field": "phone",
23389             "description": ""
23390           },
23391           {
23392             "group": "Body",
23393             "type": "String",
23394             "optional": true,
23395             "field": "readAt",
23396             "description": ""
23397           },
23398           {
23399             "group": "Body",
23400             "type": "Boolean",
23401             "optional": true,
23402             "field": "secret",
23403             "description": ""
23404           },
23405           {
23406             "group": "Body",
23407             "type": "String",
23408             "optional": true,
23409             "field": "providerName",
23410             "description": ""
23411           },
23412           {
23413             "group": "Body",
23414             "type": "Text",
23415             "optional": true,
23416             "field": "providerResponse",
23417             "description": ""
23418           }
23419         ]
23420       }
23421     },
23422     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23423     "version": "0.0.0",
23424     "filename": "server/api/smsMessage/index.js",
23425     "groupTitle": "Sms_Messages"
23426   },
23427   {
23428     "type": "delete",
23429     "url": "/api/sms/messages/{id}",
23430     "title": "Deletes a Message",
23431     "examples": [
23432       {
23433         "title": "Example usage:",
23434         "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password} -X DELETE",
23435         "type": "json"
23436       }
23437     ],
23438     "name": "DeleteMessages",
23439     "group": "Sms_Messages",
23440     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23441     "version": "0.0.0",
23442     "filename": "server/api/smsMessage/index.js",
23443     "groupTitle": "Sms_Messages"
23444   },
23445   {
23446     "type": "get",
23447     "url": "/api/sms/messages/describe",
23448     "title": "Gets table info about Messages",
23449     "examples": [
23450       {
23451         "title": "Example usage:",
23452         "content": "curl https://{domain}/api/sms/messages/describe -v -u {name}:{password}",
23453         "type": "json"
23454       }
23455     ],
23456     "name": "DescribeMessages",
23457     "group": "Sms_Messages",
23458     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23459     "version": "0.0.0",
23460     "filename": "server/api/smsMessage/index.js",
23461     "groupTitle": "Sms_Messages"
23462   },
23463   {
23464     "type": "get",
23465     "url": "/api/sms/messages",
23466     "title": "Gets a list of Messages",
23467     "examples": [
23468       {
23469         "title": "Example usage:",
23470         "content": "curl https://{domain}/api/sms/messages -v -u {name}:{password}",
23471         "type": "json"
23472       }
23473     ],
23474     "name": "GetMessages",
23475     "group": "Sms_Messages",
23476     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23477     "version": "0.0.0",
23478     "filename": "server/api/smsMessage/index.js",
23479     "groupTitle": "Sms_Messages"
23480   },
23481   {
23482     "type": "get",
23483     "url": "/api/sms/messages/{id}",
23484     "title": "Gets a single Message",
23485     "examples": [
23486       {
23487         "title": "Example usage:",
23488         "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password}",
23489         "type": "json"
23490       }
23491     ],
23492     "name": "ShowMessages",
23493     "group": "Sms_Messages",
23494     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23495     "version": "0.0.0",
23496     "filename": "server/api/smsMessage/index.js",
23497     "groupTitle": "Sms_Messages"
23498   },
23499   {
23500     "type": "put",
23501     "url": "/api/sms/messages/{id}",
23502     "title": "Update an existing Message",
23503     "examples": [
23504       {
23505         "title": "Example usage:",
23506         "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",
23507         "type": "json"
23508       }
23509     ],
23510     "name": "updateMessages",
23511     "group": "Sms_Messages",
23512     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23513     "version": "0.0.0",
23514     "filename": "server/api/smsMessage/index.js",
23515     "groupTitle": "Sms_Messages"
23516   },
23517   {
23518     "type": "post",
23519     "url": "/api/sms/reports/queue",
23520     "title": "Creates a new Sms Queue Report",
23521     "examples": [
23522       {
23523         "title": "Example usage:",
23524         "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",
23525         "type": "json"
23526       }
23527     ],
23528     "name": "CreateSms_Queue_Reports",
23529     "group": "Sms_Queue_Reports",
23530     "parameter": {
23531       "fields": {
23532         "Body": [
23533           {
23534             "group": "Body",
23535             "type": "String",
23536             "optional": false,
23537             "field": "uniqueid",
23538             "description": ""
23539           },
23540           {
23541             "group": "Body",
23542             "type": "String",
23543             "optional": true,
23544             "field": "from",
23545             "description": ""
23546           },
23547           {
23548             "group": "Body",
23549             "type": "String",
23550             "optional": true,
23551             "field": "joinAt",
23552             "description": ""
23553           },
23554           {
23555             "group": "Body",
23556             "type": "String",
23557             "optional": true,
23558             "field": "leaveAt",
23559             "description": ""
23560           },
23561           {
23562             "group": "Body",
23563             "type": "String",
23564             "optional": true,
23565             "field": "acceptAt",
23566             "description": ""
23567           },
23568           {
23569             "group": "Body",
23570             "type": "String",
23571             "optional": true,
23572             "field": "exitAt",
23573             "description": ""
23574           },
23575           {
23576             "group": "Body",
23577             "type": "String",
23578             "optional": true,
23579             "field": "reason",
23580             "description": ""
23581           }
23582         ]
23583       }
23584     },
23585     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23586     "version": "0.0.0",
23587     "filename": "server/api/smsQueueReport/index.js",
23588     "groupTitle": "Sms_Queue_Reports"
23589   },
23590   {
23591     "type": "delete",
23592     "url": "/api/sms/reports/queue/{id}",
23593     "title": "Deletes a Sms Queue Report",
23594     "examples": [
23595       {
23596         "title": "Example usage:",
23597         "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password} -X DELETE",
23598         "type": "json"
23599       }
23600     ],
23601     "name": "DeleteSms_Queue_Reports",
23602     "group": "Sms_Queue_Reports",
23603     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23604     "version": "0.0.0",
23605     "filename": "server/api/smsQueueReport/index.js",
23606     "groupTitle": "Sms_Queue_Reports"
23607   },
23608   {
23609     "type": "get",
23610     "url": "/api/sms/reports/queue/describe",
23611     "title": "Gets table info about Sms Queue Reports",
23612     "examples": [
23613       {
23614         "title": "Example usage:",
23615         "content": "curl https://{domain}/api/sms/reports/queue/describe -v -u {name}:{password}",
23616         "type": "json"
23617       }
23618     ],
23619     "name": "DescribeSms_Queue_Reports",
23620     "group": "Sms_Queue_Reports",
23621     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23622     "version": "0.0.0",
23623     "filename": "server/api/smsQueueReport/index.js",
23624     "groupTitle": "Sms_Queue_Reports"
23625   },
23626   {
23627     "type": "get",
23628     "url": "/api/sms/reports/queue",
23629     "title": "Gets a list of Sms Queue Reports",
23630     "examples": [
23631       {
23632         "title": "Example usage:",
23633         "content": "curl https://{domain}/api/sms/reports/queue -v -u {name}:{password}",
23634         "type": "json"
23635       }
23636     ],
23637     "name": "GetSms_Queue_Reports",
23638     "group": "Sms_Queue_Reports",
23639     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23640     "version": "0.0.0",
23641     "filename": "server/api/smsQueueReport/index.js",
23642     "groupTitle": "Sms_Queue_Reports"
23643   },
23644   {
23645     "type": "get",
23646     "url": "/api/sms/reports/queue/{id}",
23647     "title": "Gets a single Sms Queue Report",
23648     "examples": [
23649       {
23650         "title": "Example usage:",
23651         "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password}",
23652         "type": "json"
23653       }
23654     ],
23655     "name": "ShowSms_Queue_Reports",
23656     "group": "Sms_Queue_Reports",
23657     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23658     "version": "0.0.0",
23659     "filename": "server/api/smsQueueReport/index.js",
23660     "groupTitle": "Sms_Queue_Reports"
23661   },
23662   {
23663     "type": "put",
23664     "url": "/api/sms/reports/queue/{id}",
23665     "title": "Update an existing Sms Queue Report",
23666     "examples": [
23667       {
23668         "title": "Example usage:",
23669         "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",
23670         "type": "json"
23671       }
23672     ],
23673     "name": "updateSms_Queue_Reports",
23674     "group": "Sms_Queue_Reports",
23675     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23676     "version": "0.0.0",
23677     "filename": "server/api/smsQueueReport/index.js",
23678     "groupTitle": "Sms_Queue_Reports"
23679   },
23680   {
23681     "type": "post",
23682     "url": "/api/sms/queues/{id}/users",
23683     "title": "Add agents to a queue",
23684     "examples": [
23685       {
23686         "title": "Example usage:",
23687         "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",
23688         "type": "json"
23689       }
23690     ],
23691     "name": "AddAgents",
23692     "group": "Sms_Queues",
23693     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23694     "version": "0.0.0",
23695     "filename": "server/api/smsQueue/index.js",
23696     "groupTitle": "Sms_Queues"
23697   },
23698   {
23699     "type": "post",
23700     "url": "/api/sms/queues/{id}/teams",
23701     "title": "Add teams to a queue",
23702     "examples": [
23703       {
23704         "title": "Example usage:",
23705         "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",
23706         "type": "json"
23707       }
23708     ],
23709     "name": "AddTeams",
23710     "group": "Sms_Queues",
23711     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23712     "version": "0.0.0",
23713     "filename": "server/api/smsQueue/index.js",
23714     "groupTitle": "Sms_Queues"
23715   },
23716   {
23717     "type": "post",
23718     "url": "/api/sms/queues",
23719     "title": "Creates a new Queue",
23720     "examples": [
23721       {
23722         "title": "Example usage:",
23723         "content": "curl https://{domain}/api/sms/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23724         "type": "json"
23725       }
23726     ],
23727     "name": "CreateQueues",
23728     "group": "Sms_Queues",
23729     "parameter": {
23730       "fields": {
23731         "Body": [
23732           {
23733             "group": "Body",
23734             "type": "String",
23735             "optional": true,
23736             "field": "name",
23737             "description": ""
23738           },
23739           {
23740             "group": "Body",
23741             "type": "String",
23742             "optional": true,
23743             "field": "description",
23744             "description": ""
23745           },
23746           {
23747             "group": "Body",
23748             "type": "Integer",
23749             "optional": true,
23750             "field": "timeout",
23751             "description": ""
23752           },
23753           {
23754             "group": "Body",
23755             "type": "String",
23756             "allowedValues": [
23757               "\"rrmemory\"",
23758               "\"beepall\"",
23759               "\"roundrobin\""
23760             ],
23761             "optional": true,
23762             "field": "strategy",
23763             "description": ""
23764           }
23765         ]
23766       }
23767     },
23768     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23769     "version": "0.0.0",
23770     "filename": "server/api/smsQueue/index.js",
23771     "groupTitle": "Sms_Queues"
23772   },
23773   {
23774     "type": "delete",
23775     "url": "/api/sms/queues/{id}",
23776     "title": "Deletes a Queue",
23777     "examples": [
23778       {
23779         "title": "Example usage:",
23780         "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password} -X DELETE",
23781         "type": "json"
23782       }
23783     ],
23784     "name": "DeleteQueues",
23785     "group": "Sms_Queues",
23786     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23787     "version": "0.0.0",
23788     "filename": "server/api/smsQueue/index.js",
23789     "groupTitle": "Sms_Queues"
23790   },
23791   {
23792     "type": "get",
23793     "url": "/api/sms/queues/describe",
23794     "title": "Gets table info about Queues",
23795     "examples": [
23796       {
23797         "title": "Example usage:",
23798         "content": "curl https://{domain}/api/sms/queues/describe -v -u {name}:{password}",
23799         "type": "json"
23800       }
23801     ],
23802     "name": "DescribeQueues",
23803     "group": "Sms_Queues",
23804     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23805     "version": "0.0.0",
23806     "filename": "server/api/smsQueue/index.js",
23807     "groupTitle": "Sms_Queues"
23808   },
23809   {
23810     "type": "get",
23811     "url": "/api/sms/queues/{id}/users",
23812     "title": "Gets queue agents",
23813     "examples": [
23814       {
23815         "title": "Example usage:",
23816         "content": "curl https://{domain}/api/sms/queues/{id}/users -v -u {name}:{password} -X POST",
23817         "type": "json"
23818       }
23819     ],
23820     "name": "GetAgents",
23821     "group": "Sms_Queues",
23822     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23823     "version": "0.0.0",
23824     "filename": "server/api/smsQueue/index.js",
23825     "groupTitle": "Sms_Queues"
23826   },
23827   {
23828     "type": "get",
23829     "url": "/api/sms/queues/{id}/members",
23830     "title": "GetMembers",
23831     "examples": [
23832       {
23833         "title": "Example usage:",
23834         "content": "curl https://{domain}/api/sms/queues/{id}/members  -v -u {name}:{password}",
23835         "type": "json"
23836       }
23837     ],
23838     "name": "GetMembers",
23839     "group": "Sms_Queues",
23840     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23841     "version": "0.0.0",
23842     "filename": "server/api/smsQueue/index.js",
23843     "groupTitle": "Sms_Queues"
23844   },
23845   {
23846     "type": "get",
23847     "url": "/api/sms/queues",
23848     "title": "Gets a list of Queues",
23849     "examples": [
23850       {
23851         "title": "Example usage:",
23852         "content": "curl https://{domain}/api/sms/queues -v -u {name}:{password}",
23853         "type": "json"
23854       }
23855     ],
23856     "name": "GetQueues",
23857     "group": "Sms_Queues",
23858     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23859     "version": "0.0.0",
23860     "filename": "server/api/smsQueue/index.js",
23861     "groupTitle": "Sms_Queues"
23862   },
23863   {
23864     "type": "get",
23865     "url": "/api/sms/queues/{id}/teams",
23866     "title": "Gets queues list",
23867     "examples": [
23868       {
23869         "title": "Example usage:",
23870         "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password}",
23871         "type": "json"
23872       }
23873     ],
23874     "name": "GetTeams",
23875     "group": "Sms_Queues",
23876     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23877     "version": "0.0.0",
23878     "filename": "server/api/smsQueue/index.js",
23879     "groupTitle": "Sms_Queues"
23880   },
23881   {
23882     "type": "delete",
23883     "url": "/api/sms/queues/{id}/users",
23884     "title": "Removes agents from a queue",
23885     "examples": [
23886       {
23887         "title": "Example usage:",
23888         "content": "curl https://{domain}/api/sms/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
23889         "type": "json"
23890       }
23891     ],
23892     "name": "RemoveAgents",
23893     "group": "Sms_Queues",
23894     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23895     "version": "0.0.0",
23896     "filename": "server/api/smsQueue/index.js",
23897     "groupTitle": "Sms_Queues"
23898   },
23899   {
23900     "type": "get",
23901     "url": "/api/sms/queues/{id}",
23902     "title": "Gets a single Queue",
23903     "examples": [
23904       {
23905         "title": "Example usage:",
23906         "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password}",
23907         "type": "json"
23908       }
23909     ],
23910     "name": "ShowQueues",
23911     "group": "Sms_Queues",
23912     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23913     "version": "0.0.0",
23914     "filename": "server/api/smsQueue/index.js",
23915     "groupTitle": "Sms_Queues"
23916   },
23917   {
23918     "type": "put",
23919     "url": "/api/sms/queues/{id}",
23920     "title": "Update an existing Queue",
23921     "examples": [
23922       {
23923         "title": "Example usage:",
23924         "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",
23925         "type": "json"
23926       }
23927     ],
23928     "name": "updateQueues",
23929     "group": "Sms_Queues",
23930     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23931     "version": "0.0.0",
23932     "filename": "server/api/smsQueue/index.js",
23933     "groupTitle": "Sms_Queues"
23934   },
23935   {
23936     "type": "post",
23937     "url": "/api/sms/reports/transfer",
23938     "title": "Creates a new Sms Transfer Report",
23939     "examples": [
23940       {
23941         "title": "Example usage:",
23942         "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",
23943         "type": "json"
23944       }
23945     ],
23946     "name": "CreateSms_Transfer_Reports",
23947     "group": "Sms_Transfer_Reports",
23948     "parameter": {
23949       "fields": {
23950         "Body": [
23951           {
23952             "group": "Body",
23953             "type": "String",
23954             "optional": false,
23955             "field": "uniqueid",
23956             "description": ""
23957           },
23958           {
23959             "group": "Body",
23960             "type": "String",
23961             "allowedValues": [
23962               "\"account\"",
23963               "\"agent\"",
23964               "\"queue\""
23965             ],
23966             "optional": false,
23967             "field": "type",
23968             "description": ""
23969           },
23970           {
23971             "group": "Body",
23972             "type": "String",
23973             "optional": false,
23974             "field": "transferredAt",
23975             "description": ""
23976           }
23977         ]
23978       }
23979     },
23980     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23981     "version": "0.0.0",
23982     "filename": "server/api/smsTransferReport/index.js",
23983     "groupTitle": "Sms_Transfer_Reports"
23984   },
23985   {
23986     "type": "delete",
23987     "url": "/api/sms/reports/transfer/{id}",
23988     "title": "Deletes a Sms Transfer Report",
23989     "examples": [
23990       {
23991         "title": "Example usage:",
23992         "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
23993         "type": "json"
23994       }
23995     ],
23996     "name": "DeleteSms_Transfer_Reports",
23997     "group": "Sms_Transfer_Reports",
23998     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23999     "version": "0.0.0",
24000     "filename": "server/api/smsTransferReport/index.js",
24001     "groupTitle": "Sms_Transfer_Reports"
24002   },
24003   {
24004     "type": "get",
24005     "url": "/api/sms/reports/transfer/describe",
24006     "title": "Gets table info about Sms Transfer Reports",
24007     "examples": [
24008       {
24009         "title": "Example usage:",
24010         "content": "curl https://{domain}/api/sms/reports/transfer/describe -v -u {name}:{password}",
24011         "type": "json"
24012       }
24013     ],
24014     "name": "DescribeSms_Transfer_Reports",
24015     "group": "Sms_Transfer_Reports",
24016     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24017     "version": "0.0.0",
24018     "filename": "server/api/smsTransferReport/index.js",
24019     "groupTitle": "Sms_Transfer_Reports"
24020   },
24021   {
24022     "type": "get",
24023     "url": "/api/sms/reports/transfer",
24024     "title": "Gets a list of Sms Transfer Reports",
24025     "examples": [
24026       {
24027         "title": "Example usage:",
24028         "content": "curl https://{domain}/api/sms/reports/transfer -v -u {name}:{password}",
24029         "type": "json"
24030       }
24031     ],
24032     "name": "GetSms_Transfer_Reports",
24033     "group": "Sms_Transfer_Reports",
24034     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24035     "version": "0.0.0",
24036     "filename": "server/api/smsTransferReport/index.js",
24037     "groupTitle": "Sms_Transfer_Reports"
24038   },
24039   {
24040     "type": "get",
24041     "url": "/api/sms/reports/transfer/{id}",
24042     "title": "Gets a single Sms Transfer Report",
24043     "examples": [
24044       {
24045         "title": "Example usage:",
24046         "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password}",
24047         "type": "json"
24048       }
24049     ],
24050     "name": "ShowSms_Transfer_Reports",
24051     "group": "Sms_Transfer_Reports",
24052     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24053     "version": "0.0.0",
24054     "filename": "server/api/smsTransferReport/index.js",
24055     "groupTitle": "Sms_Transfer_Reports"
24056   },
24057   {
24058     "type": "put",
24059     "url": "/api/sms/reports/transfer/{id}",
24060     "title": "Update an existing Sms Transfer Report",
24061     "examples": [
24062       {
24063         "title": "Example usage:",
24064         "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",
24065         "type": "json"
24066       }
24067     ],
24068     "name": "updateSms_Transfer_Reports",
24069     "group": "Sms_Transfer_Reports",
24070     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24071     "version": "0.0.0",
24072     "filename": "server/api/smsTransferReport/index.js",
24073     "groupTitle": "Sms_Transfer_Reports"
24074   },
24075   {
24076     "type": "get",
24077     "url": "/api/sounds",
24078     "title": "Gets a list of Sounds",
24079     "examples": [
24080       {
24081         "title": "Example usage:",
24082         "content": "curl https://{domain}/api/sounds -v -u {name}:{password}",
24083         "type": "json"
24084       }
24085     ],
24086     "name": "GetSounds",
24087     "group": "Sounds",
24088     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24089     "version": "0.0.0",
24090     "filename": "server/api/sound/index.js",
24091     "groupTitle": "Sounds"
24092   },
24093   {
24094     "type": "get",
24095     "url": "/api/sounds/{id}",
24096     "title": "Gets a single Sound",
24097     "examples": [
24098       {
24099         "title": "Example usage:",
24100         "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password}",
24101         "type": "json"
24102       }
24103     ],
24104     "name": "ShowSounds",
24105     "group": "Sounds",
24106     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24107     "version": "0.0.0",
24108     "filename": "server/api/sound/index.js",
24109     "groupTitle": "Sounds"
24110   },
24111   {
24112     "type": "post",
24113     "url": "/api/sounds",
24114     "title": "Create a new sound",
24115     "examples": [
24116       {
24117         "title": "Example usage:",
24118         "content": "curl https://{domain}/api/sounds -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
24119         "type": "json"
24120       }
24121     ],
24122     "name": "addSound",
24123     "group": "Sounds",
24124     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24125     "version": "0.0.0",
24126     "filename": "server/api/sound/index.js",
24127     "groupTitle": "Sounds"
24128   },
24129   {
24130     "type": "delete",
24131     "url": "/api/sounds/{id}",
24132     "title": "Deletes a sound",
24133     "examples": [
24134       {
24135         "title": "Example usage:",
24136         "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password} -X DELETE",
24137         "type": "json"
24138       }
24139     ],
24140     "name": "destroySound",
24141     "group": "Sounds",
24142     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24143     "version": "0.0.0",
24144     "filename": "server/api/sound/index.js",
24145     "groupTitle": "Sounds"
24146   },
24147   {
24148     "type": "get",
24149     "url": "/api/sounds/{id}/download",
24150     "title": "Download Sound",
24151     "examples": [
24152       {
24153         "title": "Example usage:",
24154         "content": "curl https://{domain}/api/sounds/{id}/download -v -u {name}:{password} -X GET",
24155         "type": "json"
24156       }
24157     ],
24158     "name": "download",
24159     "group": "Sounds",
24160     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24161     "version": "0.0.0",
24162     "filename": "server/api/sound/index.js",
24163     "groupTitle": "Sounds"
24164   },
24165   {
24166     "type": "put",
24167     "url": "/api/sounds",
24168     "title": "Update an existing new sound",
24169     "examples": [
24170       {
24171         "title": "Example usage:",
24172         "content": "curl https://{domain}/api/sounds -d '[\"name\": \"sound_name\", \"description\": \"sound_desc\"]' -v -u {name}:{password} -X PUT",
24173         "type": "json"
24174       }
24175     ],
24176     "name": "updateSound",
24177     "group": "Sounds",
24178     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24179     "version": "0.0.0",
24180     "filename": "server/api/sound/index.js",
24181     "groupTitle": "Sounds"
24182   },
24183   {
24184     "type": "post",
24185     "url": "/api/square/details/reports",
24186     "title": "Creates a new Square Detail Report",
24187     "examples": [
24188       {
24189         "title": "Example usage:",
24190         "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",
24191         "type": "json"
24192       }
24193     ],
24194     "name": "CreateSquare_Detail_Reports",
24195     "group": "Square_Details_Reports",
24196     "parameter": {
24197       "fields": {
24198         "Body": [
24199           {
24200             "group": "Body",
24201             "type": "String",
24202             "optional": true,
24203             "field": "uniqueid",
24204             "description": ""
24205           },
24206           {
24207             "group": "Body",
24208             "type": "String",
24209             "optional": true,
24210             "field": "node",
24211             "description": ""
24212           },
24213           {
24214             "group": "Body",
24215             "type": "String",
24216             "optional": true,
24217             "field": "application",
24218             "description": ""
24219           },
24220           {
24221             "group": "Body",
24222             "type": "Text",
24223             "optional": true,
24224             "field": "data",
24225             "description": ""
24226           },
24227           {
24228             "group": "Body",
24229             "type": "String",
24230             "optional": true,
24231             "field": "project_name",
24232             "description": ""
24233           },
24234           {
24235             "group": "Body",
24236             "type": "String",
24237             "optional": true,
24238             "field": "callerid",
24239             "description": ""
24240           }
24241         ]
24242       }
24243     },
24244     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24245     "version": "0.0.0",
24246     "filename": "server/api/squareReportDetail/index.js",
24247     "groupTitle": "Square_Details_Reports"
24248   },
24249   {
24250     "type": "delete",
24251     "url": "/api/square/details/reports/{id}",
24252     "title": "Deletes a Square Detail Report",
24253     "examples": [
24254       {
24255         "title": "Example usage:",
24256         "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password} -X DELETE",
24257         "type": "json"
24258       }
24259     ],
24260     "name": "DeleteSquare_Detail_Reports",
24261     "group": "Square_Details_Reports",
24262     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24263     "version": "0.0.0",
24264     "filename": "server/api/squareReportDetail/index.js",
24265     "groupTitle": "Square_Details_Reports"
24266   },
24267   {
24268     "type": "get",
24269     "url": "/api/square/details/reports/describe",
24270     "title": "Gets table info about Square Detail Reports",
24271     "examples": [
24272       {
24273         "title": "Example usage:",
24274         "content": "curl https://{domain}/api/square/details/reports/describe -v -u {name}:{password}",
24275         "type": "json"
24276       }
24277     ],
24278     "name": "DescribeSquare_Detail_Reports",
24279     "group": "Square_Details_Reports",
24280     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24281     "version": "0.0.0",
24282     "filename": "server/api/squareReportDetail/index.js",
24283     "groupTitle": "Square_Details_Reports"
24284   },
24285   {
24286     "type": "get",
24287     "url": "/api/square/details/reports",
24288     "title": "Gets a list of Square Detail Reports",
24289     "examples": [
24290       {
24291         "title": "Example usage:",
24292         "content": "curl https://{domain}/api/square/details/reports -v -u {name}:{password}",
24293         "type": "json"
24294       }
24295     ],
24296     "name": "GetSquare_Detail_Reports",
24297     "group": "Square_Details_Reports",
24298     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24299     "version": "0.0.0",
24300     "filename": "server/api/squareReportDetail/index.js",
24301     "groupTitle": "Square_Details_Reports"
24302   },
24303   {
24304     "type": "get",
24305     "url": "/api/square/details/reports/{id}",
24306     "title": "Gets a single Square Detail Report",
24307     "examples": [
24308       {
24309         "title": "Example usage:",
24310         "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password}",
24311         "type": "json"
24312       }
24313     ],
24314     "name": "ShowSquare_Detail_Reports",
24315     "group": "Square_Details_Reports",
24316     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24317     "version": "0.0.0",
24318     "filename": "server/api/squareReportDetail/index.js",
24319     "groupTitle": "Square_Details_Reports"
24320   },
24321   {
24322     "type": "put",
24323     "url": "/api/square/details/reports/{id}",
24324     "title": "Update an existing Square Detail Report",
24325     "examples": [
24326       {
24327         "title": "Example usage:",
24328         "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",
24329         "type": "json"
24330       }
24331     ],
24332     "name": "updateSquare_Detail_Reports",
24333     "group": "Square_Details_Reports",
24334     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24335     "version": "0.0.0",
24336     "filename": "server/api/squareReportDetail/index.js",
24337     "groupTitle": "Square_Details_Reports"
24338   },
24339   {
24340     "type": "post",
24341     "url": "/api/square/messages",
24342     "title": "Creates a new Message",
24343     "examples": [
24344       {
24345         "title": "Example usage:",
24346         "content": "curl https://{domain}/api/square/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24347         "type": "json"
24348       }
24349     ],
24350     "name": "CreateMessages",
24351     "group": "Square_Messages",
24352     "parameter": {
24353       "fields": {
24354         "Body": [
24355           {
24356             "group": "Body",
24357             "type": "String",
24358             "optional": true,
24359             "field": "uniqueid",
24360             "description": ""
24361           },
24362           {
24363             "group": "Body",
24364             "type": "Text",
24365             "optional": false,
24366             "field": "body",
24367             "description": ""
24368           },
24369           {
24370             "group": "Body",
24371             "type": "String",
24372             "allowedValues": [
24373               "\"in\"",
24374               "\"out\""
24375             ],
24376             "optional": false,
24377             "field": "direction",
24378             "description": ""
24379           },
24380           {
24381             "group": "Body",
24382             "type": "String",
24383             "optional": true,
24384             "field": "providerName",
24385             "description": ""
24386           },
24387           {
24388             "group": "Body",
24389             "type": "Text",
24390             "optional": true,
24391             "field": "providerResponse",
24392             "description": ""
24393           }
24394         ]
24395       }
24396     },
24397     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24398     "version": "0.0.0",
24399     "filename": "server/api/squareMessage/index.js",
24400     "groupTitle": "Square_Messages"
24401   },
24402   {
24403     "type": "delete",
24404     "url": "/api/square/messages/{id}",
24405     "title": "Deletes a Message",
24406     "examples": [
24407       {
24408         "title": "Example usage:",
24409         "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password} -X DELETE",
24410         "type": "json"
24411       }
24412     ],
24413     "name": "DeleteMessages",
24414     "group": "Square_Messages",
24415     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24416     "version": "0.0.0",
24417     "filename": "server/api/squareMessage/index.js",
24418     "groupTitle": "Square_Messages"
24419   },
24420   {
24421     "type": "get",
24422     "url": "/api/square/messages",
24423     "title": "Gets a list of Messages",
24424     "examples": [
24425       {
24426         "title": "Example usage:",
24427         "content": "curl https://{domain}/api/square/messages -v -u {name}:{password}",
24428         "type": "json"
24429       }
24430     ],
24431     "name": "GetMessages",
24432     "group": "Square_Messages",
24433     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24434     "version": "0.0.0",
24435     "filename": "server/api/squareMessage/index.js",
24436     "groupTitle": "Square_Messages"
24437   },
24438   {
24439     "type": "get",
24440     "url": "/api/square/messages/{id}",
24441     "title": "Gets a single Message",
24442     "examples": [
24443       {
24444         "title": "Example usage:",
24445         "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password}",
24446         "type": "json"
24447       }
24448     ],
24449     "name": "ShowMessages",
24450     "group": "Square_Messages",
24451     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24452     "version": "0.0.0",
24453     "filename": "server/api/squareMessage/index.js",
24454     "groupTitle": "Square_Messages"
24455   },
24456   {
24457     "type": "put",
24458     "url": "/api/square/messages/{id}",
24459     "title": "Update an existing Message",
24460     "examples": [
24461       {
24462         "title": "Example usage:",
24463         "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",
24464         "type": "json"
24465       }
24466     ],
24467     "name": "updateMessages",
24468     "group": "Square_Messages",
24469     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24470     "version": "0.0.0",
24471     "filename": "server/api/squareMessage/index.js",
24472     "groupTitle": "Square_Messages"
24473   },
24474   {
24475     "type": "post",
24476     "url": "/api/square/odbc",
24477     "title": "Creates a new ODBC",
24478     "examples": [
24479       {
24480         "title": "Example usage:",
24481         "content": "curl https://{domain}/api/square/odbc -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24482         "type": "json"
24483       }
24484     ],
24485     "name": "CreateODBCs",
24486     "group": "Square_ODBC",
24487     "parameter": {
24488       "fields": {
24489         "Body": [
24490           {
24491             "group": "Body",
24492             "type": "String",
24493             "optional": false,
24494             "field": "name",
24495             "description": ""
24496           },
24497           {
24498             "group": "Body",
24499             "type": "String",
24500             "optional": true,
24501             "field": "dsn",
24502             "description": ""
24503           },
24504           {
24505             "group": "Body",
24506             "type": "String",
24507             "optional": true,
24508             "field": "description",
24509             "description": ""
24510           }
24511         ]
24512       }
24513     },
24514     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24515     "version": "0.0.0",
24516     "filename": "server/api/squareOdbc/index.js",
24517     "groupTitle": "Square_ODBC"
24518   },
24519   {
24520     "type": "delete",
24521     "url": "/api/square/odbc/{id}",
24522     "title": "Deletes a ODBC",
24523     "examples": [
24524       {
24525         "title": "Example usage:",
24526         "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password} -X DELETE",
24527         "type": "json"
24528       }
24529     ],
24530     "name": "DeleteODBCs",
24531     "group": "Square_ODBC",
24532     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24533     "version": "0.0.0",
24534     "filename": "server/api/squareOdbc/index.js",
24535     "groupTitle": "Square_ODBC"
24536   },
24537   {
24538     "type": "get",
24539     "url": "/api/square/odbc",
24540     "title": "Gets a list of ODBCs",
24541     "examples": [
24542       {
24543         "title": "Example usage:",
24544         "content": "curl https://{domain}/api/square/odbc -v -u {name}:{password}",
24545         "type": "json"
24546       }
24547     ],
24548     "name": "GetODBCs",
24549     "group": "Square_ODBC",
24550     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24551     "version": "0.0.0",
24552     "filename": "server/api/squareOdbc/index.js",
24553     "groupTitle": "Square_ODBC"
24554   },
24555   {
24556     "type": "get",
24557     "url": "/api/square/odbc/{id}",
24558     "title": "Gets a single ODBC",
24559     "examples": [
24560       {
24561         "title": "Example usage:",
24562         "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password}",
24563         "type": "json"
24564       }
24565     ],
24566     "name": "ShowODBCs",
24567     "group": "Square_ODBC",
24568     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24569     "version": "0.0.0",
24570     "filename": "server/api/squareOdbc/index.js",
24571     "groupTitle": "Square_ODBC"
24572   },
24573   {
24574     "type": "get",
24575     "url": "/api/square/odbc/{id}/test",
24576     "title": "Test Odbc",
24577     "examples": [
24578       {
24579         "title": "Example usage:",
24580         "content": "curl https://{domain}/api/square/odbc/{id}/test -v -u {name}:{password} -X GET",
24581         "type": "json"
24582       }
24583     ],
24584     "name": "test",
24585     "group": "Square_ODBC",
24586     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24587     "version": "0.0.0",
24588     "filename": "server/api/squareOdbc/index.js",
24589     "groupTitle": "Square_ODBC"
24590   },
24591   {
24592     "type": "put",
24593     "url": "/api/square/odbc/{id}",
24594     "title": "Update an existing ODBC",
24595     "examples": [
24596       {
24597         "title": "Example usage:",
24598         "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",
24599         "type": "json"
24600       }
24601     ],
24602     "name": "updateODBCs",
24603     "group": "Square_ODBC",
24604     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24605     "version": "0.0.0",
24606     "filename": "server/api/squareOdbc/index.js",
24607     "groupTitle": "Square_ODBC"
24608   },
24609   {
24610     "type": "post",
24611     "url": "/api/square/projects",
24612     "title": "Creates a new Project",
24613     "examples": [
24614       {
24615         "title": "Example usage:",
24616         "content": "curl https://{domain}/api/square/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24617         "type": "json"
24618       }
24619     ],
24620     "name": "CreateProjects",
24621     "group": "Square_Projects",
24622     "parameter": {
24623       "fields": {
24624         "Body": [
24625           {
24626             "group": "Body",
24627             "type": "String",
24628             "optional": false,
24629             "field": "name",
24630             "description": ""
24631           },
24632           {
24633             "group": "Body",
24634             "type": "String",
24635             "optional": true,
24636             "field": "description",
24637             "description": ""
24638           },
24639           {
24640             "group": "Body",
24641             "type": "Text",
24642             "optional": true,
24643             "field": "notes",
24644             "description": ""
24645           },
24646           {
24647             "group": "Body",
24648             "type": "Blob",
24649             "optional": true,
24650             "field": "preproduction",
24651             "description": ""
24652           },
24653           {
24654             "group": "Body",
24655             "type": "Blob",
24656             "optional": true,
24657             "field": "production",
24658             "description": ""
24659           },
24660           {
24661             "group": "Body",
24662             "type": "String",
24663             "optional": true,
24664             "field": "savedAt",
24665             "description": ""
24666           },
24667           {
24668             "group": "Body",
24669             "type": "String",
24670             "optional": true,
24671             "field": "publishedAt",
24672             "description": ""
24673           }
24674         ]
24675       }
24676     },
24677     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24678     "version": "0.0.0",
24679     "filename": "server/api/squareProject/index.js",
24680     "groupTitle": "Square_Projects"
24681   },
24682   {
24683     "type": "delete",
24684     "url": "/api/square/projects/{id}",
24685     "title": "Deletes a Project",
24686     "examples": [
24687       {
24688         "title": "Example usage:",
24689         "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password} -X DELETE",
24690         "type": "json"
24691       }
24692     ],
24693     "name": "DeleteProjects",
24694     "group": "Square_Projects",
24695     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24696     "version": "0.0.0",
24697     "filename": "server/api/squareProject/index.js",
24698     "groupTitle": "Square_Projects"
24699   },
24700   {
24701     "type": "get",
24702     "url": "/api/square/projects",
24703     "title": "Gets a list of Projects",
24704     "examples": [
24705       {
24706         "title": "Example usage:",
24707         "content": "curl https://{domain}/api/square/projects -v -u {name}:{password}",
24708         "type": "json"
24709       }
24710     ],
24711     "name": "GetProjects",
24712     "group": "Square_Projects",
24713     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24714     "version": "0.0.0",
24715     "filename": "server/api/squareProject/index.js",
24716     "groupTitle": "Square_Projects"
24717   },
24718   {
24719     "type": "get",
24720     "url": "/api/square/projects/{id}",
24721     "title": "Gets a single Project",
24722     "examples": [
24723       {
24724         "title": "Example usage:",
24725         "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password}",
24726         "type": "json"
24727       }
24728     ],
24729     "name": "ShowProjects",
24730     "group": "Square_Projects",
24731     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24732     "version": "0.0.0",
24733     "filename": "server/api/squareProject/index.js",
24734     "groupTitle": "Square_Projects"
24735   },
24736   {
24737     "type": "post",
24738     "url": "/api/square/projects/{id}/users",
24739     "title": "Adds user permissions to a Project",
24740     "examples": [
24741       {
24742         "title": "Example usage:",
24743         "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",
24744         "type": "json"
24745       }
24746     ],
24747     "name": "addUsers",
24748     "group": "Square_Projects",
24749     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24750     "version": "0.0.0",
24751     "filename": "server/api/squareProject/index.js",
24752     "groupTitle": "Square_Projects"
24753   },
24754   {
24755     "type": "get",
24756     "url": "/api/square/projects/{id}/users",
24757     "title": "Gets users permissions from Project",
24758     "examples": [
24759       {
24760         "title": "Example usage:",
24761         "content": "curl https://{domain}/api/square/projects/{id}/users -v -u {name}:{password} -X GET",
24762         "type": "json"
24763       }
24764     ],
24765     "name": "getUsers",
24766     "group": "Square_Projects",
24767     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24768     "version": "0.0.0",
24769     "filename": "server/api/squareProject/index.js",
24770     "groupTitle": "Square_Projects"
24771   },
24772   {
24773     "type": "delete",
24774     "url": "/api/square/projects/{id}/users",
24775     "title": "Removes user permissions from a Project",
24776     "examples": [
24777       {
24778         "title": "Example usage:",
24779         "content": "curl https://{domain}/api/square/projects/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
24780         "type": "json"
24781       }
24782     ],
24783     "name": "removeUsers",
24784     "group": "Square_Projects",
24785     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24786     "version": "0.0.0",
24787     "filename": "server/api/squareProject/index.js",
24788     "groupTitle": "Square_Projects"
24789   },
24790   {
24791     "type": "put",
24792     "url": "/api/square/projects/{id}",
24793     "title": "Update an existing Project",
24794     "examples": [
24795       {
24796         "title": "Example usage:",
24797         "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",
24798         "type": "json"
24799       }
24800     ],
24801     "name": "updateProjects",
24802     "group": "Square_Projects",
24803     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24804     "version": "0.0.0",
24805     "filename": "server/api/squareProject/index.js",
24806     "groupTitle": "Square_Projects"
24807   },
24808   {
24809     "type": "post",
24810     "url": "/api/square/recordings",
24811     "title": "Creates a new Recording",
24812     "examples": [
24813       {
24814         "title": "Example usage:",
24815         "content": "curl https://{domain}/api/square/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24816         "type": "json"
24817       }
24818     ],
24819     "name": "CreateRecordings",
24820     "group": "Square_Recordings",
24821     "parameter": {
24822       "fields": {
24823         "Body": [
24824           {
24825             "group": "Body",
24826             "type": "String",
24827             "optional": true,
24828             "field": "uniqueid",
24829             "description": ""
24830           },
24831           {
24832             "group": "Body",
24833             "type": "String",
24834             "optional": true,
24835             "field": "callerid",
24836             "description": ""
24837           },
24838           {
24839             "group": "Body",
24840             "type": "String",
24841             "optional": true,
24842             "field": "calleridname",
24843             "description": ""
24844           },
24845           {
24846             "group": "Body",
24847             "type": "String",
24848             "optional": true,
24849             "field": "context",
24850             "description": ""
24851           },
24852           {
24853             "group": "Body",
24854             "type": "String",
24855             "optional": true,
24856             "field": "extension",
24857             "description": ""
24858           },
24859           {
24860             "group": "Body",
24861             "type": "String",
24862             "optional": true,
24863             "field": "priority",
24864             "description": ""
24865           },
24866           {
24867             "group": "Body",
24868             "type": "String",
24869             "optional": true,
24870             "field": "accountcode",
24871             "description": ""
24872           },
24873           {
24874             "group": "Body",
24875             "type": "String",
24876             "optional": true,
24877             "field": "dnid",
24878             "description": ""
24879           },
24880           {
24881             "group": "Body",
24882             "type": "String",
24883             "optional": true,
24884             "field": "projectName",
24885             "description": ""
24886           },
24887           {
24888             "group": "Body",
24889             "type": "String",
24890             "optional": true,
24891             "field": "saveName",
24892             "description": ""
24893           },
24894           {
24895             "group": "Body",
24896             "type": "String",
24897             "optional": true,
24898             "field": "filename",
24899             "description": ""
24900           },
24901           {
24902             "group": "Body",
24903             "type": "String",
24904             "optional": true,
24905             "field": "savePath",
24906             "description": ""
24907           },
24908           {
24909             "group": "Body",
24910             "type": "Virtual",
24911             "optional": true,
24912             "field": "format",
24913             "description": ""
24914           }
24915         ]
24916       }
24917     },
24918     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24919     "version": "0.0.0",
24920     "filename": "server/api/squareRecording/index.js",
24921     "groupTitle": "Square_Recordings"
24922   },
24923   {
24924     "type": "get",
24925     "url": "/api/square/recordings",
24926     "title": "Gets a list of Recordings",
24927     "examples": [
24928       {
24929         "title": "Example usage:",
24930         "content": "curl https://{domain}/api/square/recordings -v -u {name}:{password}",
24931         "type": "json"
24932       }
24933     ],
24934     "name": "GetRecordings",
24935     "group": "Square_Recordings",
24936     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24937     "version": "0.0.0",
24938     "filename": "server/api/squareRecording/index.js",
24939     "groupTitle": "Square_Recordings"
24940   },
24941   {
24942     "type": "get",
24943     "url": "/api/square/recordings/{id}",
24944     "title": "Gets a single Recording",
24945     "examples": [
24946       {
24947         "title": "Example usage:",
24948         "content": "curl https://{domain}/api/square/recordings/{id} -v -u {name}:{password}",
24949         "type": "json"
24950       }
24951     ],
24952     "name": "ShowRecordings",
24953     "group": "Square_Recordings",
24954     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24955     "version": "0.0.0",
24956     "filename": "server/api/squareRecording/index.js",
24957     "groupTitle": "Square_Recordings"
24958   },
24959   {
24960     "type": "delete",
24961     "url": "/api/square/recordings/{id}/delete",
24962     "title": "Delete recording",
24963     "examples": [
24964       {
24965         "title": "Example usage:",
24966         "content": "curl https://{domain}/api/square/recordings/{id}/delete -v -u {name}:{password} -X DELETE",
24967         "type": "json"
24968       }
24969     ],
24970     "name": "destroy",
24971     "group": "Square_Recordings",
24972     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24973     "version": "0.0.0",
24974     "filename": "server/api/squareRecording/index.js",
24975     "groupTitle": "Square_Recordings"
24976   },
24977   {
24978     "type": "get",
24979     "url": "/api/square/recordings/{id}/download",
24980     "title": "Download Recording",
24981     "examples": [
24982       {
24983         "title": "Example usage:",
24984         "content": "curl https://{domain}/api/square/recordings/{id}/download -v -u {name}:{password} -X GET",
24985         "type": "json"
24986       }
24987     ],
24988     "name": "download",
24989     "group": "Square_Recordings",
24990     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24991     "version": "0.0.0",
24992     "filename": "server/api/squareRecording/index.js",
24993     "groupTitle": "Square_Recordings"
24994   },
24995   {
24996     "type": "put",
24997     "url": "/api/square/recordings/{id}",
24998     "title": "Update an existing Recording",
24999     "examples": [
25000       {
25001         "title": "Example usage:",
25002         "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",
25003         "type": "json"
25004       }
25005     ],
25006     "name": "updateRecordings",
25007     "group": "Square_Recordings",
25008     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25009     "version": "0.0.0",
25010     "filename": "server/api/squareRecording/index.js",
25011     "groupTitle": "Square_Recordings"
25012   },
25013   {
25014     "type": "post",
25015     "url": "/api/square/reports",
25016     "title": "Creates a new Square Report",
25017     "examples": [
25018       {
25019         "title": "Example usage:",
25020         "content": "curl https://{domain}/api/square/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25021         "type": "json"
25022       }
25023     ],
25024     "name": "CreateSquare_Reports",
25025     "group": "Square_Reports",
25026     "parameter": {
25027       "fields": {
25028         "Body": [
25029           {
25030             "group": "Body",
25031             "type": "String",
25032             "optional": true,
25033             "field": "network",
25034             "description": ""
25035           },
25036           {
25037             "group": "Body",
25038             "type": "String",
25039             "optional": true,
25040             "field": "network_script",
25041             "description": ""
25042           },
25043           {
25044             "group": "Body",
25045             "type": "String",
25046             "optional": true,
25047             "field": "request",
25048             "description": ""
25049           },
25050           {
25051             "group": "Body",
25052             "type": "String",
25053             "optional": true,
25054             "field": "channel",
25055             "description": ""
25056           },
25057           {
25058             "group": "Body",
25059             "type": "String",
25060             "optional": true,
25061             "field": "language",
25062             "description": ""
25063           },
25064           {
25065             "group": "Body",
25066             "type": "String",
25067             "optional": true,
25068             "field": "type",
25069             "description": ""
25070           },
25071           {
25072             "group": "Body",
25073             "type": "String",
25074             "optional": true,
25075             "field": "uniqueid",
25076             "description": ""
25077           },
25078           {
25079             "group": "Body",
25080             "type": "String",
25081             "optional": true,
25082             "field": "version",
25083             "description": ""
25084           },
25085           {
25086             "group": "Body",
25087             "type": "String",
25088             "optional": true,
25089             "field": "callerid",
25090             "description": ""
25091           },
25092           {
25093             "group": "Body",
25094             "type": "String",
25095             "optional": true,
25096             "field": "calleridname",
25097             "description": ""
25098           },
25099           {
25100             "group": "Body",
25101             "type": "String",
25102             "optional": true,
25103             "field": "callingpres",
25104             "description": ""
25105           },
25106           {
25107             "group": "Body",
25108             "type": "String",
25109             "optional": true,
25110             "field": "callingani2",
25111             "description": ""
25112           },
25113           {
25114             "group": "Body",
25115             "type": "String",
25116             "optional": true,
25117             "field": "callington",
25118             "description": ""
25119           },
25120           {
25121             "group": "Body",
25122             "type": "String",
25123             "optional": true,
25124             "field": "callingtns",
25125             "description": ""
25126           },
25127           {
25128             "group": "Body",
25129             "type": "String",
25130             "optional": true,
25131             "field": "dnid",
25132             "description": ""
25133           },
25134           {
25135             "group": "Body",
25136             "type": "String",
25137             "optional": true,
25138             "field": "rdnis",
25139             "description": ""
25140           },
25141           {
25142             "group": "Body",
25143             "type": "String",
25144             "optional": true,
25145             "field": "context",
25146             "description": ""
25147           },
25148           {
25149             "group": "Body",
25150             "type": "String",
25151             "optional": true,
25152             "field": "extension",
25153             "description": ""
25154           },
25155           {
25156             "group": "Body",
25157             "type": "String",
25158             "optional": true,
25159             "field": "priority",
25160             "description": ""
25161           },
25162           {
25163             "group": "Body",
25164             "type": "String",
25165             "optional": true,
25166             "field": "enhanced",
25167             "description": ""
25168           },
25169           {
25170             "group": "Body",
25171             "type": "String",
25172             "optional": true,
25173             "field": "accountcode",
25174             "description": ""
25175           },
25176           {
25177             "group": "Body",
25178             "type": "String",
25179             "optional": true,
25180             "field": "threadid",
25181             "description": ""
25182           },
25183           {
25184             "group": "Body",
25185             "type": "String",
25186             "optional": true,
25187             "field": "project_name",
25188             "description": ""
25189           },
25190           {
25191             "group": "Body",
25192             "type": "String",
25193             "optional": true,
25194             "field": "joinAt",
25195             "description": ""
25196           },
25197           {
25198             "group": "Body",
25199             "type": "String",
25200             "optional": true,
25201             "field": "leaveAt",
25202             "description": ""
25203           },
25204           {
25205             "group": "Body",
25206             "type": "Boolean",
25207             "optional": true,
25208             "field": "bot",
25209             "description": ""
25210           }
25211         ]
25212       }
25213     },
25214     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25215     "version": "0.0.0",
25216     "filename": "server/api/squareReport/index.js",
25217     "groupTitle": "Square_Reports"
25218   },
25219   {
25220     "type": "delete",
25221     "url": "/api/square/reports/{id}",
25222     "title": "Deletes a Square Report",
25223     "examples": [
25224       {
25225         "title": "Example usage:",
25226         "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password} -X DELETE",
25227         "type": "json"
25228       }
25229     ],
25230     "name": "DeleteSquare_Reports",
25231     "group": "Square_Reports",
25232     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25233     "version": "0.0.0",
25234     "filename": "server/api/squareReport/index.js",
25235     "groupTitle": "Square_Reports"
25236   },
25237   {
25238     "type": "get",
25239     "url": "/api/square/reports/describe",
25240     "title": "Gets table info about Square Reports",
25241     "examples": [
25242       {
25243         "title": "Example usage:",
25244         "content": "curl https://{domain}/api/square/reports/describe -v -u {name}:{password}",
25245         "type": "json"
25246       }
25247     ],
25248     "name": "DescribeSquare_Reports",
25249     "group": "Square_Reports",
25250     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25251     "version": "0.0.0",
25252     "filename": "server/api/squareReport/index.js",
25253     "groupTitle": "Square_Reports"
25254   },
25255   {
25256     "type": "get",
25257     "url": "/api/square/reports",
25258     "title": "Gets a list of Square Reports",
25259     "examples": [
25260       {
25261         "title": "Example usage:",
25262         "content": "curl https://{domain}/api/square/reports -v -u {name}:{password}",
25263         "type": "json"
25264       }
25265     ],
25266     "name": "GetSquare_Reports",
25267     "group": "Square_Reports",
25268     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25269     "version": "0.0.0",
25270     "filename": "server/api/squareReport/index.js",
25271     "groupTitle": "Square_Reports"
25272   },
25273   {
25274     "type": "get",
25275     "url": "/api/square/reports/{id}",
25276     "title": "Gets a single Square Report",
25277     "examples": [
25278       {
25279         "title": "Example usage:",
25280         "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password}",
25281         "type": "json"
25282       }
25283     ],
25284     "name": "ShowSquare_Reports",
25285     "group": "Square_Reports",
25286     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25287     "version": "0.0.0",
25288     "filename": "server/api/squareReport/index.js",
25289     "groupTitle": "Square_Reports"
25290   },
25291   {
25292     "type": "put",
25293     "url": "/api/square/reports/{id}",
25294     "title": "Update an existing Square Report",
25295     "examples": [
25296       {
25297         "title": "Example usage:",
25298         "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",
25299         "type": "json"
25300       }
25301     ],
25302     "name": "updateSquare_Reports",
25303     "group": "Square_Reports",
25304     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25305     "version": "0.0.0",
25306     "filename": "server/api/squareReport/index.js",
25307     "groupTitle": "Square_Reports"
25308   },
25309   {
25310     "type": "post",
25311     "url": "/api/integrations/sugarcrm/configurations",
25312     "title": "Creates a new SugarCRM Configuration",
25313     "examples": [
25314       {
25315         "title": "Example usage:",
25316         "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",
25317         "type": "json"
25318       }
25319     ],
25320     "name": "CreateSugarCRM_Configurations",
25321     "group": "SugarCRM_Configurations",
25322     "parameter": {
25323       "fields": {
25324         "Body": [
25325           {
25326             "group": "Body",
25327             "type": "String",
25328             "optional": true,
25329             "field": "name",
25330             "description": ""
25331           },
25332           {
25333             "group": "Body",
25334             "type": "String",
25335             "optional": true,
25336             "field": "description",
25337             "description": ""
25338           }
25339         ]
25340       }
25341     },
25342     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25343     "version": "0.0.0",
25344     "filename": "server/api/intSugarcrmConfiguration/index.js",
25345     "groupTitle": "SugarCRM_Configurations"
25346   },
25347   {
25348     "type": "delete",
25349     "url": "/api/integrations/sugarcrm/configurations/{id}",
25350     "title": "Deletes a SugarCRM Configuration",
25351     "examples": [
25352       {
25353         "title": "Example usage:",
25354         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password} -X DELETE",
25355         "type": "json"
25356       }
25357     ],
25358     "name": "DeleteSugarCRM_Configurations",
25359     "group": "SugarCRM_Configurations",
25360     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25361     "version": "0.0.0",
25362     "filename": "server/api/intSugarcrmConfiguration/index.js",
25363     "groupTitle": "SugarCRM_Configurations"
25364   },
25365   {
25366     "type": "get",
25367     "url": "/api/integrations/sugarcrm/configurations",
25368     "title": "Gets a list of SugarCRM Configurations",
25369     "examples": [
25370       {
25371         "title": "Example usage:",
25372         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations -v -u {name}:{password}",
25373         "type": "json"
25374       }
25375     ],
25376     "name": "GetSugarCRM_Configurations",
25377     "group": "SugarCRM_Configurations",
25378     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25379     "version": "0.0.0",
25380     "filename": "server/api/intSugarcrmConfiguration/index.js",
25381     "groupTitle": "SugarCRM_Configurations"
25382   },
25383   {
25384     "type": "get",
25385     "url": "/api/integrations/sugarcrm/configurations/{id}",
25386     "title": "Gets a single SugarCRM Configuration",
25387     "examples": [
25388       {
25389         "title": "Example usage:",
25390         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password}",
25391         "type": "json"
25392       }
25393     ],
25394     "name": "ShowSugarCRM_Configurations",
25395     "group": "SugarCRM_Configurations",
25396     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25397     "version": "0.0.0",
25398     "filename": "server/api/intSugarcrmConfiguration/index.js",
25399     "groupTitle": "SugarCRM_Configurations"
25400   },
25401   {
25402     "type": "put",
25403     "url": "/api/integrations/sugarcrm/configurations/{id}",
25404     "title": "Update an existing SugarCRM Configuration",
25405     "examples": [
25406       {
25407         "title": "Example usage:",
25408         "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",
25409         "type": "json"
25410       }
25411     ],
25412     "name": "updateSugarCRM_Configurations",
25413     "group": "SugarCRM_Configurations",
25414     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25415     "version": "0.0.0",
25416     "filename": "server/api/intSugarcrmConfiguration/index.js",
25417     "groupTitle": "SugarCRM_Configurations"
25418   },
25419   {
25420     "type": "post",
25421     "url": "/api/integrations/sugarcrm/accounts",
25422     "title": "Creates a new Sugarcrm Account",
25423     "examples": [
25424       {
25425         "title": "Example usage:",
25426         "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",
25427         "type": "json"
25428       }
25429     ],
25430     "name": "CreateSugarcrm_Accounts",
25431     "group": "Sugarcrm_Accounts",
25432     "parameter": {
25433       "fields": {
25434         "Body": [
25435           {
25436             "group": "Body",
25437             "type": "String",
25438             "optional": true,
25439             "field": "name",
25440             "description": ""
25441           },
25442           {
25443             "group": "Body",
25444             "type": "String",
25445             "optional": true,
25446             "field": "description",
25447             "description": ""
25448           },
25449           {
25450             "group": "Body",
25451             "type": "String",
25452             "optional": true,
25453             "field": "username",
25454             "description": ""
25455           },
25456           {
25457             "group": "Body",
25458             "type": "String",
25459             "optional": true,
25460             "field": "password",
25461             "description": ""
25462           },
25463           {
25464             "group": "Body",
25465             "type": "String",
25466             "optional": true,
25467             "field": "remoteUri",
25468             "description": ""
25469           },
25470           {
25471             "group": "Body",
25472             "type": "String",
25473             "optional": false,
25474             "field": "serverUrl",
25475             "description": ""
25476           }
25477         ]
25478       }
25479     },
25480     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25481     "version": "0.0.0",
25482     "filename": "server/api/intSugarcrmAccount/index.js",
25483     "groupTitle": "Sugarcrm_Accounts"
25484   },
25485   {
25486     "type": "delete",
25487     "url": "/api/integrations/sugarcrm/accounts/{id}",
25488     "title": "Deletes a Sugarcrm Account",
25489     "examples": [
25490       {
25491         "title": "Example usage:",
25492         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password} -X DELETE",
25493         "type": "json"
25494       }
25495     ],
25496     "name": "DeleteSugarcrm_Accounts",
25497     "group": "Sugarcrm_Accounts",
25498     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25499     "version": "0.0.0",
25500     "filename": "server/api/intSugarcrmAccount/index.js",
25501     "groupTitle": "Sugarcrm_Accounts"
25502   },
25503   {
25504     "type": "get",
25505     "url": "/api/integrations/sugarcrm/accounts",
25506     "title": "Gets a list of Sugarcrm Accounts",
25507     "examples": [
25508       {
25509         "title": "Example usage:",
25510         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts -v -u {name}:{password}",
25511         "type": "json"
25512       }
25513     ],
25514     "name": "GetSugarcrm_Accounts",
25515     "group": "Sugarcrm_Accounts",
25516     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25517     "version": "0.0.0",
25518     "filename": "server/api/intSugarcrmAccount/index.js",
25519     "groupTitle": "Sugarcrm_Accounts"
25520   },
25521   {
25522     "type": "get",
25523     "url": "/api/integrations/sugarcrm/accounts/{id}",
25524     "title": "Gets a single Sugarcrm Account",
25525     "examples": [
25526       {
25527         "title": "Example usage:",
25528         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password}",
25529         "type": "json"
25530       }
25531     ],
25532     "name": "ShowSugarcrm_Accounts",
25533     "group": "Sugarcrm_Accounts",
25534     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25535     "version": "0.0.0",
25536     "filename": "server/api/intSugarcrmAccount/index.js",
25537     "groupTitle": "Sugarcrm_Accounts"
25538   },
25539   {
25540     "type": "post",
25541     "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
25542     "title": "Creates new configuration",
25543     "examples": [
25544       {
25545         "title": "Example usage:",
25546         "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",
25547         "type": "json"
25548       }
25549     ],
25550     "name": "addConfiguration",
25551     "group": "Sugarcrm_Accounts",
25552     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25553     "version": "0.0.0",
25554     "filename": "server/api/intSugarcrmAccount/index.js",
25555     "groupTitle": "Sugarcrm_Accounts"
25556   },
25557   {
25558     "type": "get",
25559     "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
25560     "title": "Gets account configurations",
25561     "examples": [
25562       {
25563         "title": "Example usage:",
25564         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/configurations -v -u {name}:{password} -X GET",
25565         "type": "json"
25566       }
25567     ],
25568     "name": "getConfigurations",
25569     "group": "Sugarcrm_Accounts",
25570     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25571     "version": "0.0.0",
25572     "filename": "server/api/intSugarcrmAccount/index.js",
25573     "groupTitle": "Sugarcrm_Accounts"
25574   },
25575   {
25576     "type": "get",
25577     "url": "/api/integrations/sugarcrm/accounts/{id}/fields",
25578     "title": "Gets account fields",
25579     "examples": [
25580       {
25581         "title": "Example usage:",
25582         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/fields -v -u {name}:{password} -X GET",
25583         "type": "json"
25584       }
25585     ],
25586     "name": "getFields",
25587     "group": "Sugarcrm_Accounts",
25588     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25589     "version": "0.0.0",
25590     "filename": "server/api/intSugarcrmAccount/index.js",
25591     "groupTitle": "Sugarcrm_Accounts"
25592   },
25593   {
25594     "type": "put",
25595     "url": "/api/integrations/sugarcrm/accounts/{id}",
25596     "title": "Update an existing Sugarcrm Account",
25597     "examples": [
25598       {
25599         "title": "Example usage:",
25600         "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",
25601         "type": "json"
25602       }
25603     ],
25604     "name": "updateSugarcrm_Accounts",
25605     "group": "Sugarcrm_Accounts",
25606     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25607     "version": "0.0.0",
25608     "filename": "server/api/intSugarcrmAccount/index.js",
25609     "groupTitle": "Sugarcrm_Accounts"
25610   },
25611   {
25612     "type": "get",
25613     "url": "/api/integrations/sugarcrm/configurations/{id}/descriptions",
25614     "title": "Gets configurations descriptions",
25615     "examples": [
25616       {
25617         "title": "Example usage:",
25618         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
25619         "type": "json"
25620       }
25621     ],
25622     "name": "getDescriptions",
25623     "group": "Sugarcrm_Configurations",
25624     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25625     "version": "0.0.0",
25626     "filename": "server/api/intSugarcrmConfiguration/index.js",
25627     "groupTitle": "Sugarcrm_Configurations"
25628   },
25629   {
25630     "type": "get",
25631     "url": "/api/integrations/sugarcrm/configurations/{id}/fields",
25632     "title": "Gets configurations fields",
25633     "examples": [
25634       {
25635         "title": "Example usage:",
25636         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/fields -v -u {name}:{password} -X GET",
25637         "type": "json"
25638       }
25639     ],
25640     "name": "getFields",
25641     "group": "Sugarcrm_Configurations",
25642     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25643     "version": "0.0.0",
25644     "filename": "server/api/intSugarcrmConfiguration/index.js",
25645     "groupTitle": "Sugarcrm_Configurations"
25646   },
25647   {
25648     "type": "get",
25649     "url": "/api/integrations/sugarcrm/configurations/{id}/subjects",
25650     "title": "Gets configurations subjects",
25651     "examples": [
25652       {
25653         "title": "Example usage:",
25654         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/subjects -v -u {name}:{password} -X GET",
25655         "type": "json"
25656       }
25657     ],
25658     "name": "getSubjects",
25659     "group": "Sugarcrm_Configurations",
25660     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25661     "version": "0.0.0",
25662     "filename": "server/api/intSugarcrmConfiguration/index.js",
25663     "groupTitle": "Sugarcrm_Configurations"
25664   },
25665   {
25666     "type": "post",
25667     "url": "/api/integrations/sugarcrm/fields",
25668     "title": "Creates a new Sugarcrm Field",
25669     "examples": [
25670       {
25671         "title": "Example usage:",
25672         "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",
25673         "type": "json"
25674       }
25675     ],
25676     "name": "CreateSugarcrm_Fields",
25677     "group": "Sugarcrm_Fields",
25678     "parameter": {
25679       "fields": {
25680         "Body": [
25681           {
25682             "group": "Body",
25683             "type": "String",
25684             "allowedValues": [
25685               "\"string\"",
25686               "\"variable\"",
25687               "\"customVariable\"",
25688               "\"keyValue\"",
25689               "\"picklist\""
25690             ],
25691             "optional": true,
25692             "field": "type",
25693             "description": ""
25694           },
25695           {
25696             "group": "Body",
25697             "type": "String",
25698             "optional": true,
25699             "field": "content",
25700             "description": ""
25701           },
25702           {
25703             "group": "Body",
25704             "type": "String",
25705             "optional": true,
25706             "field": "key",
25707             "description": ""
25708           },
25709           {
25710             "group": "Body",
25711             "type": "String",
25712             "allowedValues": [
25713               "\"string\"",
25714               "\"variable\"",
25715               "\"customVariable\""
25716             ],
25717             "optional": true,
25718             "field": "keyType",
25719             "description": ""
25720           },
25721           {
25722             "group": "Body",
25723             "type": "String",
25724             "optional": true,
25725             "field": "keyContent",
25726             "description": ""
25727           },
25728           {
25729             "group": "Body",
25730             "type": "String",
25731             "optional": true,
25732             "field": "idField",
25733             "description": ""
25734           },
25735           {
25736             "group": "Body",
25737             "type": "String",
25738             "optional": true,
25739             "field": "nameField",
25740             "description": ""
25741           },
25742           {
25743             "group": "Body",
25744             "type": "Boolean",
25745             "optional": true,
25746             "field": "customField",
25747             "description": ""
25748           },
25749           {
25750             "group": "Body",
25751             "type": "String",
25752             "optional": true,
25753             "field": "variableName",
25754             "description": ""
25755           }
25756         ]
25757       }
25758     },
25759     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25760     "version": "0.0.0",
25761     "filename": "server/api/intSugarcrmField/index.js",
25762     "groupTitle": "Sugarcrm_Fields"
25763   },
25764   {
25765     "type": "delete",
25766     "url": "/api/integrations/sugarcrm/fields/{id}",
25767     "title": "Deletes a Sugarcrm Field",
25768     "examples": [
25769       {
25770         "title": "Example usage:",
25771         "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password} -X DELETE",
25772         "type": "json"
25773       }
25774     ],
25775     "name": "DeleteSugarcrm_Fields",
25776     "group": "Sugarcrm_Fields",
25777     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25778     "version": "0.0.0",
25779     "filename": "server/api/intSugarcrmField/index.js",
25780     "groupTitle": "Sugarcrm_Fields"
25781   },
25782   {
25783     "type": "get",
25784     "url": "/api/integrations/sugarcrm/fields",
25785     "title": "Gets a list of Sugarcrm Fields",
25786     "examples": [
25787       {
25788         "title": "Example usage:",
25789         "content": "curl https://{domain}/api/integrations/sugarcrm/fields -v -u {name}:{password}",
25790         "type": "json"
25791       }
25792     ],
25793     "name": "GetSugarcrm_Fields",
25794     "group": "Sugarcrm_Fields",
25795     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25796     "version": "0.0.0",
25797     "filename": "server/api/intSugarcrmField/index.js",
25798     "groupTitle": "Sugarcrm_Fields"
25799   },
25800   {
25801     "type": "get",
25802     "url": "/api/integrations/sugarcrm/fields/{id}",
25803     "title": "Gets a single Sugarcrm Field",
25804     "examples": [
25805       {
25806         "title": "Example usage:",
25807         "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password}",
25808         "type": "json"
25809       }
25810     ],
25811     "name": "ShowSugarcrm_Fields",
25812     "group": "Sugarcrm_Fields",
25813     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25814     "version": "0.0.0",
25815     "filename": "server/api/intSugarcrmField/index.js",
25816     "groupTitle": "Sugarcrm_Fields"
25817   },
25818   {
25819     "type": "put",
25820     "url": "/api/integrations/sugarcrm/fields/{id}",
25821     "title": "Update an existing Sugarcrm Field",
25822     "examples": [
25823       {
25824         "title": "Example usage:",
25825         "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",
25826         "type": "json"
25827       }
25828     ],
25829     "name": "updateSugarcrm_Fields",
25830     "group": "Sugarcrm_Fields",
25831     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25832     "version": "0.0.0",
25833     "filename": "server/api/intSugarcrmField/index.js",
25834     "groupTitle": "Sugarcrm_Fields"
25835   },
25836   {
25837     "type": "get",
25838     "url": "/api/system",
25839     "title": "Gets system information",
25840     "examples": [
25841       {
25842         "title": "Example usage:",
25843         "content": "curl https://{domain}/api/system -v -u {name}:{password}",
25844         "type": "json"
25845       }
25846     ],
25847     "name": "GetSystemInformation",
25848     "group": "System_Information",
25849     "description": "<p>Motion returns the system information.</p>",
25850     "version": "0.0.0",
25851     "filename": "server/api/system/index.js",
25852     "groupTitle": "System_Information"
25853   },
25854   {
25855     "type": "get",
25856     "url": "/api/system/process",
25857     "title": "Gets system information",
25858     "examples": [
25859       {
25860         "title": "Example usage:",
25861         "content": "curl https://{domain}/api/system -v -u {name}:{password}",
25862         "type": "json"
25863       }
25864     ],
25865     "name": "GetSystemInformation",
25866     "group": "System_Information",
25867     "description": "<p>Motion returns the system information.</p>",
25868     "version": "0.0.0",
25869     "filename": "server/api/system/index.js",
25870     "groupTitle": "System_Information"
25871   },
25872   {
25873     "type": "post",
25874     "url": "/api/tags",
25875     "title": "Creates a new Tag",
25876     "examples": [
25877       {
25878         "title": "Example usage:",
25879         "content": "curl https://{domain}/api/tags -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25880         "type": "json"
25881       }
25882     ],
25883     "name": "CreateTags",
25884     "group": "Tags",
25885     "parameter": {
25886       "fields": {
25887         "Body": [
25888           {
25889             "group": "Body",
25890             "type": "String",
25891             "optional": false,
25892             "field": "name",
25893             "description": ""
25894           },
25895           {
25896             "group": "Body",
25897             "type": "String",
25898             "optional": true,
25899             "field": "color",
25900             "description": ""
25901           },
25902           {
25903             "group": "Body",
25904             "type": "String",
25905             "optional": true,
25906             "field": "description",
25907             "description": ""
25908           }
25909         ]
25910       }
25911     },
25912     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25913     "version": "0.0.0",
25914     "filename": "server/api/tag/index.js",
25915     "groupTitle": "Tags"
25916   },
25917   {
25918     "type": "delete",
25919     "url": "/api/tags/{id}",
25920     "title": "Deletes a Tag",
25921     "examples": [
25922       {
25923         "title": "Example usage:",
25924         "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password} -X DELETE",
25925         "type": "json"
25926       }
25927     ],
25928     "name": "DeleteTags",
25929     "group": "Tags",
25930     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25931     "version": "0.0.0",
25932     "filename": "server/api/tag/index.js",
25933     "groupTitle": "Tags"
25934   },
25935   {
25936     "type": "get",
25937     "url": "/api/tags",
25938     "title": "Gets a list of Tags",
25939     "examples": [
25940       {
25941         "title": "Example usage:",
25942         "content": "curl https://{domain}/api/tags -v -u {name}:{password}",
25943         "type": "json"
25944       }
25945     ],
25946     "name": "GetTags",
25947     "group": "Tags",
25948     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25949     "version": "0.0.0",
25950     "filename": "server/api/tag/index.js",
25951     "groupTitle": "Tags"
25952   },
25953   {
25954     "type": "get",
25955     "url": "/api/tags/{id}",
25956     "title": "Gets a single Tag",
25957     "examples": [
25958       {
25959         "title": "Example usage:",
25960         "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password}",
25961         "type": "json"
25962       }
25963     ],
25964     "name": "ShowTags",
25965     "group": "Tags",
25966     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25967     "version": "0.0.0",
25968     "filename": "server/api/tag/index.js",
25969     "groupTitle": "Tags"
25970   },
25971   {
25972     "type": "put",
25973     "url": "/api/tags/{id}",
25974     "title": "Update an existing Tag",
25975     "examples": [
25976       {
25977         "title": "Example usage:",
25978         "content": "curl https://{domain}/api/tags/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
25979         "type": "json"
25980       }
25981     ],
25982     "name": "updateTags",
25983     "group": "Tags",
25984     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25985     "version": "0.0.0",
25986     "filename": "server/api/tag/index.js",
25987     "groupTitle": "Tags"
25988   },
25989   {
25990     "type": "post",
25991     "url": "/api/teams/{id}/queues",
25992     "title": "Add queues to a team",
25993     "examples": [
25994       {
25995         "title": "Example usage:",
25996         "content": "curl https://{domain}/api/teams/{id}/queues -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
25997         "type": "json"
25998       }
25999     ],
26000     "name": "AddQueues",
26001     "group": "Teams",
26002     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26003     "version": "0.0.0",
26004     "filename": "server/api/team/index.js",
26005     "groupTitle": "Teams"
26006   },
26007   {
26008     "type": "post",
26009     "url": "/api/teams",
26010     "title": "Creates a new Team",
26011     "examples": [
26012       {
26013         "title": "Example usage:",
26014         "content": "curl https://{domain}/api/teams -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26015         "type": "json"
26016       }
26017     ],
26018     "name": "CreateTeams",
26019     "group": "Teams",
26020     "parameter": {
26021       "fields": {
26022         "Body": [
26023           {
26024             "group": "Body",
26025             "type": "String",
26026             "optional": false,
26027             "field": "name",
26028             "description": ""
26029           },
26030           {
26031             "group": "Body",
26032             "type": "String",
26033             "optional": true,
26034             "field": "description",
26035             "description": ""
26036           }
26037         ]
26038       }
26039     },
26040     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26041     "version": "0.0.0",
26042     "filename": "server/api/team/index.js",
26043     "groupTitle": "Teams"
26044   },
26045   {
26046     "type": "delete",
26047     "url": "/api/teams/{id}",
26048     "title": "Deletes a Team",
26049     "examples": [
26050       {
26051         "title": "Example usage:",
26052         "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password} -X DELETE",
26053         "type": "json"
26054       }
26055     ],
26056     "name": "DeleteTeams",
26057     "group": "Teams",
26058     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26059     "version": "0.0.0",
26060     "filename": "server/api/team/index.js",
26061     "groupTitle": "Teams"
26062   },
26063   {
26064     "type": "get",
26065     "url": "/api/teams/{id}/users",
26066     "title": "Gets agents from team",
26067     "examples": [
26068       {
26069         "title": "Example usage:",
26070         "content": "curl https://{domain}/api/teams/{id}/users -v -u {name}:{password} -X GET",
26071         "type": "json"
26072       }
26073     ],
26074     "name": "GetAgents",
26075     "group": "Teams",
26076     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26077     "version": "0.0.0",
26078     "filename": "server/api/team/index.js",
26079     "groupTitle": "Teams"
26080   },
26081   {
26082     "type": "get",
26083     "url": "/api/teams/{id}/queues?channel={channel}",
26084     "title": "Gets Queues list",
26085     "examples": [
26086       {
26087         "title": "Example usage:",
26088         "content": "curl https://{domain}/api/teams/{id}/queues?channel={channel} -v -u {name}:{password}",
26089         "type": "json"
26090       }
26091     ],
26092     "name": "GetQueues",
26093     "group": "Teams",
26094     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26095     "version": "0.0.0",
26096     "filename": "server/api/team/index.js",
26097     "groupTitle": "Teams"
26098   },
26099   {
26100     "type": "get",
26101     "url": "/api/teams",
26102     "title": "Gets a list of Teams",
26103     "examples": [
26104       {
26105         "title": "Example usage:",
26106         "content": "curl https://{domain}/api/teams -v -u {name}:{password}",
26107         "type": "json"
26108       }
26109     ],
26110     "name": "GetTeams",
26111     "group": "Teams",
26112     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26113     "version": "0.0.0",
26114     "filename": "server/api/team/index.js",
26115     "groupTitle": "Teams"
26116   },
26117   {
26118     "type": "delete",
26119     "url": "/api/teams/{id}/users",
26120     "title": "Removes agents from a team",
26121     "examples": [
26122       {
26123         "title": "Example usage:",
26124         "content": "curl https://{domain}/api/teams/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
26125         "type": "json"
26126       }
26127     ],
26128     "name": "RemoveAgents",
26129     "group": "Teams",
26130     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26131     "version": "0.0.0",
26132     "filename": "server/api/team/index.js",
26133     "groupTitle": "Teams"
26134   },
26135   {
26136     "type": "delete",
26137     "url": "/api/teams/{id}/queues",
26138     "title": "Remove queues to a team",
26139     "examples": [
26140       {
26141         "title": "Example usage:",
26142         "content": "curl https://{domain}/api/teams/{id}/queues?channel=voice&ids=1&ids=2 -v -u {name}:{password} -X DELETE",
26143         "type": "json"
26144       }
26145     ],
26146     "name": "RemoveQueues",
26147     "group": "Teams",
26148     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26149     "version": "0.0.0",
26150     "filename": "server/api/team/index.js",
26151     "groupTitle": "Teams"
26152   },
26153   {
26154     "type": "delete",
26155     "url": "/api/whatsapp/queues/{id}/teams",
26156     "title": "Remove teams from a queue",
26157     "examples": [
26158       {
26159         "title": "Example usage:",
26160         "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26161         "type": "json"
26162       }
26163     ],
26164     "name": "RemoveTeams",
26165     "group": "Teams",
26166     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26167     "version": "0.0.0",
26168     "filename": "server/api/whatsappQueue/index.js",
26169     "groupTitle": "Teams"
26170   },
26171   {
26172     "type": "delete",
26173     "url": "/api/openchannel/queues/{id}/teams",
26174     "title": "Remove teams from a queue",
26175     "examples": [
26176       {
26177         "title": "Example usage:",
26178         "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26179         "type": "json"
26180       }
26181     ],
26182     "name": "RemoveTeams",
26183     "group": "Teams",
26184     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26185     "version": "0.0.0",
26186     "filename": "server/api/openchannelQueue/index.js",
26187     "groupTitle": "Teams"
26188   },
26189   {
26190     "type": "delete",
26191     "url": "/api/voice/queues/{id}/teams",
26192     "title": "Remove teams from a queue",
26193     "examples": [
26194       {
26195         "title": "Example usage:",
26196         "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26197         "type": "json"
26198       }
26199     ],
26200     "name": "RemoveTeams",
26201     "group": "Teams",
26202     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26203     "version": "0.0.0",
26204     "filename": "server/api/voiceQueue/index.js",
26205     "groupTitle": "Teams"
26206   },
26207   {
26208     "type": "delete",
26209     "url": "/api/sms/queues/{id}/teams",
26210     "title": "Remove teams from a queue",
26211     "examples": [
26212       {
26213         "title": "Example usage:",
26214         "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26215         "type": "json"
26216       }
26217     ],
26218     "name": "RemoveTeams",
26219     "group": "Teams",
26220     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26221     "version": "0.0.0",
26222     "filename": "server/api/smsQueue/index.js",
26223     "groupTitle": "Teams"
26224   },
26225   {
26226     "type": "delete",
26227     "url": "/api/chat/queues/{id}/teams",
26228     "title": "Remove teams from a queue",
26229     "examples": [
26230       {
26231         "title": "Example usage:",
26232         "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26233         "type": "json"
26234       }
26235     ],
26236     "name": "RemoveTeams",
26237     "group": "Teams",
26238     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26239     "version": "0.0.0",
26240     "filename": "server/api/chatQueue/index.js",
26241     "groupTitle": "Teams"
26242   },
26243   {
26244     "type": "delete",
26245     "url": "/api/mail/queues/{id}/teams",
26246     "title": "Remove teams from a queue",
26247     "examples": [
26248       {
26249         "title": "Example usage:",
26250         "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26251         "type": "json"
26252       }
26253     ],
26254     "name": "RemoveTeams",
26255     "group": "Teams",
26256     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26257     "version": "0.0.0",
26258     "filename": "server/api/mailQueue/index.js",
26259     "groupTitle": "Teams"
26260   },
26261   {
26262     "type": "delete",
26263     "url": "/api/fax/queues/{id}/teams",
26264     "title": "Remove teams from a queue",
26265     "examples": [
26266       {
26267         "title": "Example usage:",
26268         "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26269         "type": "json"
26270       }
26271     ],
26272     "name": "RemoveTeams",
26273     "group": "Teams",
26274     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26275     "version": "0.0.0",
26276     "filename": "server/api/faxQueue/index.js",
26277     "groupTitle": "Teams"
26278   },
26279   {
26280     "type": "get",
26281     "url": "/api/teams/{id}",
26282     "title": "Gets a single Team",
26283     "examples": [
26284       {
26285         "title": "Example usage:",
26286         "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password}",
26287         "type": "json"
26288       }
26289     ],
26290     "name": "ShowTeams",
26291     "group": "Teams",
26292     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26293     "version": "0.0.0",
26294     "filename": "server/api/team/index.js",
26295     "groupTitle": "Teams"
26296   },
26297   {
26298     "type": "post",
26299     "url": "/api/teams/{id}/users",
26300     "title": "Adds agents to a team",
26301     "examples": [
26302       {
26303         "title": "Example usage:",
26304         "content": "curl https://{domain}/api/teams/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26305         "type": "json"
26306       }
26307     ],
26308     "name": "addAgents",
26309     "group": "Teams",
26310     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26311     "version": "0.0.0",
26312     "filename": "server/api/team/index.js",
26313     "groupTitle": "Teams"
26314   },
26315   {
26316     "type": "put",
26317     "url": "/api/teams/{id}",
26318     "title": "Update an existing Team",
26319     "examples": [
26320       {
26321         "title": "Example usage:",
26322         "content": "curl https://{domain}/api/teams/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26323         "type": "json"
26324       }
26325     ],
26326     "name": "updateTeams",
26327     "group": "Teams",
26328     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26329     "version": "0.0.0",
26330     "filename": "server/api/team/index.js",
26331     "groupTitle": "Teams"
26332   },
26333   {
26334     "type": "post",
26335     "url": "/api/templates",
26336     "title": "Creates a new Template",
26337     "examples": [
26338       {
26339         "title": "Example usage:",
26340         "content": "curl https://{domain}/api/templates -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26341         "type": "json"
26342       }
26343     ],
26344     "name": "CreateTemplates",
26345     "group": "Templates",
26346     "parameter": {
26347       "fields": {
26348         "Body": [
26349           {
26350             "group": "Body",
26351             "type": "String",
26352             "optional": true,
26353             "field": "name",
26354             "description": ""
26355           },
26356           {
26357             "group": "Body",
26358             "type": "String",
26359             "optional": true,
26360             "field": "description",
26361             "description": ""
26362           },
26363           {
26364             "group": "Body",
26365             "type": "Text",
26366             "optional": true,
26367             "field": "html",
26368             "description": ""
26369           }
26370         ]
26371       }
26372     },
26373     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26374     "version": "0.0.0",
26375     "filename": "server/api/template/index.js",
26376     "groupTitle": "Templates"
26377   },
26378   {
26379     "type": "delete",
26380     "url": "/api/templates/{id}",
26381     "title": "Deletes a Template",
26382     "examples": [
26383       {
26384         "title": "Example usage:",
26385         "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password} -X DELETE",
26386         "type": "json"
26387       }
26388     ],
26389     "name": "DeleteTemplates",
26390     "group": "Templates",
26391     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26392     "version": "0.0.0",
26393     "filename": "server/api/template/index.js",
26394     "groupTitle": "Templates"
26395   },
26396   {
26397     "type": "get",
26398     "url": "/api/templates",
26399     "title": "Gets a list of Templates",
26400     "examples": [
26401       {
26402         "title": "Example usage:",
26403         "content": "curl https://{domain}/api/templates -v -u {name}:{password}",
26404         "type": "json"
26405       }
26406     ],
26407     "name": "GetTemplates",
26408     "group": "Templates",
26409     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26410     "version": "0.0.0",
26411     "filename": "server/api/template/index.js",
26412     "groupTitle": "Templates"
26413   },
26414   {
26415     "type": "get",
26416     "url": "/api/templates/{id}",
26417     "title": "Gets a single Template",
26418     "examples": [
26419       {
26420         "title": "Example usage:",
26421         "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password}",
26422         "type": "json"
26423       }
26424     ],
26425     "name": "ShowTemplates",
26426     "group": "Templates",
26427     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26428     "version": "0.0.0",
26429     "filename": "server/api/template/index.js",
26430     "groupTitle": "Templates"
26431   },
26432   {
26433     "type": "put",
26434     "url": "/api/templates/{id}",
26435     "title": "Update an existing Template",
26436     "examples": [
26437       {
26438         "title": "Example usage:",
26439         "content": "curl https://{domain}/api/templates/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26440         "type": "json"
26441       }
26442     ],
26443     "name": "updateTemplates",
26444     "group": "Templates",
26445     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26446     "version": "0.0.0",
26447     "filename": "server/api/template/index.js",
26448     "groupTitle": "Templates"
26449   },
26450   {
26451     "type": "post",
26452     "url": "/api/triggers",
26453     "title": "Creates a new Trigger",
26454     "examples": [
26455       {
26456         "title": "Example usage:",
26457         "content": "curl https://{domain}/api/triggers -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26458         "type": "json"
26459       }
26460     ],
26461     "name": "CreateTriggers",
26462     "group": "Triggers",
26463     "parameter": {
26464       "fields": {
26465         "Body": [
26466           {
26467             "group": "Body",
26468             "type": "String",
26469             "optional": true,
26470             "field": "name",
26471             "description": ""
26472           },
26473           {
26474             "group": "Body",
26475             "type": "String",
26476             "optional": true,
26477             "field": "channel",
26478             "description": ""
26479           },
26480           {
26481             "group": "Body",
26482             "type": "String",
26483             "optional": true,
26484             "field": "description",
26485             "description": ""
26486           },
26487           {
26488             "group": "Body",
26489             "type": "Boolean",
26490             "optional": true,
26491             "field": "status",
26492             "description": ""
26493           }
26494         ]
26495       }
26496     },
26497     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26498     "version": "0.0.0",
26499     "filename": "server/api/trigger/index.js",
26500     "groupTitle": "Triggers"
26501   },
26502   {
26503     "type": "delete",
26504     "url": "/api/triggers/{id}",
26505     "title": "Deletes a Trigger",
26506     "examples": [
26507       {
26508         "title": "Example usage:",
26509         "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password} -X DELETE",
26510         "type": "json"
26511       }
26512     ],
26513     "name": "DeleteTriggers",
26514     "group": "Triggers",
26515     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26516     "version": "0.0.0",
26517     "filename": "server/api/trigger/index.js",
26518     "groupTitle": "Triggers"
26519   },
26520   {
26521     "type": "get",
26522     "url": "/api/triggers",
26523     "title": "Gets a list of Triggers",
26524     "examples": [
26525       {
26526         "title": "Example usage:",
26527         "content": "curl https://{domain}/api/triggers -v -u {name}:{password}",
26528         "type": "json"
26529       }
26530     ],
26531     "name": "GetTriggers",
26532     "group": "Triggers",
26533     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26534     "version": "0.0.0",
26535     "filename": "server/api/trigger/index.js",
26536     "groupTitle": "Triggers"
26537   },
26538   {
26539     "type": "get",
26540     "url": "/api/triggers/{id}",
26541     "title": "Gets a single Trigger",
26542     "examples": [
26543       {
26544         "title": "Example usage:",
26545         "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password}",
26546         "type": "json"
26547       }
26548     ],
26549     "name": "ShowTriggers",
26550     "group": "Triggers",
26551     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26552     "version": "0.0.0",
26553     "filename": "server/api/trigger/index.js",
26554     "groupTitle": "Triggers"
26555   },
26556   {
26557     "type": "post",
26558     "url": "/api/triggers/{id}/actions",
26559     "title": "Creates new actions",
26560     "examples": [
26561       {
26562         "title": "Example usage:",
26563         "content": "curl https://{domain}/api/triggers/{id}/actions -d '{\"action\": \"contactManager\",\"data1\": \"1\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26564         "type": "json"
26565       }
26566     ],
26567     "name": "addAction",
26568     "group": "Triggers",
26569     "parameter": {
26570       "fields": {
26571         "Body": [
26572           {
26573             "group": "Body",
26574             "type": "Virtual",
26575             "optional": true,
26576             "field": "name",
26577             "description": ""
26578           },
26579           {
26580             "group": "Body",
26581             "type": "String",
26582             "optional": false,
26583             "field": "action",
26584             "description": "<p>Allowed values: contactManager, integration, motionbar, jscripty, urlForward, browser, bot, script</p>"
26585           },
26586           {
26587             "group": "Body",
26588             "type": "String",
26589             "optional": true,
26590             "field": "data1",
26591             "description": "<p>contactManager[ListId], integration[intName(zendesk)], motionbar[Popup(0),URL(1),WinApp(2)], urlForward[GET,POST], browser[TemplateId(0),URL(1)]</p>"
26592           },
26593           {
26594             "group": "Body",
26595             "type": "String",
26596             "optional": true,
26597             "field": "data2",
26598             "description": "<p>integration[AccountId], motionbar[TemplateId,URL,WinAppPath], urlForward[URL]</p>"
26599           },
26600           {
26601             "group": "Body",
26602             "type": "String",
26603             "optional": true,
26604             "field": "data3",
26605             "description": "<p>motionbar[NULL,NULL,WinAppArguments]</p>"
26606           },
26607           {
26608             "group": "Body",
26609             "type": "String",
26610             "optional": true,
26611             "field": "data4",
26612             "description": ""
26613           },
26614           {
26615             "group": "Body",
26616             "type": "String",
26617             "optional": true,
26618             "field": "data5",
26619             "description": ""
26620           },
26621           {
26622             "group": "Body",
26623             "type": "String",
26624             "optional": true,
26625             "field": "data6",
26626             "description": ""
26627           },
26628           {
26629             "group": "Body",
26630             "type": "Text",
26631             "optional": true,
26632             "field": "data7",
26633             "description": ""
26634           }
26635         ]
26636       }
26637     },
26638     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26639     "version": "0.0.0",
26640     "filename": "server/api/trigger/index.js",
26641     "groupTitle": "Triggers"
26642   },
26643   {
26644     "type": "post",
26645     "url": "/api/triggers/{id}/all_conditions",
26646     "title": "Creates a new \"AND\"condition",
26647     "examples": [
26648       {
26649         "title": "Example usage:",
26650         "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",
26651         "type": "json"
26652       }
26653     ],
26654     "name": "addAllCondition",
26655     "group": "Triggers",
26656     "parameter": {
26657       "fields": {
26658         "Body": [
26659           {
26660             "group": "Body",
26661             "type": "Virtual",
26662             "optional": true,
26663             "field": "name",
26664             "description": ""
26665           },
26666           {
26667             "group": "Body",
26668             "type": "String",
26669             "optional": false,
26670             "field": "field",
26671             "description": ""
26672           },
26673           {
26674             "group": "Body",
26675             "type": "String",
26676             "optional": false,
26677             "field": "operator",
26678             "description": ""
26679           },
26680           {
26681             "group": "Body",
26682             "type": "String",
26683             "optional": false,
26684             "field": "value",
26685             "description": ""
26686           }
26687         ]
26688       }
26689     },
26690     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26691     "version": "0.0.0",
26692     "filename": "server/api/trigger/index.js",
26693     "groupTitle": "Triggers"
26694   },
26695   {
26696     "type": "post",
26697     "url": "/api/triggers/{id}/any_conditions",
26698     "title": "Creates a new \"OR\"condition",
26699     "examples": [
26700       {
26701         "title": "Example usage:",
26702         "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",
26703         "type": "json"
26704       }
26705     ],
26706     "name": "addAnyCondition",
26707     "group": "Triggers",
26708     "parameter": {
26709       "fields": {
26710         "Body": [
26711           {
26712             "group": "Body",
26713             "type": "Virtual",
26714             "optional": true,
26715             "field": "name",
26716             "description": ""
26717           },
26718           {
26719             "group": "Body",
26720             "type": "String",
26721             "optional": false,
26722             "field": "field",
26723             "description": ""
26724           },
26725           {
26726             "group": "Body",
26727             "type": "String",
26728             "optional": false,
26729             "field": "operator",
26730             "description": ""
26731           },
26732           {
26733             "group": "Body",
26734             "type": "String",
26735             "optional": false,
26736             "field": "value",
26737             "description": ""
26738           }
26739         ]
26740       }
26741     },
26742     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26743     "version": "0.0.0",
26744     "filename": "server/api/trigger/index.js",
26745     "groupTitle": "Triggers"
26746   },
26747   {
26748     "type": "get",
26749     "url": "/api/triggers/{id}/actions",
26750     "title": "Gets Trigger Actions",
26751     "examples": [
26752       {
26753         "title": "Example usage:",
26754         "content": "curl https://{domain}/api/triggers/{id}/actions -v -u {name}:{password} -X GET",
26755         "type": "json"
26756       }
26757     ],
26758     "name": "getActions",
26759     "group": "Triggers",
26760     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26761     "version": "0.0.0",
26762     "filename": "server/api/trigger/index.js",
26763     "groupTitle": "Triggers"
26764   },
26765   {
26766     "type": "get",
26767     "url": "/api/triggers/{id}/all_conditions",
26768     "title": "Gets \"AND\" Trigger Conditions",
26769     "examples": [
26770       {
26771         "title": "Example usage:",
26772         "content": "curl https://{domain}/api/triggers/{id}/all_conditions -v -u {name}:{password} -X GET",
26773         "type": "json"
26774       }
26775     ],
26776     "name": "getAllConditions",
26777     "group": "Triggers",
26778     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26779     "version": "0.0.0",
26780     "filename": "server/api/trigger/index.js",
26781     "groupTitle": "Triggers"
26782   },
26783   {
26784     "type": "get",
26785     "url": "/api/triggers/{id}/any_conditions",
26786     "title": "Gets \"OR\" Trigger Conditions",
26787     "examples": [
26788       {
26789         "title": "Example usage:",
26790         "content": "curl https://{domain}/api/triggers/{id}/any_conditions -v -u {name}:{password} -X GET",
26791         "type": "json"
26792       }
26793     ],
26794     "name": "getAnyConditions",
26795     "group": "Triggers",
26796     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26797     "version": "0.0.0",
26798     "filename": "server/api/trigger/index.js",
26799     "groupTitle": "Triggers"
26800   },
26801   {
26802     "type": "put",
26803     "url": "/api/triggers/{id}",
26804     "title": "Update an existing Trigger",
26805     "examples": [
26806       {
26807         "title": "Example usage:",
26808         "content": "curl https://{domain}/api/triggers/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26809         "type": "json"
26810       }
26811     ],
26812     "name": "updateTriggers",
26813     "group": "Triggers",
26814     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26815     "version": "0.0.0",
26816     "filename": "server/api/trigger/index.js",
26817     "groupTitle": "Triggers"
26818   },
26819   {
26820     "type": "post",
26821     "url": "/api/trunks/clone",
26822     "title": "Clone an existing Trunk",
26823     "examples": [
26824       {
26825         "title": "Example usage:",
26826         "content": "curl https://{domain}/api/trunks/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26827         "type": "json"
26828       }
26829     ],
26830     "name": "CloneTrunks",
26831     "group": "Trunks",
26832     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26833     "version": "0.0.0",
26834     "filename": "server/api/trunk/index.js",
26835     "groupTitle": "Trunks"
26836   },
26837   {
26838     "type": "post",
26839     "url": "/api/trunks",
26840     "title": "Create a new trunk",
26841     "examples": [
26842       {
26843         "title": "Example usage:",
26844         "content": "curl https://{domain}/api/trunks -v -u {name}:{password} -X POST",
26845         "type": "json"
26846       }
26847     ],
26848     "name": "Create",
26849     "group": "Trunks",
26850     "parameter": {
26851       "fields": {
26852         "Body": [
26853           {
26854             "group": "Body",
26855             "type": "String",
26856             "optional": false,
26857             "field": "name",
26858             "description": ""
26859           },
26860           {
26861             "group": "Body",
26862             "type": "String",
26863             "allowedValues": [
26864               "\"friend\"",
26865               "\"user\"",
26866               "\"peer\""
26867             ],
26868             "optional": false,
26869             "field": "type",
26870             "description": ""
26871           },
26872           {
26873             "group": "Body",
26874             "type": "String",
26875             "optional": false,
26876             "field": "context",
26877             "description": ""
26878           },
26879           {
26880             "group": "Body",
26881             "type": "String",
26882             "allowedValues": [
26883               "\"ALLOWED_NOT_SCREENED\"",
26884               "\"ALLOWED_PASSED_SCREEN\"",
26885               "\"ALLOWED_FAILED_SCREEN\"",
26886               "\"ALLOWED\"",
26887               "\"PROHIB_NOT_SCREENED\"",
26888               "\"PROHIB_PASSED_SCREEN\"",
26889               "\"PROHIB_FAILED_SCREEN\"",
26890               "\"PROHIB\""
26891             ],
26892             "optional": true,
26893             "field": "callingpres",
26894             "description": ""
26895           },
26896           {
26897             "group": "Body",
26898             "type": "String",
26899             "optional": true,
26900             "field": "deny",
26901             "description": ""
26902           },
26903           {
26904             "group": "Body",
26905             "type": "String",
26906             "optional": true,
26907             "field": "permit",
26908             "description": ""
26909           },
26910           {
26911             "group": "Body",
26912             "type": "String",
26913             "optional": true,
26914             "field": "secret",
26915             "description": ""
26916           },
26917           {
26918             "group": "Body",
26919             "type": "String",
26920             "optional": true,
26921             "field": "md5secret",
26922             "description": ""
26923           },
26924           {
26925             "group": "Body",
26926             "type": "String",
26927             "optional": true,
26928             "field": "remotesecret",
26929             "description": ""
26930           },
26931           {
26932             "group": "Body",
26933             "type": "String",
26934             "optional": true,
26935             "field": "transport",
26936             "description": "<p>String is deprecated. Please use an Array as [&quot;udp&quot;, &quot;tcp&quot;]</p>"
26937           },
26938           {
26939             "group": "Body",
26940             "type": "String",
26941             "allowedValues": [
26942               "\"rfc2833\"",
26943               "\"info\"",
26944               "\"shortinfo\"",
26945               "\"inband\"",
26946               "\"auto\""
26947             ],
26948             "optional": true,
26949             "field": "dtmfmode",
26950             "description": ""
26951           },
26952           {
26953             "group": "Body",
26954             "type": "String",
26955             "allowedValues": [
26956               "\"yes\"",
26957               "\"no\"",
26958               "\"nonat\"",
26959               "\"update\"",
26960               "\"outgoing\""
26961             ],
26962             "optional": true,
26963             "field": "directmedia",
26964             "description": ""
26965           },
26966           {
26967             "group": "Body",
26968             "type": "String",
26969             "allowedValues": [
26970               "\"yes\"",
26971               "\"no\""
26972             ],
26973             "optional": true,
26974             "field": "directrtpsetup",
26975             "description": ""
26976           },
26977           {
26978             "group": "Body",
26979             "type": "String",
26980             "optional": true,
26981             "field": "directmediapermit",
26982             "description": ""
26983           },
26984           {
26985             "group": "Body",
26986             "type": "String",
26987             "optional": true,
26988             "field": "directmediadeny",
26989             "description": ""
26990           },
26991           {
26992             "group": "Body",
26993             "type": "String",
26994             "optional": true,
26995             "field": "nat",
26996             "description": "<p>String is deprecated. Please use an Array as [&quot;force_rport&quot;, &quot;comedia&quot;]</p>"
26997           },
26998           {
26999             "group": "Body",
27000             "type": "String",
27001             "optional": true,
27002             "field": "callgroup",
27003             "description": ""
27004           },
27005           {
27006             "group": "Body",
27007             "type": "String",
27008             "optional": true,
27009             "field": "namedcallgroup",
27010             "description": ""
27011           },
27012           {
27013             "group": "Body",
27014             "type": "String",
27015             "optional": true,
27016             "field": "pickupgroup",
27017             "description": ""
27018           },
27019           {
27020             "group": "Body",
27021             "type": "String",
27022             "optional": true,
27023             "field": "namedpickupgroup",
27024             "description": ""
27025           },
27026           {
27027             "group": "Body",
27028             "type": "String",
27029             "optional": true,
27030             "field": "language",
27031             "description": ""
27032           },
27033           {
27034             "group": "Body",
27035             "type": "String",
27036             "optional": true,
27037             "field": "tonezone",
27038             "description": ""
27039           },
27040           {
27041             "group": "Body",
27042             "type": "String",
27043             "optional": true,
27044             "field": "disallow",
27045             "description": ""
27046           },
27047           {
27048             "group": "Body",
27049             "type": "String",
27050             "optional": false,
27051             "field": "allow",
27052             "description": "<p>String is deprecated. Please use an Array as [&quot;ulaw&quot;, &quot;alaw&quot;, &quot;alaw&quot;]</p>"
27053           },
27054           {
27055             "group": "Body",
27056             "type": "String",
27057             "allowedValues": [
27058               "\"yes\"",
27059               "\"no\""
27060             ],
27061             "optional": true,
27062             "field": "autoframing",
27063             "description": ""
27064           },
27065           {
27066             "group": "Body",
27067             "type": "String",
27068             "optional": true,
27069             "field": "insecure",
27070             "description": "<p>String is deprecated. Please use an Array as [&quot;port&quot;, &quot;invite&quot;]</p>"
27071           },
27072           {
27073             "group": "Body",
27074             "type": "String",
27075             "allowedValues": [
27076               "\"yes\"",
27077               "\"no\""
27078             ],
27079             "optional": true,
27080             "field": "trustrpid",
27081             "description": ""
27082           },
27083           {
27084             "group": "Body",
27085             "type": "String",
27086             "allowedValues": [
27087               "\"yes\"",
27088               "\"no\""
27089             ],
27090             "optional": true,
27091             "field": "trust_id_outbound",
27092             "description": ""
27093           },
27094           {
27095             "group": "Body",
27096             "type": "String",
27097             "allowedValues": [
27098               "\"yes\"",
27099               "\"no\"",
27100               "\"never\""
27101             ],
27102             "optional": true,
27103             "field": "progressinband",
27104             "description": ""
27105           },
27106           {
27107             "group": "Body",
27108             "type": "String",
27109             "allowedValues": [
27110               "\"yes\"",
27111               "\"no\""
27112             ],
27113             "optional": true,
27114             "field": "promiscredir",
27115             "description": ""
27116           },
27117           {
27118             "group": "Body",
27119             "type": "String",
27120             "allowedValues": [
27121               "\"yes\"",
27122               "\"no\""
27123             ],
27124             "optional": true,
27125             "field": "useclientcode",
27126             "description": ""
27127           },
27128           {
27129             "group": "Body",
27130             "type": "Integer",
27131             "optional": true,
27132             "field": "accountcode",
27133             "description": ""
27134           },
27135           {
27136             "group": "Body",
27137             "type": "String",
27138             "optional": true,
27139             "field": "setvar",
27140             "description": ""
27141           },
27142           {
27143             "group": "Body",
27144             "type": "String",
27145             "optional": true,
27146             "field": "callerid",
27147             "description": ""
27148           },
27149           {
27150             "group": "Body",
27151             "type": "String",
27152             "optional": true,
27153             "field": "amaflags",
27154             "description": ""
27155           },
27156           {
27157             "group": "Body",
27158             "type": "String",
27159             "allowedValues": [
27160               "\"yes\"",
27161               "\"no\""
27162             ],
27163             "optional": true,
27164             "field": "callcounter",
27165             "description": ""
27166           },
27167           {
27168             "group": "Body",
27169             "type": "Integer",
27170             "optional": true,
27171             "field": "busylevel",
27172             "description": ""
27173           },
27174           {
27175             "group": "Body",
27176             "type": "String",
27177             "allowedValues": [
27178               "\"yes\"",
27179               "\"no\""
27180             ],
27181             "optional": true,
27182             "field": "allowoverlap",
27183             "description": ""
27184           },
27185           {
27186             "group": "Body",
27187             "type": "String",
27188             "allowedValues": [
27189               "\"yes\"",
27190               "\"no\""
27191             ],
27192             "optional": true,
27193             "field": "allowsubscribe",
27194             "description": ""
27195           },
27196           {
27197             "group": "Body",
27198             "type": "String",
27199             "allowedValues": [
27200               "\"yes\"",
27201               "\"no\""
27202             ],
27203             "optional": true,
27204             "field": "allowtransfer",
27205             "description": ""
27206           },
27207           {
27208             "group": "Body",
27209             "type": "String",
27210             "allowedValues": [
27211               "\"yes\"",
27212               "\"no\""
27213             ],
27214             "optional": true,
27215             "field": "ignoresdpversion",
27216             "description": ""
27217           },
27218           {
27219             "group": "Body",
27220             "type": "String",
27221             "optional": true,
27222             "field": "subscribecontext",
27223             "description": ""
27224           },
27225           {
27226             "group": "Body",
27227             "type": "String",
27228             "optional": true,
27229             "field": "template",
27230             "description": ""
27231           },
27232           {
27233             "group": "Body",
27234             "type": "String",
27235             "allowedValues": [
27236               "\"yes\"",
27237               "\"no\"",
27238               "\"always\""
27239             ],
27240             "optional": true,
27241             "field": "videosupport",
27242             "description": ""
27243           },
27244           {
27245             "group": "Body",
27246             "type": "Integer",
27247             "optional": true,
27248             "field": "maxcallbitrate",
27249             "description": ""
27250           },
27251           {
27252             "group": "Body",
27253             "type": "String",
27254             "allowedValues": [
27255               "\"yes\"",
27256               "\"no\""
27257             ],
27258             "optional": true,
27259             "field": "rfc2833compensate",
27260             "description": ""
27261           },
27262           {
27263             "group": "Body",
27264             "type": "String",
27265             "optional": true,
27266             "field": "mailbox",
27267             "description": ""
27268           },
27269           {
27270             "group": "Body",
27271             "type": "String",
27272             "allowedValues": [
27273               "\"accept\"",
27274               "\"refuse\"",
27275               "\"originate\""
27276             ],
27277             "optional": true,
27278             "field": "session_timers",
27279             "description": ""
27280           },
27281           {
27282             "group": "Body",
27283             "type": "Integer",
27284             "optional": true,
27285             "field": "session_expires",
27286             "description": ""
27287           },
27288           {
27289             "group": "Body",
27290             "type": "Integer",
27291             "optional": true,
27292             "field": "session_minse",
27293             "description": ""
27294           },
27295           {
27296             "group": "Body",
27297             "type": "String",
27298             "allowedValues": [
27299               "\"uac\"",
27300               "\"uas\""
27301             ],
27302             "optional": true,
27303             "field": "session_refresher",
27304             "description": ""
27305           },
27306           {
27307             "group": "Body",
27308             "type": "String",
27309             "optional": true,
27310             "field": "t38pt_usertpsource",
27311             "description": ""
27312           },
27313           {
27314             "group": "Body",
27315             "type": "String",
27316             "optional": true,
27317             "field": "regexten",
27318             "description": ""
27319           },
27320           {
27321             "group": "Body",
27322             "type": "String",
27323             "optional": true,
27324             "field": "fromdomain",
27325             "description": ""
27326           },
27327           {
27328             "group": "Body",
27329             "type": "String",
27330             "optional": true,
27331             "field": "fromuser",
27332             "description": ""
27333           },
27334           {
27335             "group": "Body",
27336             "type": "Integer",
27337             "optional": true,
27338             "field": "port",
27339             "description": ""
27340           },
27341           {
27342             "group": "Body",
27343             "type": "String",
27344             "allowedValues": [
27345               "\"yes\"",
27346               "\"no\""
27347             ],
27348             "optional": true,
27349             "field": "qualify",
27350             "description": ""
27351           },
27352           {
27353             "group": "Body",
27354             "type": "Integer",
27355             "optional": true,
27356             "field": "keepalive",
27357             "description": ""
27358           },
27359           {
27360             "group": "Body",
27361             "type": "String",
27362             "optional": true,
27363             "field": "defaultip",
27364             "description": ""
27365           },
27366           {
27367             "group": "Body",
27368             "type": "String",
27369             "optional": true,
27370             "field": "defaultuser",
27371             "description": ""
27372           },
27373           {
27374             "group": "Body",
27375             "type": "Integer",
27376             "optional": true,
27377             "field": "rtptimeout",
27378             "description": ""
27379           },
27380           {
27381             "group": "Body",
27382             "type": "Integer",
27383             "optional": true,
27384             "field": "rtpholdtimeout",
27385             "description": ""
27386           },
27387           {
27388             "group": "Body",
27389             "type": "Integer",
27390             "optional": true,
27391             "field": "rtpkeepalive",
27392             "description": ""
27393           },
27394           {
27395             "group": "Body",
27396             "type": "String",
27397             "allowedValues": [
27398               "\"yes\"",
27399               "\"no\"",
27400               "\"pai\""
27401             ],
27402             "optional": true,
27403             "field": "sendrpid",
27404             "description": ""
27405           },
27406           {
27407             "group": "Body",
27408             "type": "String",
27409             "optional": true,
27410             "field": "outboundproxy",
27411             "description": ""
27412           },
27413           {
27414             "group": "Body",
27415             "type": "String",
27416             "optional": true,
27417             "field": "callbackextension",
27418             "description": ""
27419           },
27420           {
27421             "group": "Body",
27422             "type": "Integer",
27423             "optional": true,
27424             "field": "timert1",
27425             "description": ""
27426           },
27427           {
27428             "group": "Body",
27429             "type": "Integer",
27430             "optional": true,
27431             "field": "timerb",
27432             "description": ""
27433           },
27434           {
27435             "group": "Body",
27436             "type": "Integer",
27437             "optional": true,
27438             "field": "qualifyfreq",
27439             "description": ""
27440           },
27441           {
27442             "group": "Body",
27443             "type": "String",
27444             "optional": true,
27445             "field": "contactpermit",
27446             "description": ""
27447           },
27448           {
27449             "group": "Body",
27450             "type": "String",
27451             "optional": true,
27452             "field": "contactdeny",
27453             "description": ""
27454           },
27455           {
27456             "group": "Body",
27457             "type": "String",
27458             "optional": true,
27459             "field": "contactacl",
27460             "description": ""
27461           },
27462           {
27463             "group": "Body",
27464             "type": "String",
27465             "optional": true,
27466             "field": "unsolicited_mailbox",
27467             "description": ""
27468           },
27469           {
27470             "group": "Body",
27471             "type": "String",
27472             "optional": true,
27473             "field": "use_q850_reason",
27474             "description": ""
27475           },
27476           {
27477             "group": "Body",
27478             "type": "Integer",
27479             "optional": true,
27480             "field": "maxforwards",
27481             "description": ""
27482           },
27483           {
27484             "group": "Body",
27485             "type": "String",
27486             "allowedValues": [
27487               "\"yes\"",
27488               "\"no\""
27489             ],
27490             "optional": true,
27491             "field": "encryption",
27492             "description": ""
27493           },
27494           {
27495             "group": "Body",
27496             "type": "String",
27497             "allowedValues": [
27498               "\"yes\"",
27499               "\"no\""
27500             ],
27501             "optional": true,
27502             "field": "avpf",
27503             "description": ""
27504           },
27505           {
27506             "group": "Body",
27507             "type": "String",
27508             "allowedValues": [
27509               "\"yes\"",
27510               "\"no\""
27511             ],
27512             "optional": true,
27513             "field": "force_avp",
27514             "description": ""
27515           },
27516           {
27517             "group": "Body",
27518             "type": "String",
27519             "allowedValues": [
27520               "\"yes\"",
27521               "\"no\""
27522             ],
27523             "optional": true,
27524             "field": "icesupport",
27525             "description": ""
27526           },
27527           {
27528             "group": "Body",
27529             "type": "String",
27530             "allowedValues": [
27531               "\"yes\"",
27532               "\"no\""
27533             ],
27534             "optional": true,
27535             "field": "dtlsenable",
27536             "description": ""
27537           },
27538           {
27539             "group": "Body",
27540             "type": "String",
27541             "allowedValues": [
27542               "\"yes\"",
27543               "\"no\"",
27544               "\"fingerprint\"",
27545               "\"certificate\""
27546             ],
27547             "optional": true,
27548             "field": "dtlsverify",
27549             "description": ""
27550           },
27551           {
27552             "group": "Body",
27553             "type": "Integer",
27554             "optional": true,
27555             "field": "dtlsrekey",
27556             "description": ""
27557           },
27558           {
27559             "group": "Body",
27560             "type": "String",
27561             "optional": true,
27562             "field": "dtlscertfile",
27563             "description": ""
27564           },
27565           {
27566             "group": "Body",
27567             "type": "String",
27568             "optional": true,
27569             "field": "dtlsprivatekey",
27570             "description": ""
27571           },
27572           {
27573             "group": "Body",
27574             "type": "String",
27575             "optional": true,
27576             "field": "dtlscipher",
27577             "description": ""
27578           },
27579           {
27580             "group": "Body",
27581             "type": "String",
27582             "optional": true,
27583             "field": "dtlscafile",
27584             "description": ""
27585           },
27586           {
27587             "group": "Body",
27588             "type": "String",
27589             "optional": true,
27590             "field": "dtlscapath",
27591             "description": ""
27592           },
27593           {
27594             "group": "Body",
27595             "type": "String",
27596             "allowedValues": [
27597               "\"active\"",
27598               "\"passive\"",
27599               "\"actpass\""
27600             ],
27601             "optional": true,
27602             "field": "dtlssetup",
27603             "description": ""
27604           },
27605           {
27606             "group": "Body",
27607             "type": "String",
27608             "optional": true,
27609             "field": "dtlsfingerprint",
27610             "description": ""
27611           },
27612           {
27613             "group": "Body",
27614             "type": "String",
27615             "allowedValues": [
27616               "\"yes\"",
27617               "\"no\""
27618             ],
27619             "optional": true,
27620             "field": "usereqphone",
27621             "description": ""
27622           },
27623           {
27624             "group": "Body",
27625             "type": "String",
27626             "optional": true,
27627             "field": "recordonfeature",
27628             "description": ""
27629           },
27630           {
27631             "group": "Body",
27632             "type": "String",
27633             "optional": true,
27634             "field": "recordofffeature",
27635             "description": ""
27636           },
27637           {
27638             "group": "Body",
27639             "type": "Integer",
27640             "optional": true,
27641             "field": "call_limit",
27642             "description": ""
27643           },
27644           {
27645             "group": "Body",
27646             "type": "String",
27647             "allowedValues": [
27648               "\"yes\"",
27649               "\"no\""
27650             ],
27651             "optional": true,
27652             "field": "registertrying",
27653             "description": ""
27654           },
27655           {
27656             "group": "Body",
27657             "type": "String",
27658             "allowedValues": [
27659               "\"yes\"",
27660               "\"no\""
27661             ],
27662             "optional": true,
27663             "field": "subscribemwi",
27664             "description": ""
27665           },
27666           {
27667             "group": "Body",
27668             "type": "String",
27669             "optional": true,
27670             "field": "vmexten",
27671             "description": ""
27672           },
27673           {
27674             "group": "Body",
27675             "type": "String",
27676             "optional": true,
27677             "field": "mohinterpret",
27678             "description": ""
27679           },
27680           {
27681             "group": "Body",
27682             "type": "String",
27683             "optional": true,
27684             "field": "mohsuggest",
27685             "description": ""
27686           },
27687           {
27688             "group": "Body",
27689             "type": "String",
27690             "optional": true,
27691             "field": "parkinglot",
27692             "description": ""
27693           },
27694           {
27695             "group": "Body",
27696             "type": "String",
27697             "optional": true,
27698             "field": "description",
27699             "description": ""
27700           },
27701           {
27702             "group": "Body",
27703             "type": "String",
27704             "optional": true,
27705             "field": "host",
27706             "description": ""
27707           },
27708           {
27709             "group": "Body",
27710             "type": "String",
27711             "allowedValues": [
27712               "\"yes\"",
27713               "\"no\"",
27714               "\"nonat\"",
27715               "\"update\"",
27716               "\"update,nonat\""
27717             ],
27718             "optional": true,
27719             "field": "canreinvite",
27720             "description": ""
27721           },
27722           {
27723             "group": "Body",
27724             "type": "String",
27725             "optional": true,
27726             "field": "registry",
27727             "description": ""
27728           },
27729           {
27730             "group": "Body",
27731             "type": "String",
27732             "optional": true,
27733             "field": "otherFields",
27734             "description": ""
27735           },
27736           {
27737             "group": "Body",
27738             "type": "Boolean",
27739             "optional": false,
27740             "field": "active",
27741             "description": ""
27742           },
27743           {
27744             "group": "Body",
27745             "type": "String",
27746             "optional": true,
27747             "field": "t38pt_udptl",
27748             "description": ""
27749           }
27750         ]
27751       }
27752     },
27753     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27754     "version": "0.0.0",
27755     "filename": "server/api/trunk/index.js",
27756     "groupTitle": "Trunks"
27757   },
27758   {
27759     "type": "delete",
27760     "url": "/api/trunks/{id}",
27761     "title": "Deletes a trunk",
27762     "examples": [
27763       {
27764         "title": "Example usage:",
27765         "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X DELETE",
27766         "type": "json"
27767       }
27768     ],
27769     "name": "Delete",
27770     "group": "Trunks",
27771     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27772     "version": "0.0.0",
27773     "filename": "server/api/trunk/index.js",
27774     "groupTitle": "Trunks"
27775   },
27776   {
27777     "type": "get",
27778     "url": "/api/trunks",
27779     "title": "Gets a list of Trunks",
27780     "examples": [
27781       {
27782         "title": "Example usage:",
27783         "content": "curl https://{domain}/api/trunks -v -u {name}:{password}",
27784         "type": "json"
27785       }
27786     ],
27787     "name": "GetTrunks",
27788     "group": "Trunks",
27789     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
27790     "version": "0.0.0",
27791     "filename": "server/api/trunk/index.js",
27792     "groupTitle": "Trunks"
27793   },
27794   {
27795     "type": "get",
27796     "url": "/api/trunks/{id}",
27797     "title": "Gets a single Trunk",
27798     "examples": [
27799       {
27800         "title": "Example usage:",
27801         "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password}",
27802         "type": "json"
27803       }
27804     ],
27805     "name": "ShowTrunks",
27806     "group": "Trunks",
27807     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27808     "version": "0.0.0",
27809     "filename": "server/api/trunk/index.js",
27810     "groupTitle": "Trunks"
27811   },
27812   {
27813     "type": "put",
27814     "url": "/api/trunks/{id}",
27815     "title": "Update an existing trunk",
27816     "examples": [
27817       {
27818         "title": "Example usage:",
27819         "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X PUT",
27820         "type": "json"
27821       }
27822     ],
27823     "name": "Update",
27824     "group": "Trunks",
27825     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27826     "version": "0.0.0",
27827     "filename": "server/api/trunk/index.js",
27828     "groupTitle": "Trunks"
27829   },
27830   {
27831     "type": "post",
27832     "url": "/api/userNotifications",
27833     "title": "Send notification to user",
27834     "examples": [
27835       {
27836         "title": "Example usage:",
27837         "content": "curl https://{domain}/api/userNotifications -d '{\"text\": \"Hello!\", \"TemplateId\": 1}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
27838         "type": "json"
27839       }
27840     ],
27841     "name": "Send",
27842     "group": "UserNotifications",
27843     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27844     "version": "0.0.0",
27845     "filename": "server/api/userNotification/index.js",
27846     "groupTitle": "UserNotifications"
27847   },
27848   {
27849     "type": "post",
27850     "url": "/api/userProfile/resources",
27851     "title": "Creates a new User Profile Resource",
27852     "examples": [
27853       {
27854         "title": "Example usage:",
27855         "content": "curl https://{domain}/api/userProfile/resources -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27856         "type": "json"
27857       }
27858     ],
27859     "name": "CreateUser_Profile_Resources",
27860     "group": "User_Profile_Resources",
27861     "parameter": {
27862       "fields": {
27863         "Body": [
27864           {
27865             "group": "Body",
27866             "type": "String",
27867             "optional": false,
27868             "field": "name",
27869             "description": ""
27870           },
27871           {
27872             "group": "Body",
27873             "type": "Integer",
27874             "optional": false,
27875             "field": "resourceId",
27876             "description": ""
27877           },
27878           {
27879             "group": "Body",
27880             "type": "String",
27881             "optional": false,
27882             "field": "type",
27883             "description": ""
27884           }
27885         ]
27886       }
27887     },
27888     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27889     "version": "0.0.0",
27890     "filename": "server/api/userProfileResource/index.js",
27891     "groupTitle": "User_Profile_Resources"
27892   },
27893   {
27894     "type": "delete",
27895     "url": "/api/userProfile/resources/{id}",
27896     "title": "Deletes a User Profile Resource",
27897     "examples": [
27898       {
27899         "title": "Example usage:",
27900         "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password} -X DELETE",
27901         "type": "json"
27902       }
27903     ],
27904     "name": "DeleteUser_Profile_Resources",
27905     "group": "User_Profile_Resources",
27906     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27907     "version": "0.0.0",
27908     "filename": "server/api/userProfileResource/index.js",
27909     "groupTitle": "User_Profile_Resources"
27910   },
27911   {
27912     "type": "get",
27913     "url": "/api/userProfile/resources/describe",
27914     "title": "Gets table info about User Profile Resources",
27915     "examples": [
27916       {
27917         "title": "Example usage:",
27918         "content": "curl https://{domain}/api/userProfile/resources/describe -v -u {name}:{password}",
27919         "type": "json"
27920       }
27921     ],
27922     "name": "DescribeUser_Profile_Resources",
27923     "group": "User_Profile_Resources",
27924     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27925     "version": "0.0.0",
27926     "filename": "server/api/userProfileResource/index.js",
27927     "groupTitle": "User_Profile_Resources"
27928   },
27929   {
27930     "type": "get",
27931     "url": "/api/userProfile/resources",
27932     "title": "Gets a list of User Profile Resources",
27933     "examples": [
27934       {
27935         "title": "Example usage:",
27936         "content": "curl https://{domain}/api/userProfile/resources -v -u {name}:{password}",
27937         "type": "json"
27938       }
27939     ],
27940     "name": "GetUser_Profile_Resources",
27941     "group": "User_Profile_Resources",
27942     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
27943     "version": "0.0.0",
27944     "filename": "server/api/userProfileResource/index.js",
27945     "groupTitle": "User_Profile_Resources"
27946   },
27947   {
27948     "type": "get",
27949     "url": "/api/userProfile/resources/{id}",
27950     "title": "Gets a single User Profile Resource",
27951     "examples": [
27952       {
27953         "title": "Example usage:",
27954         "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password}",
27955         "type": "json"
27956       }
27957     ],
27958     "name": "ShowUser_Profile_Resources",
27959     "group": "User_Profile_Resources",
27960     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27961     "version": "0.0.0",
27962     "filename": "server/api/userProfileResource/index.js",
27963     "groupTitle": "User_Profile_Resources"
27964   },
27965   {
27966     "type": "put",
27967     "url": "/api/userProfile/resources/{id}",
27968     "title": "Update an existing User Profile Resource",
27969     "examples": [
27970       {
27971         "title": "Example usage:",
27972         "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",
27973         "type": "json"
27974       }
27975     ],
27976     "name": "updateUser_Profile_Resources",
27977     "group": "User_Profile_Resources",
27978     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27979     "version": "0.0.0",
27980     "filename": "server/api/userProfileResource/index.js",
27981     "groupTitle": "User_Profile_Resources"
27982   },
27983   {
27984     "type": "post",
27985     "url": "/api/userProfile/sections",
27986     "title": "Creates a new User Profile Section",
27987     "examples": [
27988       {
27989         "title": "Example usage:",
27990         "content": "curl https://{domain}/api/userProfile/sections -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27991         "type": "json"
27992       }
27993     ],
27994     "name": "CreateUser_Profile_Sections",
27995     "group": "User_Profile_Sections",
27996     "parameter": {
27997       "fields": {
27998         "Body": [
27999           {
28000             "group": "Body",
28001             "type": "String",
28002             "optional": false,
28003             "field": "name",
28004             "description": ""
28005           },
28006           {
28007             "group": "Body",
28008             "type": "String",
28009             "optional": false,
28010             "field": "category",
28011             "description": ""
28012           },
28013           {
28014             "group": "Body",
28015             "type": "Integer",
28016             "optional": false,
28017             "field": "sectionId",
28018             "description": ""
28019           },
28020           {
28021             "group": "Body",
28022             "type": "Boolean",
28023             "optional": true,
28024             "field": "enabled",
28025             "description": ""
28026           },
28027           {
28028             "group": "Body",
28029             "type": "Boolean",
28030             "optional": true,
28031             "field": "autoAssociation",
28032             "description": ""
28033           },
28034           {
28035             "group": "Body",
28036             "type": "String",
28037             "optional": true,
28038             "field": "crudPermissions",
28039             "description": ""
28040           }
28041         ]
28042       }
28043     },
28044     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28045     "version": "0.0.0",
28046     "filename": "server/api/userProfileSection/index.js",
28047     "groupTitle": "User_Profile_Sections"
28048   },
28049   {
28050     "type": "delete",
28051     "url": "/api/userProfile/sections/{id}",
28052     "title": "Deletes a User Profile Section",
28053     "examples": [
28054       {
28055         "title": "Example usage:",
28056         "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password} -X DELETE",
28057         "type": "json"
28058       }
28059     ],
28060     "name": "DeleteUser_Profile_Sections",
28061     "group": "User_Profile_Sections",
28062     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28063     "version": "0.0.0",
28064     "filename": "server/api/userProfileSection/index.js",
28065     "groupTitle": "User_Profile_Sections"
28066   },
28067   {
28068     "type": "get",
28069     "url": "/api/userProfile/sections/describe",
28070     "title": "Gets table info about User Profile Sections",
28071     "examples": [
28072       {
28073         "title": "Example usage:",
28074         "content": "curl https://{domain}/api/userProfile/sections/describe -v -u {name}:{password}",
28075         "type": "json"
28076       }
28077     ],
28078     "name": "DescribeUser_Profile_Sections",
28079     "group": "User_Profile_Sections",
28080     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28081     "version": "0.0.0",
28082     "filename": "server/api/userProfileSection/index.js",
28083     "groupTitle": "User_Profile_Sections"
28084   },
28085   {
28086     "type": "get",
28087     "url": "/api/userProfile/sections",
28088     "title": "Gets a list of User Profile Sections",
28089     "examples": [
28090       {
28091         "title": "Example usage:",
28092         "content": "curl https://{domain}/api/userProfile/sections -v -u {name}:{password}",
28093         "type": "json"
28094       }
28095     ],
28096     "name": "GetUser_Profile_Sections",
28097     "group": "User_Profile_Sections",
28098     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
28099     "version": "0.0.0",
28100     "filename": "server/api/userProfileSection/index.js",
28101     "groupTitle": "User_Profile_Sections"
28102   },
28103   {
28104     "type": "get",
28105     "url": "/api/userProfile/sections/{id}",
28106     "title": "Gets a single User Profile Section",
28107     "examples": [
28108       {
28109         "title": "Example usage:",
28110         "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password}",
28111         "type": "json"
28112       }
28113     ],
28114     "name": "ShowUser_Profile_Sections",
28115     "group": "User_Profile_Sections",
28116     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28117     "version": "0.0.0",
28118     "filename": "server/api/userProfileSection/index.js",
28119     "groupTitle": "User_Profile_Sections"
28120   },
28121   {
28122     "type": "put",
28123     "url": "/api/userProfile/sections/{id}",
28124     "title": "Update an existing User Profile Section",
28125     "examples": [
28126       {
28127         "title": "Example usage:",
28128         "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",
28129         "type": "json"
28130       }
28131     ],
28132     "name": "updateUser_Profile_Sections",
28133     "group": "User_Profile_Sections",
28134     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28135     "version": "0.0.0",
28136     "filename": "server/api/userProfileSection/index.js",
28137     "groupTitle": "User_Profile_Sections"
28138   },
28139   {
28140     "type": "post",
28141     "url": "/api/userProfiles/{id}/resources",
28142     "title": "Add resources' permissions to User Profile",
28143     "examples": [
28144       {
28145         "title": "Example usage:",
28146         "content": "curl https://{domain}/api/userProfiles/{id}/resources -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28147         "type": "json"
28148       }
28149     ],
28150     "name": "AddResources",
28151     "group": "User_Profiles",
28152     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28153     "version": "0.0.0",
28154     "filename": "server/api/userProfile/index.js",
28155     "groupTitle": "User_Profiles"
28156   },
28157   {
28158     "type": "post",
28159     "url": "/api/userProfiles/{id}/sections",
28160     "title": "Add sections' permissions to User Profile",
28161     "examples": [
28162       {
28163         "title": "Example usage:",
28164         "content": "curl https://{domain}/api/userProfiles/{id}/sections -d '[{\"sectionId\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28165         "type": "json"
28166       }
28167     ],
28168     "name": "AddSections",
28169     "group": "User_Profiles",
28170     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28171     "version": "0.0.0",
28172     "filename": "server/api/userProfile/index.js",
28173     "groupTitle": "User_Profiles"
28174   },
28175   {
28176     "type": "post",
28177     "url": "/api/userProfiles/clone",
28178     "title": "Clone an existing User Profile",
28179     "examples": [
28180       {
28181         "title": "Example usage:",
28182         "content": "curl https://{domain}/api/userProfiles/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28183         "type": "json"
28184       }
28185     ],
28186     "name": "CloneUser_Profiles",
28187     "group": "User_Profiles",
28188     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28189     "version": "0.0.0",
28190     "filename": "server/api/userProfile/index.js",
28191     "groupTitle": "User_Profiles"
28192   },
28193   {
28194     "type": "post",
28195     "url": "/api/userProfiles",
28196     "title": "Creates a new User Profile",
28197     "examples": [
28198       {
28199         "title": "Example usage:",
28200         "content": "curl https://{domain}/api/userProfiles -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28201         "type": "json"
28202       }
28203     ],
28204     "name": "CreateUser_Profiles",
28205     "group": "User_Profiles",
28206     "parameter": {
28207       "fields": {
28208         "Body": [
28209           {
28210             "group": "Body",
28211             "type": "String",
28212             "optional": false,
28213             "field": "name",
28214             "description": ""
28215           },
28216           {
28217             "group": "Body",
28218             "type": "String",
28219             "optional": false,
28220             "field": "crudPermissions",
28221             "description": ""
28222           },
28223           {
28224             "group": "Body",
28225             "type": "String",
28226             "optional": true,
28227             "field": "description",
28228             "description": ""
28229           },
28230           {
28231             "group": "Body",
28232             "type": "Boolean",
28233             "optional": true,
28234             "field": "privacyEnabled",
28235             "description": ""
28236           }
28237         ]
28238       }
28239     },
28240     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28241     "version": "0.0.0",
28242     "filename": "server/api/userProfile/index.js",
28243     "groupTitle": "User_Profiles"
28244   },
28245   {
28246     "type": "delete",
28247     "url": "/api/userProfiles/{id}",
28248     "title": "Deletes a User Profile",
28249     "examples": [
28250       {
28251         "title": "Example usage:",
28252         "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password} -X DELETE",
28253         "type": "json"
28254       }
28255     ],
28256     "name": "DeleteUser_Profiles",
28257     "group": "User_Profiles",
28258     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28259     "version": "0.0.0",
28260     "filename": "server/api/userProfile/index.js",
28261     "groupTitle": "User_Profiles"
28262   },
28263   {
28264     "type": "get",
28265     "url": "/api/userProfiles/describe",
28266     "title": "Gets table info about User Profiles",
28267     "examples": [
28268       {
28269         "title": "Example usage:",
28270         "content": "curl https://{domain}/api/userProfiles/describe -v -u {name}:{password}",
28271         "type": "json"
28272       }
28273     ],
28274     "name": "DescribeUser_Profiles",
28275     "group": "User_Profiles",
28276     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28277     "version": "0.0.0",
28278     "filename": "server/api/userProfile/index.js",
28279     "groupTitle": "User_Profiles"
28280   },
28281   {
28282     "type": "get",
28283     "url": "/api/userProfiles/{id}/resources?section={section}",
28284     "title": "Get Resources assigned to a Section",
28285     "examples": [
28286       {
28287         "title": "Example usage:",
28288         "content": "curl https://{domain}/api/userProfiles/{id}/resources?section={section} -v -u {name}:{password} -X GET",
28289         "type": "json"
28290       }
28291     ],
28292     "name": "GetResources",
28293     "group": "User_Profiles",
28294     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28295     "version": "0.0.0",
28296     "filename": "server/api/userProfile/index.js",
28297     "groupTitle": "User_Profiles"
28298   },
28299   {
28300     "type": "get",
28301     "url": "/api/userProfiles/{id}/sections",
28302     "title": "Get sections associated to a User Profile",
28303     "examples": [
28304       {
28305         "title": "Example usage:",
28306         "content": "curl https://{domain}/api/userProfiles/{id}/sections -v -u {name}:{password} -X GET",
28307         "type": "json"
28308       }
28309     ],
28310     "name": "GetSections",
28311     "group": "User_Profiles",
28312     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28313     "version": "0.0.0",
28314     "filename": "server/api/userProfile/index.js",
28315     "groupTitle": "User_Profiles"
28316   },
28317   {
28318     "type": "get",
28319     "url": "/api/userProfiles",
28320     "title": "Gets a list of User Profiles",
28321     "examples": [
28322       {
28323         "title": "Example usage:",
28324         "content": "curl https://{domain}/api/userProfiles -v -u {name}:{password}",
28325         "type": "json"
28326       }
28327     ],
28328     "name": "GetUser_Profiles",
28329     "group": "User_Profiles",
28330     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
28331     "version": "0.0.0",
28332     "filename": "server/api/userProfile/index.js",
28333     "groupTitle": "User_Profiles"
28334   },
28335   {
28336     "type": "delete",
28337     "url": "/api/userProfiles/{id}/resources",
28338     "title": "Removes resources' permissions from User Profile",
28339     "examples": [
28340       {
28341         "title": "Example usage:",
28342         "content": "curl https://{domain}/api/userProfiles/{id}/resources?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
28343         "type": "json"
28344       }
28345     ],
28346     "name": "RemoveResources",
28347     "group": "User_Profiles",
28348     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28349     "version": "0.0.0",
28350     "filename": "server/api/userProfile/index.js",
28351     "groupTitle": "User_Profiles"
28352   },
28353   {
28354     "type": "delete",
28355     "url": "/api/userProfiles/{id}/sections",
28356     "title": "Removes sections' permissions from User Profile",
28357     "examples": [
28358       {
28359         "title": "Example usage:",
28360         "content": "curl https://{domain}/api/userProfiles/{id}/sections?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
28361         "type": "json"
28362       }
28363     ],
28364     "name": "RemoveSections",
28365     "group": "User_Profiles",
28366     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28367     "version": "0.0.0",
28368     "filename": "server/api/userProfile/index.js",
28369     "groupTitle": "User_Profiles"
28370   },
28371   {
28372     "type": "get",
28373     "url": "/api/userProfiles/{id}",
28374     "title": "Gets a single User Profile",
28375     "examples": [
28376       {
28377         "title": "Example usage:",
28378         "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password}",
28379         "type": "json"
28380       }
28381     ],
28382     "name": "ShowUser_Profiles",
28383     "group": "User_Profiles",
28384     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28385     "version": "0.0.0",
28386     "filename": "server/api/userProfile/index.js",
28387     "groupTitle": "User_Profiles"
28388   },
28389   {
28390     "type": "put",
28391     "url": "/api/userProfiles/{id}",
28392     "title": "Update an existing User Profile",
28393     "examples": [
28394       {
28395         "title": "Example usage:",
28396         "content": "curl https://{domain}/api/userProfiles/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
28397         "type": "json"
28398       }
28399     ],
28400     "name": "updateUser_Profiles",
28401     "group": "User_Profiles",
28402     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28403     "version": "0.0.0",
28404     "filename": "server/api/userProfile/index.js",
28405     "groupTitle": "User_Profiles"
28406   },
28407   {
28408     "type": "post",
28409     "url": "/api/users/{id}/chat_interactions",
28410     "title": "Add chat interaction tabs to an agent",
28411     "examples": [
28412       {
28413         "title": "Example usage:",
28414         "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",
28415         "type": "json"
28416       }
28417     ],
28418     "name": "AddChatInteractions",
28419     "group": "Users",
28420     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28421     "version": "0.0.0",
28422     "filename": "server/api/user/index.js",
28423     "groupTitle": "Users"
28424   },
28425   {
28426     "type": "post",
28427     "url": "/api/users/{id}/chat_websites",
28428     "title": "Add a Chat Website to a user",
28429     "examples": [
28430       {
28431         "title": "Example usage:",
28432         "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",
28433         "type": "json"
28434       }
28435     ],
28436     "name": "AddChatWebsites",
28437     "group": "Users",
28438     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28439     "version": "0.0.0",
28440     "filename": "server/api/user/index.js",
28441     "groupTitle": "Users"
28442   },
28443   {
28444     "type": "post",
28445     "url": "/api/users/{id}/contacts",
28446     "title": "Add contacts to a user",
28447     "examples": [
28448       {
28449         "title": "Example usage:",
28450         "content": "curl https://{domain}/api/users/{id}/contacts -d '{\"ids\": [1,2]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28451         "type": "json"
28452       }
28453     ],
28454     "name": "AddContacts",
28455     "group": "Users",
28456     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28457     "version": "0.0.0",
28458     "filename": "server/api/user/index.js",
28459     "groupTitle": "Users"
28460   },
28461   {
28462     "type": "post",
28463     "url": "/api/users/{id}/fax_accounts",
28464     "title": "Add a Fax Account to a user",
28465     "examples": [
28466       {
28467         "title": "Example usage:",
28468         "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",
28469         "type": "json"
28470       }
28471     ],
28472     "name": "AddFaxAccounts",
28473     "group": "Users",
28474     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28475     "version": "0.0.0",
28476     "filename": "server/api/user/index.js",
28477     "groupTitle": "Users"
28478   },
28479   {
28480     "type": "post",
28481     "url": "/api/users/{id}/fax_interactions",
28482     "title": "Add fax interaction tabs to an agent",
28483     "examples": [
28484       {
28485         "title": "Example usage:",
28486         "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",
28487         "type": "json"
28488       }
28489     ],
28490     "name": "AddFaxInteractions",
28491     "group": "Users",
28492     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28493     "version": "0.0.0",
28494     "filename": "server/api/user/index.js",
28495     "groupTitle": "Users"
28496   },
28497   {
28498     "type": "post",
28499     "url": "/api/users/{id}/mail_accounts",
28500     "title": "Add a Mail Account to a user",
28501     "examples": [
28502       {
28503         "title": "Example usage:",
28504         "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",
28505         "type": "json"
28506       }
28507     ],
28508     "name": "AddMailAccounts",
28509     "group": "Users",
28510     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28511     "version": "0.0.0",
28512     "filename": "server/api/user/index.js",
28513     "groupTitle": "Users"
28514   },
28515   {
28516     "type": "post",
28517     "url": "/api/users/{id}/mail_interactions",
28518     "title": "Add mail interaction tabs to an agent",
28519     "examples": [
28520       {
28521         "title": "Example usage:",
28522         "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",
28523         "type": "json"
28524       }
28525     ],
28526     "name": "AddMailInteractions",
28527     "group": "Users",
28528     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28529     "version": "0.0.0",
28530     "filename": "server/api/user/index.js",
28531     "groupTitle": "Users"
28532   },
28533   {
28534     "type": "post",
28535     "url": "/api/users/{id}/openchannel_accounts",
28536     "title": "Add a Open Channel Account to a user",
28537     "examples": [
28538       {
28539         "title": "Example usage:",
28540         "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",
28541         "type": "json"
28542       }
28543     ],
28544     "name": "AddOpenchannelAccounts",
28545     "group": "Users",
28546     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28547     "version": "0.0.0",
28548     "filename": "server/api/user/index.js",
28549     "groupTitle": "Users"
28550   },
28551   {
28552     "type": "post",
28553     "url": "/api/users/{id}/openchannel_interactions",
28554     "title": "Add openchannel interaction tabs to an agent",
28555     "examples": [
28556       {
28557         "title": "Example usage:",
28558         "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",
28559         "type": "json"
28560       }
28561     ],
28562     "name": "AddOpenchannelInteractions",
28563     "group": "Users",
28564     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28565     "version": "0.0.0",
28566     "filename": "server/api/user/index.js",
28567     "groupTitle": "Users"
28568   },
28569   {
28570     "type": "post",
28571     "url": "/api/users/{id}/queues",
28572     "title": "Add queues to an agent",
28573     "examples": [
28574       {
28575         "title": "Example usage:",
28576         "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",
28577         "type": "json"
28578       }
28579     ],
28580     "name": "AddQueues",
28581     "group": "Users",
28582     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28583     "version": "0.0.0",
28584     "filename": "server/api/user/index.js",
28585     "groupTitle": "Users"
28586   },
28587   {
28588     "type": "post",
28589     "url": "/api/users/{id}/sms_accounts",
28590     "title": "Add a Sms Account to a user",
28591     "examples": [
28592       {
28593         "title": "Example usage:",
28594         "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",
28595         "type": "json"
28596       }
28597     ],
28598     "name": "AddSmsAccounts",
28599     "group": "Users",
28600     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28601     "version": "0.0.0",
28602     "filename": "server/api/user/index.js",
28603     "groupTitle": "Users"
28604   },
28605   {
28606     "type": "post",
28607     "url": "/api/users/{id}/sms_interactions",
28608     "title": "Add sms interaction tabs to an agent",
28609     "examples": [
28610       {
28611         "title": "Example usage:",
28612         "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",
28613         "type": "json"
28614       }
28615     ],
28616     "name": "AddSmsInteractions",
28617     "group": "Users",
28618     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28619     "version": "0.0.0",
28620     "filename": "server/api/user/index.js",
28621     "groupTitle": "Users"
28622   },
28623   {
28624     "type": "post",
28625     "url": "/api/users/{id}/square_projects",
28626     "title": "Add a Square Project to a user",
28627     "examples": [
28628       {
28629         "title": "Example usage:",
28630         "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",
28631         "type": "json"
28632       }
28633     ],
28634     "name": "AddSquareProjects",
28635     "group": "Users",
28636     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28637     "version": "0.0.0",
28638     "filename": "server/api/user/index.js",
28639     "groupTitle": "Users"
28640   },
28641   {
28642     "type": "post",
28643     "url": "/api/users/{id}/teams",
28644     "title": "Add teams to an agent",
28645     "examples": [
28646       {
28647         "title": "Example usage:",
28648         "content": "curl https://{domain}/api/users/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28649         "type": "json"
28650       }
28651     ],
28652     "name": "AddTeams",
28653     "group": "Users",
28654     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28655     "version": "0.0.0",
28656     "filename": "server/api/user/index.js",
28657     "groupTitle": "Users"
28658   },
28659   {
28660     "type": "post",
28661     "url": "/api/users/{id}/whatsapp_accounts",
28662     "title": "Add a Whatsapp Account to a user",
28663     "examples": [
28664       {
28665         "title": "Example usage:",
28666         "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",
28667         "type": "json"
28668       }
28669     ],
28670     "name": "AddWhatsappAccounts",
28671     "group": "Users",
28672     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28673     "version": "0.0.0",
28674     "filename": "server/api/user/index.js",
28675     "groupTitle": "Users"
28676   },
28677   {
28678     "type": "post",
28679     "url": "/api/users/{id}/whatsapp_interactions",
28680     "title": "Add Whatsapp interaction tabs to an agent",
28681     "examples": [
28682       {
28683         "title": "Example usage:",
28684         "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",
28685         "type": "json"
28686       }
28687     ],
28688     "name": "AddWhatsappInteractions",
28689     "group": "Users",
28690     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28691     "version": "0.0.0",
28692     "filename": "server/api/user/index.js",
28693     "groupTitle": "Users"
28694   },
28695   {
28696     "type": "put",
28697     "url": "/api/users/{id}/password",
28698     "title": "Change user password",
28699     "examples": [
28700       {
28701         "title": "Example usage:",
28702         "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",
28703         "type": "json"
28704       }
28705     ],
28706     "name": "ChangePwd",
28707     "group": "Users",
28708     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28709     "version": "0.0.0",
28710     "filename": "server/api/user/index.js",
28711     "groupTitle": "Users"
28712   },
28713   {
28714     "type": "post",
28715     "url": "/api/users",
28716     "title": "Create a new user",
28717     "examples": [
28718       {
28719         "title": "Example usage:",
28720         "content": "curl https://{domain}/api/users -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28721         "type": "json"
28722       }
28723     ],
28724     "name": "Create",
28725     "group": "Users",
28726     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28727     "version": "0.0.0",
28728     "filename": "server/api/user/index.js",
28729     "groupTitle": "Users"
28730   },
28731   {
28732     "type": "post",
28733     "url": "/api/users/{id}/api_key",
28734     "title": "Create a new API access key for the user",
28735     "examples": [
28736       {
28737         "title": "Example usage:",
28738         "content": "curl https://{domain}/api/users/:id/api_key -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28739         "type": "json"
28740       }
28741     ],
28742     "name": "CreateApiKey",
28743     "group": "Users",
28744     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28745     "version": "0.0.0",
28746     "filename": "server/api/user/index.js",
28747     "groupTitle": "Users"
28748   },
28749   {
28750     "type": "delete",
28751     "url": "/api/users/{id}",
28752     "title": "Deletes a user",
28753     "examples": [
28754       {
28755         "title": "Example usage:",
28756         "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password} -X DELETE",
28757         "type": "json"
28758       }
28759     ],
28760     "name": "Delete",
28761     "group": "Users",
28762     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28763     "version": "0.0.0",
28764     "filename": "server/api/user/index.js",
28765     "groupTitle": "Users"
28766   },
28767   {
28768     "type": "get",
28769     "url": "/api/users/describe",
28770     "title": "Gets table info about Users",
28771     "examples": [
28772       {
28773         "title": "Example usage:",
28774         "content": "curl https://{domain}/api/users/describe -v -u {name}:{password}",
28775         "type": "json"
28776       }
28777     ],
28778     "name": "DescribeUsers",
28779     "group": "Users",
28780     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28781     "version": "0.0.0",
28782     "filename": "server/api/user/index.js",
28783     "groupTitle": "Users"
28784   },
28785   {
28786     "type": "get",
28787     "url": "/api/users/{id}/agents",
28788     "title": "GetAgents",
28789     "examples": [
28790       {
28791         "title": "Example usage:",
28792         "content": "curl https://{domain}/api/users/{id}/agents -v -u {name}:{password} -X GET",
28793         "type": "json"
28794       }
28795     ],
28796     "name": "GetAgents",
28797     "group": "Users",
28798     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28799     "version": "0.0.0",
28800     "filename": "server/api/user/index.js",
28801     "groupTitle": "Users"
28802   },
28803   {
28804     "type": "get",
28805     "url": "/api/users/{id}/api_key",
28806     "title": "Get the API access key for the user",
28807     "examples": [
28808       {
28809         "title": "Example usage:",
28810         "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X GET",
28811         "type": "json"
28812       }
28813     ],
28814     "name": "GetApiKey",
28815     "group": "Users",
28816     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28817     "version": "0.0.0",
28818     "filename": "server/api/user/index.js",
28819     "groupTitle": "Users"
28820   },
28821   {
28822     "type": "get",
28823     "url": "/api/users/{id}/groups",
28824     "title": "GetChatGroups",
28825     "examples": [
28826       {
28827         "title": "Example usage:",
28828         "content": "curl https://{domain}/api/users/{id}/groups -v -u {name}:{password} -X GET",
28829         "type": "json"
28830       }
28831     ],
28832     "name": "GetChatGroups",
28833     "group": "Users",
28834     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28835     "version": "0.0.0",
28836     "filename": "server/api/user/index.js",
28837     "groupTitle": "Users"
28838   },
28839   {
28840     "type": "get",
28841     "url": "/api/users/{id}/chat/interactions",
28842     "title": "GetChatInteractions",
28843     "examples": [
28844       {
28845         "title": "Example usage:",
28846         "content": "curl https://{domain}/api/users/{id}/chat/interactions -v -u {name}:{password} -X GET",
28847         "type": "json"
28848       }
28849     ],
28850     "name": "GetChatInteractions",
28851     "group": "Users",
28852     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28853     "version": "0.0.0",
28854     "filename": "server/api/user/index.js",
28855     "groupTitle": "Users"
28856   },
28857   {
28858     "type": "get",
28859     "url": "/api/users/{id}/chat_websites",
28860     "title": "GetChatWebsites",
28861     "examples": [
28862       {
28863         "title": "Example usage:",
28864         "content": "curl https://{domain}/api/users/{id}/chat_websites -v -u {name}:{password} -X GET",
28865         "type": "json"
28866       }
28867     ],
28868     "name": "GetChatWebsites",
28869     "group": "Users",
28870     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28871     "version": "0.0.0",
28872     "filename": "server/api/user/index.js",
28873     "groupTitle": "Users"
28874   },
28875   {
28876     "type": "get",
28877     "url": "/api/users/{id}/contacts",
28878     "title": "GetContacts",
28879     "examples": [
28880       {
28881         "title": "Example usage:",
28882         "content": "curl https://{domain}/api/users/{id}/contacts -v -u {name}:{password} -X GET",
28883         "type": "json"
28884       }
28885     ],
28886     "name": "GetContacts",
28887     "group": "Users",
28888     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28889     "version": "0.0.0",
28890     "filename": "server/api/user/index.js",
28891     "groupTitle": "Users"
28892   },
28893   {
28894     "type": "get",
28895     "url": "/api/users/{id}/fax_accounts",
28896     "title": "GetFaxAccounts",
28897     "examples": [
28898       {
28899         "title": "Example usage:",
28900         "content": "curl https://{domain}/api/users/{id}/fax_accounts -v -u {name}:{password} -X GET",
28901         "type": "json"
28902       }
28903     ],
28904     "name": "GetFaxAccounts",
28905     "group": "Users",
28906     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28907     "version": "0.0.0",
28908     "filename": "server/api/user/index.js",
28909     "groupTitle": "Users"
28910   },
28911   {
28912     "type": "get",
28913     "url": "/api/users/{id}/fax/interactions",
28914     "title": "GetFaxInteractions",
28915     "examples": [
28916       {
28917         "title": "Example usage:",
28918         "content": "curl https://{domain}/api/users/{id}/fax/interactions -v -u {name}:{password} -X GET",
28919         "type": "json"
28920       }
28921     ],
28922     "name": "GetFaxInteractions",
28923     "group": "Users",
28924     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28925     "version": "0.0.0",
28926     "filename": "server/api/user/index.js",
28927     "groupTitle": "Users"
28928   },
28929   {
28930     "type": "get",
28931     "url": "/api/users/{id}/lists",
28932     "title": "GetLists",
28933     "examples": [
28934       {
28935         "title": "Example usage:",
28936         "content": "curl https://{domain}/api/users/{id}/lists -v -u {name}:{password} -X GET",
28937         "type": "json"
28938       }
28939     ],
28940     "name": "GetLists",
28941     "group": "Users",
28942     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28943     "version": "0.0.0",
28944     "filename": "server/api/user/index.js",
28945     "groupTitle": "Users"
28946   },
28947   {
28948     "type": "get",
28949     "url": "/api/users/{id}/mail_accounts",
28950     "title": "GetMailAccounts",
28951     "examples": [
28952       {
28953         "title": "Example usage:",
28954         "content": "curl https://{domain}/api/users/{id}/mail_accounts -v -u {name}:{password} -X GET",
28955         "type": "json"
28956       }
28957     ],
28958     "name": "GetMailAccounts",
28959     "group": "Users",
28960     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28961     "version": "0.0.0",
28962     "filename": "server/api/user/index.js",
28963     "groupTitle": "Users"
28964   },
28965   {
28966     "type": "get",
28967     "url": "/api/users/{id}/mail/interactions",
28968     "title": "GetMailInteractions",
28969     "examples": [
28970       {
28971         "title": "Example usage:",
28972         "content": "curl https://{domain}/api/users/{id}/mail/interactions -v -u {name}:{password} -X GET",
28973         "type": "json"
28974       }
28975     ],
28976     "name": "GetMailInteractions",
28977     "group": "Users",
28978     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28979     "version": "0.0.0",
28980     "filename": "server/api/user/index.js",
28981     "groupTitle": "Users"
28982   },
28983   {
28984     "type": "get",
28985     "url": "/api/users/{id}/openchannel_accounts",
28986     "title": "GetOpenchannelAccounts",
28987     "examples": [
28988       {
28989         "title": "Example usage:",
28990         "content": "curl https://{domain}/api/users/{id}/openchannel_accounts -v -u {name}:{password} -X GET",
28991         "type": "json"
28992       }
28993     ],
28994     "name": "GetOpenchannelAccounts",
28995     "group": "Users",
28996     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28997     "version": "0.0.0",
28998     "filename": "server/api/user/index.js",
28999     "groupTitle": "Users"
29000   },
29001   {
29002     "type": "get",
29003     "url": "/api/users/{id}/openchannel/interactions",
29004     "title": "GetOpenchannelInteractions",
29005     "examples": [
29006       {
29007         "title": "Example usage:",
29008         "content": "curl https://{domain}/api/users/{id}/openchannel/interactions -v -u {name}:{password}",
29009         "type": "json"
29010       }
29011     ],
29012     "name": "GetOpenchannelInteractions",
29013     "group": "Users",
29014     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29015     "version": "0.0.0",
29016     "filename": "server/api/user/index.js",
29017     "groupTitle": "Users"
29018   },
29019   {
29020     "type": "get",
29021     "url": "/api/users/{id}/prefixes",
29022     "title": "GetPrefixes",
29023     "examples": [
29024       {
29025         "title": "Example usage:",
29026         "content": "curl https://{domain}/api/users/{id}/prefixes -v -u {name}:{password} -X GET",
29027         "type": "json"
29028       }
29029     ],
29030     "name": "GetPrefixes",
29031     "group": "Users",
29032     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29033     "version": "0.0.0",
29034     "filename": "server/api/user/index.js",
29035     "groupTitle": "Users"
29036   },
29037   {
29038     "type": "get",
29039     "url": "/api/users/{id}/queues?channel={channel}",
29040     "title": "Gets Queues list",
29041     "examples": [
29042       {
29043         "title": "Example usage:",
29044         "content": "curl https://{domain}/api/users/{id}/queues/?channel={channel} -v -u {name}:{password} -X GET",
29045         "type": "json"
29046       }
29047     ],
29048     "name": "GetQueues",
29049     "group": "Users",
29050     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29051     "version": "0.0.0",
29052     "filename": "server/api/user/index.js",
29053     "groupTitle": "Users"
29054   },
29055   {
29056     "type": "get",
29057     "url": "/api/users/{id}/recordings",
29058     "title": "GetRecordings",
29059     "examples": [
29060       {
29061         "title": "Example usage:",
29062         "content": "curl https://{domain}/api/users/{id}/recordings -v -u {name}:{password} -X GET",
29063         "type": "json"
29064       }
29065     ],
29066     "name": "GetRecordings",
29067     "group": "Users",
29068     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29069     "version": "0.0.0",
29070     "filename": "server/api/user/index.js",
29071     "groupTitle": "Users"
29072   },
29073   {
29074     "type": "get",
29075     "url": "/api/users/{id}/scheduled_calls",
29076     "title": "GetScheduledCalls",
29077     "examples": [
29078       {
29079         "title": "Example usage:",
29080         "content": "curl https://{domain}/api/users/{id}/scheduled_calls -v -u {name}:{password} -X GET",
29081         "type": "json"
29082       }
29083     ],
29084     "name": "GetScheduledCalls",
29085     "group": "Users",
29086     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29087     "version": "0.0.0",
29088     "filename": "server/api/user/index.js",
29089     "groupTitle": "Users"
29090   },
29091   {
29092     "type": "get",
29093     "url": "/api/users/{id}/screen_recordings",
29094     "title": "GetScreenRecordings",
29095     "examples": [
29096       {
29097         "title": "Example usage:",
29098         "content": "curl https://{domain}/api/users/{id}/screen_recordings -v -u {name}:{password} -X GET",
29099         "type": "json"
29100       }
29101     ],
29102     "name": "GetScreenRecordings",
29103     "group": "Users",
29104     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29105     "version": "0.0.0",
29106     "filename": "server/api/user/index.js",
29107     "groupTitle": "Users"
29108   },
29109   {
29110     "type": "get",
29111     "url": "/api/users/{id}/sms_accounts",
29112     "title": "GetSmsAccounts",
29113     "examples": [
29114       {
29115         "title": "Example usage:",
29116         "content": "curl https://{domain}/api/users/{id}/sms_accounts -v -u {name}:{password} -X GET",
29117         "type": "json"
29118       }
29119     ],
29120     "name": "GetSmsAccounts",
29121     "group": "Users",
29122     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29123     "version": "0.0.0",
29124     "filename": "server/api/user/index.js",
29125     "groupTitle": "Users"
29126   },
29127   {
29128     "type": "get",
29129     "url": "/api/users/{id}/sms/interactions",
29130     "title": "GetSmsInteractions",
29131     "examples": [
29132       {
29133         "title": "Example usage:",
29134         "content": "curl https://{domain}/api/users/{id}/sms/interactions -v -u {name}:{password} -X GET",
29135         "type": "json"
29136       }
29137     ],
29138     "name": "GetSmsInteractions",
29139     "group": "Users",
29140     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29141     "version": "0.0.0",
29142     "filename": "server/api/user/index.js",
29143     "groupTitle": "Users"
29144   },
29145   {
29146     "type": "get",
29147     "url": "/api/users/{id}/square_projects",
29148     "title": "GetSquareProjects",
29149     "examples": [
29150       {
29151         "title": "Example usage:",
29152         "content": "curl https://{domain}/api/users/{id}/square_projects -v -u {name}:{password} -X GET",
29153         "type": "json"
29154       }
29155     ],
29156     "name": "GetSquareProjects",
29157     "group": "Users",
29158     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29159     "version": "0.0.0",
29160     "filename": "server/api/user/index.js",
29161     "groupTitle": "Users"
29162   },
29163   {
29164     "type": "get",
29165     "url": "/api/users/{id}/teams",
29166     "title": "GetTeams",
29167     "examples": [
29168       {
29169         "title": "Example usage:",
29170         "content": "curl https://{domain}/api/users/{id}/teams -v -u {name}:{password} -X GET",
29171         "type": "json"
29172       }
29173     ],
29174     "name": "GetTeams",
29175     "group": "Users",
29176     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29177     "version": "0.0.0",
29178     "filename": "server/api/user/index.js",
29179     "groupTitle": "Users"
29180   },
29181   {
29182     "type": "get",
29183     "url": "/api/users",
29184     "title": "Gets a list of Users",
29185     "examples": [
29186       {
29187         "title": "Example usage:",
29188         "content": "curl https://{domain}/api/users -v -u {name}:{password}",
29189         "type": "json"
29190       }
29191     ],
29192     "name": "GetUsers",
29193     "group": "Users",
29194     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
29195     "version": "0.0.0",
29196     "filename": "server/api/user/index.js",
29197     "groupTitle": "Users"
29198   },
29199   {
29200     "type": "get",
29201     "url": "/api/users/{id}/queues_rt",
29202     "title": "GetVoiceQueuesRt",
29203     "examples": [
29204       {
29205         "title": "Example usage:",
29206         "content": "curl https://{domain}/api/users/{id}/queues_rt -v -u {name}:{password} -X GET",
29207         "type": "json"
29208       }
29209     ],
29210     "name": "GetVoiceQueuesRt",
29211     "group": "Users",
29212     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29213     "version": "0.0.0",
29214     "filename": "server/api/user/index.js",
29215     "groupTitle": "Users"
29216   },
29217   {
29218     "type": "get",
29219     "url": "/api/users/{id}/whatsapp_accounts",
29220     "title": "GetWhatsappAccounts",
29221     "examples": [
29222       {
29223         "title": "Example usage:",
29224         "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts -v -u {name}:{password} -X GET",
29225         "type": "json"
29226       }
29227     ],
29228     "name": "GetWhatsappAccounts",
29229     "group": "Users",
29230     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29231     "version": "0.0.0",
29232     "filename": "server/api/user/index.js",
29233     "groupTitle": "Users"
29234   },
29235   {
29236     "type": "get",
29237     "url": "/api/users/{id}/whatsapp/interactions",
29238     "title": "GetWhatsappInteractions",
29239     "examples": [
29240       {
29241         "title": "Example usage:",
29242         "content": "curl https://{domain}/api/users/{id}/whatsapp/interactions -v -u {name}:{password} -X GET",
29243         "type": "json"
29244       }
29245     ],
29246     "name": "GetWhatsappInteractions",
29247     "group": "Users",
29248     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29249     "version": "0.0.0",
29250     "filename": "server/api/user/index.js",
29251     "groupTitle": "Users"
29252   },
29253   {
29254     "type": "post",
29255     "url": "/api/users/{id}/login",
29256     "title": "Login",
29257     "examples": [
29258       {
29259         "title": "Example usage:",
29260         "content": "curl https://{domain}/api/users/{id}/login  -v -u {name}:{password} -X POST",
29261         "type": "json"
29262       }
29263     ],
29264     "name": "Login",
29265     "group": "Users",
29266     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29267     "version": "0.0.0",
29268     "filename": "server/api/user/index.js",
29269     "groupTitle": "Users"
29270   },
29271   {
29272     "type": "post",
29273     "url": "/api/users/{id}/logout",
29274     "title": "Logout",
29275     "examples": [
29276       {
29277         "title": "Example usage:",
29278         "content": "curl https://{domain}/api/users/{id}/logout -v -u {name}:{password} -X POST",
29279         "type": "json"
29280       }
29281     ],
29282     "name": "Logout",
29283     "group": "Users",
29284     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29285     "version": "0.0.0",
29286     "filename": "server/api/user/index.js",
29287     "groupTitle": "Users"
29288   },
29289   {
29290     "type": "post",
29291     "url": "/api/users/{id}/pause",
29292     "title": "Pause",
29293     "examples": [
29294       {
29295         "title": "Example usage:",
29296         "content": "curl https://{domain}/api/users/{id}/pause -v -u {name}:{password} -X POST",
29297         "type": "json"
29298       }
29299     ],
29300     "name": "Pause",
29301     "group": "Users",
29302     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29303     "version": "0.0.0",
29304     "filename": "server/api/user/index.js",
29305     "groupTitle": "Users"
29306   },
29307   {
29308     "type": "delete",
29309     "url": "/api/users/{id}/api_key",
29310     "title": "Remove API access key for the user",
29311     "examples": [
29312       {
29313         "title": "Example usage:",
29314         "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X DELETE",
29315         "type": "json"
29316       }
29317     ],
29318     "name": "RemoveApiKey",
29319     "group": "Users",
29320     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29321     "version": "0.0.0",
29322     "filename": "server/api/user/index.js",
29323     "groupTitle": "Users"
29324   },
29325   {
29326     "type": "delete",
29327     "url": "/api/users/{id}/chat_interactions",
29328     "title": "Removes interactions from an agent",
29329     "examples": [
29330       {
29331         "title": "Example usage:",
29332         "content": "curl https://{domain}/api/users/{id}/chat_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29333         "type": "json"
29334       }
29335     ],
29336     "name": "RemoveChatInteractions",
29337     "group": "Users",
29338     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29339     "version": "0.0.0",
29340     "filename": "server/api/user/index.js",
29341     "groupTitle": "Users"
29342   },
29343   {
29344     "type": "delete",
29345     "url": "/api/users/{id}/chat_websites",
29346     "title": "Removes a Chat Website from a user",
29347     "examples": [
29348       {
29349         "title": "Example usage:",
29350         "content": "curl https://{domain}/api/users/{id}/chat_websites?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29351         "type": "json"
29352       }
29353     ],
29354     "name": "RemoveChatWebsites",
29355     "group": "Users",
29356     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29357     "version": "0.0.0",
29358     "filename": "server/api/user/index.js",
29359     "groupTitle": "Users"
29360   },
29361   {
29362     "type": "delete",
29363     "url": "/api/users/{id}/fax_accounts",
29364     "title": "Removes a Fax Account from a user",
29365     "examples": [
29366       {
29367         "title": "Example usage:",
29368         "content": "curl https://{domain}/api/users/{id}/fax_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29369         "type": "json"
29370       }
29371     ],
29372     "name": "RemoveFaxAccounts",
29373     "group": "Users",
29374     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29375     "version": "0.0.0",
29376     "filename": "server/api/user/index.js",
29377     "groupTitle": "Users"
29378   },
29379   {
29380     "type": "delete",
29381     "url": "/api/users/{id}/fax_interactions",
29382     "title": "Removes interactions from an agent",
29383     "examples": [
29384       {
29385         "title": "Example usage:",
29386         "content": "curl https://{domain}/api/users/{id}/fax_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29387         "type": "json"
29388       }
29389     ],
29390     "name": "RemoveFaxInteractions",
29391     "group": "Users",
29392     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29393     "version": "0.0.0",
29394     "filename": "server/api/user/index.js",
29395     "groupTitle": "Users"
29396   },
29397   {
29398     "type": "delete",
29399     "url": "/api/users/{id}/mail_accounts",
29400     "title": "Removes a Mail Account from a user",
29401     "examples": [
29402       {
29403         "title": "Example usage:",
29404         "content": "curl https://{domain}/api/users/{id}/mail_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29405         "type": "json"
29406       }
29407     ],
29408     "name": "RemoveMailAccounts",
29409     "group": "Users",
29410     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29411     "version": "0.0.0",
29412     "filename": "server/api/user/index.js",
29413     "groupTitle": "Users"
29414   },
29415   {
29416     "type": "delete",
29417     "url": "/api/users/{id}/mail_interactions",
29418     "title": "Removes interactions from an agent",
29419     "examples": [
29420       {
29421         "title": "Example usage:",
29422         "content": "curl https://{domain}/api/users/{id}/mail_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29423         "type": "json"
29424       }
29425     ],
29426     "name": "RemoveMailInteractions",
29427     "group": "Users",
29428     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29429     "version": "0.0.0",
29430     "filename": "server/api/user/index.js",
29431     "groupTitle": "Users"
29432   },
29433   {
29434     "type": "delete",
29435     "url": "/api/users/{id}/openchannel_accounts",
29436     "title": "Removes a Open Channel Account from a user",
29437     "examples": [
29438       {
29439         "title": "Example usage:",
29440         "content": "curl https://{domain}/api/users/{id}/openchannel_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29441         "type": "json"
29442       }
29443     ],
29444     "name": "RemoveOpenchannelAccounts",
29445     "group": "Users",
29446     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29447     "version": "0.0.0",
29448     "filename": "server/api/user/index.js",
29449     "groupTitle": "Users"
29450   },
29451   {
29452     "type": "delete",
29453     "url": "/api/users/{id}/openchannel_interactions",
29454     "title": "Removes openchannel interactions from an agent",
29455     "examples": [
29456       {
29457         "title": "Example usage:",
29458         "content": "curl https://{domain}/api/users/{id}/openchannel_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29459         "type": "json"
29460       }
29461     ],
29462     "name": "RemoveOpenchannelInteractions",
29463     "group": "Users",
29464     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29465     "version": "0.0.0",
29466     "filename": "server/api/user/index.js",
29467     "groupTitle": "Users"
29468   },
29469   {
29470     "type": "delete",
29471     "url": "/api/users/{id}/queues",
29472     "title": "Remove queues to an agent",
29473     "examples": [
29474       {
29475         "title": "Example usage:",
29476         "content": "curl https://{domain}/api/users/{id}/queues?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29477         "type": "json"
29478       }
29479     ],
29480     "name": "RemoveQueues",
29481     "group": "Users",
29482     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29483     "version": "0.0.0",
29484     "filename": "server/api/user/index.js",
29485     "groupTitle": "Users"
29486   },
29487   {
29488     "type": "delete",
29489     "url": "/api/users/{id}/sms_accounts",
29490     "title": "Removes a Sms Account from a user",
29491     "examples": [
29492       {
29493         "title": "Example usage:",
29494         "content": "curl https://{domain}/api/users/{id}/sms_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29495         "type": "json"
29496       }
29497     ],
29498     "name": "RemoveSmsAccounts",
29499     "group": "Users",
29500     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29501     "version": "0.0.0",
29502     "filename": "server/api/user/index.js",
29503     "groupTitle": "Users"
29504   },
29505   {
29506     "type": "delete",
29507     "url": "/api/users/{id}/sms_interactions",
29508     "title": "Removes interactions from an agent",
29509     "examples": [
29510       {
29511         "title": "Example usage:",
29512         "content": "curl https://{domain}/api/users/{id}/sms_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29513         "type": "json"
29514       }
29515     ],
29516     "name": "RemoveSmsInteractions",
29517     "group": "Users",
29518     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29519     "version": "0.0.0",
29520     "filename": "server/api/user/index.js",
29521     "groupTitle": "Users"
29522   },
29523   {
29524     "type": "delete",
29525     "url": "/api/users/{id}/square_projects",
29526     "title": "Removes a Square Project from a user",
29527     "examples": [
29528       {
29529         "title": "Example usage:",
29530         "content": "curl https://{domain}/api/users/{id}/square_projects?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29531         "type": "json"
29532       }
29533     ],
29534     "name": "RemoveSquareProjects",
29535     "group": "Users",
29536     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29537     "version": "0.0.0",
29538     "filename": "server/api/user/index.js",
29539     "groupTitle": "Users"
29540   },
29541   {
29542     "type": "delete",
29543     "url": "/api/users/{id}/teams",
29544     "title": "Removes teams from an agent",
29545     "examples": [
29546       {
29547         "title": "Example usage:",
29548         "content": "curl https://{domain}/api/users/{id}/teams?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29549         "type": "json"
29550       }
29551     ],
29552     "name": "RemoveTeams",
29553     "group": "Users",
29554     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29555     "version": "0.0.0",
29556     "filename": "server/api/user/index.js",
29557     "groupTitle": "Users"
29558   },
29559   {
29560     "type": "delete",
29561     "url": "/api/users/{id}/whatsapp_accounts",
29562     "title": "Removes a Whatsapp Account from a user",
29563     "examples": [
29564       {
29565         "title": "Example usage:",
29566         "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29567         "type": "json"
29568       }
29569     ],
29570     "name": "RemoveWhatsappAccounts",
29571     "group": "Users",
29572     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29573     "version": "0.0.0",
29574     "filename": "server/api/user/index.js",
29575     "groupTitle": "Users"
29576   },
29577   {
29578     "type": "delete",
29579     "url": "/api/users/{id}/whatsapp_interactions",
29580     "title": "Removes Whatsapp interactions from an agent",
29581     "examples": [
29582       {
29583         "title": "Example usage:",
29584         "content": "curl https://{domain}/api/users/{id}/whatsapp_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29585         "type": "json"
29586       }
29587     ],
29588     "name": "RemoveWhatsappInteractions",
29589     "group": "Users",
29590     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29591     "version": "0.0.0",
29592     "filename": "server/api/user/index.js",
29593     "groupTitle": "Users"
29594   },
29595   {
29596     "type": "get",
29597     "url": "/api/users/{id}",
29598     "title": "Gets a single User",
29599     "examples": [
29600       {
29601         "title": "Example usage:",
29602         "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password}",
29603         "type": "json"
29604       }
29605     ],
29606     "name": "ShowUsers",
29607     "group": "Users",
29608     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29609     "version": "0.0.0",
29610     "filename": "server/api/user/index.js",
29611     "groupTitle": "Users"
29612   },
29613   {
29614     "type": "post",
29615     "url": "/api/users/{id}/unpause",
29616     "title": "Unpause",
29617     "examples": [
29618       {
29619         "title": "Example usage:",
29620         "content": "curl https://{domain}/api/users/{id}/unpause -v -u {name}:{password} -X POST",
29621         "type": "json"
29622       }
29623     ],
29624     "name": "Unpause",
29625     "group": "Users",
29626     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29627     "version": "0.0.0",
29628     "filename": "server/api/user/index.js",
29629     "groupTitle": "Users"
29630   },
29631   {
29632     "type": "get",
29633     "url": "/api/users/whoami",
29634     "title": "WhoAmI",
29635     "examples": [
29636       {
29637         "title": "Example usage:",
29638         "content": "curl https://{domain}/api/users/whoami -v -u {name}:{password} -X GET",
29639         "type": "json"
29640       }
29641     ],
29642     "name": "WhoAmI",
29643     "group": "Users",
29644     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29645     "version": "0.0.0",
29646     "filename": "server/api/user/index.js",
29647     "groupTitle": "Users"
29648   },
29649   {
29650     "type": "post",
29651     "url": "/api/users/{id}/avatar",
29652     "title": "Add avatar",
29653     "examples": [
29654       {
29655         "title": "Example usage:",
29656         "content": "curl https://{domain}/api/users/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
29657         "type": "json"
29658       }
29659     ],
29660     "name": "addAvatar",
29661     "group": "Users",
29662     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29663     "version": "0.0.0",
29664     "filename": "server/api/user/index.js",
29665     "groupTitle": "Users"
29666   },
29667   {
29668     "type": "post",
29669     "url": "/api/users/create_many",
29670     "title": "Create Users",
29671     "examples": [
29672       {
29673         "title": "Example usage:",
29674         "content": "curl https://{domain}/api/users/create_many -d '[{\"name\": \"john.doe\", \"role\": \"user\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",
29675         "type": "json"
29676       }
29677     ],
29678     "name": "bulkCreate",
29679     "group": "Users",
29680     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29681     "version": "0.0.0",
29682     "filename": "server/api/user/index.js",
29683     "groupTitle": "Users"
29684   },
29685   {
29686     "type": "get",
29687     "url": "/api/users/{id}/avatar",
29688     "title": "Get avatar",
29689     "examples": [
29690       {
29691         "title": "Example usage:",
29692         "content": "curl https://{domain}/api/users/{id}/avatar -v -u {name}:{password} -X GET",
29693         "type": "json"
29694       }
29695     ],
29696     "name": "getAvatar",
29697     "group": "Users",
29698     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29699     "version": "0.0.0",
29700     "filename": "server/api/user/index.js",
29701     "groupTitle": "Users"
29702   },
29703   {
29704     "type": "get",
29705     "url": "/api/users/presence",
29706     "title": "Gets agent presence",
29707     "examples": [
29708       {
29709         "title": "Example usage:",
29710         "content": "curl https://{domain}/api/users/presence -v -u {name}:{password}  -X GET",
29711         "type": "json"
29712       }
29713     ],
29714     "name": "getPresence",
29715     "group": "Users",
29716     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29717     "version": "0.0.0",
29718     "filename": "server/api/user/index.js",
29719     "groupTitle": "Users"
29720   },
29721   {
29722     "type": "put",
29723     "url": "/api/users/{id}",
29724     "title": "Update an existing User",
29725     "examples": [
29726       {
29727         "title": "Example usage:",
29728         "content": "curl https://{domain}/api/users/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
29729         "type": "json"
29730       }
29731     ],
29732     "name": "updateUsers",
29733     "group": "Users",
29734     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29735     "version": "0.0.0",
29736     "filename": "server/api/user/index.js",
29737     "groupTitle": "Users"
29738   },
29739   {
29740     "type": "post",
29741     "url": "/api/variables",
29742     "title": "Creates a new Variable",
29743     "examples": [
29744       {
29745         "title": "Example usage:",
29746         "content": "curl https://{domain}/api/variables -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
29747         "type": "json"
29748       }
29749     ],
29750     "name": "CreateVariables",
29751     "group": "Variables",
29752     "parameter": {
29753       "fields": {
29754         "Body": [
29755           {
29756             "group": "Body",
29757             "type": "String",
29758             "optional": false,
29759             "field": "name",
29760             "description": ""
29761           },
29762           {
29763             "group": "Body",
29764             "type": "String",
29765             "optional": true,
29766             "field": "description",
29767             "description": ""
29768           }
29769         ]
29770       }
29771     },
29772     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29773     "version": "0.0.0",
29774     "filename": "server/api/variable/index.js",
29775     "groupTitle": "Variables"
29776   },
29777   {
29778     "type": "delete",
29779     "url": "/api/variables/{id}",
29780     "title": "Deletes a Variable",
29781     "examples": [
29782       {
29783         "title": "Example usage:",
29784         "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password} -X DELETE",
29785         "type": "json"
29786       }
29787     ],
29788     "name": "DeleteVariables",
29789     "group": "Variables",
29790     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29791     "version": "0.0.0",
29792     "filename": "server/api/variable/index.js",
29793     "groupTitle": "Variables"
29794   },
29795   {
29796     "type": "get",
29797     "url": "/api/variables",
29798     "title": "Gets a list of Variables",
29799     "examples": [
29800       {
29801         "title": "Example usage:",
29802         "content": "curl https://{domain}/api/variables -v -u {name}:{password}",
29803         "type": "json"
29804       }
29805     ],
29806     "name": "GetVariables",
29807     "group": "Variables",
29808     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
29809     "version": "0.0.0",
29810     "filename": "server/api/variable/index.js",
29811     "groupTitle": "Variables"
29812   },
29813   {
29814     "type": "get",
29815     "url": "/api/variables/{id}",
29816     "title": "Gets a single Variable",
29817     "examples": [
29818       {
29819         "title": "Example usage:",
29820         "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password}",
29821         "type": "json"
29822       }
29823     ],
29824     "name": "ShowVariables",
29825     "group": "Variables",
29826     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29827     "version": "0.0.0",
29828     "filename": "server/api/variable/index.js",
29829     "groupTitle": "Variables"
29830   },
29831   {
29832     "type": "put",
29833     "url": "/api/variables/{id}",
29834     "title": "Update an existing Variable",
29835     "examples": [
29836       {
29837         "title": "Example usage:",
29838         "content": "curl https://{domain}/api/variables/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
29839         "type": "json"
29840       }
29841     ],
29842     "name": "updateVariables",
29843     "group": "Variables",
29844     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29845     "version": "0.0.0",
29846     "filename": "server/api/variable/index.js",
29847     "groupTitle": "Variables"
29848   },
29849   {
29850     "type": "get",
29851     "url": "/api/version/fetch",
29852     "title": "Fetch git version",
29853     "examples": [
29854       {
29855         "title": "Example usage:",
29856         "content": "curl https://{domain}/api/version/fetch -v -u {name}:{password}",
29857         "type": "json"
29858       }
29859     ],
29860     "name": "FetchVersion",
29861     "group": "Version",
29862     "description": "<p>Motion run the following command: git fetch origin master</p>",
29863     "version": "0.0.0",
29864     "filename": "server/api/version/index.js",
29865     "groupTitle": "Version"
29866   },
29867   {
29868     "type": "get",
29869     "url": "/api/version",
29870     "title": "Gets version",
29871     "examples": [
29872       {
29873         "title": "Example usage:",
29874         "content": "curl https://{domain}/api/version -v -u {name}:{password}",
29875         "type": "json"
29876       }
29877     ],
29878     "name": "GetVersion",
29879     "group": "Version",
29880     "description": "<p>Motion returns the current and latest motion version.</p>",
29881     "version": "0.0.0",
29882     "filename": "server/api/version/index.js",
29883     "groupTitle": "Version"
29884   },
29885   {
29886     "type": "get",
29887     "url": "/api/version/migrations",
29888     "title": "Launch database migrations",
29889     "examples": [
29890       {
29891         "title": "Example usage:",
29892         "content": "curl https://{domain}/api/version/migrations -v -u {name}:{password}",
29893         "type": "json"
29894       }
29895     ],
29896     "name": "MigrateVersion",
29897     "group": "Version",
29898     "description": "<p>Motion launch the database migrations, according to the application version</p>",
29899     "version": "0.0.0",
29900     "filename": "server/api/version/index.js",
29901     "groupTitle": "Version"
29902   },
29903   {
29904     "type": "get",
29905     "url": "/api/version/pull",
29906     "title": "Pull git version",
29907     "examples": [
29908       {
29909         "title": "Example usage:",
29910         "content": "curl https://{domain}/api/version/pull -v -u {name}:{password}",
29911         "type": "json"
29912       }
29913     ],
29914     "name": "PullVersion",
29915     "group": "Version",
29916     "description": "<p>Motion run the following command: git pull</p>",
29917     "version": "0.0.0",
29918     "filename": "server/api/version/index.js",
29919     "groupTitle": "Version"
29920   },
29921   {
29922     "type": "get",
29923     "url": "/api/version/reset",
29924     "title": "Reset git version",
29925     "examples": [
29926       {
29927         "title": "Example usage:",
29928         "content": "curl https://{domain}/api/version/reset -v -u {name}:{password}",
29929         "type": "json"
29930       }
29931     ],
29932     "name": "ResetVersion",
29933     "group": "Version",
29934     "description": "<p>Motion run the following command: git reset --hard FETCH_HEAD</p>",
29935     "version": "0.0.0",
29936     "filename": "server/api/version/index.js",
29937     "groupTitle": "Version"
29938   },
29939   {
29940     "type": "get",
29941     "url": "/api/version/restart",
29942     "title": "Restart motion2 after update",
29943     "examples": [
29944       {
29945         "title": "Example usage:",
29946         "content": "curl https://{domain}/api/version/restart -v -u {name}:{password}",
29947         "type": "json"
29948       }
29949     ],
29950     "name": "RestartVersion",
29951     "group": "Version",
29952     "description": "<p>Motion run the following command: pm2 restart motion</p>",
29953     "version": "0.0.0",
29954     "filename": "server/api/version/index.js",
29955     "groupTitle": "Version"
29956   },
29957   {
29958     "type": "get",
29959     "url": "/api/voice/agents/reports/describe",
29960     "title": "Gets table info about Agent Reports",
29961     "examples": [
29962       {
29963         "title": "Example usage:",
29964         "content": "curl https://{domain}/api/voice/agents/reports/describe -v -u {name}:{password}",
29965         "type": "json"
29966       }
29967     ],
29968     "name": "DescribeAgent_Reports",
29969     "group": "Voice_Agent_Reports",
29970     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29971     "version": "0.0.0",
29972     "filename": "server/api/voiceAgentReport/index.js",
29973     "groupTitle": "Voice_Agent_Reports"
29974   },
29975   {
29976     "type": "get",
29977     "url": "/api/voice/agents/reports",
29978     "title": "Gets a list of Agent Reports",
29979     "examples": [
29980       {
29981         "title": "Example usage:",
29982         "content": "curl https://{domain}/api/voice/agents/reports -v -u {name}:{password}",
29983         "type": "json"
29984       }
29985     ],
29986     "name": "GetAgent_Reports",
29987     "group": "Voice_Agent_Reports",
29988     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
29989     "version": "0.0.0",
29990     "filename": "server/api/voiceAgentReport/index.js",
29991     "groupTitle": "Voice_Agent_Reports"
29992   },
29993   {
29994     "type": "get",
29995     "url": "/api/voice/agents/reports/{id}",
29996     "title": "Gets a single Agent Report",
29997     "examples": [
29998       {
29999         "title": "Example usage:",
30000         "content": "curl https://{domain}/api/voice/agents/reports/{id} -v -u {name}:{password}",
30001         "type": "json"
30002       }
30003     ],
30004     "name": "ShowAgent_Reports",
30005     "group": "Voice_Agent_Reports",
30006     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30007     "version": "0.0.0",
30008     "filename": "server/api/voiceAgentReport/index.js",
30009     "groupTitle": "Voice_Agent_Reports"
30010   },
30011   {
30012     "type": "get",
30013     "url": "/api/voice/calls/reports/describe",
30014     "title": "Gets table info about Call Reports",
30015     "examples": [
30016       {
30017         "title": "Example usage:",
30018         "content": "curl https://{domain}/api/voice/calls/reports/describe -v -u {name}:{password}",
30019         "type": "json"
30020       }
30021     ],
30022     "name": "DescribeCall_Reports",
30023     "group": "Voice_Call_Reports",
30024     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30025     "version": "0.0.0",
30026     "filename": "server/api/voiceCallReport/index.js",
30027     "groupTitle": "Voice_Call_Reports"
30028   },
30029   {
30030     "type": "get",
30031     "url": "/api/voice/calls/reports",
30032     "title": "Gets a list of Call Reports",
30033     "examples": [
30034       {
30035         "title": "Example usage:",
30036         "content": "curl https://{domain}/api/voice/calls/reports -v -u {name}:{password}",
30037         "type": "json"
30038       }
30039     ],
30040     "name": "GetCall_Reports",
30041     "group": "Voice_Call_Reports",
30042     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30043     "version": "0.0.0",
30044     "filename": "server/api/voiceCallReport/index.js",
30045     "groupTitle": "Voice_Call_Reports"
30046   },
30047   {
30048     "type": "get",
30049     "url": "/api/voice/calls/reports/{id}",
30050     "title": "Gets a single Call Report",
30051     "examples": [
30052       {
30053         "title": "Example usage:",
30054         "content": "curl https://{domain}/api/voice/calls/reports/{id} -v -u {name}:{password}",
30055         "type": "json"
30056       }
30057     ],
30058     "name": "ShowCall_Reports",
30059     "group": "Voice_Call_Reports",
30060     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30061     "version": "0.0.0",
30062     "filename": "server/api/voiceCallReport/index.js",
30063     "groupTitle": "Voice_Call_Reports"
30064   },
30065   {
30066     "type": "put",
30067     "url": "/api/voice/calls/reports/{id}",
30068     "title": "Update a single cdr",
30069     "examples": [
30070       {
30071         "title": "Example usage:",
30072         "content": "curl https://{domain}/api/voice/calls/reports/{id} -d '{\"userDispositio\": \"OK\"}' -v -u {name}:{password} -X PUT",
30073         "type": "json"
30074       }
30075     ],
30076     "name": "update",
30077     "group": "Voice_Call_Reports",
30078     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30079     "version": "0.0.0",
30080     "filename": "server/api/voiceCallReport/index.js",
30081     "groupTitle": "Voice_Call_Reports"
30082   },
30083   {
30084     "type": "post",
30085     "url": "/api/voice/chanspy",
30086     "title": "Creates a new ChanSpy",
30087     "examples": [
30088       {
30089         "title": "Example usage:",
30090         "content": "curl https://{domain}/api/voice/chanspy -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
30091         "type": "json"
30092       }
30093     ],
30094     "name": "CreateChanSpy",
30095     "group": "Voice_ChanSpy",
30096     "parameter": {
30097       "fields": {
30098         "Body": [
30099           {
30100             "group": "Body",
30101             "type": "String",
30102             "optional": true,
30103             "field": "name",
30104             "description": ""
30105           },
30106           {
30107             "group": "Body",
30108             "type": "String",
30109             "optional": false,
30110             "field": "prefix",
30111             "description": ""
30112           },
30113           {
30114             "group": "Body",
30115             "type": "String",
30116             "optional": true,
30117             "field": "options",
30118             "description": ""
30119           },
30120           {
30121             "group": "Body",
30122             "type": "Boolean",
30123             "optional": true,
30124             "field": "auth",
30125             "description": ""
30126           },
30127           {
30128             "group": "Body",
30129             "type": "String",
30130             "optional": true,
30131             "field": "password",
30132             "description": ""
30133           },
30134           {
30135             "group": "Body",
30136             "type": "Boolean",
30137             "optional": true,
30138             "field": "record",
30139             "description": ""
30140           },
30141           {
30142             "group": "Body",
30143             "type": "String",
30144             "optional": true,
30145             "field": "recordingFormat",
30146             "description": ""
30147           },
30148           {
30149             "group": "Body",
30150             "type": "String",
30151             "optional": true,
30152             "field": "description",
30153             "description": ""
30154           }
30155         ]
30156       }
30157     },
30158     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30159     "version": "0.0.0",
30160     "filename": "server/api/voiceChanSpy/index.js",
30161     "groupTitle": "Voice_ChanSpy"
30162   },
30163   {
30164     "type": "delete",
30165     "url": "/api/voice/chanspy/{id}",
30166     "title": "Deletes a ChanSpy",
30167     "examples": [
30168       {
30169         "title": "Example usage:",
30170         "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password} -X DELETE",
30171         "type": "json"
30172       }
30173     ],
30174     "name": "DeleteChanSpy",
30175     "group": "Voice_ChanSpy",
30176     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30177     "version": "0.0.0",
30178     "filename": "server/api/voiceChanSpy/index.js",
30179     "groupTitle": "Voice_ChanSpy"
30180   },
30181   {
30182     "type": "get",
30183     "url": "/api/voice/chanspy",
30184     "title": "Gets a list of ChanSpy",
30185     "examples": [
30186       {
30187         "title": "Example usage:",
30188         "content": "curl https://{domain}/api/voice/chanspy -v -u {name}:{password}",
30189         "type": "json"
30190       }
30191     ],
30192     "name": "GetChanSpy",
30193     "group": "Voice_ChanSpy",
30194     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30195     "version": "0.0.0",
30196     "filename": "server/api/voiceChanSpy/index.js",
30197     "groupTitle": "Voice_ChanSpy"
30198   },
30199   {
30200     "type": "get",
30201     "url": "/api/voice/chanspy/{id}",
30202     "title": "Gets a single ChanSpy",
30203     "examples": [
30204       {
30205         "title": "Example usage:",
30206         "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password}",
30207         "type": "json"
30208       }
30209     ],
30210     "name": "ShowChanSpy",
30211     "group": "Voice_ChanSpy",
30212     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30213     "version": "0.0.0",
30214     "filename": "server/api/voiceChanSpy/index.js",
30215     "groupTitle": "Voice_ChanSpy"
30216   },
30217   {
30218     "type": "put",
30219     "url": "/api/voice/chanspy/{id}",
30220     "title": "Update an existing ChanSpy",
30221     "examples": [
30222       {
30223         "title": "Example usage:",
30224         "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",
30225         "type": "json"
30226       }
30227     ],
30228     "name": "updateChanSpy",
30229     "group": "Voice_ChanSpy",
30230     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30231     "version": "0.0.0",
30232     "filename": "server/api/voiceChanSpy/index.js",
30233     "groupTitle": "Voice_ChanSpy"
30234   },
30235   {
30236     "type": "post",
30237     "url": "/api/voice/contexts",
30238     "title": "Create a new context",
30239     "examples": [
30240       {
30241         "title": "Example usage:",
30242         "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password} -X POST",
30243         "type": "json"
30244       }
30245     ],
30246     "name": "Create",
30247     "group": "Voice_Contexts",
30248     "parameter": {
30249       "fields": {
30250         "Body": [
30251           {
30252             "group": "Body",
30253             "type": "String",
30254             "optional": true,
30255             "field": "name",
30256             "description": ""
30257           },
30258           {
30259             "group": "Body",
30260             "type": "String",
30261             "optional": true,
30262             "field": "description",
30263             "description": ""
30264           },
30265           {
30266             "group": "Body",
30267             "type": "Boolean",
30268             "optional": true,
30269             "field": "defaultEntry",
30270             "description": ""
30271           }
30272         ]
30273       }
30274     },
30275     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30276     "version": "0.0.0",
30277     "filename": "server/api/voiceContext/index.js",
30278     "groupTitle": "Voice_Contexts"
30279   },
30280   {
30281     "type": "delete",
30282     "url": "/api/voice/contexts/{id}",
30283     "title": "Deletes a context",
30284     "examples": [
30285       {
30286         "title": "Example usage:",
30287         "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X DELETE",
30288         "type": "json"
30289       }
30290     ],
30291     "name": "Delete",
30292     "group": "Voice_Contexts",
30293     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30294     "version": "0.0.0",
30295     "filename": "server/api/voiceContext/index.js",
30296     "groupTitle": "Voice_Contexts"
30297   },
30298   {
30299     "type": "get",
30300     "url": "/api/voice/contexts",
30301     "title": "Gets a list of Contexts",
30302     "examples": [
30303       {
30304         "title": "Example usage:",
30305         "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password}",
30306         "type": "json"
30307       }
30308     ],
30309     "name": "GetContexts",
30310     "group": "Voice_Contexts",
30311     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30312     "version": "0.0.0",
30313     "filename": "server/api/voiceContext/index.js",
30314     "groupTitle": "Voice_Contexts"
30315   },
30316   {
30317     "type": "get",
30318     "url": "/api/voice/contexts/{id}",
30319     "title": "Gets a single Context",
30320     "examples": [
30321       {
30322         "title": "Example usage:",
30323         "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password}",
30324         "type": "json"
30325       }
30326     ],
30327     "name": "ShowContexts",
30328     "group": "Voice_Contexts",
30329     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30330     "version": "0.0.0",
30331     "filename": "server/api/voiceContext/index.js",
30332     "groupTitle": "Voice_Contexts"
30333   },
30334   {
30335     "type": "put",
30336     "url": "/api/voice/contexts/{id}",
30337     "title": "Update an existing context",
30338     "examples": [
30339       {
30340         "title": "Example usage:",
30341         "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X PUT",
30342         "type": "json"
30343       }
30344     ],
30345     "name": "Update",
30346     "group": "Voice_Contexts",
30347     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30348     "version": "0.0.0",
30349     "filename": "server/api/voiceContext/index.js",
30350     "groupTitle": "Voice_Contexts"
30351   },
30352   {
30353     "type": "get",
30354     "url": "/api/voice/dials/reports/describe",
30355     "title": "Gets table info about Dial Reports",
30356     "examples": [
30357       {
30358         "title": "Example usage:",
30359         "content": "curl https://{domain}/api/voice/dials/reports/describe -v -u {name}:{password}",
30360         "type": "json"
30361       }
30362     ],
30363     "name": "DescribeDial_Reports",
30364     "group": "Voice_Dial_Reports",
30365     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30366     "version": "0.0.0",
30367     "filename": "server/api/voiceDialReport/index.js",
30368     "groupTitle": "Voice_Dial_Reports"
30369   },
30370   {
30371     "type": "get",
30372     "url": "/api/voice/dials/reports",
30373     "title": "Gets a list of Dial Reports",
30374     "examples": [
30375       {
30376         "title": "Example usage:",
30377         "content": "curl https://{domain}/api/voice/dials/reports -v -u {name}:{password}",
30378         "type": "json"
30379       }
30380     ],
30381     "name": "GetDial_Reports",
30382     "group": "Voice_Dial_Reports",
30383     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30384     "version": "0.0.0",
30385     "filename": "server/api/voiceDialReport/index.js",
30386     "groupTitle": "Voice_Dial_Reports"
30387   },
30388   {
30389     "type": "get",
30390     "url": "/api/voice/dials/reports/{id}",
30391     "title": "Gets a single Dial Report",
30392     "examples": [
30393       {
30394         "title": "Example usage:",
30395         "content": "curl https://{domain}/api/voice/dials/reports/{id} -v -u {name}:{password}",
30396         "type": "json"
30397       }
30398     ],
30399     "name": "ShowDial_Reports",
30400     "group": "Voice_Dial_Reports",
30401     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30402     "version": "0.0.0",
30403     "filename": "server/api/voiceDialReport/index.js",
30404     "groupTitle": "Voice_Dial_Reports"
30405   },
30406   {
30407     "type": "delete",
30408     "url": "/api/voice/extensions/{id}",
30409     "title": "Deletes a Extension",
30410     "examples": [
30411       {
30412         "title": "Example usage:",
30413         "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password} -X DELETE",
30414         "type": "json"
30415       }
30416     ],
30417     "name": "DeleteExtensions",
30418     "group": "Voice_Extensions",
30419     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30420     "version": "0.0.0",
30421     "filename": "server/api/voiceExtension/index.js",
30422     "groupTitle": "Voice_Extensions"
30423   },
30424   {
30425     "type": "get",
30426     "url": "/api/voice/extensions",
30427     "title": "Gets a list of Extensions",
30428     "examples": [
30429       {
30430         "title": "Example usage:",
30431         "content": "curl https://{domain}/api/voice/extensions -v -u {name}:{password}",
30432         "type": "json"
30433       }
30434     ],
30435     "name": "GetExtensions",
30436     "group": "Voice_Extensions",
30437     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30438     "version": "0.0.0",
30439     "filename": "server/api/voiceExtension/index.js",
30440     "groupTitle": "Voice_Extensions"
30441   },
30442   {
30443     "type": "get",
30444     "url": "/api/voice/extensions/{id}",
30445     "title": "Gets a single Extension",
30446     "examples": [
30447       {
30448         "title": "Example usage:",
30449         "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password}",
30450         "type": "json"
30451       }
30452     ],
30453     "name": "ShowExtensions",
30454     "group": "Voice_Extensions",
30455     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30456     "version": "0.0.0",
30457     "filename": "server/api/voiceExtension/index.js",
30458     "groupTitle": "Voice_Extensions"
30459   },
30460   {
30461     "type": "post",
30462     "url": "/api/voice/extensions",
30463     "title": "Create new applications",
30464     "examples": [
30465       {
30466         "title": "Example usage:",
30467         "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",
30468         "type": "json"
30469       }
30470     ],
30471     "name": "addApplications",
30472     "group": "Voice_Extensions",
30473     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30474     "version": "0.0.0",
30475     "filename": "server/api/voiceExtension/index.js",
30476     "groupTitle": "Voice_Extensions"
30477   },
30478   {
30479     "type": "post",
30480     "url": "/api/voice/extensions",
30481     "title": "Create an extension",
30482     "examples": [
30483       {
30484         "title": "Example usage:",
30485         "content": "curl https://{domain}/api/voice/extensions -d '{\"exten\": \"12345\", \"context\": \"from-custom\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30486         "type": "json"
30487       }
30488     ],
30489     "name": "create",
30490     "group": "Voice_Extensions",
30491     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30492     "version": "0.0.0",
30493     "filename": "server/api/voiceExtension/index.js",
30494     "groupTitle": "Voice_Extensions"
30495   },
30496   {
30497     "type": "put",
30498     "url": "/api/voice/extensions/{id}",
30499     "title": "Update an extension",
30500     "examples": [
30501       {
30502         "title": "Example usage:",
30503         "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",
30504         "type": "json"
30505       }
30506     ],
30507     "name": "update",
30508     "group": "Voice_Extensions",
30509     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30510     "version": "0.0.0",
30511     "filename": "server/api/voiceExtension/index.js",
30512     "groupTitle": "Voice_Extensions"
30513   },
30514   {
30515     "type": "post",
30516     "url": "/api/voice/mohs",
30517     "title": "Create a new a new MOH",
30518     "examples": [
30519       {
30520         "title": "Example usage:",
30521         "content": "curl https://{domain}/api/voice/mohs -d '{\"name\": \"xmas_musics\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30522         "type": "json"
30523       }
30524     ],
30525     "name": "AddMoh",
30526     "group": "Voice_MOHs",
30527     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30528     "version": "0.0.0",
30529     "filename": "server/api/voiceMusicOnHold/index.js",
30530     "groupTitle": "Voice_MOHs"
30531   },
30532   {
30533     "type": "post",
30534     "url": "/api/voice/mohs/{id}/sounds",
30535     "title": "Add sound to MOH",
30536     "examples": [
30537       {
30538         "title": "Example usage:",
30539         "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -d '{\"id\": 1}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30540         "type": "json"
30541       }
30542     ],
30543     "name": "AddSound",
30544     "group": "Voice_MOHs",
30545     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30546     "version": "0.0.0",
30547     "filename": "server/api/voiceMusicOnHold/index.js",
30548     "groupTitle": "Voice_MOHs"
30549   },
30550   {
30551     "type": "delete",
30552     "url": "/api/voice/mohs/{id}",
30553     "title": "Deletes an MOH",
30554     "examples": [
30555       {
30556         "title": "Example usage:",
30557         "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password} -X DELETE",
30558         "type": "json"
30559       }
30560     ],
30561     "name": "DestroyMoh",
30562     "group": "Voice_MOHs",
30563     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30564     "version": "0.0.0",
30565     "filename": "server/api/voiceMusicOnHold/index.js",
30566     "groupTitle": "Voice_MOHs"
30567   },
30568   {
30569     "type": "get",
30570     "url": "/api/voice/mohs",
30571     "title": "Gets a list of Music On Holds",
30572     "examples": [
30573       {
30574         "title": "Example usage:",
30575         "content": "curl https://{domain}/api/voice/mohs -v -u {name}:{password}",
30576         "type": "json"
30577       }
30578     ],
30579     "name": "GetMusic_On_Holds",
30580     "group": "Voice_MOHs",
30581     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30582     "version": "0.0.0",
30583     "filename": "server/api/voiceMusicOnHold/index.js",
30584     "groupTitle": "Voice_MOHs"
30585   },
30586   {
30587     "type": "get",
30588     "url": "/api/voice/mohs/{id}/sounds",
30589     "title": "Gets sounds from MOH",
30590     "examples": [
30591       {
30592         "title": "Example usage:",
30593         "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -v -u {name}:{password} -X DELETE",
30594         "type": "json"
30595       }
30596     ],
30597     "name": "GetSounds",
30598     "group": "Voice_MOHs",
30599     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30600     "version": "0.0.0",
30601     "filename": "server/api/voiceMusicOnHold/index.js",
30602     "groupTitle": "Voice_MOHs"
30603   },
30604   {
30605     "type": "delete",
30606     "url": "/api/voice/mohs/{id}/sounds/{id2}",
30607     "title": "Remove sound from MOH",
30608     "examples": [
30609       {
30610         "title": "Example usage:",
30611         "content": "curl https://{domain}/api/voice/mohs/{id}/sounds/{id2} -v -u {name}:{password} -X DELETE",
30612         "type": "json"
30613       }
30614     ],
30615     "name": "RemoveSound",
30616     "group": "Voice_MOHs",
30617     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30618     "version": "0.0.0",
30619     "filename": "server/api/voiceMusicOnHold/index.js",
30620     "groupTitle": "Voice_MOHs"
30621   },
30622   {
30623     "type": "get",
30624     "url": "/api/voice/mohs/{id}",
30625     "title": "Gets a single Music On Hold",
30626     "examples": [
30627       {
30628         "title": "Example usage:",
30629         "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password}",
30630         "type": "json"
30631       }
30632     ],
30633     "name": "ShowMusic_On_Holds",
30634     "group": "Voice_MOHs",
30635     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30636     "version": "0.0.0",
30637     "filename": "server/api/voiceMusicOnHold/index.js",
30638     "groupTitle": "Voice_MOHs"
30639   },
30640   {
30641     "type": "put",
30642     "url": "/api/voice/mohs/{id}",
30643     "title": "Update an existing Music On Hold",
30644     "examples": [
30645       {
30646         "title": "Example usage:",
30647         "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",
30648         "type": "json"
30649       }
30650     ],
30651     "name": "updateMusic_On_Holds",
30652     "group": "Voice_MOHs",
30653     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30654     "version": "0.0.0",
30655     "filename": "server/api/voiceMusicOnHold/index.js",
30656     "groupTitle": "Voice_MOHs"
30657   },
30658   {
30659     "type": "post",
30660     "url": "/api/voice/mails",
30661     "title": "Creates a new Mail",
30662     "examples": [
30663       {
30664         "title": "Example usage:",
30665         "content": "curl https://{domain}/api/voice/mails -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
30666         "type": "json"
30667       }
30668     ],
30669     "name": "CreateMails",
30670     "group": "Voice_Mails",
30671     "parameter": {
30672       "fields": {
30673         "Body": [
30674           {
30675             "group": "Body",
30676             "type": "String",
30677             "optional": true,
30678             "field": "customer_id",
30679             "description": ""
30680           },
30681           {
30682             "group": "Body",
30683             "type": "String",
30684             "optional": true,
30685             "field": "context",
30686             "description": ""
30687           },
30688           {
30689             "group": "Body",
30690             "type": "String",
30691             "optional": false,
30692             "field": "mailbox",
30693             "description": ""
30694           },
30695           {
30696             "group": "Body",
30697             "type": "String",
30698             "optional": true,
30699             "field": "password",
30700             "description": ""
30701           },
30702           {
30703             "group": "Body",
30704             "type": "String",
30705             "optional": true,
30706             "field": "fullname",
30707             "description": ""
30708           },
30709           {
30710             "group": "Body",
30711             "type": "String",
30712             "optional": true,
30713             "field": "email",
30714             "description": ""
30715           },
30716           {
30717             "group": "Body",
30718             "type": "String",
30719             "optional": true,
30720             "field": "pager",
30721             "description": ""
30722           },
30723           {
30724             "group": "Body",
30725             "type": "String",
30726             "optional": true,
30727             "field": "tz",
30728             "description": ""
30729           },
30730           {
30731             "group": "Body",
30732             "type": "String",
30733             "allowedValues": [
30734               "\"yes\"",
30735               "\"no\""
30736             ],
30737             "optional": false,
30738             "field": "attach",
30739             "description": ""
30740           },
30741           {
30742             "group": "Body",
30743             "type": "String",
30744             "allowedValues": [
30745               "\"yes\"",
30746               "\"no\""
30747             ],
30748             "optional": false,
30749             "field": "saycid",
30750             "description": ""
30751           },
30752           {
30753             "group": "Body",
30754             "type": "String",
30755             "optional": true,
30756             "field": "dialout",
30757             "description": ""
30758           },
30759           {
30760             "group": "Body",
30761             "type": "String",
30762             "optional": true,
30763             "field": "callback",
30764             "description": ""
30765           },
30766           {
30767             "group": "Body",
30768             "type": "String",
30769             "allowedValues": [
30770               "\"yes\"",
30771               "\"no\""
30772             ],
30773             "optional": false,
30774             "field": "review",
30775             "description": ""
30776           },
30777           {
30778             "group": "Body",
30779             "type": "String",
30780             "allowedValues": [
30781               "\"yes\"",
30782               "\"no\""
30783             ],
30784             "optional": false,
30785             "field": "operator",
30786             "description": ""
30787           },
30788           {
30789             "group": "Body",
30790             "type": "String",
30791             "allowedValues": [
30792               "\"yes\"",
30793               "\"no\""
30794             ],
30795             "optional": false,
30796             "field": "envelope",
30797             "description": ""
30798           },
30799           {
30800             "group": "Body",
30801             "type": "String",
30802             "allowedValues": [
30803               "\"yes\"",
30804               "\"no\""
30805             ],
30806             "optional": false,
30807             "field": "sayduration",
30808             "description": ""
30809           },
30810           {
30811             "group": "Body",
30812             "type": "String",
30813             "optional": false,
30814             "field": "saydurationm",
30815             "description": ""
30816           },
30817           {
30818             "group": "Body",
30819             "type": "String",
30820             "allowedValues": [
30821               "\"yes\"",
30822               "\"no\""
30823             ],
30824             "optional": false,
30825             "field": "sendvoicemail",
30826             "description": ""
30827           },
30828           {
30829             "group": "Body",
30830             "type": "String",
30831             "allowedValues": [
30832               "\"yes\"",
30833               "\"no\""
30834             ],
30835             "optional": false,
30836             "field": "delete",
30837             "description": ""
30838           },
30839           {
30840             "group": "Body",
30841             "type": "String",
30842             "allowedValues": [
30843               "\"yes\"",
30844               "\"no\""
30845             ],
30846             "optional": false,
30847             "field": "nextaftercmd",
30848             "description": ""
30849           },
30850           {
30851             "group": "Body",
30852             "type": "String",
30853             "allowedValues": [
30854               "\"yes\"",
30855               "\"no\""
30856             ],
30857             "optional": false,
30858             "field": "forcename",
30859             "description": ""
30860           },
30861           {
30862             "group": "Body",
30863             "type": "String",
30864             "allowedValues": [
30865               "\"yes\"",
30866               "\"no\""
30867             ],
30868             "optional": false,
30869             "field": "forcegreetings",
30870             "description": ""
30871           },
30872           {
30873             "group": "Body",
30874             "type": "String",
30875             "allowedValues": [
30876               "\"yes\"",
30877               "\"no\""
30878             ],
30879             "optional": false,
30880             "field": "hidefromdir",
30881             "description": ""
30882           },
30883           {
30884             "group": "Body",
30885             "type": "String",
30886             "optional": true,
30887             "field": "stamp",
30888             "description": ""
30889           },
30890           {
30891             "group": "Body",
30892             "type": "String",
30893             "optional": true,
30894             "field": "emailsubject",
30895             "description": ""
30896           },
30897           {
30898             "group": "Body",
30899             "type": "String",
30900             "optional": true,
30901             "field": "emailbody",
30902             "description": ""
30903           },
30904           {
30905             "group": "Body",
30906             "type": "Integer",
30907             "optional": false,
30908             "field": "maxsecs",
30909             "description": ""
30910           },
30911           {
30912             "group": "Body",
30913             "type": "Integer",
30914             "optional": false,
30915             "field": "maxmsg",
30916             "description": ""
30917           },
30918           {
30919             "group": "Body",
30920             "type": "Virtual",
30921             "optional": true,
30922             "field": "name",
30923             "description": ""
30924           }
30925         ]
30926       }
30927     },
30928     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30929     "version": "0.0.0",
30930     "filename": "server/api/voiceMail/index.js",
30931     "groupTitle": "Voice_Mails"
30932   },
30933   {
30934     "type": "delete",
30935     "url": "/api/voice/mails/{id}",
30936     "title": "Deletes a Mail",
30937     "examples": [
30938       {
30939         "title": "Example usage:",
30940         "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password} -X DELETE",
30941         "type": "json"
30942       }
30943     ],
30944     "name": "DeleteMails",
30945     "group": "Voice_Mails",
30946     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30947     "version": "0.0.0",
30948     "filename": "server/api/voiceMail/index.js",
30949     "groupTitle": "Voice_Mails"
30950   },
30951   {
30952     "type": "get",
30953     "url": "/api/voice/mails",
30954     "title": "Gets a list of Mails",
30955     "examples": [
30956       {
30957         "title": "Example usage:",
30958         "content": "curl https://{domain}/api/voice/mails -v -u {name}:{password}",
30959         "type": "json"
30960       }
30961     ],
30962     "name": "GetMails",
30963     "group": "Voice_Mails",
30964     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30965     "version": "0.0.0",
30966     "filename": "server/api/voiceMail/index.js",
30967     "groupTitle": "Voice_Mails"
30968   },
30969   {
30970     "type": "get",
30971     "url": "/api/voice/mails/{id}",
30972     "title": "Gets a single Mail",
30973     "examples": [
30974       {
30975         "title": "Example usage:",
30976         "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password}",
30977         "type": "json"
30978       }
30979     ],
30980     "name": "ShowMails",
30981     "group": "Voice_Mails",
30982     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30983     "version": "0.0.0",
30984     "filename": "server/api/voiceMail/index.js",
30985     "groupTitle": "Voice_Mails"
30986   },
30987   {
30988     "type": "get",
30989     "url": "/api/voice/mails/{id}/messages",
30990     "title": "Gets voice mail messages",
30991     "examples": [
30992       {
30993         "title": "Example usage:",
30994         "content": "curl https://{domain}/api/voice/mails/{id}/messages -v -u {name}:{password} -X GET",
30995         "type": "json"
30996       }
30997     ],
30998     "name": "getMessages",
30999     "group": "Voice_Mails",
31000     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31001     "version": "0.0.0",
31002     "filename": "server/api/voiceMail/index.js",
31003     "groupTitle": "Voice_Mails"
31004   },
31005   {
31006     "type": "put",
31007     "url": "/api/voice/mails/{id}",
31008     "title": "Update an existing Mail",
31009     "examples": [
31010       {
31011         "title": "Example usage:",
31012         "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",
31013         "type": "json"
31014       }
31015     ],
31016     "name": "updateMails",
31017     "group": "Voice_Mails",
31018     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31019     "version": "0.0.0",
31020     "filename": "server/api/voiceMail/index.js",
31021     "groupTitle": "Voice_Mails"
31022   },
31023   {
31024     "type": "post",
31025     "url": "/api/voice/mails/messages",
31026     "title": "Creates a new Message",
31027     "examples": [
31028       {
31029         "title": "Example usage:",
31030         "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",
31031         "type": "json"
31032       }
31033     ],
31034     "name": "CreateMessages",
31035     "group": "Voice_Messages",
31036     "parameter": {
31037       "fields": {
31038         "Body": [
31039           {
31040             "group": "Body",
31041             "type": "Virtual",
31042             "optional": true,
31043             "field": "name",
31044             "description": ""
31045           },
31046           {
31047             "group": "Body",
31048             "type": "Integer",
31049             "optional": false,
31050             "field": "msgnum",
31051             "description": ""
31052           },
31053           {
31054             "group": "Body",
31055             "type": "String",
31056             "optional": true,
31057             "field": "dir",
31058             "description": ""
31059           },
31060           {
31061             "group": "Body",
31062             "type": "String",
31063             "optional": true,
31064             "field": "context",
31065             "description": ""
31066           },
31067           {
31068             "group": "Body",
31069             "type": "String",
31070             "optional": true,
31071             "field": "macrocontext",
31072             "description": ""
31073           },
31074           {
31075             "group": "Body",
31076             "type": "String",
31077             "optional": true,
31078             "field": "callerid",
31079             "description": ""
31080           },
31081           {
31082             "group": "Body",
31083             "type": "String",
31084             "optional": true,
31085             "field": "origtime",
31086             "description": ""
31087           },
31088           {
31089             "group": "Body",
31090             "type": "String",
31091             "optional": true,
31092             "field": "duration",
31093             "description": ""
31094           },
31095           {
31096             "group": "Body",
31097             "type": "String",
31098             "optional": true,
31099             "field": "mailboxuser",
31100             "description": ""
31101           },
31102           {
31103             "group": "Body",
31104             "type": "String",
31105             "optional": true,
31106             "field": "mailboxcontext",
31107             "description": ""
31108           },
31109           {
31110             "group": "Body",
31111             "type": "Blob",
31112             "optional": true,
31113             "field": "recording",
31114             "description": ""
31115           },
31116           {
31117             "group": "Body",
31118             "type": "String",
31119             "optional": true,
31120             "field": "flag",
31121             "description": ""
31122           },
31123           {
31124             "group": "Body",
31125             "type": "String",
31126             "optional": true,
31127             "field": "msg_id",
31128             "description": ""
31129           },
31130           {
31131             "group": "Body",
31132             "type": "String",
31133             "optional": true,
31134             "field": "stamp",
31135             "description": ""
31136           }
31137         ]
31138       }
31139     },
31140     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31141     "version": "0.0.0",
31142     "filename": "server/api/voiceMailMessage/index.js",
31143     "groupTitle": "Voice_Messages"
31144   },
31145   {
31146     "type": "delete",
31147     "url": "/api/voice/mails/messages/{id}",
31148     "title": "Deletes a Message",
31149     "examples": [
31150       {
31151         "title": "Example usage:",
31152         "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password} -X DELETE",
31153         "type": "json"
31154       }
31155     ],
31156     "name": "DeleteMessages",
31157     "group": "Voice_Messages",
31158     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31159     "version": "0.0.0",
31160     "filename": "server/api/voiceMailMessage/index.js",
31161     "groupTitle": "Voice_Messages"
31162   },
31163   {
31164     "type": "get",
31165     "url": "/api/voice/mails/messages",
31166     "title": "Gets a list of Messages",
31167     "examples": [
31168       {
31169         "title": "Example usage:",
31170         "content": "curl https://{domain}/api/voice/mails/messages -v -u {name}:{password}",
31171         "type": "json"
31172       }
31173     ],
31174     "name": "GetMessages",
31175     "group": "Voice_Messages",
31176     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31177     "version": "0.0.0",
31178     "filename": "server/api/voiceMailMessage/index.js",
31179     "groupTitle": "Voice_Messages"
31180   },
31181   {
31182     "type": "get",
31183     "url": "/api/voice/mails/messages/{id}",
31184     "title": "Gets a single Message",
31185     "examples": [
31186       {
31187         "title": "Example usage:",
31188         "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password}",
31189         "type": "json"
31190       }
31191     ],
31192     "name": "ShowMessages",
31193     "group": "Voice_Messages",
31194     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31195     "version": "0.0.0",
31196     "filename": "server/api/voiceMailMessage/index.js",
31197     "groupTitle": "Voice_Messages"
31198   },
31199   {
31200     "type": "get",
31201     "url": "voice/mails/messages/{id}/download",
31202     "title": "Download Voice Message",
31203     "examples": [
31204       {
31205         "title": "Example usage:",
31206         "content": "curl https://{domain}voice/mails/messages/{id}/download -v -u {name}:{password} -X GET",
31207         "type": "json"
31208       }
31209     ],
31210     "name": "download",
31211     "group": "Voice_Messages",
31212     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31213     "version": "0.0.0",
31214     "filename": "server/api/voiceMailMessage/index.js",
31215     "groupTitle": "Voice_Messages"
31216   },
31217   {
31218     "type": "put",
31219     "url": "/api/voice/mails/messages/{id}",
31220     "title": "Update an existing Message",
31221     "examples": [
31222       {
31223         "title": "Example usage:",
31224         "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",
31225         "type": "json"
31226       }
31227     ],
31228     "name": "updateMessages",
31229     "group": "Voice_Messages",
31230     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31231     "version": "0.0.0",
31232     "filename": "server/api/voiceMailMessage/index.js",
31233     "groupTitle": "Voice_Messages"
31234   },
31235   {
31236     "type": "post",
31237     "url": "/api/voice/prefixes/{id}/users",
31238     "title": "Add agents to a prefix",
31239     "examples": [
31240       {
31241         "title": "Example usage:",
31242         "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",
31243         "type": "json"
31244       }
31245     ],
31246     "name": "AddAgents",
31247     "group": "Voice_Prefixes",
31248     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31249     "version": "0.0.0",
31250     "filename": "server/api/voicePrefix/index.js",
31251     "groupTitle": "Voice_Prefixes"
31252   },
31253   {
31254     "type": "delete",
31255     "url": "/api/voice/prefixes/{id}",
31256     "title": "Deletes a Prefix",
31257     "examples": [
31258       {
31259         "title": "Example usage:",
31260         "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X DELETE",
31261         "type": "json"
31262       }
31263     ],
31264     "name": "DeletePrefixes",
31265     "group": "Voice_Prefixes",
31266     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31267     "version": "0.0.0",
31268     "filename": "server/api/voicePrefix/index.js",
31269     "groupTitle": "Voice_Prefixes"
31270   },
31271   {
31272     "type": "get",
31273     "url": "/api/voice/prefixes/describe",
31274     "title": "Gets table info about Prefixes",
31275     "examples": [
31276       {
31277         "title": "Example usage:",
31278         "content": "curl https://{domain}/api/voice/prefixes/describe -v -u {name}:{password}",
31279         "type": "json"
31280       }
31281     ],
31282     "name": "DescribePrefixes",
31283     "group": "Voice_Prefixes",
31284     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31285     "version": "0.0.0",
31286     "filename": "server/api/voicePrefix/index.js",
31287     "groupTitle": "Voice_Prefixes"
31288   },
31289   {
31290     "type": "get",
31291     "url": "/api/voice/prefixes/{id}/users",
31292     "title": "Gets agents from prefix",
31293     "examples": [
31294       {
31295         "title": "Example usage:",
31296         "content": "curl https://{domain}/api/voice/prefixes/{id}/users -v -u {name}:{password} -X GET",
31297         "type": "json"
31298       }
31299     ],
31300     "name": "GetAgents",
31301     "group": "Voice_Prefixes",
31302     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31303     "version": "0.0.0",
31304     "filename": "server/api/voicePrefix/index.js",
31305     "groupTitle": "Voice_Prefixes"
31306   },
31307   {
31308     "type": "get",
31309     "url": "/api/voice/prefixes",
31310     "title": "Gets a list of Prefixes",
31311     "examples": [
31312       {
31313         "title": "Example usage:",
31314         "content": "curl https://{domain}/api/voice/prefixes -v -u {name}:{password}",
31315         "type": "json"
31316       }
31317     ],
31318     "name": "GetPrefixes",
31319     "group": "Voice_Prefixes",
31320     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31321     "version": "0.0.0",
31322     "filename": "server/api/voicePrefix/index.js",
31323     "groupTitle": "Voice_Prefixes"
31324   },
31325   {
31326     "type": "delete",
31327     "url": "/api/voice/prefixes/{id}/users",
31328     "title": "Removes agents from a prefix",
31329     "examples": [
31330       {
31331         "title": "Example usage:",
31332         "content": "curl https://{domain}/api/voice/prefixes/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
31333         "type": "json"
31334       }
31335     ],
31336     "name": "RemoveAgents",
31337     "group": "Voice_Prefixes",
31338     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31339     "version": "0.0.0",
31340     "filename": "server/api/voicePrefix/index.js",
31341     "groupTitle": "Voice_Prefixes"
31342   },
31343   {
31344     "type": "get",
31345     "url": "/api/voice/prefixes/{id}",
31346     "title": "Gets a single Prefix",
31347     "examples": [
31348       {
31349         "title": "Example usage:",
31350         "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password}",
31351         "type": "json"
31352       }
31353     ],
31354     "name": "ShowPrefixes",
31355     "group": "Voice_Prefixes",
31356     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31357     "version": "0.0.0",
31358     "filename": "server/api/voicePrefix/index.js",
31359     "groupTitle": "Voice_Prefixes"
31360   },
31361   {
31362     "type": "put",
31363     "url": "/api/voice/prefixes/{id}",
31364     "title": "Update an existing prefix",
31365     "examples": [
31366       {
31367         "title": "Example usage:",
31368         "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X PUT",
31369         "type": "json"
31370       }
31371     ],
31372     "name": "Update",
31373     "group": "Voice_Prefixes",
31374     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31375     "version": "0.0.0",
31376     "filename": "server/api/voicePrefix/index.js",
31377     "groupTitle": "Voice_Prefixes"
31378   },
31379   {
31380     "type": "post",
31381     "url": "/api/voice/prefixes",
31382     "title": "Create a prefix",
31383     "examples": [
31384       {
31385         "title": "Example usage:",
31386         "content": "curl https://{domain}/api/voice/prefixes -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31387         "type": "json"
31388       }
31389     ],
31390     "name": "create",
31391     "group": "Voice_Prefixes",
31392     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31393     "version": "0.0.0",
31394     "filename": "server/api/voicePrefix/index.js",
31395     "groupTitle": "Voice_Prefixes"
31396   },
31397   {
31398     "type": "get",
31399     "url": "/api/voice/queues/reports/describe",
31400     "title": "Gets table info about Queue Reports",
31401     "examples": [
31402       {
31403         "title": "Example usage:",
31404         "content": "curl https://{domain}/api/voice/queues/reports/describe -v -u {name}:{password}",
31405         "type": "json"
31406       }
31407     ],
31408     "name": "DescribeQueue_Reports",
31409     "group": "Voice_Queue_Reports",
31410     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31411     "version": "0.0.0",
31412     "filename": "server/api/voiceQueueReport/index.js",
31413     "groupTitle": "Voice_Queue_Reports"
31414   },
31415   {
31416     "type": "get",
31417     "url": "/api/voice/queues/reports",
31418     "title": "Gets a list of Queue Reports",
31419     "examples": [
31420       {
31421         "title": "Example usage:",
31422         "content": "curl https://{domain}/api/voice/queues/reports -v -u {name}:{password}",
31423         "type": "json"
31424       }
31425     ],
31426     "name": "GetQueue_Reports",
31427     "group": "Voice_Queue_Reports",
31428     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31429     "version": "0.0.0",
31430     "filename": "server/api/voiceQueueReport/index.js",
31431     "groupTitle": "Voice_Queue_Reports"
31432   },
31433   {
31434     "type": "get",
31435     "url": "/api/voice/queues/reports/{id}",
31436     "title": "Gets a single Queue Report",
31437     "examples": [
31438       {
31439         "title": "Example usage:",
31440         "content": "curl https://{domain}/api/voice/queues/reports/{id} -v -u {name}:{password}",
31441         "type": "json"
31442       }
31443     ],
31444     "name": "ShowQueue_Reports",
31445     "group": "Voice_Queue_Reports",
31446     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31447     "version": "0.0.0",
31448     "filename": "server/api/voiceQueueReport/index.js",
31449     "groupTitle": "Voice_Queue_Reports"
31450   },
31451   {
31452     "type": "get",
31453     "url": "/api/voice/queues/reports/index",
31454     "title": "Get Voice Queues Report",
31455     "examples": [
31456       {
31457         "title": "Example usage:",
31458         "content": "curl https://{domain}/api/voice/queues/reports/index -v -u {name}:{password} -X GET",
31459         "type": "json"
31460       }
31461     ],
31462     "name": "getVoiceQueuesReport",
31463     "group": "Voice_Queue_Reports",
31464     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31465     "version": "0.0.0",
31466     "filename": "server/api/voiceQueueReport/index.js",
31467     "groupTitle": "Voice_Queue_Reports"
31468   },
31469   {
31470     "type": "post",
31471     "url": "/api/voice/queues/{id}/users",
31472     "title": "Add agents to queue",
31473     "examples": [
31474       {
31475         "title": "Example usage:",
31476         "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",
31477         "type": "json"
31478       }
31479     ],
31480     "name": "AddAgents",
31481     "group": "Voice_Queues",
31482     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31483     "version": "0.0.0",
31484     "filename": "server/api/voiceQueue/index.js",
31485     "groupTitle": "Voice_Queues"
31486   },
31487   {
31488     "type": "post",
31489     "url": "/api/voice/queues/{id}/blacklists",
31490     "title": "Add blacklists to a queue",
31491     "examples": [
31492       {
31493         "title": "Example usage:",
31494         "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",
31495         "type": "json"
31496       }
31497     ],
31498     "name": "AddBlackLists",
31499     "group": "Voice_Queues",
31500     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31501     "version": "0.0.0",
31502     "filename": "server/api/voiceQueue/index.js",
31503     "groupTitle": "Voice_Queues"
31504   },
31505   {
31506     "type": "post",
31507     "url": "/api/voice/queues/{id}/lists",
31508     "title": "Add lists to a queue",
31509     "examples": [
31510       {
31511         "title": "Example usage:",
31512         "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",
31513         "type": "json"
31514       }
31515     ],
31516     "name": "AddLists",
31517     "group": "Voice_Queues",
31518     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31519     "version": "0.0.0",
31520     "filename": "server/api/voiceQueue/index.js",
31521     "groupTitle": "Voice_Queues"
31522   },
31523   {
31524     "type": "post",
31525     "url": "/api/voice/queues/{id}/teams",
31526     "title": "Add teams to queue",
31527     "examples": [
31528       {
31529         "title": "Example usage:",
31530         "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",
31531         "type": "json"
31532       }
31533     ],
31534     "name": "AddTeams",
31535     "group": "Voice_Queues",
31536     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31537     "version": "0.0.0",
31538     "filename": "server/api/voiceQueue/index.js",
31539     "groupTitle": "Voice_Queues"
31540   },
31541   {
31542     "type": "post",
31543     "url": "/api/voice/queues/clone",
31544     "title": "Clone an existing Queue",
31545     "examples": [
31546       {
31547         "title": "Example usage:",
31548         "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",
31549         "type": "json"
31550       }
31551     ],
31552     "name": "CloneQueues",
31553     "group": "Voice_Queues",
31554     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31555     "version": "0.0.0",
31556     "filename": "server/api/voiceQueue/index.js",
31557     "groupTitle": "Voice_Queues"
31558   },
31559   {
31560     "type": "post",
31561     "url": "/api/voice/queues",
31562     "title": "Creates a new Queue",
31563     "examples": [
31564       {
31565         "title": "Example usage:",
31566         "content": "curl https://{domain}/api/voice/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
31567         "type": "json"
31568       }
31569     ],
31570     "name": "CreateQueues",
31571     "group": "Voice_Queues",
31572     "parameter": {
31573       "fields": {
31574         "Body": [
31575           {
31576             "group": "Body",
31577             "type": "String",
31578             "optional": false,
31579             "field": "name",
31580             "description": ""
31581           },
31582           {
31583             "group": "Body",
31584             "type": "String",
31585             "allowedValues": [
31586               "\"inbound\"",
31587               "\"outbound\""
31588             ],
31589             "optional": false,
31590             "field": "type",
31591             "description": ""
31592           },
31593           {
31594             "group": "Body",
31595             "type": "String",
31596             "optional": true,
31597             "field": "musiconhold",
31598             "description": ""
31599           },
31600           {
31601             "group": "Body",
31602             "type": "String",
31603             "optional": true,
31604             "field": "announce",
31605             "description": ""
31606           },
31607           {
31608             "group": "Body",
31609             "type": "String",
31610             "allowedValues": [
31611               "\"rr\"",
31612               "\"ringall\"",
31613               "\"leastrecent\"",
31614               "\"fewestcalls\"",
31615               "\"random\"",
31616               "\"rrmemory\"",
31617               "\"linear\"",
31618               "\"wrandom\"",
31619               "\"rrordered\""
31620             ],
31621             "optional": false,
31622             "field": "strategy",
31623             "description": ""
31624           },
31625           {
31626             "group": "Body",
31627             "type": "Integer",
31628             "optional": true,
31629             "field": "servicelevel",
31630             "description": ""
31631           },
31632           {
31633             "group": "Body",
31634             "type": "String",
31635             "optional": true,
31636             "field": "context",
31637             "description": ""
31638           },
31639           {
31640             "group": "Body",
31641             "type": "Integer",
31642             "optional": true,
31643             "field": "penaltymemberslimit",
31644             "description": ""
31645           },
31646           {
31647             "group": "Body",
31648             "type": "Integer",
31649             "optional": true,
31650             "field": "timeout",
31651             "description": ""
31652           },
31653           {
31654             "group": "Body",
31655             "type": "Integer",
31656             "optional": true,
31657             "field": "retry",
31658             "description": ""
31659           },
31660           {
31661             "group": "Body",
31662             "type": "String",
31663             "optional": true,
31664             "field": "timeoutpriority",
31665             "description": ""
31666           },
31667           {
31668             "group": "Body",
31669             "type": "Integer",
31670             "optional": true,
31671             "field": "weight",
31672             "description": ""
31673           },
31674           {
31675             "group": "Body",
31676             "type": "Integer",
31677             "optional": true,
31678             "field": "wrapuptime",
31679             "description": ""
31680           },
31681           {
31682             "group": "Body",
31683             "type": "String",
31684             "allowedValues": [
31685               "\"yes\"",
31686               "\"no\""
31687             ],
31688             "optional": true,
31689             "field": "autofill",
31690             "description": ""
31691           },
31692           {
31693             "group": "Body",
31694             "type": "String",
31695             "allowedValues": [
31696               "\"yes\"",
31697               "\"no\"",
31698               "\"all\""
31699             ],
31700             "optional": true,
31701             "field": "autopause",
31702             "description": ""
31703           },
31704           {
31705             "group": "Body",
31706             "type": "Integer",
31707             "optional": true,
31708             "field": "autopausedelay",
31709             "description": ""
31710           },
31711           {
31712             "group": "Body",
31713             "type": "String",
31714             "allowedValues": [
31715               "\"yes\"",
31716               "\"no\""
31717             ],
31718             "optional": true,
31719             "field": "autopausebusy",
31720             "description": ""
31721           },
31722           {
31723             "group": "Body",
31724             "type": "String",
31725             "allowedValues": [
31726               "\"yes\"",
31727               "\"no\""
31728             ],
31729             "optional": true,
31730             "field": "autopauseunavail",
31731             "description": ""
31732           },
31733           {
31734             "group": "Body",
31735             "type": "Integer",
31736             "optional": true,
31737             "field": "maxlen",
31738             "description": ""
31739           },
31740           {
31741             "group": "Body",
31742             "type": "String",
31743             "allowedValues": [
31744               "\"yes\"",
31745               "\"no\""
31746             ],
31747             "optional": true,
31748             "field": "setinterfacevar",
31749             "description": ""
31750           },
31751           {
31752             "group": "Body",
31753             "type": "String",
31754             "allowedValues": [
31755               "\"yes\"",
31756               "\"no\""
31757             ],
31758             "optional": true,
31759             "field": "setqueueentryvar",
31760             "description": ""
31761           },
31762           {
31763             "group": "Body",
31764             "type": "String",
31765             "allowedValues": [
31766               "\"yes\"",
31767               "\"no\""
31768             ],
31769             "optional": true,
31770             "field": "setqueuevar",
31771             "description": ""
31772           },
31773           {
31774             "group": "Body",
31775             "type": "String",
31776             "allowedValues": [
31777               "\"yes\"",
31778               "\"no\""
31779             ],
31780             "optional": true,
31781             "field": "eventmemberstatus",
31782             "description": ""
31783           },
31784           {
31785             "group": "Body",
31786             "type": "String",
31787             "optional": true,
31788             "field": "membermacro",
31789             "description": ""
31790           },
31791           {
31792             "group": "Body",
31793             "type": "String",
31794             "optional": true,
31795             "field": "membergosub",
31796             "description": ""
31797           },
31798           {
31799             "group": "Body",
31800             "type": "Integer",
31801             "optional": true,
31802             "field": "announce_frequency",
31803             "description": ""
31804           },
31805           {
31806             "group": "Body",
31807             "type": "Integer",
31808             "optional": true,
31809             "field": "min_announce_frequency",
31810             "description": ""
31811           },
31812           {
31813             "group": "Body",
31814             "type": "Integer",
31815             "optional": true,
31816             "field": "periodic_announce_frequency",
31817             "description": ""
31818           },
31819           {
31820             "group": "Body",
31821             "type": "String",
31822             "allowedValues": [
31823               "\"yes\"",
31824               "\"no\""
31825             ],
31826             "optional": true,
31827             "field": "random_periodic_announce",
31828             "description": ""
31829           },
31830           {
31831             "group": "Body",
31832             "type": "String",
31833             "allowedValues": [
31834               "\"yes\"",
31835               "\"no\""
31836             ],
31837             "optional": true,
31838             "field": "relative_periodic_announce",
31839             "description": ""
31840           },
31841           {
31842             "group": "Body",
31843             "type": "String",
31844             "allowedValues": [
31845               "\"yes\"",
31846               "\"no\"",
31847               "\"once\""
31848             ],
31849             "optional": true,
31850             "field": "announce_holdtime",
31851             "description": ""
31852           },
31853           {
31854             "group": "Body",
31855             "type": "String",
31856             "optional": true,
31857             "field": "announce_position",
31858             "description": ""
31859           },
31860           {
31861             "group": "Body",
31862             "type": "String",
31863             "allowedValues": [
31864               "\"yes\"",
31865               "\"no\""
31866             ],
31867             "optional": true,
31868             "field": "announce_to_first_user",
31869             "description": ""
31870           },
31871           {
31872             "group": "Body",
31873             "type": "Integer",
31874             "optional": true,
31875             "field": "announce_position_limit",
31876             "description": ""
31877           },
31878           {
31879             "group": "Body",
31880             "type": "String",
31881             "allowedValues": [
31882               "\"0\"",
31883               "\"5\"",
31884               "\"10\"",
31885               "\"15\"",
31886               "\"20\"",
31887               "\"30\""
31888             ],
31889             "optional": true,
31890             "field": "announce_round_seconds",
31891             "description": ""
31892           },
31893           {
31894             "group": "Body",
31895             "type": "String",
31896             "optional": true,
31897             "field": "monitor_format",
31898             "description": ""
31899           },
31900           {
31901             "group": "Body",
31902             "type": "String",
31903             "optional": true,
31904             "field": "monitor_type",
31905             "description": ""
31906           },
31907           {
31908             "group": "Body",
31909             "type": "String",
31910             "optional": true,
31911             "field": "queue_youarenext",
31912             "description": ""
31913           },
31914           {
31915             "group": "Body",
31916             "type": "String",
31917             "optional": true,
31918             "field": "queue_thereare",
31919             "description": ""
31920           },
31921           {
31922             "group": "Body",
31923             "type": "String",
31924             "optional": true,
31925             "field": "queue_callswaiting",
31926             "description": ""
31927           },
31928           {
31929             "group": "Body",
31930             "type": "String",
31931             "optional": true,
31932             "field": "queue_holdtime",
31933             "description": ""
31934           },
31935           {
31936             "group": "Body",
31937             "type": "String",
31938             "optional": true,
31939             "field": "queue_minute",
31940             "description": ""
31941           },
31942           {
31943             "group": "Body",
31944             "type": "String",
31945             "optional": true,
31946             "field": "queue_minutes",
31947             "description": ""
31948           },
31949           {
31950             "group": "Body",
31951             "type": "String",
31952             "optional": true,
31953             "field": "queue_seconds",
31954             "description": ""
31955           },
31956           {
31957             "group": "Body",
31958             "type": "String",
31959             "optional": true,
31960             "field": "queue_thankyou",
31961             "description": ""
31962           },
31963           {
31964             "group": "Body",
31965             "type": "String",
31966             "optional": true,
31967             "field": "queue_reporthold",
31968             "description": ""
31969           },
31970           {
31971             "group": "Body",
31972             "type": "String",
31973             "optional": true,
31974             "field": "queue_quantity1",
31975             "description": ""
31976           },
31977           {
31978             "group": "Body",
31979             "type": "String",
31980             "optional": true,
31981             "field": "queue_quantity2",
31982             "description": ""
31983           },
31984           {
31985             "group": "Body",
31986             "type": "String",
31987             "optional": true,
31988             "field": "queue_periodic_announce",
31989             "description": ""
31990           },
31991           {
31992             "group": "Body",
31993             "type": "String",
31994             "optional": true,
31995             "field": "queue_less_than",
31996             "description": ""
31997           },
31998           {
31999             "group": "Body",
32000             "type": "Text",
32001             "optional": true,
32002             "field": "periodic_announce",
32003             "description": ""
32004           },
32005           {
32006             "group": "Body",
32007             "type": "String",
32008             "optional": true,
32009             "field": "joinempty",
32010             "description": ""
32011           },
32012           {
32013             "group": "Body",
32014             "type": "String",
32015             "optional": true,
32016             "field": "leavewhenempty",
32017             "description": ""
32018           },
32019           {
32020             "group": "Body",
32021             "type": "String",
32022             "allowedValues": [
32023               "\"yes\"",
32024               "\"no\""
32025             ],
32026             "optional": true,
32027             "field": "reportholdtime",
32028             "description": ""
32029           },
32030           {
32031             "group": "Body",
32032             "type": "String",
32033             "allowedValues": [
32034               "\"yes\"",
32035               "\"no\""
32036             ],
32037             "optional": true,
32038             "field": "ringinuse",
32039             "description": ""
32040           },
32041           {
32042             "group": "Body",
32043             "type": "Integer",
32044             "optional": true,
32045             "field": "memberdelay",
32046             "description": ""
32047           },
32048           {
32049             "group": "Body",
32050             "type": "String",
32051             "allowedValues": [
32052               "\"yes\"",
32053               "\"no\""
32054             ],
32055             "optional": true,
32056             "field": "timeoutrestart",
32057             "description": ""
32058           },
32059           {
32060             "group": "Body",
32061             "type": "String",
32062             "optional": true,
32063             "field": "defaultrule",
32064             "description": ""
32065           },
32066           {
32067             "group": "Body",
32068             "type": "String",
32069             "optional": true,
32070             "field": "description",
32071             "description": ""
32072           },
32073           {
32074             "group": "Body",
32075             "type": "Boolean",
32076             "optional": true,
32077             "field": "acw",
32078             "description": ""
32079           },
32080           {
32081             "group": "Body",
32082             "type": "Integer",
32083             "optional": true,
32084             "field": "acwTimeout",
32085             "description": ""
32086           },
32087           {
32088             "group": "Body",
32089             "type": "Boolean",
32090             "optional": true,
32091             "field": "dialActive",
32092             "description": "<p>Active/Disactive Campaign</p>"
32093           },
32094           {
32095             "group": "Body",
32096             "type": "String",
32097             "allowedValues": [
32098               "\"preview\"",
32099               "\"progressive\"",
32100               "\"power\"",
32101               "\"predictive\"",
32102               "\"booked\""
32103             ],
32104             "optional": true,
32105             "field": "dialMethod",
32106             "description": "<p>Dial Method.</p>"
32107           },
32108           {
32109             "group": "Body",
32110             "type": "Integer",
32111             "optional": true,
32112             "field": "dialLimitChannel",
32113             "description": "<p>Max 9999 channels, 0 means unlimited.</p>"
32114           },
32115           {
32116             "group": "Body",
32117             "type": "Integer",
32118             "optional": true,
32119             "field": "dialLimitQueue",
32120             "description": "<p>Max 9999 member in queue(min:1, max:9999), 0 means unlimited.</p>"
32121           },
32122           {
32123             "group": "Body",
32124             "type": "Float",
32125             "optional": true,
32126             "field": "dialPowerLevel",
32127             "description": "<p>Power Level: Calls for agents (min:1, max:10).</p>"
32128           },
32129           {
32130             "group": "Body",
32131             "type": "String",
32132             "allowedValues": [
32133               "\"agentBusyFactor\"",
32134               "\"dropRate\""
32135             ],
32136             "optional": true,
32137             "field": "dialPredictiveOptimization",
32138             "description": "<p>Only for predictive method.</p>"
32139           },
32140           {
32141             "group": "Body",
32142             "type": "Float",
32143             "optional": true,
32144             "field": "dialPredictiveOptimizationPercentage",
32145             "description": "<p>Predictive Optimization Percentage (min: 1, max: 95)</p>"
32146           },
32147           {
32148             "group": "Body",
32149             "type": "Integer",
32150             "optional": true,
32151             "field": "dialPredictiveInterval",
32152             "description": "<p>Interval Predictive Minutes (min:5 max:30)</p>"
32153           },
32154           {
32155             "group": "Body",
32156             "type": "String",
32157             "optional": true,
32158             "field": "dialOriginateCallerIdName",
32159             "description": ""
32160           },
32161           {
32162             "group": "Body",
32163             "type": "String",
32164             "optional": true,
32165             "field": "dialOriginateCallerIdNumber",
32166             "description": ""
32167           },
32168           {
32169             "group": "Body",
32170             "type": "Integer",
32171             "optional": true,
32172             "field": "dialOriginateTimeout",
32173             "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
32174           },
32175           {
32176             "group": "Body",
32177             "type": "String",
32178             "optional": true,
32179             "field": "dialQueueOptions",
32180             "description": "<p>https://wiki.asterisk.org/wiki/display/AST/Asterisk+13+Application_Queue</p>"
32181           },
32182           {
32183             "group": "Body",
32184             "type": "Integer",
32185             "optional": true,
32186             "field": "dialQueueTimeout",
32187             "description": "<p>Queue Timeout Seconds (min:1, max:999)</p>"
32188           },
32189           {
32190             "group": "Body",
32191             "type": "String",
32192             "optional": true,
32193             "field": "dialQueueProject",
32194             "description": "<p>AGI queue option (use: agi://127.0.0.1/square,&lt;project_name&gt;)</p>"
32195           },
32196           {
32197             "group": "Body",
32198             "type": "Integer",
32199             "optional": true,
32200             "field": "dialCongestionMaxRetry",
32201             "description": "<p>#Congestion Retry (min:1, max:999)</p>"
32202           },
32203           {
32204             "group": "Body",
32205             "type": "Integer",
32206             "optional": true,
32207             "field": "dialCongestionRetryFrequency",
32208             "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
32209           },
32210           {
32211             "group": "Body",
32212             "type": "Integer",
32213             "optional": true,
32214             "field": "dialBusyMaxRetry",
32215             "description": "<p>#Busy Retry (min:1, max:999)</p>"
32216           },
32217           {
32218             "group": "Body",
32219             "type": "Integer",
32220             "optional": true,
32221             "field": "dialBusyRetryFrequency",
32222             "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
32223           },
32224           {
32225             "group": "Body",
32226             "type": "Integer",
32227             "optional": true,
32228             "field": "dialNoAnswerMaxRetry",
32229             "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
32230           },
32231           {
32232             "group": "Body",
32233             "type": "Integer",
32234             "optional": true,
32235             "field": "dialNoAnswerRetryFrequency",
32236             "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
32237           },
32238           {
32239             "group": "Body",
32240             "type": "Integer",
32241             "optional": true,
32242             "field": "dialGlobalMaxRetry",
32243             "description": "<p>#Global Max Retry (min:1, max:999)</p>"
32244           },
32245           {
32246             "group": "Body",
32247             "type": "String",
32248             "optional": true,
32249             "field": "dialTimezone",
32250             "description": ""
32251           },
32252           {
32253             "group": "Body",
32254             "type": "String",
32255             "optional": true,
32256             "field": "dialGlobalInterval",
32257             "description": ""
32258           },
32259           {
32260             "group": "Body",
32261             "type": "String",
32262             "optional": true,
32263             "field": "dialPrefix",
32264             "description": ""
32265           },
32266           {
32267             "group": "Body",
32268             "type": "String",
32269             "allowedValues": [
32270               "\"always\"",
32271               "\"never\"",
32272               "\"onlyIfOpen\""
32273             ],
32274             "optional": true,
32275             "field": "dialCheckDuplicateType",
32276             "description": ""
32277           },
32278           {
32279             "group": "Body",
32280             "type": "Boolean",
32281             "optional": true,
32282             "field": "dialAMDActive",
32283             "description": "<p>Active/Disactive AMD</p>"
32284           },
32285           {
32286             "group": "Body",
32287             "type": "Integer",
32288             "optional": true,
32289             "field": "dialAMDInitialSilence",
32290             "description": "<p>#AMD Initial Silence</p>"
32291           },
32292           {
32293             "group": "Body",
32294             "type": "Integer",
32295             "optional": true,
32296             "field": "dialAMDGreeting",
32297             "description": "<p>#AMD Greeting</p>"
32298           },
32299           {
32300             "group": "Body",
32301             "type": "Integer",
32302             "optional": true,
32303             "field": "dialAMDAfterGreetingSilence",
32304             "description": "<p>#AMD After Greeting Silence</p>"
32305           },
32306           {
32307             "group": "Body",
32308             "type": "Integer",
32309             "optional": true,
32310             "field": "dialAMDTotalAnalysisTime",
32311             "description": "<p>#AMD Total Analysis Time</p>"
32312           },
32313           {
32314             "group": "Body",
32315             "type": "Integer",
32316             "optional": true,
32317             "field": "dialAMDMinWordLength",
32318             "description": "<p>#AMD Min Word Length</p>"
32319           },
32320           {
32321             "group": "Body",
32322             "type": "Integer",
32323             "optional": true,
32324             "field": "dialAMDBetweenWordsSilence",
32325             "description": "<p>#AMD Between Words Silence</p>"
32326           },
32327           {
32328             "group": "Body",
32329             "type": "Integer",
32330             "optional": true,
32331             "field": "dialAMDMaximumNumberOfWords",
32332             "description": "<p>#AMD Maximum Number Of Words</p>"
32333           },
32334           {
32335             "group": "Body",
32336             "type": "Integer",
32337             "optional": true,
32338             "field": "dialAMDSilenceThreshold",
32339             "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
32340           },
32341           {
32342             "group": "Body",
32343             "type": "Integer",
32344             "optional": true,
32345             "field": "dialAMDMaximumWordLength",
32346             "description": "<p>#AMD Maximum Word Length</p>"
32347           },
32348           {
32349             "group": "Body",
32350             "type": "Integer",
32351             "optional": true,
32352             "field": "dialRecallMeTimeout",
32353             "description": "<p>#RecallMe Timeout (min:1)</p>"
32354           },
32355           {
32356             "group": "Body",
32357             "type": "Boolean",
32358             "optional": true,
32359             "field": "dialRecallInQueue",
32360             "description": "<p>Active/Disactive Recall In Queue</p>"
32361           },
32362           {
32363             "group": "Body",
32364             "type": "String",
32365             "allowedValues": [
32366               "\"DESC\"",
32367               "\"ASC\""
32368             ],
32369             "optional": true,
32370             "field": "dialOrderByScheduledAt",
32371             "description": ""
32372           },
32373           {
32374             "group": "Body",
32375             "type": "String",
32376             "optional": true,
32377             "field": "dialQueueProject2",
32378             "description": "<p>AGI queue option (use: agi://127.0.0.1/square,&lt;project_name&gt;)</p>"
32379           },
32380           {
32381             "group": "Body",
32382             "type": "Boolean",
32383             "optional": true,
32384             "field": "dialAgiAfterHangupClient",
32385             "description": ""
32386           },
32387           {
32388             "group": "Body",
32389             "type": "Boolean",
32390             "optional": true,
32391             "field": "dialAgiAfterHangupAgent",
32392             "description": ""
32393           },
32394           {
32395             "group": "Body",
32396             "type": "Integer",
32397             "optional": true,
32398             "field": "dialRandomLastDigitCallerIdNumber",
32399             "description": "<p>Random Last Digit (min:1, max:15)</p>"
32400           },
32401           {
32402             "group": "Body",
32403             "type": "Integer",
32404             "optional": true,
32405             "field": "dialCutDigit",
32406             "description": "<p>Cut Digit (min:1, max:15)</p>"
32407           },
32408           {
32409             "group": "Body",
32410             "type": "Integer",
32411             "optional": true,
32412             "field": "dialNoSuchNumberMaxRetry",
32413             "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
32414           },
32415           {
32416             "group": "Body",
32417             "type": "Integer",
32418             "optional": true,
32419             "field": "dialNoSuchNumberRetryFrequency",
32420             "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
32421           },
32422           {
32423             "group": "Body",
32424             "type": "Integer",
32425             "optional": true,
32426             "field": "dialDropMaxRetry",
32427             "description": "<p>#Drop Retry (min:1, max:999)</p>"
32428           },
32429           {
32430             "group": "Body",
32431             "type": "Integer",
32432             "optional": true,
32433             "field": "dialDropRetryFrequency",
32434             "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
32435           },
32436           {
32437             "group": "Body",
32438             "type": "Integer",
32439             "optional": true,
32440             "field": "dialAbandonedMaxRetry",
32441             "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
32442           },
32443           {
32444             "group": "Body",
32445             "type": "Integer",
32446             "optional": true,
32447             "field": "dialAbandonedRetryFrequency",
32448             "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
32449           },
32450           {
32451             "group": "Body",
32452             "type": "Integer",
32453             "optional": true,
32454             "field": "dialMachineMaxRetry",
32455             "description": "<p>#Machine Retry (min:1, max:999)</p>"
32456           },
32457           {
32458             "group": "Body",
32459             "type": "Integer",
32460             "optional": true,
32461             "field": "dialMachineRetryFrequency",
32462             "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
32463           },
32464           {
32465             "group": "Body",
32466             "type": "Integer",
32467             "optional": true,
32468             "field": "dialAgentRejectMaxRetry",
32469             "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
32470           },
32471           {
32472             "group": "Body",
32473             "type": "Integer",
32474             "optional": true,
32475             "field": "dialAgentRejectRetryFrequency",
32476             "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
32477           },
32478           {
32479             "group": "Body",
32480             "type": "Integer",
32481             "optional": true,
32482             "field": "mandatoryDispositionPauseId",
32483             "description": "<p>Status to put when mandatory disposition is enabled</p>"
32484           },
32485           {
32486             "group": "Body",
32487             "type": "Boolean",
32488             "optional": true,
32489             "field": "mandatoryDisposition",
32490             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
32491           },
32492           {
32493             "group": "Body",
32494             "type": "Integer",
32495             "optional": true,
32496             "field": "dialPredictiveIntervalMaxThreshold",
32497             "description": ""
32498           },
32499           {
32500             "group": "Body",
32501             "type": "Integer",
32502             "optional": true,
32503             "field": "dialPredictiveIntervalMinThreshold",
32504             "description": ""
32505           }
32506         ]
32507       }
32508     },
32509     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32510     "version": "0.0.0",
32511     "filename": "server/api/voiceQueue/index.js",
32512     "groupTitle": "Voice_Queues"
32513   },
32514   {
32515     "type": "delete",
32516     "url": "/api/voice/queues/{id}",
32517     "title": "Deletes a Queue",
32518     "examples": [
32519       {
32520         "title": "Example usage:",
32521         "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password} -X DELETE",
32522         "type": "json"
32523       }
32524     ],
32525     "name": "DeleteQueues",
32526     "group": "Voice_Queues",
32527     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32528     "version": "0.0.0",
32529     "filename": "server/api/voiceQueue/index.js",
32530     "groupTitle": "Voice_Queues"
32531   },
32532   {
32533     "type": "get",
32534     "url": "/api/voice/queues/{id}/users",
32535     "title": "Gets queue agents",
32536     "examples": [
32537       {
32538         "title": "Example usage:",
32539         "content": "curl https://{domain}/api/voice/queues/{id}/users -v -u {name}:{password} -X GET",
32540         "type": "json"
32541       }
32542     ],
32543     "name": "GetAgents",
32544     "group": "Voice_Queues",
32545     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32546     "version": "0.0.0",
32547     "filename": "server/api/voiceQueue/index.js",
32548     "groupTitle": "Voice_Queues"
32549   },
32550   {
32551     "type": "get",
32552     "url": "/api/voice/queues/{id}/blacklists",
32553     "title": "Get queue blacklists",
32554     "examples": [
32555       {
32556         "title": "Example usage:",
32557         "content": "curl https://{domain}/api/voice/queues/{id}/blacklists -v -u {name}:{password} -X GET",
32558         "type": "json"
32559       }
32560     ],
32561     "name": "GetBlackLists",
32562     "group": "Voice_Queues",
32563     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32564     "version": "0.0.0",
32565     "filename": "server/api/voiceQueue/index.js",
32566     "groupTitle": "Voice_Queues"
32567   },
32568   {
32569     "type": "get",
32570     "url": "/api/voice/queues/{id}/finals",
32571     "title": "Gets queue hopper finals",
32572     "examples": [
32573       {
32574         "title": "Example usage:",
32575         "content": "curl https://{domain}/api/voice/queues/{id}/hopper_finals -v -u {name}:{password}  -X GET",
32576         "type": "json"
32577       }
32578     ],
32579     "name": "GetHopperFinals",
32580     "group": "Voice_Queues",
32581     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32582     "version": "0.0.0",
32583     "filename": "server/api/voiceQueue/index.js",
32584     "groupTitle": "Voice_Queues"
32585   },
32586   {
32587     "type": "get",
32588     "url": "/api/voice/queues/{id}/hopper_histories",
32589     "title": "Gets queue hopper histories",
32590     "examples": [
32591       {
32592         "title": "Example usage:",
32593         "content": "curl https://{domain}/api/voice/queues/{id}/hopper_histories -v -u {name}:{password} -X GET",
32594         "type": "json"
32595       }
32596     ],
32597     "name": "GetHopperHistories",
32598     "group": "Voice_Queues",
32599     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32600     "version": "0.0.0",
32601     "filename": "server/api/voiceQueue/index.js",
32602     "groupTitle": "Voice_Queues"
32603   },
32604   {
32605     "type": "get",
32606     "url": "/api/voice/queues/{id}/hoppers",
32607     "title": "Gets queue hoppers",
32608     "examples": [
32609       {
32610         "title": "Example usage:",
32611         "content": "curl https://{domain}/api/voice/queues/{id}/hoppers -v -u {name}:{password} -X GET",
32612         "type": "json"
32613       }
32614     ],
32615     "name": "GetHoppers",
32616     "group": "Voice_Queues",
32617     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32618     "version": "0.0.0",
32619     "filename": "server/api/voiceQueue/index.js",
32620     "groupTitle": "Voice_Queues"
32621   },
32622   {
32623     "type": "get",
32624     "url": "/api/voice/queues/{id}/lists",
32625     "title": "Get queue lists",
32626     "examples": [
32627       {
32628         "title": "Example usage:",
32629         "content": "curl https://{domain}/api/voice/queues/{id}/lists -v -u {name}:{password} -X GET",
32630         "type": "json"
32631       }
32632     ],
32633     "name": "GetLists",
32634     "group": "Voice_Queues",
32635     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32636     "version": "0.0.0",
32637     "filename": "server/api/voiceQueue/index.js",
32638     "groupTitle": "Voice_Queues"
32639   },
32640   {
32641     "type": "get",
32642     "url": "/api/voice/queues/{id}/members",
32643     "title": "Gets queue members",
32644     "examples": [
32645       {
32646         "title": "Example usage:",
32647         "content": "curl https://{domain}/api/voice/queues/{id}/members -v -u {name}:{password} -X GET",
32648         "type": "json"
32649       }
32650     ],
32651     "name": "GetMembers",
32652     "group": "Voice_Queues",
32653     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32654     "version": "0.0.0",
32655     "filename": "server/api/voiceQueue/index.js",
32656     "groupTitle": "Voice_Queues"
32657   },
32658   {
32659     "type": "get",
32660     "url": "/api/voice/queues",
32661     "title": "Gets a list of Queues",
32662     "examples": [
32663       {
32664         "title": "Example usage:",
32665         "content": "curl https://{domain}/api/voice/queues -v -u {name}:{password}",
32666         "type": "json"
32667       }
32668     ],
32669     "name": "GetQueues",
32670     "group": "Voice_Queues",
32671     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
32672     "version": "0.0.0",
32673     "filename": "server/api/voiceQueue/index.js",
32674     "groupTitle": "Voice_Queues"
32675   },
32676   {
32677     "type": "get",
32678     "url": "/api/voice/queues/{id}/teams",
32679     "title": "Gets queue team",
32680     "examples": [
32681       {
32682         "title": "Example usage:",
32683         "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password}  -X GET",
32684         "type": "json"
32685       }
32686     ],
32687     "name": "GetTeams",
32688     "group": "Voice_Queues",
32689     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32690     "version": "0.0.0",
32691     "filename": "server/api/voiceQueue/index.js",
32692     "groupTitle": "Voice_Queues"
32693   },
32694   {
32695     "type": "delete",
32696     "url": "/api/voice/queues/{id}/users",
32697     "title": "Removes agents from a queue",
32698     "examples": [
32699       {
32700         "title": "Example usage:",
32701         "content": "curl https://{domain}/api/voice/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32702         "type": "json"
32703       }
32704     ],
32705     "name": "RemoveAgents",
32706     "group": "Voice_Queues",
32707     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32708     "version": "0.0.0",
32709     "filename": "server/api/voiceQueue/index.js",
32710     "groupTitle": "Voice_Queues"
32711   },
32712   {
32713     "type": "delete",
32714     "url": "/api/voice/queues/{id}/blacklists",
32715     "title": "Remove blacklists from a queue",
32716     "examples": [
32717       {
32718         "title": "Example usage:",
32719         "content": "curl https://{domain}/api/voice/queues/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32720         "type": "json"
32721       }
32722     ],
32723     "name": "RemoveBlackLists",
32724     "group": "Voice_Queues",
32725     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32726     "version": "0.0.0",
32727     "filename": "server/api/voiceQueue/index.js",
32728     "groupTitle": "Voice_Queues"
32729   },
32730   {
32731     "type": "delete",
32732     "url": "/api/voice/queues/{id}/lists",
32733     "title": "Remove lists from a queue",
32734     "examples": [
32735       {
32736         "title": "Example usage:",
32737         "content": "curl https://{domain}/api/voice/queues/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32738         "type": "json"
32739       }
32740     ],
32741     "name": "RemoveLists",
32742     "group": "Voice_Queues",
32743     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32744     "version": "0.0.0",
32745     "filename": "server/api/voiceQueue/index.js",
32746     "groupTitle": "Voice_Queues"
32747   },
32748   {
32749     "type": "get",
32750     "url": "/api/voice/queues/{id}",
32751     "title": "Gets a single Queue",
32752     "examples": [
32753       {
32754         "title": "Example usage:",
32755         "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password}",
32756         "type": "json"
32757       }
32758     ],
32759     "name": "ShowQueues",
32760     "group": "Voice_Queues",
32761     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32762     "version": "0.0.0",
32763     "filename": "server/api/voiceQueue/index.js",
32764     "groupTitle": "Voice_Queues"
32765   },
32766   {
32767     "type": "get",
32768     "url": "/api/voice/queues/{id}/blacks",
32769     "title": "Gets queue hopper blacks",
32770     "examples": [
32771       {
32772         "title": "Example usage:",
32773         "content": "curl https://{domain}/api/voice/queues/{id}/hopper_black -v -u {name}:{password}  -X GET",
32774         "type": "json"
32775       }
32776     ],
32777     "name": "getHopperBlacks",
32778     "group": "Voice_Queues",
32779     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32780     "version": "0.0.0",
32781     "filename": "server/api/voiceQueue/index.js",
32782     "groupTitle": "Voice_Queues"
32783   },
32784   {
32785     "type": "put",
32786     "url": "/api/voice/queues/{id}",
32787     "title": "Update an existing Queue",
32788     "examples": [
32789       {
32790         "title": "Example usage:",
32791         "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",
32792         "type": "json"
32793       }
32794     ],
32795     "name": "updateQueues",
32796     "group": "Voice_Queues",
32797     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32798     "version": "0.0.0",
32799     "filename": "server/api/voiceQueue/index.js",
32800     "groupTitle": "Voice_Queues"
32801   },
32802   {
32803     "type": "post",
32804     "url": "/api/voice/recordings",
32805     "title": "Creates a new Recording",
32806     "examples": [
32807       {
32808         "title": "Example usage:",
32809         "content": "curl https://{domain}/api/voice/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
32810         "type": "json"
32811       }
32812     ],
32813     "name": "CreateRecordings",
32814     "group": "Voice_Recordings",
32815     "parameter": {
32816       "fields": {
32817         "Body": [
32818           {
32819             "group": "Body",
32820             "type": "Virtual",
32821             "optional": true,
32822             "field": "format",
32823             "description": ""
32824           },
32825           {
32826             "group": "Body",
32827             "type": "String",
32828             "optional": true,
32829             "field": "uniqueid",
32830             "description": ""
32831           },
32832           {
32833             "group": "Body",
32834             "type": "String",
32835             "optional": true,
32836             "field": "channel",
32837             "description": ""
32838           },
32839           {
32840             "group": "Body",
32841             "type": "String",
32842             "optional": true,
32843             "field": "membername",
32844             "description": ""
32845           },
32846           {
32847             "group": "Body",
32848             "type": "String",
32849             "optional": true,
32850             "field": "calleridnum",
32851             "description": ""
32852           },
32853           {
32854             "group": "Body",
32855             "type": "String",
32856             "optional": true,
32857             "field": "calleridname",
32858             "description": ""
32859           },
32860           {
32861             "group": "Body",
32862             "type": "String",
32863             "optional": true,
32864             "field": "connectedlinenum",
32865             "description": ""
32866           },
32867           {
32868             "group": "Body",
32869             "type": "String",
32870             "optional": true,
32871             "field": "connectedlinename",
32872             "description": ""
32873           },
32874           {
32875             "group": "Body",
32876             "type": "String",
32877             "optional": true,
32878             "field": "accountcode",
32879             "description": ""
32880           },
32881           {
32882             "group": "Body",
32883             "type": "String",
32884             "optional": true,
32885             "field": "context",
32886             "description": ""
32887           },
32888           {
32889             "group": "Body",
32890             "type": "String",
32891             "optional": true,
32892             "field": "exten",
32893             "description": ""
32894           },
32895           {
32896             "group": "Body",
32897             "type": "String",
32898             "optional": true,
32899             "field": "value",
32900             "description": ""
32901           },
32902           {
32903             "group": "Body",
32904             "type": "String",
32905             "optional": true,
32906             "field": "type",
32907             "description": ""
32908           },
32909           {
32910             "group": "Body",
32911             "type": "Integer",
32912             "optional": true,
32913             "field": "rating",
32914             "description": ""
32915           },
32916           {
32917             "group": "Body",
32918             "type": "String",
32919             "optional": true,
32920             "field": "queue",
32921             "description": ""
32922           },
32923           {
32924             "group": "Body",
32925             "type": "String",
32926             "optional": true,
32927             "field": "userDisposition",
32928             "description": ""
32929           },
32930           {
32931             "group": "Body",
32932             "type": "String",
32933             "optional": true,
32934             "field": "userSecondDisposition",
32935             "description": ""
32936           },
32937           {
32938             "group": "Body",
32939             "type": "String",
32940             "optional": true,
32941             "field": "userThirdDisposition",
32942             "description": ""
32943           },
32944           {
32945             "group": "Body",
32946             "type": "Text",
32947             "optional": true,
32948             "field": "location",
32949             "description": ""
32950           },
32951           {
32952             "group": "Body",
32953             "type": "String",
32954             "optional": true,
32955             "field": "transcribeName",
32956             "description": ""
32957           },
32958           {
32959             "group": "Body",
32960             "type": "String",
32961             "optional": true,
32962             "field": "transcribeStatus",
32963             "description": ""
32964           },
32965           {
32966             "group": "Body",
32967             "type": "Text",
32968             "optional": true,
32969             "field": "fileUri",
32970             "description": ""
32971           },
32972           {
32973             "group": "Body",
32974             "type": "Text",
32975             "optional": true,
32976             "field": "fileText",
32977             "description": ""
32978           },
32979           {
32980             "group": "Body",
32981             "type": "Text",
32982             "optional": true,
32983             "field": "failureReason",
32984             "description": ""
32985           },
32986           {
32987             "group": "Body",
32988             "type": "String",
32989             "optional": true,
32990             "field": "sentiment",
32991             "description": ""
32992           },
32993           {
32994             "group": "Body",
32995             "type": "Float",
32996             "optional": true,
32997             "field": "sPositive",
32998             "description": ""
32999           },
33000           {
33001             "group": "Body",
33002             "type": "Float",
33003             "optional": true,
33004             "field": "sNegative",
33005             "description": ""
33006           },
33007           {
33008             "group": "Body",
33009             "type": "Float",
33010             "optional": true,
33011             "field": "sNeutral",
33012             "description": ""
33013           },
33014           {
33015             "group": "Body",
33016             "type": "Float",
33017             "optional": true,
33018             "field": "sMixed",
33019             "description": ""
33020           },
33021           {
33022             "group": "Body",
33023             "type": "Boolean",
33024             "optional": true,
33025             "field": "tempSentiment",
33026             "description": ""
33027           },
33028           {
33029             "group": "Body",
33030             "type": "String",
33031             "optional": true,
33032             "field": "createdAt",
33033             "description": ""
33034           },
33035           {
33036             "group": "Body",
33037             "type": "String",
33038             "optional": true,
33039             "field": "updatedAt",
33040             "description": ""
33041           }
33042         ]
33043       }
33044     },
33045     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33046     "version": "0.0.0",
33047     "filename": "server/api/voiceRecording/index.js",
33048     "groupTitle": "Voice_Recordings"
33049   },
33050   {
33051     "type": "get",
33052     "url": "/api/voice/recordings/describe",
33053     "title": "Gets table info about Recordings",
33054     "examples": [
33055       {
33056         "title": "Example usage:",
33057         "content": "curl https://{domain}/api/voice/recordings/describe -v -u {name}:{password}",
33058         "type": "json"
33059       }
33060     ],
33061     "name": "DescribeRecordings",
33062     "group": "Voice_Recordings",
33063     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33064     "version": "0.0.0",
33065     "filename": "server/api/voiceRecording/index.js",
33066     "groupTitle": "Voice_Recordings"
33067   },
33068   {
33069     "type": "get",
33070     "url": "/api/voice/recordings",
33071     "title": "Gets a list of Recordings",
33072     "examples": [
33073       {
33074         "title": "Example usage:",
33075         "content": "curl https://{domain}/api/voice/recordings -v -u {name}:{password}",
33076         "type": "json"
33077       }
33078     ],
33079     "name": "GetRecordings",
33080     "group": "Voice_Recordings",
33081     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33082     "version": "0.0.0",
33083     "filename": "server/api/voiceRecording/index.js",
33084     "groupTitle": "Voice_Recordings"
33085   },
33086   {
33087     "type": "get",
33088     "url": "/api/voice/recordings/{id}",
33089     "title": "Gets a single Recording",
33090     "examples": [
33091       {
33092         "title": "Example usage:",
33093         "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password}",
33094         "type": "json"
33095       }
33096     ],
33097     "name": "ShowRecordings",
33098     "group": "Voice_Recordings",
33099     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33100     "version": "0.0.0",
33101     "filename": "server/api/voiceRecording/index.js",
33102     "groupTitle": "Voice_Recordings"
33103   },
33104   {
33105     "type": "delete",
33106     "url": "/api/voice/recordings/{id}",
33107     "title": "Delete voice recording",
33108     "examples": [
33109       {
33110         "title": "Example usage:",
33111         "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password} -X DELETE",
33112         "type": "json"
33113       }
33114     ],
33115     "name": "destroy",
33116     "group": "Voice_Recordings",
33117     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33118     "version": "0.0.0",
33119     "filename": "server/api/voiceRecording/index.js",
33120     "groupTitle": "Voice_Recordings"
33121   },
33122   {
33123     "type": "get",
33124     "url": "/api/voice/recordings/{id}/download",
33125     "title": "Download Recording",
33126     "examples": [
33127       {
33128         "title": "Example usage:",
33129         "content": "curl https://{domain}/api/voice/recordings/{id}/download -v -u {name}:{password} -X GET",
33130         "type": "json"
33131       }
33132     ],
33133     "name": "download",
33134     "group": "Voice_Recordings",
33135     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33136     "version": "0.0.0",
33137     "filename": "server/api/voiceRecording/index.js",
33138     "groupTitle": "Voice_Recordings"
33139   },
33140   {
33141     "type": "get",
33142     "url": "/api/voice/recordings/{id}/downloads",
33143     "title": "Download Recording",
33144     "examples": [
33145       {
33146         "title": "Example usage:",
33147         "content": "curl https://{domain}/api/voice/recordings/{id}/downloads -v -u {name}:{password} -X GET",
33148         "type": "json"
33149       }
33150     ],
33151     "name": "downloads",
33152     "group": "Voice_Recordings",
33153     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33154     "version": "0.0.0",
33155     "filename": "server/api/voiceRecording/index.js",
33156     "groupTitle": "Voice_Recordings"
33157   },
33158   {
33159     "type": "post",
33160     "url": "/api/voice/recordings/{id}/transcribe",
33161     "title": "Run Transcribe Recording",
33162     "examples": [
33163       {
33164         "title": "Example usage:",
33165         "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -d '{\"runSentiment\": \"true\"}' -v -u {name}:{password} -X POST",
33166         "type": "json"
33167       }
33168     ],
33169     "name": "transcribe",
33170     "group": "Voice_Recordings",
33171     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33172     "version": "0.0.0",
33173     "filename": "server/api/voiceRecording/index.js",
33174     "groupTitle": "Voice_Recordings"
33175   },
33176   {
33177     "type": "get",
33178     "url": "/api/voice/recordings/{id}/transcribe",
33179     "title": "Run Transcribe Recording",
33180     "examples": [
33181       {
33182         "title": "Example usage:",
33183         "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -v -u {name}:{password} -X GET",
33184         "type": "json"
33185       }
33186     ],
33187     "name": "transcribe",
33188     "group": "Voice_Recordings",
33189     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33190     "version": "0.0.0",
33191     "filename": "server/api/voiceRecording/index.js",
33192     "groupTitle": "Voice_Recordings"
33193   },
33194   {
33195     "type": "put",
33196     "url": "/api/voice/recordings/{id}",
33197     "title": "Update an existing Recording",
33198     "examples": [
33199       {
33200         "title": "Example usage:",
33201         "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",
33202         "type": "json"
33203       }
33204     ],
33205     "name": "updateRecordings",
33206     "group": "Voice_Recordings",
33207     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33208     "version": "0.0.0",
33209     "filename": "server/api/voiceRecording/index.js",
33210     "groupTitle": "Voice_Recordings"
33211   },
33212   {
33213     "type": "post",
33214     "url": "/api/voice/transfers/reports",
33215     "title": "Creates a new Transfer Report",
33216     "examples": [
33217       {
33218         "title": "Example usage:",
33219         "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",
33220         "type": "json"
33221       }
33222     ],
33223     "name": "CreateTransfer_Reports",
33224     "group": "Voice_Transfer_Reports",
33225     "parameter": {
33226       "fields": {
33227         "Body": [
33228           {
33229             "group": "Body",
33230             "type": "String",
33231             "allowedValues": [
33232               "\"blind\"",
33233               "\"attended\""
33234             ],
33235             "optional": true,
33236             "field": "type",
33237             "description": ""
33238           },
33239           {
33240             "group": "Body",
33241             "type": "String",
33242             "optional": true,
33243             "field": "result",
33244             "description": ""
33245           },
33246           {
33247             "group": "Body",
33248             "type": "String",
33249             "optional": true,
33250             "field": "transfererchannel",
33251             "description": ""
33252           },
33253           {
33254             "group": "Body",
33255             "type": "String",
33256             "optional": true,
33257             "field": "transferercalleridnum",
33258             "description": ""
33259           },
33260           {
33261             "group": "Body",
33262             "type": "String",
33263             "optional": true,
33264             "field": "transferercalleridname",
33265             "description": ""
33266           },
33267           {
33268             "group": "Body",
33269             "type": "String",
33270             "optional": true,
33271             "field": "transfererconnectedlinenum",
33272             "description": ""
33273           },
33274           {
33275             "group": "Body",
33276             "type": "String",
33277             "optional": true,
33278             "field": "transfererconnectedlinename",
33279             "description": ""
33280           },
33281           {
33282             "group": "Body",
33283             "type": "String",
33284             "optional": true,
33285             "field": "transfereraccountcode",
33286             "description": ""
33287           },
33288           {
33289             "group": "Body",
33290             "type": "String",
33291             "optional": true,
33292             "field": "transferercontext",
33293             "description": ""
33294           },
33295           {
33296             "group": "Body",
33297             "type": "String",
33298             "optional": true,
33299             "field": "transfererexten",
33300             "description": ""
33301           },
33302           {
33303             "group": "Body",
33304             "type": "String",
33305             "optional": true,
33306             "field": "transfererlinkedid",
33307             "description": ""
33308           },
33309           {
33310             "group": "Body",
33311             "type": "String",
33312             "optional": true,
33313             "field": "transfereechannel",
33314             "description": ""
33315           },
33316           {
33317             "group": "Body",
33318             "type": "String",
33319             "optional": true,
33320             "field": "transfereecalleridnum",
33321             "description": ""
33322           },
33323           {
33324             "group": "Body",
33325             "type": "String",
33326             "optional": true,
33327             "field": "transfereecalleridname",
33328             "description": ""
33329           },
33330           {
33331             "group": "Body",
33332             "type": "String",
33333             "optional": true,
33334             "field": "transfereeconnectedlinenum",
33335             "description": ""
33336           },
33337           {
33338             "group": "Body",
33339             "type": "String",
33340             "optional": true,
33341             "field": "transfereeconnectedlinename",
33342             "description": ""
33343           },
33344           {
33345             "group": "Body",
33346             "type": "String",
33347             "optional": true,
33348             "field": "transfereeaccountcode",
33349             "description": ""
33350           },
33351           {
33352             "group": "Body",
33353             "type": "String",
33354             "optional": true,
33355             "field": "transfereecontext",
33356             "description": ""
33357           },
33358           {
33359             "group": "Body",
33360             "type": "String",
33361             "optional": true,
33362             "field": "transfereeexten",
33363             "description": ""
33364           },
33365           {
33366             "group": "Body",
33367             "type": "String",
33368             "optional": true,
33369             "field": "transfereelinkedid",
33370             "description": ""
33371           },
33372           {
33373             "group": "Body",
33374             "type": "String",
33375             "allowedValues": [
33376               "\"Yes\"",
33377               "\"No\""
33378             ],
33379             "optional": true,
33380             "field": "isexternal",
33381             "description": ""
33382           },
33383           {
33384             "group": "Body",
33385             "type": "String",
33386             "optional": true,
33387             "field": "context",
33388             "description": ""
33389           },
33390           {
33391             "group": "Body",
33392             "type": "String",
33393             "optional": true,
33394             "field": "extension",
33395             "description": ""
33396           }
33397         ]
33398       }
33399     },
33400     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33401     "version": "0.0.0",
33402     "filename": "server/api/voiceTransferReport/index.js",
33403     "groupTitle": "Voice_Transfer_Reports"
33404   },
33405   {
33406     "type": "delete",
33407     "url": "/api/voice/transfers/reports/{id}",
33408     "title": "Deletes a Transfer Report",
33409     "examples": [
33410       {
33411         "title": "Example usage:",
33412         "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password} -X DELETE",
33413         "type": "json"
33414       }
33415     ],
33416     "name": "DeleteTransfer_Reports",
33417     "group": "Voice_Transfer_Reports",
33418     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33419     "version": "0.0.0",
33420     "filename": "server/api/voiceTransferReport/index.js",
33421     "groupTitle": "Voice_Transfer_Reports"
33422   },
33423   {
33424     "type": "get",
33425     "url": "/api/voice/transfers/reports/describe",
33426     "title": "Gets table info about Transfer Reports",
33427     "examples": [
33428       {
33429         "title": "Example usage:",
33430         "content": "curl https://{domain}/api/voice/transfers/reports/describe -v -u {name}:{password}",
33431         "type": "json"
33432       }
33433     ],
33434     "name": "DescribeTransfer_Reports",
33435     "group": "Voice_Transfer_Reports",
33436     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33437     "version": "0.0.0",
33438     "filename": "server/api/voiceTransferReport/index.js",
33439     "groupTitle": "Voice_Transfer_Reports"
33440   },
33441   {
33442     "type": "get",
33443     "url": "/api/voice/transfers/reports",
33444     "title": "Gets a list of Transfer Reports",
33445     "examples": [
33446       {
33447         "title": "Example usage:",
33448         "content": "curl https://{domain}/api/voice/transfers/reports -v -u {name}:{password}",
33449         "type": "json"
33450       }
33451     ],
33452     "name": "GetTransfer_Reports",
33453     "group": "Voice_Transfer_Reports",
33454     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33455     "version": "0.0.0",
33456     "filename": "server/api/voiceTransferReport/index.js",
33457     "groupTitle": "Voice_Transfer_Reports"
33458   },
33459   {
33460     "type": "get",
33461     "url": "/api/voice/transfers/reports/{id}",
33462     "title": "Gets a single Transfer Report",
33463     "examples": [
33464       {
33465         "title": "Example usage:",
33466         "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password}",
33467         "type": "json"
33468       }
33469     ],
33470     "name": "ShowTransfer_Reports",
33471     "group": "Voice_Transfer_Reports",
33472     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33473     "version": "0.0.0",
33474     "filename": "server/api/voiceTransferReport/index.js",
33475     "groupTitle": "Voice_Transfer_Reports"
33476   },
33477   {
33478     "type": "put",
33479     "url": "/api/voice/transfers/reports/{id}",
33480     "title": "Update an existing Transfer Report",
33481     "examples": [
33482       {
33483         "title": "Example usage:",
33484         "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",
33485         "type": "json"
33486       }
33487     ],
33488     "name": "updateTransfer_Reports",
33489     "group": "Voice_Transfer_Reports",
33490     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33491     "version": "0.0.0",
33492     "filename": "server/api/voiceTransferReport/index.js",
33493     "groupTitle": "Voice_Transfer_Reports"
33494   },
33495   {
33496     "type": "post",
33497     "url": "/api/integrations/vtiger/accounts",
33498     "title": "Creates a new Vtiger Account",
33499     "examples": [
33500       {
33501         "title": "Example usage:",
33502         "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",
33503         "type": "json"
33504       }
33505     ],
33506     "name": "CreateVtiger_Accounts",
33507     "group": "Vtiger_Accounts",
33508     "parameter": {
33509       "fields": {
33510         "Body": [
33511           {
33512             "group": "Body",
33513             "type": "String",
33514             "optional": false,
33515             "field": "name",
33516             "description": ""
33517           },
33518           {
33519             "group": "Body",
33520             "type": "String",
33521             "optional": true,
33522             "field": "description",
33523             "description": ""
33524           },
33525           {
33526             "group": "Body",
33527             "type": "String",
33528             "optional": false,
33529             "field": "username",
33530             "description": ""
33531           },
33532           {
33533             "group": "Body",
33534             "type": "String",
33535             "optional": false,
33536             "field": "moduleName",
33537             "description": ""
33538           },
33539           {
33540             "group": "Body",
33541             "type": "String",
33542             "optional": false,
33543             "field": "remoteUri",
33544             "description": ""
33545           },
33546           {
33547             "group": "Body",
33548             "type": "String",
33549             "optional": false,
33550             "field": "serverUrl",
33551             "description": ""
33552           },
33553           {
33554             "group": "Body",
33555             "type": "String",
33556             "optional": false,
33557             "field": "accessKey",
33558             "description": ""
33559           }
33560         ]
33561       }
33562     },
33563     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33564     "version": "0.0.0",
33565     "filename": "server/api/intVtigerAccount/index.js",
33566     "groupTitle": "Vtiger_Accounts"
33567   },
33568   {
33569     "type": "delete",
33570     "url": "/api/integrations/vtiger/accounts/{id}",
33571     "title": "Deletes a Vtiger Account",
33572     "examples": [
33573       {
33574         "title": "Example usage:",
33575         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password} -X DELETE",
33576         "type": "json"
33577       }
33578     ],
33579     "name": "DeleteVtiger_Accounts",
33580     "group": "Vtiger_Accounts",
33581     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33582     "version": "0.0.0",
33583     "filename": "server/api/intVtigerAccount/index.js",
33584     "groupTitle": "Vtiger_Accounts"
33585   },
33586   {
33587     "type": "get",
33588     "url": "/api/integrations/vtiger/accounts",
33589     "title": "Gets a list of Vtiger Accounts",
33590     "examples": [
33591       {
33592         "title": "Example usage:",
33593         "content": "curl https://{domain}/api/integrations/vtiger/accounts -v -u {name}:{password}",
33594         "type": "json"
33595       }
33596     ],
33597     "name": "GetVtiger_Accounts",
33598     "group": "Vtiger_Accounts",
33599     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33600     "version": "0.0.0",
33601     "filename": "server/api/intVtigerAccount/index.js",
33602     "groupTitle": "Vtiger_Accounts"
33603   },
33604   {
33605     "type": "get",
33606     "url": "/api/integrations/vtiger/accounts/{id}",
33607     "title": "Gets a single Vtiger Account",
33608     "examples": [
33609       {
33610         "title": "Example usage:",
33611         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password}",
33612         "type": "json"
33613       }
33614     ],
33615     "name": "ShowVtiger_Accounts",
33616     "group": "Vtiger_Accounts",
33617     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33618     "version": "0.0.0",
33619     "filename": "server/api/intVtigerAccount/index.js",
33620     "groupTitle": "Vtiger_Accounts"
33621   },
33622   {
33623     "type": "post",
33624     "url": "/api/integrations/vtiger/accounts/{id}/configurations",
33625     "title": "Creates new configuration",
33626     "examples": [
33627       {
33628         "title": "Example usage:",
33629         "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",
33630         "type": "json"
33631       }
33632     ],
33633     "name": "addConfiguration",
33634     "group": "Vtiger_Accounts",
33635     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33636     "version": "0.0.0",
33637     "filename": "server/api/intVtigerAccount/index.js",
33638     "groupTitle": "Vtiger_Accounts"
33639   },
33640   {
33641     "type": "get",
33642     "url": "/api/integrations/vtiger/accounts/{id}/configurations",
33643     "title": "Gets account configurations",
33644     "examples": [
33645       {
33646         "title": "Example usage:",
33647         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/configurations -v -u {name}:{password} -X GET",
33648         "type": "json"
33649       }
33650     ],
33651     "name": "getConfigurations",
33652     "group": "Vtiger_Accounts",
33653     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33654     "version": "0.0.0",
33655     "filename": "server/api/intVtigerAccount/index.js",
33656     "groupTitle": "Vtiger_Accounts"
33657   },
33658   {
33659     "type": "get",
33660     "url": "/api/integrations/vtiger/accounts/{id}/fields",
33661     "title": "Gets account fields",
33662     "examples": [
33663       {
33664         "title": "Example usage:",
33665         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/fields -v -u {name}:{password} -X GET",
33666         "type": "json"
33667       }
33668     ],
33669     "name": "getFields",
33670     "group": "Vtiger_Accounts",
33671     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33672     "version": "0.0.0",
33673     "filename": "server/api/intVtigerAccount/index.js",
33674     "groupTitle": "Vtiger_Accounts"
33675   },
33676   {
33677     "type": "put",
33678     "url": "/api/integrations/vtiger/accounts/{id}",
33679     "title": "Update an existing Vtiger Account",
33680     "examples": [
33681       {
33682         "title": "Example usage:",
33683         "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",
33684         "type": "json"
33685       }
33686     ],
33687     "name": "updateVtiger_Accounts",
33688     "group": "Vtiger_Accounts",
33689     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33690     "version": "0.0.0",
33691     "filename": "server/api/intVtigerAccount/index.js",
33692     "groupTitle": "Vtiger_Accounts"
33693   },
33694   {
33695     "type": "post",
33696     "url": "/api/integrations/vtiger/configurations",
33697     "title": "Creates a new Vtiger Configuration",
33698     "examples": [
33699       {
33700         "title": "Example usage:",
33701         "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",
33702         "type": "json"
33703       }
33704     ],
33705     "name": "CreateVtiger_Configurations",
33706     "group": "Vtiger_Configurations",
33707     "parameter": {
33708       "fields": {
33709         "Body": [
33710           {
33711             "group": "Body",
33712             "type": "String",
33713             "optional": true,
33714             "field": "name",
33715             "description": ""
33716           },
33717           {
33718             "group": "Body",
33719             "type": "String",
33720             "optional": true,
33721             "field": "description",
33722             "description": ""
33723           }
33724         ]
33725       }
33726     },
33727     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33728     "version": "0.0.0",
33729     "filename": "server/api/intVtigerConfiguration/index.js",
33730     "groupTitle": "Vtiger_Configurations"
33731   },
33732   {
33733     "type": "delete",
33734     "url": "/api/integrations/vtiger/configurations/{id}",
33735     "title": "Deletes a Vtiger Configuration",
33736     "examples": [
33737       {
33738         "title": "Example usage:",
33739         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password} -X DELETE",
33740         "type": "json"
33741       }
33742     ],
33743     "name": "DeleteVtiger_Configurations",
33744     "group": "Vtiger_Configurations",
33745     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33746     "version": "0.0.0",
33747     "filename": "server/api/intVtigerConfiguration/index.js",
33748     "groupTitle": "Vtiger_Configurations"
33749   },
33750   {
33751     "type": "get",
33752     "url": "/api/integrations/vtiger/configurations",
33753     "title": "Gets a list of Vtiger Configurations",
33754     "examples": [
33755       {
33756         "title": "Example usage:",
33757         "content": "curl https://{domain}/api/integrations/vtiger/configurations -v -u {name}:{password}",
33758         "type": "json"
33759       }
33760     ],
33761     "name": "GetVtiger_Configurations",
33762     "group": "Vtiger_Configurations",
33763     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33764     "version": "0.0.0",
33765     "filename": "server/api/intVtigerConfiguration/index.js",
33766     "groupTitle": "Vtiger_Configurations"
33767   },
33768   {
33769     "type": "get",
33770     "url": "/api/integrations/vtiger/configurations/{id}",
33771     "title": "Gets a single Vtiger Configuration",
33772     "examples": [
33773       {
33774         "title": "Example usage:",
33775         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password}",
33776         "type": "json"
33777       }
33778     ],
33779     "name": "ShowVtiger_Configurations",
33780     "group": "Vtiger_Configurations",
33781     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33782     "version": "0.0.0",
33783     "filename": "server/api/intVtigerConfiguration/index.js",
33784     "groupTitle": "Vtiger_Configurations"
33785   },
33786   {
33787     "type": "get",
33788     "url": "/api/integrations/vtiger/configurations/{id}/descriptions",
33789     "title": "Gets configurations descriptions",
33790     "examples": [
33791       {
33792         "title": "Example usage:",
33793         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
33794         "type": "json"
33795       }
33796     ],
33797     "name": "getDescriptions",
33798     "group": "Vtiger_Configurations",
33799     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33800     "version": "0.0.0",
33801     "filename": "server/api/intVtigerConfiguration/index.js",
33802     "groupTitle": "Vtiger_Configurations"
33803   },
33804   {
33805     "type": "get",
33806     "url": "/api/integrations/vtiger/configurations/{id}/fields",
33807     "title": "Gets configurations fields",
33808     "examples": [
33809       {
33810         "title": "Example usage:",
33811         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/fields -v -u {name}:{password} -X GET",
33812         "type": "json"
33813       }
33814     ],
33815     "name": "getFields",
33816     "group": "Vtiger_Configurations",
33817     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33818     "version": "0.0.0",
33819     "filename": "server/api/intVtigerConfiguration/index.js",
33820     "groupTitle": "Vtiger_Configurations"
33821   },
33822   {
33823     "type": "get",
33824     "url": "/api/integrations/vtiger/configurations/{id}/subjects",
33825     "title": "Gets configurations subjects",
33826     "examples": [
33827       {
33828         "title": "Example usage:",
33829         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/subjects -v -u {name}:{password} -X GET",
33830         "type": "json"
33831       }
33832     ],
33833     "name": "getSubjects",
33834     "group": "Vtiger_Configurations",
33835     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33836     "version": "0.0.0",
33837     "filename": "server/api/intVtigerConfiguration/index.js",
33838     "groupTitle": "Vtiger_Configurations"
33839   },
33840   {
33841     "type": "put",
33842     "url": "/api/integrations/vtiger/configurations/{id}",
33843     "title": "Update an existing Vtiger Configuration",
33844     "examples": [
33845       {
33846         "title": "Example usage:",
33847         "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",
33848         "type": "json"
33849       }
33850     ],
33851     "name": "updateVtiger_Configurations",
33852     "group": "Vtiger_Configurations",
33853     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33854     "version": "0.0.0",
33855     "filename": "server/api/intVtigerConfiguration/index.js",
33856     "groupTitle": "Vtiger_Configurations"
33857   },
33858   {
33859     "type": "post",
33860     "url": "/api/integrations/vtiger/fields",
33861     "title": "Creates a new Vtiger Field",
33862     "examples": [
33863       {
33864         "title": "Example usage:",
33865         "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",
33866         "type": "json"
33867       }
33868     ],
33869     "name": "CreateVtiger_Fields",
33870     "group": "Vtiger_Fields",
33871     "parameter": {
33872       "fields": {
33873         "Body": [
33874           {
33875             "group": "Body",
33876             "type": "String",
33877             "allowedValues": [
33878               "\"string\"",
33879               "\"variable\"",
33880               "\"customVariable\"",
33881               "\"keyValue\"",
33882               "\"picklist\""
33883             ],
33884             "optional": true,
33885             "field": "type",
33886             "description": ""
33887           },
33888           {
33889             "group": "Body",
33890             "type": "String",
33891             "optional": true,
33892             "field": "content",
33893             "description": ""
33894           },
33895           {
33896             "group": "Body",
33897             "type": "String",
33898             "optional": true,
33899             "field": "key",
33900             "description": ""
33901           },
33902           {
33903             "group": "Body",
33904             "type": "String",
33905             "allowedValues": [
33906               "\"string\"",
33907               "\"variable\"",
33908               "\"customVariable\""
33909             ],
33910             "optional": true,
33911             "field": "keyType",
33912             "description": ""
33913           },
33914           {
33915             "group": "Body",
33916             "type": "String",
33917             "optional": true,
33918             "field": "keyContent",
33919             "description": ""
33920           },
33921           {
33922             "group": "Body",
33923             "type": "String",
33924             "optional": true,
33925             "field": "idField",
33926             "description": ""
33927           },
33928           {
33929             "group": "Body",
33930             "type": "String",
33931             "optional": true,
33932             "field": "nameField",
33933             "description": ""
33934           },
33935           {
33936             "group": "Body",
33937             "type": "Boolean",
33938             "optional": true,
33939             "field": "customField",
33940             "description": ""
33941           },
33942           {
33943             "group": "Body",
33944             "type": "String",
33945             "optional": true,
33946             "field": "variableName",
33947             "description": ""
33948           }
33949         ]
33950       }
33951     },
33952     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33953     "version": "0.0.0",
33954     "filename": "server/api/intVtigerField/index.js",
33955     "groupTitle": "Vtiger_Fields"
33956   },
33957   {
33958     "type": "delete",
33959     "url": "/api/integrations/vtiger/fields/{id}",
33960     "title": "Deletes a Vtiger Field",
33961     "examples": [
33962       {
33963         "title": "Example usage:",
33964         "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password} -X DELETE",
33965         "type": "json"
33966       }
33967     ],
33968     "name": "DeleteVtiger_Fields",
33969     "group": "Vtiger_Fields",
33970     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33971     "version": "0.0.0",
33972     "filename": "server/api/intVtigerField/index.js",
33973     "groupTitle": "Vtiger_Fields"
33974   },
33975   {
33976     "type": "get",
33977     "url": "/api/integrations/vtiger/fields",
33978     "title": "Gets a list of Vtiger Fields",
33979     "examples": [
33980       {
33981         "title": "Example usage:",
33982         "content": "curl https://{domain}/api/integrations/vtiger/fields -v -u {name}:{password}",
33983         "type": "json"
33984       }
33985     ],
33986     "name": "GetVtiger_Fields",
33987     "group": "Vtiger_Fields",
33988     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33989     "version": "0.0.0",
33990     "filename": "server/api/intVtigerField/index.js",
33991     "groupTitle": "Vtiger_Fields"
33992   },
33993   {
33994     "type": "get",
33995     "url": "/api/integrations/vtiger/fields/{id}",
33996     "title": "Gets a single Vtiger Field",
33997     "examples": [
33998       {
33999         "title": "Example usage:",
34000         "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password}",
34001         "type": "json"
34002       }
34003     ],
34004     "name": "ShowVtiger_Fields",
34005     "group": "Vtiger_Fields",
34006     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34007     "version": "0.0.0",
34008     "filename": "server/api/intVtigerField/index.js",
34009     "groupTitle": "Vtiger_Fields"
34010   },
34011   {
34012     "type": "put",
34013     "url": "/api/integrations/vtiger/fields/{id}",
34014     "title": "Update an existing Vtiger Field",
34015     "examples": [
34016       {
34017         "title": "Example usage:",
34018         "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",
34019         "type": "json"
34020       }
34021     ],
34022     "name": "updateVtiger_Fields",
34023     "group": "Vtiger_Fields",
34024     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34025     "version": "0.0.0",
34026     "filename": "server/api/intVtigerField/index.js",
34027     "groupTitle": "Vtiger_Fields"
34028   },
34029   {
34030     "type": "post",
34031     "url": "/api/webbar/answer",
34032     "title": "answer webrtc call",
34033     "examples": [
34034       {
34035         "title": "Example usage:",
34036         "content": "curl https://{domain}/api/webbar/answer -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34037         "type": "json"
34038       }
34039     ],
34040     "name": "Web_Bar_answer",
34041     "group": "WebBar",
34042     "parameter": {
34043       "fields": {
34044         "Body": [
34045           {
34046             "group": "Body",
34047             "type": "String",
34048             "optional": false,
34049             "field": "sessionId",
34050             "description": ""
34051           },
34052           {
34053             "group": "Body",
34054             "type": "number",
34055             "optional": false,
34056             "field": "userId",
34057             "description": ""
34058           }
34059         ]
34060       }
34061     },
34062     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34063     "version": "0.0.0",
34064     "filename": "server/api/webbar/index.js",
34065     "groupTitle": "WebBar"
34066   },
34067   {
34068     "type": "post",
34069     "url": "/api/webbar/calls",
34070     "title": "webrtc call list",
34071     "examples": [
34072       {
34073         "title": "Example usage:",
34074         "content": "curl https://{domain}/api/webbar/calls -d '{\"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34075         "type": "json"
34076       }
34077     ],
34078     "name": "Web_Bar_calls",
34079     "group": "WebBar",
34080     "parameter": {
34081       "fields": {
34082         "Body": [
34083           {
34084             "group": "Body",
34085             "type": "number",
34086             "optional": false,
34087             "field": "userId",
34088             "description": ""
34089           }
34090         ]
34091       }
34092     },
34093     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34094     "version": "0.0.0",
34095     "filename": "server/api/webbar/index.js",
34096     "groupTitle": "WebBar"
34097   },
34098   {
34099     "type": "post",
34100     "url": "/api/webbar/hangup",
34101     "title": "hangup webrtc call",
34102     "examples": [
34103       {
34104         "title": "Example usage:",
34105         "content": "curl https://{domain}/api/webbar/hangup -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34106         "type": "json"
34107       }
34108     ],
34109     "name": "Web_Bar_hangup",
34110     "group": "WebBar",
34111     "parameter": {
34112       "fields": {
34113         "Body": [
34114           {
34115             "group": "Body",
34116             "type": "String",
34117             "optional": false,
34118             "field": "sessionId",
34119             "description": ""
34120           },
34121           {
34122             "group": "Body",
34123             "type": "number",
34124             "optional": false,
34125             "field": "userId",
34126             "description": ""
34127           }
34128         ]
34129       }
34130     },
34131     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34132     "version": "0.0.0",
34133     "filename": "server/api/webbar/index.js",
34134     "groupTitle": "WebBar"
34135   },
34136   {
34137     "type": "post",
34138     "url": "/api/webbar/hold",
34139     "title": "hold webrtc call",
34140     "examples": [
34141       {
34142         "title": "Example usage:",
34143         "content": "curl https://{domain}/api/webbar/hold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34144         "type": "json"
34145       }
34146     ],
34147     "name": "Web_Bar_hold",
34148     "group": "WebBar",
34149     "parameter": {
34150       "fields": {
34151         "Body": [
34152           {
34153             "group": "Body",
34154             "type": "String",
34155             "optional": true,
34156             "field": "sessionId",
34157             "description": ""
34158           },
34159           {
34160             "group": "Body",
34161             "type": "number",
34162             "optional": false,
34163             "field": "userId",
34164             "description": ""
34165           }
34166         ]
34167       }
34168     },
34169     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34170     "version": "0.0.0",
34171     "filename": "server/api/webbar/index.js",
34172     "groupTitle": "WebBar"
34173   },
34174   {
34175     "type": "post",
34176     "url": "/api/webbar/unhold",
34177     "title": "unhold webrtc call",
34178     "examples": [
34179       {
34180         "title": "Example usage:",
34181         "content": "curl https://{domain}/api/webbar/unhold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34182         "type": "json"
34183       }
34184     ],
34185     "name": "Web_Bar_hold",
34186     "group": "WebBar",
34187     "parameter": {
34188       "fields": {
34189         "Body": [
34190           {
34191             "group": "Body",
34192             "type": "String",
34193             "optional": false,
34194             "field": "sessionId",
34195             "description": ""
34196           },
34197           {
34198             "group": "Body",
34199             "type": "number",
34200             "optional": false,
34201             "field": "userId",
34202             "description": ""
34203           }
34204         ]
34205       }
34206     },
34207     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34208     "version": "0.0.0",
34209     "filename": "server/api/webbar/index.js",
34210     "groupTitle": "WebBar"
34211   },
34212   {
34213     "type": "post",
34214     "url": "/api/webbar/originate",
34215     "title": "Originate new webrtc call",
34216     "examples": [
34217       {
34218         "title": "Example usage:",
34219         "content": "curl https://{domain}/api/webbar/originate -d '{\"callNumber\": \"0119692844\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34220         "type": "json"
34221       }
34222     ],
34223     "name": "Web_Bar_originate",
34224     "group": "WebBar",
34225     "parameter": {
34226       "fields": {
34227         "Body": [
34228           {
34229             "group": "Body",
34230             "type": "String",
34231             "optional": false,
34232             "field": "callNumber",
34233             "description": ""
34234           },
34235           {
34236             "group": "Body",
34237             "type": "number",
34238             "optional": false,
34239             "field": "userId",
34240             "description": ""
34241           },
34242           {
34243             "group": "Body",
34244             "type": "String",
34245             "optional": false,
34246             "field": "callerId",
34247             "description": ""
34248           },
34249           {
34250             "group": "Body",
34251             "type": "String",
34252             "optional": false,
34253             "field": "callbackUrl",
34254             "description": ""
34255           }
34256         ]
34257       }
34258     },
34259     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34260     "version": "0.0.0",
34261     "filename": "server/api/webbar/index.js",
34262     "groupTitle": "WebBar"
34263   },
34264   {
34265     "type": "post",
34266     "url": "/api/webbar/transfer",
34267     "title": "blind transfer webrtc call",
34268     "examples": [
34269       {
34270         "title": "Example usage:",
34271         "content": "curl https://{domain}/api/webbar/transfer -d '{\"userId\": 54, \"sessionId\":\"<sessionId>\", \"transferNumber\":\"<transferNumber>\"}' \\\n -H \"Content-Type: application/json\" -X POST",
34272         "type": "json"
34273       }
34274     ],
34275     "name": "Web_Bar_transfer",
34276     "group": "WebBar",
34277     "parameter": {
34278       "fields": {
34279         "Body": [
34280           {
34281             "group": "Body",
34282             "type": "number",
34283             "optional": false,
34284             "field": "userId",
34285             "description": ""
34286           },
34287           {
34288             "group": "Body",
34289             "type": "string",
34290             "optional": false,
34291             "field": "sessionId",
34292             "description": ""
34293           },
34294           {
34295             "group": "Body",
34296             "type": "string",
34297             "optional": false,
34298             "field": "transferNumber",
34299             "description": ""
34300           }
34301         ]
34302       }
34303     },
34304     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34305     "version": "0.0.0",
34306     "filename": "server/api/webbar/index.js",
34307     "groupTitle": "WebBar"
34308   },
34309   {
34310     "type": "post",
34311     "url": "/api/whatsapp/accounts/{id}/users",
34312     "title": "Add agents to a whatsapp account",
34313     "examples": [
34314       {
34315         "title": "Example usage:",
34316         "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",
34317         "type": "json"
34318       }
34319     ],
34320     "name": "AddAgents",
34321     "group": "Whatsapp_Accounts",
34322     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34323     "version": "0.0.0",
34324     "filename": "server/api/whatsappAccount/index.js",
34325     "groupTitle": "Whatsapp_Accounts"
34326   },
34327   {
34328     "type": "post",
34329     "url": "/api/whatsapp/accounts",
34330     "title": "Creates a new Account",
34331     "examples": [
34332       {
34333         "title": "Example usage:",
34334         "content": "curl https://{domain}/api/whatsapp/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
34335         "type": "json"
34336       }
34337     ],
34338     "name": "CreateAccounts",
34339     "group": "Whatsapp_Accounts",
34340     "parameter": {
34341       "fields": {
34342         "Body": [
34343           {
34344             "group": "Body",
34345             "type": "String",
34346             "optional": false,
34347             "field": "name",
34348             "description": ""
34349           },
34350           {
34351             "group": "Body",
34352             "type": "String",
34353             "optional": false,
34354             "field": "key",
34355             "description": ""
34356           },
34357           {
34358             "group": "Body",
34359             "type": "String",
34360             "optional": false,
34361             "field": "remote",
34362             "description": ""
34363           },
34364           {
34365             "group": "Body",
34366             "type": "String",
34367             "optional": true,
34368             "field": "token",
34369             "description": ""
34370           },
34371           {
34372             "group": "Body",
34373             "type": "String",
34374             "optional": true,
34375             "field": "phone",
34376             "description": ""
34377           },
34378           {
34379             "group": "Body",
34380             "type": "String",
34381             "allowedValues": [
34382               "\"twilio\""
34383             ],
34384             "optional": true,
34385             "field": "type",
34386             "description": ""
34387           },
34388           {
34389             "group": "Body",
34390             "type": "String",
34391             "optional": true,
34392             "field": "accountSid",
34393             "description": ""
34394           },
34395           {
34396             "group": "Body",
34397             "type": "String",
34398             "optional": true,
34399             "field": "authToken",
34400             "description": ""
34401           },
34402           {
34403             "group": "Body",
34404             "type": "Text",
34405             "optional": true,
34406             "field": "notificationTemplate",
34407             "description": ""
34408           },
34409           {
34410             "group": "Body",
34411             "type": "Boolean",
34412             "optional": true,
34413             "field": "notificationSound",
34414             "description": ""
34415           },
34416           {
34417             "group": "Body",
34418             "type": "Boolean",
34419             "optional": true,
34420             "field": "notificationShake",
34421             "description": ""
34422           },
34423           {
34424             "group": "Body",
34425             "type": "Integer",
34426             "optional": true,
34427             "field": "waitForTheAssignedAgent",
34428             "description": ""
34429           },
34430           {
34431             "group": "Body",
34432             "type": "Boolean",
34433             "optional": true,
34434             "field": "queueTransfer",
34435             "description": ""
34436           },
34437           {
34438             "group": "Body",
34439             "type": "Integer",
34440             "optional": true,
34441             "field": "queueTransferTimeout",
34442             "description": ""
34443           },
34444           {
34445             "group": "Body",
34446             "type": "Boolean",
34447             "optional": true,
34448             "field": "agentTransfer",
34449             "description": ""
34450           },
34451           {
34452             "group": "Body",
34453             "type": "Integer",
34454             "optional": true,
34455             "field": "agentTransferTimeout",
34456             "description": ""
34457           },
34458           {
34459             "group": "Body",
34460             "type": "Integer",
34461             "optional": true,
34462             "field": "mandatoryDispositionPauseId",
34463             "description": "<p>Status to put when mandatory disposition is enabled</p>"
34464           },
34465           {
34466             "group": "Body",
34467             "type": "Boolean",
34468             "optional": true,
34469             "field": "mandatoryDisposition",
34470             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
34471           },
34472           {
34473             "group": "Body",
34474             "type": "String",
34475             "optional": true,
34476             "field": "description",
34477             "description": ""
34478           }
34479         ]
34480       }
34481     },
34482     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34483     "version": "0.0.0",
34484     "filename": "server/api/whatsappAccount/index.js",
34485     "groupTitle": "Whatsapp_Accounts"
34486   },
34487   {
34488     "type": "delete",
34489     "url": "/api/whatsapp/accounts/{id}",
34490     "title": "Deletes a Account",
34491     "examples": [
34492       {
34493         "title": "Example usage:",
34494         "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password} -X DELETE",
34495         "type": "json"
34496       }
34497     ],
34498     "name": "DeleteAccounts",
34499     "group": "Whatsapp_Accounts",
34500     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34501     "version": "0.0.0",
34502     "filename": "server/api/whatsappAccount/index.js",
34503     "groupTitle": "Whatsapp_Accounts"
34504   },
34505   {
34506     "type": "get",
34507     "url": "/api/whatsapp/accounts/describe",
34508     "title": "Gets table info about Accounts",
34509     "examples": [
34510       {
34511         "title": "Example usage:",
34512         "content": "curl https://{domain}/api/whatsapp/accounts/describe -v -u {name}:{password}",
34513         "type": "json"
34514       }
34515     ],
34516     "name": "DescribeAccounts",
34517     "group": "Whatsapp_Accounts",
34518     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34519     "version": "0.0.0",
34520     "filename": "server/api/whatsappAccount/index.js",
34521     "groupTitle": "Whatsapp_Accounts"
34522   },
34523   {
34524     "type": "get",
34525     "url": "/api/whatsapp/accounts",
34526     "title": "Gets a list of Accounts",
34527     "examples": [
34528       {
34529         "title": "Example usage:",
34530         "content": "curl https://{domain}/api/whatsapp/accounts -v -u {name}:{password}",
34531         "type": "json"
34532       }
34533     ],
34534     "name": "GetAccounts",
34535     "group": "Whatsapp_Accounts",
34536     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34537     "version": "0.0.0",
34538     "filename": "server/api/whatsappAccount/index.js",
34539     "groupTitle": "Whatsapp_Accounts"
34540   },
34541   {
34542     "type": "get",
34543     "url": "/api/whatsapp/accounts/{id}/users",
34544     "title": "Gets agents from whatsapp account",
34545     "examples": [
34546       {
34547         "title": "Example usage:",
34548         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users -v -u {name}:{password} -X GET",
34549         "type": "json"
34550       }
34551     ],
34552     "name": "GetAgents",
34553     "group": "Whatsapp_Accounts",
34554     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34555     "version": "0.0.0",
34556     "filename": "server/api/whatsappAccount/index.js",
34557     "groupTitle": "Whatsapp_Accounts"
34558   },
34559   {
34560     "type": "delete",
34561     "url": "/api/whatsapp/accounts/{id}/users",
34562     "title": "Removes agents from a whatsapp account",
34563     "examples": [
34564       {
34565         "title": "Example usage:",
34566         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
34567         "type": "json"
34568       }
34569     ],
34570     "name": "RemoveAgents",
34571     "group": "Whatsapp_Accounts",
34572     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34573     "version": "0.0.0",
34574     "filename": "server/api/whatsappAccount/index.js",
34575     "groupTitle": "Whatsapp_Accounts"
34576   },
34577   {
34578     "type": "delete",
34579     "url": "/api/whatsapp/accounts/{id}/canned_answers",
34580     "title": "Removes canned answers from account",
34581     "examples": [
34582       {
34583         "title": "Example usage:",
34584         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
34585         "type": "json"
34586       }
34587     ],
34588     "name": "RemoveAnswers",
34589     "group": "Whatsapp_Accounts",
34590     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34591     "version": "0.0.0",
34592     "filename": "server/api/whatsappAccount/index.js",
34593     "groupTitle": "Whatsapp_Accounts"
34594   },
34595   {
34596     "type": "delete",
34597     "url": "/api/whatsapp/accounts/{id}/dispositions",
34598     "title": "Removes dispositions from account",
34599     "examples": [
34600       {
34601         "title": "Example usage:",
34602         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
34603         "type": "json"
34604       }
34605     ],
34606     "name": "RemoveDispositions",
34607     "group": "Whatsapp_Accounts",
34608     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34609     "version": "0.0.0",
34610     "filename": "server/api/whatsappAccount/index.js",
34611     "groupTitle": "Whatsapp_Accounts"
34612   },
34613   {
34614     "type": "get",
34615     "url": "/api/whatsapp/accounts/{id}",
34616     "title": "Gets a single Account",
34617     "examples": [
34618       {
34619         "title": "Example usage:",
34620         "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password}",
34621         "type": "json"
34622       }
34623     ],
34624     "name": "ShowAccounts",
34625     "group": "Whatsapp_Accounts",
34626     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34627     "version": "0.0.0",
34628     "filename": "server/api/whatsappAccount/index.js",
34629     "groupTitle": "Whatsapp_Accounts"
34630   },
34631   {
34632     "type": "put",
34633     "url": "/api/whatsapp/messages/{id}/accept",
34634     "title": "Accepts message",
34635     "examples": [
34636       {
34637         "title": "Example usage:",
34638         "content": "curl https://{domain}/api/whatsapp/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
34639         "type": "json"
34640       }
34641     ],
34642     "name": "acceptMessage",
34643     "group": "Whatsapp_Accounts",
34644     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34645     "version": "0.0.0",
34646     "filename": "server/api/whatsappMessage/index.js",
34647     "groupTitle": "Whatsapp_Accounts"
34648   },
34649   {
34650     "type": "post",
34651     "url": "/api/whatsapp/accounts/{id}/canned_answers",
34652     "title": "Creates new canned answer",
34653     "examples": [
34654       {
34655         "title": "Example usage:",
34656         "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",
34657         "type": "json"
34658       }
34659     ],
34660     "name": "addAnswer",
34661     "group": "Whatsapp_Accounts",
34662     "parameter": {
34663       "fields": {
34664         "Body": [
34665           {
34666             "group": "Body",
34667             "type": "String",
34668             "optional": false,
34669             "field": "key",
34670             "description": ""
34671           },
34672           {
34673             "group": "Body",
34674             "type": "Text",
34675             "optional": false,
34676             "field": "value",
34677             "description": ""
34678           },
34679           {
34680             "group": "Body",
34681             "type": "String",
34682             "optional": true,
34683             "field": "description",
34684             "description": ""
34685           },
34686           {
34687             "group": "Body",
34688             "type": "Virtual",
34689             "optional": true,
34690             "field": "name",
34691             "description": ""
34692           }
34693         ]
34694       }
34695     },
34696     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34697     "version": "0.0.0",
34698     "filename": "server/api/whatsappAccount/index.js",
34699     "groupTitle": "Whatsapp_Accounts"
34700   },
34701   {
34702     "type": "post",
34703     "url": "/api/whatsapp/accounts/{id}/applications",
34704     "title": "Creates new applications",
34705     "examples": [
34706       {
34707         "title": "Example usage:",
34708         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
34709         "type": "json"
34710       }
34711     ],
34712     "name": "addApplications",
34713     "group": "Whatsapp_Accounts",
34714     "parameter": {
34715       "fields": {
34716         "Body": [
34717           {
34718             "group": "Body",
34719             "type": "Integer",
34720             "optional": false,
34721             "field": "priority",
34722             "description": ""
34723           },
34724           {
34725             "group": "Body",
34726             "type": "String",
34727             "optional": false,
34728             "field": "app",
34729             "description": ""
34730           },
34731           {
34732             "group": "Body",
34733             "type": "Text",
34734             "optional": true,
34735             "field": "appdata",
34736             "description": ""
34737           },
34738           {
34739             "group": "Body",
34740             "type": "String",
34741             "optional": true,
34742             "field": "description",
34743             "description": ""
34744           },
34745           {
34746             "group": "Body",
34747             "type": "String",
34748             "optional": true,
34749             "field": "interval",
34750             "description": ""
34751           }
34752         ]
34753       }
34754     },
34755     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34756     "version": "0.0.0",
34757     "filename": "server/api/whatsappAccount/index.js",
34758     "groupTitle": "Whatsapp_Accounts"
34759   },
34760   {
34761     "type": "post",
34762     "url": "/api/whatsapp/accounts/{id}/dispositions",
34763     "title": "Creates new disposition",
34764     "examples": [
34765       {
34766         "title": "Example usage:",
34767         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
34768         "type": "json"
34769       }
34770     ],
34771     "name": "addDisposition",
34772     "group": "Whatsapp_Accounts",
34773     "parameter": {
34774       "fields": {
34775         "Body": [
34776           {
34777             "group": "Body",
34778             "type": "String",
34779             "optional": false,
34780             "field": "name",
34781             "description": ""
34782           },
34783           {
34784             "group": "Body",
34785             "type": "String",
34786             "allowedValues": [
34787               "\"first\"",
34788               "\"second\"",
34789               "\"third\""
34790             ],
34791             "optional": false,
34792             "field": "level",
34793             "description": ""
34794           },
34795           {
34796             "group": "Body",
34797             "type": "String",
34798             "optional": true,
34799             "field": "description",
34800             "description": ""
34801           }
34802         ]
34803       }
34804     },
34805     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34806     "version": "0.0.0",
34807     "filename": "server/api/whatsappAccount/index.js",
34808     "groupTitle": "Whatsapp_Accounts"
34809   },
34810   {
34811     "type": "get",
34812     "url": "/api/whatsapp/accounts/{id}/canned_answers",
34813     "title": "Gets account canned answers",
34814     "examples": [
34815       {
34816         "title": "Example usage:",
34817         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
34818         "type": "json"
34819       }
34820     ],
34821     "name": "getAnswers",
34822     "group": "Whatsapp_Accounts",
34823     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34824     "version": "0.0.0",
34825     "filename": "server/api/whatsappAccount/index.js",
34826     "groupTitle": "Whatsapp_Accounts"
34827   },
34828   {
34829     "type": "get",
34830     "url": "/api/whatsapp/accounts/{id}/applications",
34831     "title": "Gets account applications",
34832     "examples": [
34833       {
34834         "title": "Example usage:",
34835         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -v -u {name}:{password} -X GET",
34836         "type": "json"
34837       }
34838     ],
34839     "name": "getApplications",
34840     "group": "Whatsapp_Accounts",
34841     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34842     "version": "0.0.0",
34843     "filename": "server/api/whatsappAccount/index.js",
34844     "groupTitle": "Whatsapp_Accounts"
34845   },
34846   {
34847     "type": "get",
34848     "url": "/api/whatsapp/accounts/{id}/dispositions",
34849     "title": "Gets account dispositions",
34850     "examples": [
34851       {
34852         "title": "Example usage:",
34853         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
34854         "type": "json"
34855       }
34856     ],
34857     "name": "getDispositions",
34858     "group": "Whatsapp_Accounts",
34859     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34860     "version": "0.0.0",
34861     "filename": "server/api/whatsappAccount/index.js",
34862     "groupTitle": "Whatsapp_Accounts"
34863   },
34864   {
34865     "type": "post",
34866     "url": "/api/whatsapp/accounts/{id}/notify",
34867     "title": "Notify new message",
34868     "examples": [
34869       {
34870         "title": "Example usage:",
34871         "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",
34872         "type": "json"
34873       }
34874     ],
34875     "name": "notify",
34876     "group": "Whatsapp_Accounts",
34877     "description": "<p>Motion 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>",
34878     "version": "0.0.0",
34879     "filename": "server/api/whatsappAccount/index.js",
34880     "groupTitle": "Whatsapp_Accounts"
34881   },
34882   {
34883     "type": "put",
34884     "url": "/api/whatsapp/messages/{id}/reject",
34885     "title": "Rejects message",
34886     "examples": [
34887       {
34888         "title": "Example usage:",
34889         "content": "curl https://{domain}/api/whatsapp/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
34890         "type": "json"
34891       }
34892     ],
34893     "name": "rejectMessage",
34894     "group": "Whatsapp_Accounts",
34895     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34896     "version": "0.0.0",
34897     "filename": "server/api/whatsappMessage/index.js",
34898     "groupTitle": "Whatsapp_Accounts"
34899   },
34900   {
34901     "type": "post",
34902     "url": "/api/whatsapp/accounts/{id}/send",
34903     "title": "Send new whatsapp message",
34904     "examples": [
34905       {
34906         "title": "Example usage:",
34907         "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",
34908         "type": "json"
34909       }
34910     ],
34911     "name": "sendWhatsapp",
34912     "group": "Whatsapp_Accounts",
34913     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34914     "version": "0.0.0",
34915     "filename": "server/api/whatsappAccount/index.js",
34916     "groupTitle": "Whatsapp_Accounts"
34917   },
34918   {
34919     "type": "post",
34920     "url": "/api/whatsapp/messages/{id}/status",
34921     "title": "Receive message status",
34922     "examples": [
34923       {
34924         "title": "Example usage:",
34925         "content": "curl https://{domain}/api/whatsapp/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
34926         "type": "json"
34927       }
34928     ],
34929     "name": "statusMessage",
34930     "group": "Whatsapp_Accounts",
34931     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34932     "version": "0.0.0",
34933     "filename": "server/api/whatsappMessage/index.js",
34934     "groupTitle": "Whatsapp_Accounts"
34935   },
34936   {
34937     "type": "put",
34938     "url": "/api/whatsapp/accounts/{id}",
34939     "title": "Update an existing Account",
34940     "examples": [
34941       {
34942         "title": "Example usage:",
34943         "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",
34944         "type": "json"
34945       }
34946     ],
34947     "name": "updateAccounts",
34948     "group": "Whatsapp_Accounts",
34949     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34950     "version": "0.0.0",
34951     "filename": "server/api/whatsappAccount/index.js",
34952     "groupTitle": "Whatsapp_Accounts"
34953   },
34954   {
34955     "type": "post",
34956     "url": "/api/whatsapp/applications",
34957     "title": "Creates a new Application",
34958     "examples": [
34959       {
34960         "title": "Example usage:",
34961         "content": "curl https://{domain}/api/whatsapp/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
34962         "type": "json"
34963       }
34964     ],
34965     "name": "CreateApplications",
34966     "group": "Whatsapp_Applications",
34967     "parameter": {
34968       "fields": {
34969         "Body": [
34970           {
34971             "group": "Body",
34972             "type": "Integer",
34973             "optional": false,
34974             "field": "priority",
34975             "description": ""
34976           },
34977           {
34978             "group": "Body",
34979             "type": "String",
34980             "optional": false,
34981             "field": "app",
34982             "description": ""
34983           },
34984           {
34985             "group": "Body",
34986             "type": "Text",
34987             "optional": true,
34988             "field": "appdata",
34989             "description": ""
34990           },
34991           {
34992             "group": "Body",
34993             "type": "String",
34994             "optional": true,
34995             "field": "description",
34996             "description": ""
34997           },
34998           {
34999             "group": "Body",
35000             "type": "String",
35001             "optional": true,
35002             "field": "interval",
35003             "description": ""
35004           }
35005         ]
35006       }
35007     },
35008     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35009     "version": "0.0.0",
35010     "filename": "server/api/whatsappApplication/index.js",
35011     "groupTitle": "Whatsapp_Applications"
35012   },
35013   {
35014     "type": "delete",
35015     "url": "/api/whatsapp/applications/{id}",
35016     "title": "Deletes a Application",
35017     "examples": [
35018       {
35019         "title": "Example usage:",
35020         "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password} -X DELETE",
35021         "type": "json"
35022       }
35023     ],
35024     "name": "DeleteApplications",
35025     "group": "Whatsapp_Applications",
35026     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35027     "version": "0.0.0",
35028     "filename": "server/api/whatsappApplication/index.js",
35029     "groupTitle": "Whatsapp_Applications"
35030   },
35031   {
35032     "type": "get",
35033     "url": "/api/whatsapp/applications",
35034     "title": "Gets a list of Applications",
35035     "examples": [
35036       {
35037         "title": "Example usage:",
35038         "content": "curl https://{domain}/api/whatsapp/applications -v -u {name}:{password}",
35039         "type": "json"
35040       }
35041     ],
35042     "name": "GetApplications",
35043     "group": "Whatsapp_Applications",
35044     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35045     "version": "0.0.0",
35046     "filename": "server/api/whatsappApplication/index.js",
35047     "groupTitle": "Whatsapp_Applications"
35048   },
35049   {
35050     "type": "get",
35051     "url": "/api/whatsapp/applications/{id}",
35052     "title": "Gets a single Application",
35053     "examples": [
35054       {
35055         "title": "Example usage:",
35056         "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password}",
35057         "type": "json"
35058       }
35059     ],
35060     "name": "ShowApplications",
35061     "group": "Whatsapp_Applications",
35062     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35063     "version": "0.0.0",
35064     "filename": "server/api/whatsappApplication/index.js",
35065     "groupTitle": "Whatsapp_Applications"
35066   },
35067   {
35068     "type": "put",
35069     "url": "/api/whatsapp/applications/{id}",
35070     "title": "Update an existing Application",
35071     "examples": [
35072       {
35073         "title": "Example usage:",
35074         "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",
35075         "type": "json"
35076       }
35077     ],
35078     "name": "updateApplications",
35079     "group": "Whatsapp_Applications",
35080     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35081     "version": "0.0.0",
35082     "filename": "server/api/whatsappApplication/index.js",
35083     "groupTitle": "Whatsapp_Applications"
35084   },
35085   {
35086     "type": "post",
35087     "url": "/api/whatsapp/interactions/{id}/tags",
35088     "title": "Add tags to the interaction",
35089     "examples": [
35090       {
35091         "title": "Example usage:",
35092         "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",
35093         "type": "json"
35094       }
35095     ],
35096     "name": "AddTags",
35097     "group": "Whatsapp_Interactions",
35098     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35099     "version": "0.0.0",
35100     "filename": "server/api/whatsappInteraction/index.js",
35101     "groupTitle": "Whatsapp_Interactions"
35102   },
35103   {
35104     "type": "post",
35105     "url": "/api/whatsapp/interactions",
35106     "title": "Creates a new Interaction",
35107     "examples": [
35108       {
35109         "title": "Example usage:",
35110         "content": "curl https://{domain}/api/whatsapp/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35111         "type": "json"
35112       }
35113     ],
35114     "name": "CreateInteractions",
35115     "group": "Whatsapp_Interactions",
35116     "parameter": {
35117       "fields": {
35118         "Body": [
35119           {
35120             "group": "Body",
35121             "type": "Boolean",
35122             "optional": true,
35123             "field": "closed",
35124             "description": ""
35125           },
35126           {
35127             "group": "Body",
35128             "type": "String",
35129             "optional": true,
35130             "field": "closedAt",
35131             "description": ""
35132           },
35133           {
35134             "group": "Body",
35135             "type": "String",
35136             "optional": true,
35137             "field": "disposition",
35138             "description": ""
35139           },
35140           {
35141             "group": "Body",
35142             "type": "String",
35143             "optional": true,
35144             "field": "secondDisposition",
35145             "description": ""
35146           },
35147           {
35148             "group": "Body",
35149             "type": "String",
35150             "optional": true,
35151             "field": "thirdDisposition",
35152             "description": ""
35153           },
35154           {
35155             "group": "Body",
35156             "type": "String",
35157             "optional": true,
35158             "field": "note",
35159             "description": ""
35160           },
35161           {
35162             "group": "Body",
35163             "type": "String",
35164             "optional": true,
35165             "field": "phone",
35166             "description": ""
35167           },
35168           {
35169             "group": "Body",
35170             "type": "String",
35171             "optional": true,
35172             "field": "read1stAt",
35173             "description": ""
35174           },
35175           {
35176             "group": "Body",
35177             "type": "String",
35178             "allowedValues": [
35179               "\"in\"",
35180               "\"out\""
35181             ],
35182             "optional": false,
35183             "field": "firstMsgDirection",
35184             "description": ""
35185           },
35186           {
35187             "group": "Body",
35188             "type": "String",
35189             "optional": true,
35190             "field": "lastMsgAt",
35191             "description": ""
35192           },
35193           {
35194             "group": "Body",
35195             "type": "String",
35196             "allowedValues": [
35197               "\"in\"",
35198               "\"out\""
35199             ],
35200             "optional": false,
35201             "field": "lastMsgDirection",
35202             "description": ""
35203           }
35204         ]
35205       }
35206     },
35207     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35208     "version": "0.0.0",
35209     "filename": "server/api/whatsappInteraction/index.js",
35210     "groupTitle": "Whatsapp_Interactions"
35211   },
35212   {
35213     "type": "delete",
35214     "url": "/api/whatsapp/interactions/{id}",
35215     "title": "Deletes a Interaction",
35216     "examples": [
35217       {
35218         "title": "Example usage:",
35219         "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password} -X DELETE",
35220         "type": "json"
35221       }
35222     ],
35223     "name": "DeleteInteractions",
35224     "group": "Whatsapp_Interactions",
35225     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35226     "version": "0.0.0",
35227     "filename": "server/api/whatsappInteraction/index.js",
35228     "groupTitle": "Whatsapp_Interactions"
35229   },
35230   {
35231     "type": "get",
35232     "url": "/api/whatsapp/interactions/describe",
35233     "title": "Gets table info about Interactions",
35234     "examples": [
35235       {
35236         "title": "Example usage:",
35237         "content": "curl https://{domain}/api/whatsapp/interactions/describe -v -u {name}:{password}",
35238         "type": "json"
35239       }
35240     ],
35241     "name": "DescribeInteractions",
35242     "group": "Whatsapp_Interactions",
35243     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35244     "version": "0.0.0",
35245     "filename": "server/api/whatsappInteraction/index.js",
35246     "groupTitle": "Whatsapp_Interactions"
35247   },
35248   {
35249     "type": "get",
35250     "url": "/api/whatsapp/interactions",
35251     "title": "Gets a list of Interactions",
35252     "examples": [
35253       {
35254         "title": "Example usage:",
35255         "content": "curl https://{domain}/api/whatsapp/interactions -v -u {name}:{password}",
35256         "type": "json"
35257       }
35258     ],
35259     "name": "GetInteractions",
35260     "group": "Whatsapp_Interactions",
35261     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35262     "version": "0.0.0",
35263     "filename": "server/api/whatsappInteraction/index.js",
35264     "groupTitle": "Whatsapp_Interactions"
35265   },
35266   {
35267     "type": "delete",
35268     "url": "/api/whatsapp/interactions/{id}/tags",
35269     "title": "Removes tags from interaction",
35270     "examples": [
35271       {
35272         "title": "Example usage:",
35273         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
35274         "type": "json"
35275       }
35276     ],
35277     "name": "RemoveTags",
35278     "group": "Whatsapp_Interactions",
35279     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35280     "version": "0.0.0",
35281     "filename": "server/api/whatsappInteraction/index.js",
35282     "groupTitle": "Whatsapp_Interactions"
35283   },
35284   {
35285     "type": "get",
35286     "url": "/api/whatsapp/interactions/{id}",
35287     "title": "Gets a single Interaction",
35288     "examples": [
35289       {
35290         "title": "Example usage:",
35291         "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password}",
35292         "type": "json"
35293       }
35294     ],
35295     "name": "ShowInteractions",
35296     "group": "Whatsapp_Interactions",
35297     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35298     "version": "0.0.0",
35299     "filename": "server/api/whatsappInteraction/index.js",
35300     "groupTitle": "Whatsapp_Interactions"
35301   },
35302   {
35303     "type": "post",
35304     "url": "/api/whatsapp/interactions/{id}/messages",
35305     "title": "Creates new messages",
35306     "examples": [
35307       {
35308         "title": "Example usage:",
35309         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35310         "type": "json"
35311       }
35312     ],
35313     "name": "addMessage",
35314     "group": "Whatsapp_Interactions",
35315     "parameter": {
35316       "fields": {
35317         "Body": [
35318           {
35319             "group": "Body",
35320             "type": "Text",
35321             "optional": false,
35322             "field": "body",
35323             "description": ""
35324           },
35325           {
35326             "group": "Body",
35327             "type": "Boolean",
35328             "optional": true,
35329             "field": "read",
35330             "description": ""
35331           },
35332           {
35333             "group": "Body",
35334             "type": "String",
35335             "allowedValues": [
35336               "\"in\"",
35337               "\"out\""
35338             ],
35339             "optional": false,
35340             "field": "direction",
35341             "description": ""
35342           },
35343           {
35344             "group": "Body",
35345             "type": "String",
35346             "optional": true,
35347             "field": "messageId",
35348             "description": ""
35349           },
35350           {
35351             "group": "Body",
35352             "type": "String",
35353             "optional": true,
35354             "field": "phone",
35355             "description": ""
35356           },
35357           {
35358             "group": "Body",
35359             "type": "String",
35360             "optional": true,
35361             "field": "readAt",
35362             "description": ""
35363           },
35364           {
35365             "group": "Body",
35366             "type": "Boolean",
35367             "optional": true,
35368             "field": "secret",
35369             "description": ""
35370           },
35371           {
35372             "group": "Body",
35373             "type": "String",
35374             "optional": true,
35375             "field": "providerName",
35376             "description": ""
35377           },
35378           {
35379             "group": "Body",
35380             "type": "Text",
35381             "optional": true,
35382             "field": "providerResponse",
35383             "description": ""
35384           }
35385         ]
35386       }
35387     },
35388     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35389     "version": "0.0.0",
35390     "filename": "server/api/whatsappInteraction/index.js",
35391     "groupTitle": "Whatsapp_Interactions"
35392   },
35393   {
35394     "type": "get",
35395     "url": "/api/whatsapp/interactions/{id}/download",
35396     "title": "Gets interaction",
35397     "examples": [
35398       {
35399         "title": "Example usage:",
35400         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/download -v -u {name}:{password} -X GET",
35401         "type": "json"
35402       }
35403     ],
35404     "name": "download",
35405     "group": "Whatsapp_Interactions",
35406     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35407     "version": "0.0.0",
35408     "filename": "server/api/whatsappInteraction/index.js",
35409     "groupTitle": "Whatsapp_Interactions"
35410   },
35411   {
35412     "type": "get",
35413     "url": "/api/whatsapp/interactions/{id}/messages",
35414     "title": "Gets interaction messages",
35415     "examples": [
35416       {
35417         "title": "Example usage:",
35418         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -v -u {name}:{password} -X GET",
35419         "type": "json"
35420       }
35421     ],
35422     "name": "getMessages",
35423     "group": "Whatsapp_Interactions",
35424     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35425     "version": "0.0.0",
35426     "filename": "server/api/whatsappInteraction/index.js",
35427     "groupTitle": "Whatsapp_Interactions"
35428   },
35429   {
35430     "type": "put",
35431     "url": "/api/whatsapp/interactions/{id}",
35432     "title": "Update an existing Interaction",
35433     "examples": [
35434       {
35435         "title": "Example usage:",
35436         "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",
35437         "type": "json"
35438       }
35439     ],
35440     "name": "updateInteractions",
35441     "group": "Whatsapp_Interactions",
35442     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35443     "version": "0.0.0",
35444     "filename": "server/api/whatsappInteraction/index.js",
35445     "groupTitle": "Whatsapp_Interactions"
35446   },
35447   {
35448     "type": "post",
35449     "url": "/api/whatsapp/messages",
35450     "title": "Creates a new Message",
35451     "examples": [
35452       {
35453         "title": "Example usage:",
35454         "content": "curl https://{domain}/api/whatsapp/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35455         "type": "json"
35456       }
35457     ],
35458     "name": "CreateMessages",
35459     "group": "Whatsapp_Messages",
35460     "parameter": {
35461       "fields": {
35462         "Body": [
35463           {
35464             "group": "Body",
35465             "type": "Text",
35466             "optional": false,
35467             "field": "body",
35468             "description": ""
35469           },
35470           {
35471             "group": "Body",
35472             "type": "Boolean",
35473             "optional": true,
35474             "field": "read",
35475             "description": ""
35476           },
35477           {
35478             "group": "Body",
35479             "type": "String",
35480             "allowedValues": [
35481               "\"in\"",
35482               "\"out\""
35483             ],
35484             "optional": false,
35485             "field": "direction",
35486             "description": ""
35487           },
35488           {
35489             "group": "Body",
35490             "type": "String",
35491             "optional": true,
35492             "field": "messageId",
35493             "description": ""
35494           },
35495           {
35496             "group": "Body",
35497             "type": "String",
35498             "optional": true,
35499             "field": "phone",
35500             "description": ""
35501           },
35502           {
35503             "group": "Body",
35504             "type": "String",
35505             "optional": true,
35506             "field": "readAt",
35507             "description": ""
35508           },
35509           {
35510             "group": "Body",
35511             "type": "Boolean",
35512             "optional": true,
35513             "field": "secret",
35514             "description": ""
35515           },
35516           {
35517             "group": "Body",
35518             "type": "String",
35519             "optional": true,
35520             "field": "providerName",
35521             "description": ""
35522           },
35523           {
35524             "group": "Body",
35525             "type": "Text",
35526             "optional": true,
35527             "field": "providerResponse",
35528             "description": ""
35529           }
35530         ]
35531       }
35532     },
35533     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35534     "version": "0.0.0",
35535     "filename": "server/api/whatsappMessage/index.js",
35536     "groupTitle": "Whatsapp_Messages"
35537   },
35538   {
35539     "type": "delete",
35540     "url": "/api/whatsapp/messages/{id}",
35541     "title": "Deletes a Message",
35542     "examples": [
35543       {
35544         "title": "Example usage:",
35545         "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password} -X DELETE",
35546         "type": "json"
35547       }
35548     ],
35549     "name": "DeleteMessages",
35550     "group": "Whatsapp_Messages",
35551     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35552     "version": "0.0.0",
35553     "filename": "server/api/whatsappMessage/index.js",
35554     "groupTitle": "Whatsapp_Messages"
35555   },
35556   {
35557     "type": "get",
35558     "url": "/api/whatsapp/messages/describe",
35559     "title": "Gets table info about Messages",
35560     "examples": [
35561       {
35562         "title": "Example usage:",
35563         "content": "curl https://{domain}/api/whatsapp/messages/describe -v -u {name}:{password}",
35564         "type": "json"
35565       }
35566     ],
35567     "name": "DescribeMessages",
35568     "group": "Whatsapp_Messages",
35569     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35570     "version": "0.0.0",
35571     "filename": "server/api/whatsappMessage/index.js",
35572     "groupTitle": "Whatsapp_Messages"
35573   },
35574   {
35575     "type": "get",
35576     "url": "/api/whatsapp/messages",
35577     "title": "Gets a list of Messages",
35578     "examples": [
35579       {
35580         "title": "Example usage:",
35581         "content": "curl https://{domain}/api/whatsapp/messages -v -u {name}:{password}",
35582         "type": "json"
35583       }
35584     ],
35585     "name": "GetMessages",
35586     "group": "Whatsapp_Messages",
35587     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35588     "version": "0.0.0",
35589     "filename": "server/api/whatsappMessage/index.js",
35590     "groupTitle": "Whatsapp_Messages"
35591   },
35592   {
35593     "type": "get",
35594     "url": "/api/whatsapp/messages/{id}",
35595     "title": "Gets a single Message",
35596     "examples": [
35597       {
35598         "title": "Example usage:",
35599         "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password}",
35600         "type": "json"
35601       }
35602     ],
35603     "name": "ShowMessages",
35604     "group": "Whatsapp_Messages",
35605     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35606     "version": "0.0.0",
35607     "filename": "server/api/whatsappMessage/index.js",
35608     "groupTitle": "Whatsapp_Messages"
35609   },
35610   {
35611     "type": "put",
35612     "url": "/api/whatsapp/messages/{id}",
35613     "title": "Update an existing Message",
35614     "examples": [
35615       {
35616         "title": "Example usage:",
35617         "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",
35618         "type": "json"
35619       }
35620     ],
35621     "name": "updateMessages",
35622     "group": "Whatsapp_Messages",
35623     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35624     "version": "0.0.0",
35625     "filename": "server/api/whatsappMessage/index.js",
35626     "groupTitle": "Whatsapp_Messages"
35627   },
35628   {
35629     "type": "post",
35630     "url": "/api/whatsapp/reports/queue",
35631     "title": "Creates a new Whatsapp Queue Report",
35632     "examples": [
35633       {
35634         "title": "Example usage:",
35635         "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",
35636         "type": "json"
35637       }
35638     ],
35639     "name": "CreateWhatsapp_Queue_Reports",
35640     "group": "Whatsapp_Queue_Reports",
35641     "parameter": {
35642       "fields": {
35643         "Body": [
35644           {
35645             "group": "Body",
35646             "type": "String",
35647             "optional": false,
35648             "field": "uniqueid",
35649             "description": ""
35650           },
35651           {
35652             "group": "Body",
35653             "type": "String",
35654             "optional": true,
35655             "field": "from",
35656             "description": ""
35657           },
35658           {
35659             "group": "Body",
35660             "type": "String",
35661             "optional": true,
35662             "field": "joinAt",
35663             "description": ""
35664           },
35665           {
35666             "group": "Body",
35667             "type": "String",
35668             "optional": true,
35669             "field": "leaveAt",
35670             "description": ""
35671           },
35672           {
35673             "group": "Body",
35674             "type": "String",
35675             "optional": true,
35676             "field": "acceptAt",
35677             "description": ""
35678           },
35679           {
35680             "group": "Body",
35681             "type": "String",
35682             "optional": true,
35683             "field": "exitAt",
35684             "description": ""
35685           },
35686           {
35687             "group": "Body",
35688             "type": "String",
35689             "optional": true,
35690             "field": "reason",
35691             "description": ""
35692           }
35693         ]
35694       }
35695     },
35696     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35697     "version": "0.0.0",
35698     "filename": "server/api/whatsappQueueReport/index.js",
35699     "groupTitle": "Whatsapp_Queue_Reports"
35700   },
35701   {
35702     "type": "delete",
35703     "url": "/api/whatsapp/reports/queue/{id}",
35704     "title": "Deletes a Whatsapp Queue Report",
35705     "examples": [
35706       {
35707         "title": "Example usage:",
35708         "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password} -X DELETE",
35709         "type": "json"
35710       }
35711     ],
35712     "name": "DeleteWhatsapp_Queue_Reports",
35713     "group": "Whatsapp_Queue_Reports",
35714     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35715     "version": "0.0.0",
35716     "filename": "server/api/whatsappQueueReport/index.js",
35717     "groupTitle": "Whatsapp_Queue_Reports"
35718   },
35719   {
35720     "type": "get",
35721     "url": "/api/whatsapp/reports/queue/describe",
35722     "title": "Gets table info about Whatsapp Queue Reports",
35723     "examples": [
35724       {
35725         "title": "Example usage:",
35726         "content": "curl https://{domain}/api/whatsapp/reports/queue/describe -v -u {name}:{password}",
35727         "type": "json"
35728       }
35729     ],
35730     "name": "DescribeWhatsapp_Queue_Reports",
35731     "group": "Whatsapp_Queue_Reports",
35732     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35733     "version": "0.0.0",
35734     "filename": "server/api/whatsappQueueReport/index.js",
35735     "groupTitle": "Whatsapp_Queue_Reports"
35736   },
35737   {
35738     "type": "get",
35739     "url": "/api/whatsapp/reports/queue",
35740     "title": "Gets a list of Whatsapp Queue Reports",
35741     "examples": [
35742       {
35743         "title": "Example usage:",
35744         "content": "curl https://{domain}/api/whatsapp/reports/queue -v -u {name}:{password}",
35745         "type": "json"
35746       }
35747     ],
35748     "name": "GetWhatsapp_Queue_Reports",
35749     "group": "Whatsapp_Queue_Reports",
35750     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35751     "version": "0.0.0",
35752     "filename": "server/api/whatsappQueueReport/index.js",
35753     "groupTitle": "Whatsapp_Queue_Reports"
35754   },
35755   {
35756     "type": "get",
35757     "url": "/api/whatsapp/reports/queue/{id}",
35758     "title": "Gets a single Whatsapp Queue Report",
35759     "examples": [
35760       {
35761         "title": "Example usage:",
35762         "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password}",
35763         "type": "json"
35764       }
35765     ],
35766     "name": "ShowWhatsapp_Queue_Reports",
35767     "group": "Whatsapp_Queue_Reports",
35768     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35769     "version": "0.0.0",
35770     "filename": "server/api/whatsappQueueReport/index.js",
35771     "groupTitle": "Whatsapp_Queue_Reports"
35772   },
35773   {
35774     "type": "put",
35775     "url": "/api/whatsapp/reports/queue/{id}",
35776     "title": "Update an existing Whatsapp Queue Report",
35777     "examples": [
35778       {
35779         "title": "Example usage:",
35780         "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",
35781         "type": "json"
35782       }
35783     ],
35784     "name": "updateWhatsapp_Queue_Reports",
35785     "group": "Whatsapp_Queue_Reports",
35786     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35787     "version": "0.0.0",
35788     "filename": "server/api/whatsappQueueReport/index.js",
35789     "groupTitle": "Whatsapp_Queue_Reports"
35790   },
35791   {
35792     "type": "post",
35793     "url": "/api/whatsapp/queues/{id}/users",
35794     "title": "Add agents to a queue",
35795     "examples": [
35796       {
35797         "title": "Example usage:",
35798         "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",
35799         "type": "json"
35800       }
35801     ],
35802     "name": "AddAgents",
35803     "group": "Whatsapp_Queues",
35804     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35805     "version": "0.0.0",
35806     "filename": "server/api/whatsappQueue/index.js",
35807     "groupTitle": "Whatsapp_Queues"
35808   },
35809   {
35810     "type": "post",
35811     "url": "/api/whatsapp/queues/{id}/teams",
35812     "title": "Add teams to a queue",
35813     "examples": [
35814       {
35815         "title": "Example usage:",
35816         "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",
35817         "type": "json"
35818       }
35819     ],
35820     "name": "AddTeams",
35821     "group": "Whatsapp_Queues",
35822     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35823     "version": "0.0.0",
35824     "filename": "server/api/whatsappQueue/index.js",
35825     "groupTitle": "Whatsapp_Queues"
35826   },
35827   {
35828     "type": "post",
35829     "url": "/api/whatsapp/queues",
35830     "title": "Creates a new Queue",
35831     "examples": [
35832       {
35833         "title": "Example usage:",
35834         "content": "curl https://{domain}/api/whatsapp/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35835         "type": "json"
35836       }
35837     ],
35838     "name": "CreateQueues",
35839     "group": "Whatsapp_Queues",
35840     "parameter": {
35841       "fields": {
35842         "Body": [
35843           {
35844             "group": "Body",
35845             "type": "String",
35846             "optional": true,
35847             "field": "name",
35848             "description": ""
35849           },
35850           {
35851             "group": "Body",
35852             "type": "Integer",
35853             "optional": true,
35854             "field": "timeout",
35855             "description": ""
35856           },
35857           {
35858             "group": "Body",
35859             "type": "String",
35860             "allowedValues": [
35861               "\"rrmemory\"",
35862               "\"beepall\"",
35863               "\"roundrobin\""
35864             ],
35865             "optional": true,
35866             "field": "strategy",
35867             "description": ""
35868           },
35869           {
35870             "group": "Body",
35871             "type": "String",
35872             "optional": true,
35873             "field": "description",
35874             "description": ""
35875           }
35876         ]
35877       }
35878     },
35879     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35880     "version": "0.0.0",
35881     "filename": "server/api/whatsappQueue/index.js",
35882     "groupTitle": "Whatsapp_Queues"
35883   },
35884   {
35885     "type": "delete",
35886     "url": "/api/whatsapp/queues/{id}",
35887     "title": "Deletes a Queue",
35888     "examples": [
35889       {
35890         "title": "Example usage:",
35891         "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password} -X DELETE",
35892         "type": "json"
35893       }
35894     ],
35895     "name": "DeleteQueues",
35896     "group": "Whatsapp_Queues",
35897     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35898     "version": "0.0.0",
35899     "filename": "server/api/whatsappQueue/index.js",
35900     "groupTitle": "Whatsapp_Queues"
35901   },
35902   {
35903     "type": "get",
35904     "url": "/api/whatsapp/queues/describe",
35905     "title": "Gets table info about Queues",
35906     "examples": [
35907       {
35908         "title": "Example usage:",
35909         "content": "curl https://{domain}/api/whatsapp/queues/describe -v -u {name}:{password}",
35910         "type": "json"
35911       }
35912     ],
35913     "name": "DescribeQueues",
35914     "group": "Whatsapp_Queues",
35915     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35916     "version": "0.0.0",
35917     "filename": "server/api/whatsappQueue/index.js",
35918     "groupTitle": "Whatsapp_Queues"
35919   },
35920   {
35921     "type": "get",
35922     "url": "/api/whatsapp/queues/{id}/users",
35923     "title": "Gets queue agents",
35924     "examples": [
35925       {
35926         "title": "Example usage:",
35927         "content": "curl https://{domain}/api/whatsapp/queues/{id}/users -v -u {name}:{password} -X POST",
35928         "type": "json"
35929       }
35930     ],
35931     "name": "GetAgents",
35932     "group": "Whatsapp_Queues",
35933     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35934     "version": "0.0.0",
35935     "filename": "server/api/whatsappQueue/index.js",
35936     "groupTitle": "Whatsapp_Queues"
35937   },
35938   {
35939     "type": "get",
35940     "url": "/api/whatsapp/queues/{id}/members",
35941     "title": "GetMembers",
35942     "examples": [
35943       {
35944         "title": "Example usage:",
35945         "content": "curl https://{domain}/api/whatsapp/queues/{id}/members  -v -u {name}:{password}",
35946         "type": "json"
35947       }
35948     ],
35949     "name": "GetMembers",
35950     "group": "Whatsapp_Queues",
35951     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35952     "version": "0.0.0",
35953     "filename": "server/api/whatsappQueue/index.js",
35954     "groupTitle": "Whatsapp_Queues"
35955   },
35956   {
35957     "type": "get",
35958     "url": "/api/whatsapp/queues",
35959     "title": "Gets a list of Queues",
35960     "examples": [
35961       {
35962         "title": "Example usage:",
35963         "content": "curl https://{domain}/api/whatsapp/queues -v -u {name}:{password}",
35964         "type": "json"
35965       }
35966     ],
35967     "name": "GetQueues",
35968     "group": "Whatsapp_Queues",
35969     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35970     "version": "0.0.0",
35971     "filename": "server/api/whatsappQueue/index.js",
35972     "groupTitle": "Whatsapp_Queues"
35973   },
35974   {
35975     "type": "get",
35976     "url": "/api/whatsapp/queues/{id}/teams",
35977     "title": "Gets queues list",
35978     "examples": [
35979       {
35980         "title": "Example usage:",
35981         "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password}",
35982         "type": "json"
35983       }
35984     ],
35985     "name": "GetTeams",
35986     "group": "Whatsapp_Queues",
35987     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35988     "version": "0.0.0",
35989     "filename": "server/api/whatsappQueue/index.js",
35990     "groupTitle": "Whatsapp_Queues"
35991   },
35992   {
35993     "type": "delete",
35994     "url": "/api/whatsapp/queues/{id}/users",
35995     "title": "Removes agents from a queue",
35996     "examples": [
35997       {
35998         "title": "Example usage:",
35999         "content": "curl https://{domain}/api/whatsapp/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
36000         "type": "json"
36001       }
36002     ],
36003     "name": "RemoveAgents",
36004     "group": "Whatsapp_Queues",
36005     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36006     "version": "0.0.0",
36007     "filename": "server/api/whatsappQueue/index.js",
36008     "groupTitle": "Whatsapp_Queues"
36009   },
36010   {
36011     "type": "get",
36012     "url": "/api/whatsapp/queues/{id}",
36013     "title": "Gets a single Queue",
36014     "examples": [
36015       {
36016         "title": "Example usage:",
36017         "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password}",
36018         "type": "json"
36019       }
36020     ],
36021     "name": "ShowQueues",
36022     "group": "Whatsapp_Queues",
36023     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36024     "version": "0.0.0",
36025     "filename": "server/api/whatsappQueue/index.js",
36026     "groupTitle": "Whatsapp_Queues"
36027   },
36028   {
36029     "type": "put",
36030     "url": "/api/whatsapp/queues/{id}",
36031     "title": "Update an existing Queue",
36032     "examples": [
36033       {
36034         "title": "Example usage:",
36035         "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",
36036         "type": "json"
36037       }
36038     ],
36039     "name": "updateQueues",
36040     "group": "Whatsapp_Queues",
36041     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36042     "version": "0.0.0",
36043     "filename": "server/api/whatsappQueue/index.js",
36044     "groupTitle": "Whatsapp_Queues"
36045   },
36046   {
36047     "type": "post",
36048     "url": "/api/whatsapp/reports/transfer",
36049     "title": "Creates a new Whatsapp Transfer Report",
36050     "examples": [
36051       {
36052         "title": "Example usage:",
36053         "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",
36054         "type": "json"
36055       }
36056     ],
36057     "name": "CreateWhatsapp_Transfer_Reports",
36058     "group": "Whatsapp_Transfer_Reports",
36059     "parameter": {
36060       "fields": {
36061         "Body": [
36062           {
36063             "group": "Body",
36064             "type": "String",
36065             "optional": false,
36066             "field": "uniqueid",
36067             "description": ""
36068           },
36069           {
36070             "group": "Body",
36071             "type": "String",
36072             "allowedValues": [
36073               "\"account\"",
36074               "\"agent\"",
36075               "\"queue\""
36076             ],
36077             "optional": false,
36078             "field": "type",
36079             "description": ""
36080           },
36081           {
36082             "group": "Body",
36083             "type": "String",
36084             "optional": true,
36085             "field": "transferredAt",
36086             "description": ""
36087           }
36088         ]
36089       }
36090     },
36091     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36092     "version": "0.0.0",
36093     "filename": "server/api/whatsappTransferReport/index.js",
36094     "groupTitle": "Whatsapp_Transfer_Reports"
36095   },
36096   {
36097     "type": "delete",
36098     "url": "/api/whatsapp/reports/transfer/{id}",
36099     "title": "Deletes a Whatsapp Transfer Report",
36100     "examples": [
36101       {
36102         "title": "Example usage:",
36103         "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
36104         "type": "json"
36105       }
36106     ],
36107     "name": "DeleteWhatsapp_Transfer_Reports",
36108     "group": "Whatsapp_Transfer_Reports",
36109     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36110     "version": "0.0.0",
36111     "filename": "server/api/whatsappTransferReport/index.js",
36112     "groupTitle": "Whatsapp_Transfer_Reports"
36113   },
36114   {
36115     "type": "get",
36116     "url": "/api/whatsapp/reports/transfer/describe",
36117     "title": "Gets table info about Whatsapp Transfer Reports",
36118     "examples": [
36119       {
36120         "title": "Example usage:",
36121         "content": "curl https://{domain}/api/whatsapp/reports/transfer/describe -v -u {name}:{password}",
36122         "type": "json"
36123       }
36124     ],
36125     "name": "DescribeWhatsapp_Transfer_Reports",
36126     "group": "Whatsapp_Transfer_Reports",
36127     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36128     "version": "0.0.0",
36129     "filename": "server/api/whatsappTransferReport/index.js",
36130     "groupTitle": "Whatsapp_Transfer_Reports"
36131   },
36132   {
36133     "type": "get",
36134     "url": "/api/whatsapp/reports/transfer",
36135     "title": "Gets a list of Whatsapp Transfer Reports",
36136     "examples": [
36137       {
36138         "title": "Example usage:",
36139         "content": "curl https://{domain}/api/whatsapp/reports/transfer -v -u {name}:{password}",
36140         "type": "json"
36141       }
36142     ],
36143     "name": "GetWhatsapp_Transfer_Reports",
36144     "group": "Whatsapp_Transfer_Reports",
36145     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36146     "version": "0.0.0",
36147     "filename": "server/api/whatsappTransferReport/index.js",
36148     "groupTitle": "Whatsapp_Transfer_Reports"
36149   },
36150   {
36151     "type": "get",
36152     "url": "/api/whatsapp/reports/transfer/{id}",
36153     "title": "Gets a single Whatsapp Transfer Report",
36154     "examples": [
36155       {
36156         "title": "Example usage:",
36157         "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password}",
36158         "type": "json"
36159       }
36160     ],
36161     "name": "ShowWhatsapp_Transfer_Reports",
36162     "group": "Whatsapp_Transfer_Reports",
36163     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36164     "version": "0.0.0",
36165     "filename": "server/api/whatsappTransferReport/index.js",
36166     "groupTitle": "Whatsapp_Transfer_Reports"
36167   },
36168   {
36169     "type": "put",
36170     "url": "/api/whatsapp/reports/transfer/{id}",
36171     "title": "Update an existing Whatsapp Transfer Report",
36172     "examples": [
36173       {
36174         "title": "Example usage:",
36175         "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",
36176         "type": "json"
36177       }
36178     ],
36179     "name": "updateWhatsapp_Transfer_Reports",
36180     "group": "Whatsapp_Transfer_Reports",
36181     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36182     "version": "0.0.0",
36183     "filename": "server/api/whatsappTransferReport/index.js",
36184     "groupTitle": "Whatsapp_Transfer_Reports"
36185   },
36186   {
36187     "type": "post",
36188     "url": "/api/integrations/zendesk/accounts",
36189     "title": "Creates a new Zendesk Account",
36190     "examples": [
36191       {
36192         "title": "Example usage:",
36193         "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",
36194         "type": "json"
36195       }
36196     ],
36197     "name": "CreateZendesk_Accounts",
36198     "group": "Zendesk_Accounts",
36199     "parameter": {
36200       "fields": {
36201         "Body": [
36202           {
36203             "group": "Body",
36204             "type": "String",
36205             "optional": true,
36206             "field": "name",
36207             "description": ""
36208           },
36209           {
36210             "group": "Body",
36211             "type": "String",
36212             "optional": true,
36213             "field": "description",
36214             "description": ""
36215           },
36216           {
36217             "group": "Body",
36218             "type": "String",
36219             "optional": true,
36220             "field": "username",
36221             "description": ""
36222           },
36223           {
36224             "group": "Body",
36225             "type": "String",
36226             "optional": true,
36227             "field": "password",
36228             "description": ""
36229           },
36230           {
36231             "group": "Body",
36232             "type": "String",
36233             "optional": true,
36234             "field": "token",
36235             "description": ""
36236           },
36237           {
36238             "group": "Body",
36239             "type": "String",
36240             "optional": true,
36241             "field": "remoteUri",
36242             "description": ""
36243           },
36244           {
36245             "group": "Body",
36246             "type": "String",
36247             "allowedValues": [
36248               "\"password\"",
36249               "\"token\""
36250             ],
36251             "optional": true,
36252             "field": "authType",
36253             "description": ""
36254           },
36255           {
36256             "group": "Body",
36257             "type": "String",
36258             "optional": false,
36259             "field": "serverUrl",
36260             "description": ""
36261           },
36262           {
36263             "group": "Body",
36264             "type": "String",
36265             "allowedValues": [
36266               "\"integrationTab\"",
36267               "\"newTab\""
36268             ],
36269             "optional": true,
36270             "field": "type",
36271             "description": ""
36272           }
36273         ]
36274       }
36275     },
36276     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36277     "version": "0.0.0",
36278     "filename": "server/api/intZendeskAccount/index.js",
36279     "groupTitle": "Zendesk_Accounts"
36280   },
36281   {
36282     "type": "delete",
36283     "url": "/api/integrations/zendesk/accounts/{id}",
36284     "title": "Deletes a Zendesk Account",
36285     "examples": [
36286       {
36287         "title": "Example usage:",
36288         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password} -X DELETE",
36289         "type": "json"
36290       }
36291     ],
36292     "name": "DeleteZendesk_Accounts",
36293     "group": "Zendesk_Accounts",
36294     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36295     "version": "0.0.0",
36296     "filename": "server/api/intZendeskAccount/index.js",
36297     "groupTitle": "Zendesk_Accounts"
36298   },
36299   {
36300     "type": "get",
36301     "url": "/api/integrations/zendesk/accounts",
36302     "title": "Gets a list of Zendesk Accounts",
36303     "examples": [
36304       {
36305         "title": "Example usage:",
36306         "content": "curl https://{domain}/api/integrations/zendesk/accounts -v -u {name}:{password}",
36307         "type": "json"
36308       }
36309     ],
36310     "name": "GetZendesk_Accounts",
36311     "group": "Zendesk_Accounts",
36312     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36313     "version": "0.0.0",
36314     "filename": "server/api/intZendeskAccount/index.js",
36315     "groupTitle": "Zendesk_Accounts"
36316   },
36317   {
36318     "type": "get",
36319     "url": "/api/integrations/zendesk/accounts/{id}",
36320     "title": "Gets a single Zendesk Account",
36321     "examples": [
36322       {
36323         "title": "Example usage:",
36324         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password}",
36325         "type": "json"
36326       }
36327     ],
36328     "name": "ShowZendesk_Accounts",
36329     "group": "Zendesk_Accounts",
36330     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36331     "version": "0.0.0",
36332     "filename": "server/api/intZendeskAccount/index.js",
36333     "groupTitle": "Zendesk_Accounts"
36334   },
36335   {
36336     "type": "post",
36337     "url": "/api/integrations/zendesk/accounts/{id}/configurations",
36338     "title": "Creates new configuration",
36339     "examples": [
36340       {
36341         "title": "Example usage:",
36342         "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",
36343         "type": "json"
36344       }
36345     ],
36346     "name": "addConfiguration",
36347     "group": "Zendesk_Accounts",
36348     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36349     "version": "0.0.0",
36350     "filename": "server/api/intZendeskAccount/index.js",
36351     "groupTitle": "Zendesk_Accounts"
36352   },
36353   {
36354     "type": "get",
36355     "url": "/api/integrations/zendesk/accounts/{id}/configurations",
36356     "title": "Gets account configurations",
36357     "examples": [
36358       {
36359         "title": "Example usage:",
36360         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
36361         "type": "json"
36362       }
36363     ],
36364     "name": "getConfigurations",
36365     "group": "Zendesk_Accounts",
36366     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36367     "version": "0.0.0",
36368     "filename": "server/api/intZendeskAccount/index.js",
36369     "groupTitle": "Zendesk_Accounts"
36370   },
36371   {
36372     "type": "get",
36373     "url": "/api/integrations/zendesk/accounts/{id}/fields",
36374     "title": "Gets account fields",
36375     "examples": [
36376       {
36377         "title": "Example usage:",
36378         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
36379         "type": "json"
36380       }
36381     ],
36382     "name": "getFields",
36383     "group": "Zendesk_Accounts",
36384     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36385     "version": "0.0.0",
36386     "filename": "server/api/intZendeskAccount/index.js",
36387     "groupTitle": "Zendesk_Accounts"
36388   },
36389   {
36390     "type": "put",
36391     "url": "/api/integrations/zendesk/accounts/{id}",
36392     "title": "Update an existing Zendesk Account",
36393     "examples": [
36394       {
36395         "title": "Example usage:",
36396         "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",
36397         "type": "json"
36398       }
36399     ],
36400     "name": "updateZendesk_Accounts",
36401     "group": "Zendesk_Accounts",
36402     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36403     "version": "0.0.0",
36404     "filename": "server/api/intZendeskAccount/index.js",
36405     "groupTitle": "Zendesk_Accounts"
36406   },
36407   {
36408     "type": "post",
36409     "url": "/api/integrations/zendesk/configurations",
36410     "title": "Creates a new Zendesk Configuration",
36411     "examples": [
36412       {
36413         "title": "Example usage:",
36414         "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",
36415         "type": "json"
36416       }
36417     ],
36418     "name": "CreateZendesk_Configurations",
36419     "group": "Zendesk_Configurations",
36420     "parameter": {
36421       "fields": {
36422         "Body": [
36423           {
36424             "group": "Body",
36425             "type": "String",
36426             "optional": true,
36427             "field": "name",
36428             "description": ""
36429           },
36430           {
36431             "group": "Body",
36432             "type": "String",
36433             "optional": true,
36434             "field": "description",
36435             "description": ""
36436           }
36437         ]
36438       }
36439     },
36440     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36441     "version": "0.0.0",
36442     "filename": "server/api/intZendeskConfiguration/index.js",
36443     "groupTitle": "Zendesk_Configurations"
36444   },
36445   {
36446     "type": "delete",
36447     "url": "/api/integrations/zendesk/configurations/{id}",
36448     "title": "Deletes a Zendesk Configuration",
36449     "examples": [
36450       {
36451         "title": "Example usage:",
36452         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password} -X DELETE",
36453         "type": "json"
36454       }
36455     ],
36456     "name": "DeleteZendesk_Configurations",
36457     "group": "Zendesk_Configurations",
36458     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36459     "version": "0.0.0",
36460     "filename": "server/api/intZendeskConfiguration/index.js",
36461     "groupTitle": "Zendesk_Configurations"
36462   },
36463   {
36464     "type": "get",
36465     "url": "/api/integrations/zendesk/configurations",
36466     "title": "Gets a list of Zendesk Configurations",
36467     "examples": [
36468       {
36469         "title": "Example usage:",
36470         "content": "curl https://{domain}/api/integrations/zendesk/configurations -v -u {name}:{password}",
36471         "type": "json"
36472       }
36473     ],
36474     "name": "GetZendesk_Configurations",
36475     "group": "Zendesk_Configurations",
36476     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36477     "version": "0.0.0",
36478     "filename": "server/api/intZendeskConfiguration/index.js",
36479     "groupTitle": "Zendesk_Configurations"
36480   },
36481   {
36482     "type": "get",
36483     "url": "/api/integrations/zendesk/configurations/{id}",
36484     "title": "Gets a single Zendesk Configuration",
36485     "examples": [
36486       {
36487         "title": "Example usage:",
36488         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password}",
36489         "type": "json"
36490       }
36491     ],
36492     "name": "ShowZendesk_Configurations",
36493     "group": "Zendesk_Configurations",
36494     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36495     "version": "0.0.0",
36496     "filename": "server/api/intZendeskConfiguration/index.js",
36497     "groupTitle": "Zendesk_Configurations"
36498   },
36499   {
36500     "type": "get",
36501     "url": "/api/integrations/zendesk/configurations/{id}/descriptions",
36502     "title": "Gets configurations descriptions",
36503     "examples": [
36504       {
36505         "title": "Example usage:",
36506         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
36507         "type": "json"
36508       }
36509     ],
36510     "name": "getDescriptions",
36511     "group": "Zendesk_Configurations",
36512     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36513     "version": "0.0.0",
36514     "filename": "server/api/intZendeskConfiguration/index.js",
36515     "groupTitle": "Zendesk_Configurations"
36516   },
36517   {
36518     "type": "get",
36519     "url": "/api/integrations/zendesk/configurations/{id}/fields",
36520     "title": "Gets configurations fields",
36521     "examples": [
36522       {
36523         "title": "Example usage:",
36524         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
36525         "type": "json"
36526       }
36527     ],
36528     "name": "getFields",
36529     "group": "Zendesk_Configurations",
36530     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36531     "version": "0.0.0",
36532     "filename": "server/api/intZendeskConfiguration/index.js",
36533     "groupTitle": "Zendesk_Configurations"
36534   },
36535   {
36536     "type": "get",
36537     "url": "/api/integrations/zendesk/configurations/{id}/subjects",
36538     "title": "Gets configurations subjects",
36539     "examples": [
36540       {
36541         "title": "Example usage:",
36542         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
36543         "type": "json"
36544       }
36545     ],
36546     "name": "getSubjects",
36547     "group": "Zendesk_Configurations",
36548     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36549     "version": "0.0.0",
36550     "filename": "server/api/intZendeskConfiguration/index.js",
36551     "groupTitle": "Zendesk_Configurations"
36552   },
36553   {
36554     "type": "get",
36555     "url": "/api/integrations/zendesk/configurations/{id}/tags",
36556     "title": "Gets configurations tags",
36557     "examples": [
36558       {
36559         "title": "Example usage:",
36560         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
36561         "type": "json"
36562       }
36563     ],
36564     "name": "getTags",
36565     "group": "Zendesk_Configurations",
36566     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36567     "version": "0.0.0",
36568     "filename": "server/api/intZendeskConfiguration/index.js",
36569     "groupTitle": "Zendesk_Configurations"
36570   },
36571   {
36572     "type": "post",
36573     "url": "/api/integrations/zendesk/configurations/{id}/tags",
36574     "title": "Sets new tags",
36575     "examples": [
36576       {
36577         "title": "Example usage:",
36578         "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",
36579         "type": "json"
36580       }
36581     ],
36582     "name": "setTags",
36583     "group": "Zendesk_Configurations",
36584     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36585     "version": "0.0.0",
36586     "filename": "server/api/intZendeskConfiguration/index.js",
36587     "groupTitle": "Zendesk_Configurations"
36588   },
36589   {
36590     "type": "put",
36591     "url": "/api/integrations/zendesk/configurations/{id}",
36592     "title": "Update an existing Zendesk Configuration",
36593     "examples": [
36594       {
36595         "title": "Example usage:",
36596         "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",
36597         "type": "json"
36598       }
36599     ],
36600     "name": "updateZendesk_Configurations",
36601     "group": "Zendesk_Configurations",
36602     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36603     "version": "0.0.0",
36604     "filename": "server/api/intZendeskConfiguration/index.js",
36605     "groupTitle": "Zendesk_Configurations"
36606   },
36607   {
36608     "type": "post",
36609     "url": "/api/integrations/zendesk/fields",
36610     "title": "Creates a new Zendesk Field",
36611     "examples": [
36612       {
36613         "title": "Example usage:",
36614         "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",
36615         "type": "json"
36616       }
36617     ],
36618     "name": "CreateZendesk_Fields",
36619     "group": "Zendesk_Fields",
36620     "parameter": {
36621       "fields": {
36622         "Body": [
36623           {
36624             "group": "Body",
36625             "type": "String",
36626             "allowedValues": [
36627               "\"string\"",
36628               "\"variable\"",
36629               "\"customVariable\"",
36630               "\"keyValue\"",
36631               "\"picklist\""
36632             ],
36633             "optional": true,
36634             "field": "type",
36635             "description": ""
36636           },
36637           {
36638             "group": "Body",
36639             "type": "String",
36640             "optional": true,
36641             "field": "content",
36642             "description": ""
36643           },
36644           {
36645             "group": "Body",
36646             "type": "String",
36647             "optional": true,
36648             "field": "key",
36649             "description": ""
36650           },
36651           {
36652             "group": "Body",
36653             "type": "String",
36654             "allowedValues": [
36655               "\"string\"",
36656               "\"variable\"",
36657               "\"customVariable\""
36658             ],
36659             "optional": true,
36660             "field": "keyType",
36661             "description": ""
36662           },
36663           {
36664             "group": "Body",
36665             "type": "String",
36666             "optional": true,
36667             "field": "keyContent",
36668             "description": ""
36669           },
36670           {
36671             "group": "Body",
36672             "type": "String",
36673             "optional": true,
36674             "field": "idField",
36675             "description": ""
36676           },
36677           {
36678             "group": "Body",
36679             "type": "String",
36680             "optional": true,
36681             "field": "nameField",
36682             "description": ""
36683           },
36684           {
36685             "group": "Body",
36686             "type": "Boolean",
36687             "optional": true,
36688             "field": "customField",
36689             "description": ""
36690           },
36691           {
36692             "group": "Body",
36693             "type": "String",
36694             "optional": true,
36695             "field": "variableName",
36696             "description": ""
36697           }
36698         ]
36699       }
36700     },
36701     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36702     "version": "0.0.0",
36703     "filename": "server/api/intZendeskField/index.js",
36704     "groupTitle": "Zendesk_Fields"
36705   },
36706   {
36707     "type": "delete",
36708     "url": "/api/integrations/zendesk/fields/{id}",
36709     "title": "Deletes a Zendesk Field",
36710     "examples": [
36711       {
36712         "title": "Example usage:",
36713         "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password} -X DELETE",
36714         "type": "json"
36715       }
36716     ],
36717     "name": "DeleteZendesk_Fields",
36718     "group": "Zendesk_Fields",
36719     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36720     "version": "0.0.0",
36721     "filename": "server/api/intZendeskField/index.js",
36722     "groupTitle": "Zendesk_Fields"
36723   },
36724   {
36725     "type": "get",
36726     "url": "/api/integrations/zendesk/fields",
36727     "title": "Gets a list of Zendesk Fields",
36728     "examples": [
36729       {
36730         "title": "Example usage:",
36731         "content": "curl https://{domain}/api/integrations/zendesk/fields -v -u {name}:{password}",
36732         "type": "json"
36733       }
36734     ],
36735     "name": "GetZendesk_Fields",
36736     "group": "Zendesk_Fields",
36737     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36738     "version": "0.0.0",
36739     "filename": "server/api/intZendeskField/index.js",
36740     "groupTitle": "Zendesk_Fields"
36741   },
36742   {
36743     "type": "get",
36744     "url": "/api/integrations/zendesk/fields/{id}",
36745     "title": "Gets a single Zendesk Field",
36746     "examples": [
36747       {
36748         "title": "Example usage:",
36749         "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password}",
36750         "type": "json"
36751       }
36752     ],
36753     "name": "ShowZendesk_Fields",
36754     "group": "Zendesk_Fields",
36755     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36756     "version": "0.0.0",
36757     "filename": "server/api/intZendeskField/index.js",
36758     "groupTitle": "Zendesk_Fields"
36759   },
36760   {
36761     "type": "put",
36762     "url": "/api/integrations/zendesk/fields/{id}",
36763     "title": "Update an existing Zendesk Field",
36764     "examples": [
36765       {
36766         "title": "Example usage:",
36767         "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",
36768         "type": "json"
36769       }
36770     ],
36771     "name": "updateZendesk_Fields",
36772     "group": "Zendesk_Fields",
36773     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36774     "version": "0.0.0",
36775     "filename": "server/api/intZendeskField/index.js",
36776     "groupTitle": "Zendesk_Fields"
36777   },
36778   {
36779     "type": "post",
36780     "url": "/api/integrations/zoho/accounts",
36781     "title": "Creates a new Zoho Account",
36782     "examples": [
36783       {
36784         "title": "Example usage:",
36785         "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",
36786         "type": "json"
36787       }
36788     ],
36789     "name": "CreateZoho_Accounts",
36790     "group": "Zoho_Accounts",
36791     "parameter": {
36792       "fields": {
36793         "Body": [
36794           {
36795             "group": "Body",
36796             "type": "String",
36797             "optional": true,
36798             "field": "name",
36799             "description": ""
36800           },
36801           {
36802             "group": "Body",
36803             "type": "String",
36804             "optional": true,
36805             "field": "description",
36806             "description": ""
36807           },
36808           {
36809             "group": "Body",
36810             "type": "String",
36811             "optional": true,
36812             "field": "host",
36813             "description": ""
36814           },
36815           {
36816             "group": "Body",
36817             "type": "String",
36818             "optional": true,
36819             "field": "zone",
36820             "description": ""
36821           },
36822           {
36823             "group": "Body",
36824             "type": "String",
36825             "optional": true,
36826             "field": "clientId",
36827             "description": ""
36828           },
36829           {
36830             "group": "Body",
36831             "type": "String",
36832             "optional": true,
36833             "field": "clientSecret",
36834             "description": ""
36835           },
36836           {
36837             "group": "Body",
36838             "type": "String",
36839             "optional": false,
36840             "field": "serverUrl",
36841             "description": ""
36842           },
36843           {
36844             "group": "Body",
36845             "type": "String",
36846             "optional": true,
36847             "field": "code",
36848             "description": ""
36849           },
36850           {
36851             "group": "Body",
36852             "type": "String",
36853             "optional": true,
36854             "field": "refreshToken",
36855             "description": ""
36856           }
36857         ]
36858       }
36859     },
36860     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36861     "version": "0.0.0",
36862     "filename": "server/api/intZohoAccount/index.js",
36863     "groupTitle": "Zoho_Accounts"
36864   },
36865   {
36866     "type": "delete",
36867     "url": "/api/integrations/zoho/accounts/{id}",
36868     "title": "Deletes a Zoho Account",
36869     "examples": [
36870       {
36871         "title": "Example usage:",
36872         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password} -X DELETE",
36873         "type": "json"
36874       }
36875     ],
36876     "name": "DeleteZoho_Accounts",
36877     "group": "Zoho_Accounts",
36878     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36879     "version": "0.0.0",
36880     "filename": "server/api/intZohoAccount/index.js",
36881     "groupTitle": "Zoho_Accounts"
36882   },
36883   {
36884     "type": "get",
36885     "url": "/api/integrations/zoho/accounts",
36886     "title": "Gets a list of Zoho Accounts",
36887     "examples": [
36888       {
36889         "title": "Example usage:",
36890         "content": "curl https://{domain}/api/integrations/zoho/accounts -v -u {name}:{password}",
36891         "type": "json"
36892       }
36893     ],
36894     "name": "GetZoho_Accounts",
36895     "group": "Zoho_Accounts",
36896     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36897     "version": "0.0.0",
36898     "filename": "server/api/intZohoAccount/index.js",
36899     "groupTitle": "Zoho_Accounts"
36900   },
36901   {
36902     "type": "get",
36903     "url": "/api/integrations/zoho/accounts/{id}",
36904     "title": "Gets a single Zoho Account",
36905     "examples": [
36906       {
36907         "title": "Example usage:",
36908         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password}",
36909         "type": "json"
36910       }
36911     ],
36912     "name": "ShowZoho_Accounts",
36913     "group": "Zoho_Accounts",
36914     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36915     "version": "0.0.0",
36916     "filename": "server/api/intZohoAccount/index.js",
36917     "groupTitle": "Zoho_Accounts"
36918   },
36919   {
36920     "type": "post",
36921     "url": "/api/integrations/zoho/accounts/{id}/configurations",
36922     "title": "Creates new configuration",
36923     "examples": [
36924       {
36925         "title": "Example usage:",
36926         "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",
36927         "type": "json"
36928       }
36929     ],
36930     "name": "addConfiguration",
36931     "group": "Zoho_Accounts",
36932     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36933     "version": "0.0.0",
36934     "filename": "server/api/intZohoAccount/index.js",
36935     "groupTitle": "Zoho_Accounts"
36936   },
36937   {
36938     "type": "get",
36939     "url": "/api/integrations/zoho/accounts/{id}/configurations",
36940     "title": "Gets account configurations",
36941     "examples": [
36942       {
36943         "title": "Example usage:",
36944         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/configurations -v -u {name}:{password} -X GET",
36945         "type": "json"
36946       }
36947     ],
36948     "name": "getConfigurations",
36949     "group": "Zoho_Accounts",
36950     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36951     "version": "0.0.0",
36952     "filename": "server/api/intZohoAccount/index.js",
36953     "groupTitle": "Zoho_Accounts"
36954   },
36955   {
36956     "type": "get",
36957     "url": "/api/integrations/zoho/accounts/{id}/fields",
36958     "title": "Gets account fields",
36959     "examples": [
36960       {
36961         "title": "Example usage:",
36962         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/fields -v -u {name}:{password} -X GET",
36963         "type": "json"
36964       }
36965     ],
36966     "name": "getFields",
36967     "group": "Zoho_Accounts",
36968     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36969     "version": "0.0.0",
36970     "filename": "server/api/intZohoAccount/index.js",
36971     "groupTitle": "Zoho_Accounts"
36972   },
36973   {
36974     "type": "put",
36975     "url": "/api/integrations/zoho/accounts/{id}",
36976     "title": "Update an existing Zoho Account",
36977     "examples": [
36978       {
36979         "title": "Example usage:",
36980         "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",
36981         "type": "json"
36982       }
36983     ],
36984     "name": "updateZoho_Accounts",
36985     "group": "Zoho_Accounts",
36986     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36987     "version": "0.0.0",
36988     "filename": "server/api/intZohoAccount/index.js",
36989     "groupTitle": "Zoho_Accounts"
36990   },
36991   {
36992     "type": "post",
36993     "url": "/api/integrations/zoho/configurations",
36994     "title": "Creates a new Zoho Configuration",
36995     "examples": [
36996       {
36997         "title": "Example usage:",
36998         "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",
36999         "type": "json"
37000       }
37001     ],
37002     "name": "CreateZoho_Configurations",
37003     "group": "Zoho_Configurations",
37004     "parameter": {
37005       "fields": {
37006         "Body": [
37007           {
37008             "group": "Body",
37009             "type": "String",
37010             "optional": true,
37011             "field": "name",
37012             "description": ""
37013           },
37014           {
37015             "group": "Body",
37016             "type": "String",
37017             "allowedValues": [
37018               "\"lead\"",
37019               "\"contact\"",
37020               "\"nothing\""
37021             ],
37022             "optional": true,
37023             "field": "moduleCreate",
37024             "description": ""
37025           },
37026           {
37027             "group": "Body",
37028             "type": "String",
37029             "allowedValues": [
37030               "\"contact_lead\"",
37031               "\"contact\"",
37032               "\"lead\""
37033             ],
37034             "optional": true,
37035             "field": "moduleSearch",
37036             "description": ""
37037           },
37038           {
37039             "group": "Body",
37040             "type": "String",
37041             "optional": true,
37042             "field": "description",
37043             "description": ""
37044           }
37045         ]
37046       }
37047     },
37048     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37049     "version": "0.0.0",
37050     "filename": "server/api/intZohoConfiguration/index.js",
37051     "groupTitle": "Zoho_Configurations"
37052   },
37053   {
37054     "type": "delete",
37055     "url": "/api/integrations/zoho/configurations/{id}",
37056     "title": "Deletes a Zoho Configuration",
37057     "examples": [
37058       {
37059         "title": "Example usage:",
37060         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password} -X DELETE",
37061         "type": "json"
37062       }
37063     ],
37064     "name": "DeleteZoho_Configurations",
37065     "group": "Zoho_Configurations",
37066     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37067     "version": "0.0.0",
37068     "filename": "server/api/intZohoConfiguration/index.js",
37069     "groupTitle": "Zoho_Configurations"
37070   },
37071   {
37072     "type": "get",
37073     "url": "/api/integrations/zoho/configurations",
37074     "title": "Gets a list of Zoho Configurations",
37075     "examples": [
37076       {
37077         "title": "Example usage:",
37078         "content": "curl https://{domain}/api/integrations/zoho/configurations -v -u {name}:{password}",
37079         "type": "json"
37080       }
37081     ],
37082     "name": "GetZoho_Configurations",
37083     "group": "Zoho_Configurations",
37084     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37085     "version": "0.0.0",
37086     "filename": "server/api/intZohoConfiguration/index.js",
37087     "groupTitle": "Zoho_Configurations"
37088   },
37089   {
37090     "type": "get",
37091     "url": "/api/integrations/zoho/configurations/{id}",
37092     "title": "Gets a single Zoho Configuration",
37093     "examples": [
37094       {
37095         "title": "Example usage:",
37096         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password}",
37097         "type": "json"
37098       }
37099     ],
37100     "name": "ShowZoho_Configurations",
37101     "group": "Zoho_Configurations",
37102     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37103     "version": "0.0.0",
37104     "filename": "server/api/intZohoConfiguration/index.js",
37105     "groupTitle": "Zoho_Configurations"
37106   },
37107   {
37108     "type": "get",
37109     "url": "/api/integrations/zoho/configurations/{id}/descriptions",
37110     "title": "Gets configurations descriptions",
37111     "examples": [
37112       {
37113         "title": "Example usage:",
37114         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
37115         "type": "json"
37116       }
37117     ],
37118     "name": "getDescriptions",
37119     "group": "Zoho_Configurations",
37120     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37121     "version": "0.0.0",
37122     "filename": "server/api/intZohoConfiguration/index.js",
37123     "groupTitle": "Zoho_Configurations"
37124   },
37125   {
37126     "type": "get",
37127     "url": "/api/integrations/zoho/configurations/{id}/fields",
37128     "title": "Gets configurations fields",
37129     "examples": [
37130       {
37131         "title": "Example usage:",
37132         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
37133         "type": "json"
37134       }
37135     ],
37136     "name": "getFields",
37137     "group": "Zoho_Configurations",
37138     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37139     "version": "0.0.0",
37140     "filename": "server/api/intZohoConfiguration/index.js",
37141     "groupTitle": "Zoho_Configurations"
37142   },
37143   {
37144     "type": "get",
37145     "url": "/api/integrations/zoho/configurations/{id}/subjects",
37146     "title": "Gets configurations subjects",
37147     "examples": [
37148       {
37149         "title": "Example usage:",
37150         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/subjects -v -u {name}:{password} -X GET",
37151         "type": "json"
37152       }
37153     ],
37154     "name": "getSubjects",
37155     "group": "Zoho_Configurations",
37156     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37157     "version": "0.0.0",
37158     "filename": "server/api/intZohoConfiguration/index.js",
37159     "groupTitle": "Zoho_Configurations"
37160   },
37161   {
37162     "type": "put",
37163     "url": "/api/integrations/zoho/configurations/{id}",
37164     "title": "Update an existing Zoho Configuration",
37165     "examples": [
37166       {
37167         "title": "Example usage:",
37168         "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",
37169         "type": "json"
37170       }
37171     ],
37172     "name": "updateZoho_Configurations",
37173     "group": "Zoho_Configurations",
37174     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37175     "version": "0.0.0",
37176     "filename": "server/api/intZohoConfiguration/index.js",
37177     "groupTitle": "Zoho_Configurations"
37178   },
37179   {
37180     "type": "post",
37181     "url": "/api/integrations/zoho/fields",
37182     "title": "Creates a new Zoho Field",
37183     "examples": [
37184       {
37185         "title": "Example usage:",
37186         "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",
37187         "type": "json"
37188       }
37189     ],
37190     "name": "CreateZoho_Fields",
37191     "group": "Zoho_Fields",
37192     "parameter": {
37193       "fields": {
37194         "Body": [
37195           {
37196             "group": "Body",
37197             "type": "String",
37198             "allowedValues": [
37199               "\"string\"",
37200               "\"variable\"",
37201               "\"customVariable\"",
37202               "\"keyValue\"",
37203               "\"picklist\""
37204             ],
37205             "optional": true,
37206             "field": "type",
37207             "description": ""
37208           },
37209           {
37210             "group": "Body",
37211             "type": "String",
37212             "optional": true,
37213             "field": "content",
37214             "description": ""
37215           },
37216           {
37217             "group": "Body",
37218             "type": "String",
37219             "optional": true,
37220             "field": "key",
37221             "description": ""
37222           },
37223           {
37224             "group": "Body",
37225             "type": "String",
37226             "allowedValues": [
37227               "\"string\"",
37228               "\"variable\"",
37229               "\"customVariable\""
37230             ],
37231             "optional": true,
37232             "field": "keyType",
37233             "description": ""
37234           },
37235           {
37236             "group": "Body",
37237             "type": "String",
37238             "optional": true,
37239             "field": "keyContent",
37240             "description": ""
37241           },
37242           {
37243             "group": "Body",
37244             "type": "String",
37245             "optional": true,
37246             "field": "idField",
37247             "description": ""
37248           },
37249           {
37250             "group": "Body",
37251             "type": "String",
37252             "optional": true,
37253             "field": "nameField",
37254             "description": ""
37255           },
37256           {
37257             "group": "Body",
37258             "type": "Boolean",
37259             "optional": true,
37260             "field": "customField",
37261             "description": ""
37262           },
37263           {
37264             "group": "Body",
37265             "type": "String",
37266             "optional": true,
37267             "field": "variableName",
37268             "description": ""
37269           }
37270         ]
37271       }
37272     },
37273     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37274     "version": "0.0.0",
37275     "filename": "server/api/intZohoField/index.js",
37276     "groupTitle": "Zoho_Fields"
37277   },
37278   {
37279     "type": "delete",
37280     "url": "/api/integrations/zoho/fields/{id}",
37281     "title": "Deletes a Zoho Field",
37282     "examples": [
37283       {
37284         "title": "Example usage:",
37285         "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password} -X DELETE",
37286         "type": "json"
37287       }
37288     ],
37289     "name": "DeleteZoho_Fields",
37290     "group": "Zoho_Fields",
37291     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37292     "version": "0.0.0",
37293     "filename": "server/api/intZohoField/index.js",
37294     "groupTitle": "Zoho_Fields"
37295   },
37296   {
37297     "type": "get",
37298     "url": "/api/integrations/zoho/fields",
37299     "title": "Gets a list of Zoho Fields",
37300     "examples": [
37301       {
37302         "title": "Example usage:",
37303         "content": "curl https://{domain}/api/integrations/zoho/fields -v -u {name}:{password}",
37304         "type": "json"
37305       }
37306     ],
37307     "name": "GetZoho_Fields",
37308     "group": "Zoho_Fields",
37309     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37310     "version": "0.0.0",
37311     "filename": "server/api/intZohoField/index.js",
37312     "groupTitle": "Zoho_Fields"
37313   },
37314   {
37315     "type": "get",
37316     "url": "/api/integrations/zoho/fields/{id}",
37317     "title": "Gets a single Zoho Field",
37318     "examples": [
37319       {
37320         "title": "Example usage:",
37321         "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password}",
37322         "type": "json"
37323       }
37324     ],
37325     "name": "ShowZoho_Fields",
37326     "group": "Zoho_Fields",
37327     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37328     "version": "0.0.0",
37329     "filename": "server/api/intZohoField/index.js",
37330     "groupTitle": "Zoho_Fields"
37331   },
37332   {
37333     "type": "put",
37334     "url": "/api/integrations/zoho/fields/{id}",
37335     "title": "Update an existing Zoho Field",
37336     "examples": [
37337       {
37338         "title": "Example usage:",
37339         "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",
37340         "type": "json"
37341       }
37342     ],
37343     "name": "updateZoho_Fields",
37344     "group": "Zoho_Fields",
37345     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37346     "version": "0.0.0",
37347     "filename": "server/api/intZohoField/index.js",
37348     "groupTitle": "Zoho_Fields"
37349   },
37350   {
37351     "type": "post",
37352     "url": "/api/cdr",
37353     "title": "Creates a new Cdr",
37354     "examples": [
37355       {
37356         "title": "Example usage:",
37357         "content": "curl https://{domain}/api/cdr -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
37358         "type": "json"
37359       }
37360     ],
37361     "name": "CreateCdrs",
37362     "group": "cdr",
37363     "parameter": {
37364       "fields": {
37365         "Body": [
37366           {
37367             "group": "Body",
37368             "type": "String",
37369             "optional": false,
37370             "field": "calldate",
37371             "description": ""
37372           },
37373           {
37374             "group": "Body",
37375             "type": "String",
37376             "optional": true,
37377             "field": "clid",
37378             "description": ""
37379           },
37380           {
37381             "group": "Body",
37382             "type": "String",
37383             "optional": true,
37384             "field": "src",
37385             "description": ""
37386           },
37387           {
37388             "group": "Body",
37389             "type": "String",
37390             "optional": true,
37391             "field": "dst",
37392             "description": ""
37393           },
37394           {
37395             "group": "Body",
37396             "type": "String",
37397             "optional": true,
37398             "field": "dcontext",
37399             "description": ""
37400           },
37401           {
37402             "group": "Body",
37403             "type": "String",
37404             "optional": true,
37405             "field": "channel",
37406             "description": ""
37407           },
37408           {
37409             "group": "Body",
37410             "type": "String",
37411             "optional": true,
37412             "field": "dstchannel",
37413             "description": ""
37414           },
37415           {
37416             "group": "Body",
37417             "type": "String",
37418             "optional": true,
37419             "field": "lastapp",
37420             "description": ""
37421           },
37422           {
37423             "group": "Body",
37424             "type": "String",
37425             "optional": true,
37426             "field": "lastdata",
37427             "description": ""
37428           },
37429           {
37430             "group": "Body",
37431             "type": "Integer",
37432             "optional": false,
37433             "field": "duration",
37434             "description": ""
37435           },
37436           {
37437             "group": "Body",
37438             "type": "Integer",
37439             "optional": false,
37440             "field": "billsec",
37441             "description": ""
37442           },
37443           {
37444             "group": "Body",
37445             "type": "String",
37446             "optional": true,
37447             "field": "disposition",
37448             "description": ""
37449           },
37450           {
37451             "group": "Body",
37452             "type": "Integer",
37453             "optional": false,
37454             "field": "amaflags",
37455             "description": ""
37456           },
37457           {
37458             "group": "Body",
37459             "type": "String",
37460             "optional": true,
37461             "field": "accountcode",
37462             "description": ""
37463           },
37464           {
37465             "group": "Body",
37466             "type": "String",
37467             "optional": true,
37468             "field": "userfield",
37469             "description": ""
37470           },
37471           {
37472             "group": "Body",
37473             "type": "String",
37474             "optional": true,
37475             "field": "uniqueid",
37476             "description": ""
37477           },
37478           {
37479             "group": "Body",
37480             "type": "String",
37481             "optional": true,
37482             "field": "linkedid",
37483             "description": ""
37484           },
37485           {
37486             "group": "Body",
37487             "type": "String",
37488             "optional": true,
37489             "field": "sequence",
37490             "description": ""
37491           },
37492           {
37493             "group": "Body",
37494             "type": "String",
37495             "optional": true,
37496             "field": "peeraccount",
37497             "description": ""
37498           },
37499           {
37500             "group": "Body",
37501             "type": "String",
37502             "optional": true,
37503             "field": "type",
37504             "description": ""
37505           },
37506           {
37507             "group": "Body",
37508             "type": "String",
37509             "optional": true,
37510             "field": "tag",
37511             "description": ""
37512           }
37513         ]
37514       }
37515     },
37516     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37517     "version": "0.0.0",
37518     "filename": "server/api/cdr/index.js",
37519     "groupTitle": "cdr"
37520   },
37521   {
37522     "type": "delete",
37523     "url": "/api/cdr/{id}",
37524     "title": "Deletes a Cdr",
37525     "examples": [
37526       {
37527         "title": "Example usage:",
37528         "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password} -X DELETE",
37529         "type": "json"
37530       }
37531     ],
37532     "name": "DeleteCdrs",
37533     "group": "cdr",
37534     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37535     "version": "0.0.0",
37536     "filename": "server/api/cdr/index.js",
37537     "groupTitle": "cdr"
37538   },
37539   {
37540     "type": "get",
37541     "url": "/api/cdr/describe",
37542     "title": "Gets table info about Cdrs",
37543     "examples": [
37544       {
37545         "title": "Example usage:",
37546         "content": "curl https://{domain}/api/cdr/describe -v -u {name}:{password}",
37547         "type": "json"
37548       }
37549     ],
37550     "name": "DescribeCdrs",
37551     "group": "cdr",
37552     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37553     "version": "0.0.0",
37554     "filename": "server/api/cdr/index.js",
37555     "groupTitle": "cdr"
37556   },
37557   {
37558     "type": "get",
37559     "url": "/api/cdr",
37560     "title": "Gets a list of Cdrs",
37561     "examples": [
37562       {
37563         "title": "Example usage:",
37564         "content": "curl https://{domain}/api/cdr -v -u {name}:{password}",
37565         "type": "json"
37566       }
37567     ],
37568     "name": "GetCdrs",
37569     "group": "cdr",
37570     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37571     "version": "0.0.0",
37572     "filename": "server/api/cdr/index.js",
37573     "groupTitle": "cdr"
37574   },
37575   {
37576     "type": "get",
37577     "url": "/api/cdr/{id}",
37578     "title": "Gets a single Cdr",
37579     "examples": [
37580       {
37581         "title": "Example usage:",
37582         "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password}",
37583         "type": "json"
37584       }
37585     ],
37586     "name": "ShowCdrs",
37587     "group": "cdr",
37588     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37589     "version": "0.0.0",
37590     "filename": "server/api/cdr/index.js",
37591     "groupTitle": "cdr"
37592   },
37593   {
37594     "type": "put",
37595     "url": "/api/cdr/{id}",
37596     "title": "Update an existing Cdr",
37597     "examples": [
37598       {
37599         "title": "Example usage:",
37600         "content": "curl https://{domain}/api/cdr/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
37601         "type": "json"
37602       }
37603     ],
37604     "name": "updateCdrs",
37605     "group": "cdr",
37606     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37607     "version": "0.0.0",
37608     "filename": "server/api/cdr/index.js",
37609     "groupTitle": "cdr"
37610   },
37611   {
37612     "type": "post",
37613     "url": "/api/voiceQueuesLog",
37614     "title": "Creates a new VoiceQueuesLog",
37615     "examples": [
37616       {
37617         "title": "Example usage:",
37618         "content": "curl https://{domain}/api/voiceQueuesLog -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
37619         "type": "json"
37620       }
37621     ],
37622     "name": "CreateVoiceQueuesLogs",
37623     "group": "voiceQueuesLog",
37624     "parameter": {
37625       "fields": {
37626         "Body": [
37627           {
37628             "group": "Body",
37629             "type": "String",
37630             "optional": true,
37631             "field": "time",
37632             "description": ""
37633           },
37634           {
37635             "group": "Body",
37636             "type": "String",
37637             "optional": false,
37638             "field": "callid",
37639             "description": ""
37640           },
37641           {
37642             "group": "Body",
37643             "type": "String",
37644             "optional": false,
37645             "field": "queuename",
37646             "description": ""
37647           },
37648           {
37649             "group": "Body",
37650             "type": "String",
37651             "optional": false,
37652             "field": "agent",
37653             "description": ""
37654           },
37655           {
37656             "group": "Body",
37657             "type": "String",
37658             "optional": false,
37659             "field": "event",
37660             "description": ""
37661           },
37662           {
37663             "group": "Body",
37664             "type": "String",
37665             "optional": false,
37666             "field": "data",
37667             "description": ""
37668           },
37669           {
37670             "group": "Body",
37671             "type": "String",
37672             "optional": false,
37673             "field": "data1",
37674             "description": ""
37675           },
37676           {
37677             "group": "Body",
37678             "type": "String",
37679             "optional": false,
37680             "field": "data2",
37681             "description": ""
37682           },
37683           {
37684             "group": "Body",
37685             "type": "String",
37686             "optional": false,
37687             "field": "data3",
37688             "description": ""
37689           },
37690           {
37691             "group": "Body",
37692             "type": "String",
37693             "optional": false,
37694             "field": "data4",
37695             "description": ""
37696           },
37697           {
37698             "group": "Body",
37699             "type": "String",
37700             "optional": false,
37701             "field": "data5",
37702             "description": ""
37703           },
37704           {
37705             "group": "Body",
37706             "type": "String",
37707             "optional": false,
37708             "field": "dtm",
37709             "description": ""
37710           }
37711         ]
37712       }
37713     },
37714     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37715     "version": "0.0.0",
37716     "filename": "server/api/voiceQueuesLog/index.js",
37717     "groupTitle": "voiceQueuesLog"
37718   },
37719   {
37720     "type": "delete",
37721     "url": "/api/voiceQueuesLog/{id}",
37722     "title": "Deletes a VoiceQueuesLog",
37723     "examples": [
37724       {
37725         "title": "Example usage:",
37726         "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password} -X DELETE",
37727         "type": "json"
37728       }
37729     ],
37730     "name": "DeleteVoiceQueuesLogs",
37731     "group": "voiceQueuesLog",
37732     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37733     "version": "0.0.0",
37734     "filename": "server/api/voiceQueuesLog/index.js",
37735     "groupTitle": "voiceQueuesLog"
37736   },
37737   {
37738     "type": "get",
37739     "url": "/api/voiceQueuesLog",
37740     "title": "Gets a list of VoiceQueuesLogs",
37741     "examples": [
37742       {
37743         "title": "Example usage:",
37744         "content": "curl https://{domain}/api/voiceQueuesLog -v -u {name}:{password}",
37745         "type": "json"
37746       }
37747     ],
37748     "name": "GetVoiceQueuesLogs",
37749     "group": "voiceQueuesLog",
37750     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37751     "version": "0.0.0",
37752     "filename": "server/api/voiceQueuesLog/index.js",
37753     "groupTitle": "voiceQueuesLog"
37754   },
37755   {
37756     "type": "get",
37757     "url": "/api/voiceQueuesLog/{id}",
37758     "title": "Gets a single VoiceQueuesLog",
37759     "examples": [
37760       {
37761         "title": "Example usage:",
37762         "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password}",
37763         "type": "json"
37764       }
37765     ],
37766     "name": "ShowVoiceQueuesLogs",
37767     "group": "voiceQueuesLog",
37768     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37769     "version": "0.0.0",
37770     "filename": "server/api/voiceQueuesLog/index.js",
37771     "groupTitle": "voiceQueuesLog"
37772   },
37773   {
37774     "type": "put",
37775     "url": "/api/voiceQueuesLog/{id}",
37776     "title": "Update an existing VoiceQueuesLog",
37777     "examples": [
37778       {
37779         "title": "Example usage:",
37780         "content": "curl https://{domain}/api/voiceQueuesLog/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
37781         "type": "json"
37782       }
37783     ],
37784     "name": "updateVoiceQueuesLogs",
37785     "group": "voiceQueuesLog",
37786     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37787     "version": "0.0.0",
37788     "filename": "server/api/voiceQueuesLog/index.js",
37789     "groupTitle": "voiceQueuesLog"
37790   }
37791 ]