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       }
4387     },
4388     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4389     "version": "0.0.0",
4390     "filename": "server/api/chatWebsite/index.js",
4391     "groupTitle": "Chat_Websites"
4392   },
4393   {
4394     "type": "delete",
4395     "url": "/api/chat/websites/{id}",
4396     "title": "Deletes a Website",
4397     "examples": [
4398       {
4399         "title": "Example usage:",
4400         "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password} -X DELETE",
4401         "type": "json"
4402       }
4403     ],
4404     "name": "DeleteWebsites",
4405     "group": "Chat_Websites",
4406     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4407     "version": "0.0.0",
4408     "filename": "server/api/chatWebsite/index.js",
4409     "groupTitle": "Chat_Websites"
4410   },
4411   {
4412     "type": "get",
4413     "url": "/api/chat/websites/describe",
4414     "title": "Gets table info about Websites",
4415     "examples": [
4416       {
4417         "title": "Example usage:",
4418         "content": "curl https://{domain}/api/chat/websites/describe -v -u {name}:{password}",
4419         "type": "json"
4420       }
4421     ],
4422     "name": "DescribeWebsites",
4423     "group": "Chat_Websites",
4424     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4425     "version": "0.0.0",
4426     "filename": "server/api/chatWebsite/index.js",
4427     "groupTitle": "Chat_Websites"
4428   },
4429   {
4430     "type": "get",
4431     "url": "/api/chat/websites/{id}/users",
4432     "title": "Gets agents from website",
4433     "examples": [
4434       {
4435         "title": "Example usage:",
4436         "content": "curl https://{domain}/api/chat/websites/{id}/users -v -u {name}:{password} -X GET",
4437         "type": "json"
4438       }
4439     ],
4440     "name": "GetAgents",
4441     "group": "Chat_Websites",
4442     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4443     "version": "0.0.0",
4444     "filename": "server/api/chatWebsite/index.js",
4445     "groupTitle": "Chat_Websites"
4446   },
4447   {
4448     "type": "get",
4449     "url": "/api/chat/websites",
4450     "title": "Gets a list of Websites",
4451     "examples": [
4452       {
4453         "title": "Example usage:",
4454         "content": "curl https://{domain}/api/chat/websites -v -u {name}:{password}",
4455         "type": "json"
4456       }
4457     ],
4458     "name": "GetWebsites",
4459     "group": "Chat_Websites",
4460     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/websites?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/websites?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/websites?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/websites?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/websites?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
4461     "version": "0.0.0",
4462     "filename": "server/api/chatWebsite/index.js",
4463     "groupTitle": "Chat_Websites"
4464   },
4465   {
4466     "type": "delete",
4467     "url": "/api/chat/websites/{id}/users",
4468     "title": "Removes agents from a website",
4469     "examples": [
4470       {
4471         "title": "Example usage:",
4472         "content": "curl https://{domain}/api/chat/websites/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4473         "type": "json"
4474       }
4475     ],
4476     "name": "RemoveAgents",
4477     "group": "Chat_Websites",
4478     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4479     "version": "0.0.0",
4480     "filename": "server/api/chatWebsite/index.js",
4481     "groupTitle": "Chat_Websites"
4482   },
4483   {
4484     "type": "delete",
4485     "url": "/api/chat/websites/{id}/canned_answers",
4486     "title": "Removes canned answers from account",
4487     "examples": [
4488       {
4489         "title": "Example usage:",
4490         "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4491         "type": "json"
4492       }
4493     ],
4494     "name": "RemoveAnswers",
4495     "group": "Chat_Websites",
4496     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4497     "version": "0.0.0",
4498     "filename": "server/api/chatWebsite/index.js",
4499     "groupTitle": "Chat_Websites"
4500   },
4501   {
4502     "type": "delete",
4503     "url": "/api/chat/websites/{id}/dispositions",
4504     "title": "Removes canned answers from account",
4505     "examples": [
4506       {
4507         "title": "Example usage:",
4508         "content": "curl https://{domain}/api/chat/websites/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4509         "type": "json"
4510       }
4511     ],
4512     "name": "RemoveDispositions",
4513     "group": "Chat_Websites",
4514     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4515     "version": "0.0.0",
4516     "filename": "server/api/chatWebsite/index.js",
4517     "groupTitle": "Chat_Websites"
4518   },
4519   {
4520     "type": "get",
4521     "url": "/api/chat/websites/{id}",
4522     "title": "Gets a single Website",
4523     "examples": [
4524       {
4525         "title": "Example usage:",
4526         "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password}",
4527         "type": "json"
4528       }
4529     ],
4530     "name": "ShowWebsites",
4531     "group": "Chat_Websites",
4532     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4533     "version": "0.0.0",
4534     "filename": "server/api/chatWebsite/index.js",
4535     "groupTitle": "Chat_Websites"
4536   },
4537   {
4538     "type": "put",
4539     "url": "/api/chat/messages/{id}/accept",
4540     "title": "Accepts message",
4541     "examples": [
4542       {
4543         "title": "Example usage:",
4544         "content": "curl https://{domain}/api/chat/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
4545         "type": "json"
4546       }
4547     ],
4548     "name": "acceptMessage",
4549     "group": "Chat_Websites",
4550     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4551     "version": "0.0.0",
4552     "filename": "server/api/chatMessage/index.js",
4553     "groupTitle": "Chat_Websites"
4554   },
4555   {
4556     "type": "post",
4557     "url": "/api/chat/websites/{id}/canned_answers",
4558     "title": "Creates new canned answer",
4559     "examples": [
4560       {
4561         "title": "Example usage:",
4562         "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers -d '{\"name\": \"vip\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4563         "type": "json"
4564       }
4565     ],
4566     "name": "addAnswer",
4567     "group": "Chat_Websites",
4568     "parameter": {
4569       "fields": {
4570         "Body": [
4571           {
4572             "group": "Body",
4573             "type": "String",
4574             "optional": false,
4575             "field": "key",
4576             "description": ""
4577           },
4578           {
4579             "group": "Body",
4580             "type": "Text",
4581             "optional": false,
4582             "field": "value",
4583             "description": ""
4584           },
4585           {
4586             "group": "Body",
4587             "type": "String",
4588             "optional": true,
4589             "field": "description",
4590             "description": ""
4591           },
4592           {
4593             "group": "Body",
4594             "type": "Virtual",
4595             "optional": true,
4596             "field": "name",
4597             "description": ""
4598           }
4599         ]
4600       }
4601     },
4602     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4603     "version": "0.0.0",
4604     "filename": "server/api/chatWebsite/index.js",
4605     "groupTitle": "Chat_Websites"
4606   },
4607   {
4608     "type": "post",
4609     "url": "/api/chat/websites/{id}/applications",
4610     "title": "Creates new applications",
4611     "examples": [
4612       {
4613         "title": "Example usage:",
4614         "content": "curl https://{domain}/api/chat/websites/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4615         "type": "json"
4616       }
4617     ],
4618     "name": "addApplications",
4619     "group": "Chat_Websites",
4620     "parameter": {
4621       "fields": {
4622         "Body": [
4623           {
4624             "group": "Body",
4625             "type": "Integer",
4626             "optional": false,
4627             "field": "priority",
4628             "description": ""
4629           },
4630           {
4631             "group": "Body",
4632             "type": "String",
4633             "optional": false,
4634             "field": "app",
4635             "description": ""
4636           },
4637           {
4638             "group": "Body",
4639             "type": "Text",
4640             "optional": true,
4641             "field": "appdata",
4642             "description": ""
4643           },
4644           {
4645             "group": "Body",
4646             "type": "String",
4647             "optional": true,
4648             "field": "description",
4649             "description": ""
4650           },
4651           {
4652             "group": "Body",
4653             "type": "String",
4654             "optional": true,
4655             "field": "interval",
4656             "description": ""
4657           }
4658         ]
4659       }
4660     },
4661     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4662     "version": "0.0.0",
4663     "filename": "server/api/chatWebsite/index.js",
4664     "groupTitle": "Chat_Websites"
4665   },
4666   {
4667     "type": "post",
4668     "url": "/api/chat/websites/{id}/avatar",
4669     "title": "Add avatar",
4670     "examples": [
4671       {
4672         "title": "Example usage:",
4673         "content": "curl https://{domain}/api/chat/websites/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
4674         "type": "json"
4675       }
4676     ],
4677     "name": "addAvatar",
4678     "group": "Chat_Websites",
4679     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4680     "version": "0.0.0",
4681     "filename": "server/api/chatWebsite/index.js",
4682     "groupTitle": "Chat_Websites"
4683   },
4684   {
4685     "type": "post",
4686     "url": "/api/chat/websites/{id}/customer_avatar",
4687     "title": "Add customer avatar",
4688     "examples": [
4689       {
4690         "title": "Example usage:",
4691         "content": "curl https://{domain}/api/chat/websites/{id}/customer_avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
4692         "type": "json"
4693       }
4694     ],
4695     "name": "addCustomerAvatar",
4696     "group": "Chat_Websites",
4697     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4698     "version": "0.0.0",
4699     "filename": "server/api/chatWebsite/index.js",
4700     "groupTitle": "Chat_Websites"
4701   },
4702   {
4703     "type": "post",
4704     "url": "/api/chat/websites/{id}/dispositions",
4705     "title": "Creates new disposition",
4706     "examples": [
4707       {
4708         "title": "Example usage:",
4709         "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4710         "type": "json"
4711       }
4712     ],
4713     "name": "addDisposition",
4714     "group": "Chat_Websites",
4715     "parameter": {
4716       "fields": {
4717         "Body": [
4718           {
4719             "group": "Body",
4720             "type": "String",
4721             "optional": false,
4722             "field": "name",
4723             "description": ""
4724           },
4725           {
4726             "group": "Body",
4727             "type": "String",
4728             "allowedValues": [
4729               "\"first\"",
4730               "\"second\"",
4731               "\"third\""
4732             ],
4733             "optional": false,
4734             "field": "level",
4735             "description": ""
4736           },
4737           {
4738             "group": "Body",
4739             "type": "String",
4740             "optional": true,
4741             "field": "description",
4742             "description": ""
4743           }
4744         ]
4745       }
4746     },
4747     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4748     "version": "0.0.0",
4749     "filename": "server/api/chatWebsite/index.js",
4750     "groupTitle": "Chat_Websites"
4751   },
4752   {
4753     "type": "post",
4754     "url": "/api/chat/accounts/{id}/interactions",
4755     "title": "Creates new interactions",
4756     "examples": [
4757       {
4758         "title": "Example usage:",
4759         "content": "curl https://{domain}/api/chat/websites/{id}/interactions -d '{\"host\": \"host\", \"username\": \"username\", \"password\": \"password\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4760         "type": "json"
4761       }
4762     ],
4763     "name": "addInteraction",
4764     "group": "Chat_Websites",
4765     "parameter": {
4766       "fields": {
4767         "Body": [
4768           {
4769             "group": "Body",
4770             "type": "Boolean",
4771             "optional": true,
4772             "field": "closed",
4773             "description": ""
4774           },
4775           {
4776             "group": "Body",
4777             "type": "Integer",
4778             "optional": true,
4779             "field": "ratingValue",
4780             "description": ""
4781           },
4782           {
4783             "group": "Body",
4784             "type": "String",
4785             "allowedValues": [
4786               "\"star\"",
4787               "\"thumb\""
4788             ],
4789             "optional": true,
4790             "field": "ratingType",
4791             "description": ""
4792           },
4793           {
4794             "group": "Body",
4795             "type": "Text",
4796             "optional": true,
4797             "field": "ratingMessage",
4798             "description": ""
4799           },
4800           {
4801             "group": "Body",
4802             "type": "Text",
4803             "optional": true,
4804             "field": "pathTranscript",
4805             "description": ""
4806           },
4807           {
4808             "group": "Body",
4809             "type": "String",
4810             "optional": true,
4811             "field": "mailTranscript",
4812             "description": ""
4813           },
4814           {
4815             "group": "Body",
4816             "type": "String",
4817             "optional": true,
4818             "field": "closedAt",
4819             "description": ""
4820           },
4821           {
4822             "group": "Body",
4823             "type": "String",
4824             "optional": true,
4825             "field": "disposition",
4826             "description": ""
4827           },
4828           {
4829             "group": "Body",
4830             "type": "String",
4831             "optional": true,
4832             "field": "secondDisposition",
4833             "description": ""
4834           },
4835           {
4836             "group": "Body",
4837             "type": "String",
4838             "optional": true,
4839             "field": "thirdDisposition",
4840             "description": ""
4841           },
4842           {
4843             "group": "Body",
4844             "type": "String",
4845             "optional": true,
4846             "field": "note",
4847             "description": ""
4848           },
4849           {
4850             "group": "Body",
4851             "type": "String",
4852             "optional": true,
4853             "field": "browserName",
4854             "description": ""
4855           },
4856           {
4857             "group": "Body",
4858             "type": "String",
4859             "optional": true,
4860             "field": "browserVersion",
4861             "description": ""
4862           },
4863           {
4864             "group": "Body",
4865             "type": "String",
4866             "optional": true,
4867             "field": "osName",
4868             "description": ""
4869           },
4870           {
4871             "group": "Body",
4872             "type": "String",
4873             "optional": true,
4874             "field": "osVersion",
4875             "description": ""
4876           },
4877           {
4878             "group": "Body",
4879             "type": "String",
4880             "optional": true,
4881             "field": "deviceModel",
4882             "description": ""
4883           },
4884           {
4885             "group": "Body",
4886             "type": "String",
4887             "optional": true,
4888             "field": "deviceVendor",
4889             "description": ""
4890           },
4891           {
4892             "group": "Body",
4893             "type": "String",
4894             "optional": true,
4895             "field": "deviceType",
4896             "description": ""
4897           },
4898           {
4899             "group": "Body",
4900             "type": "Text",
4901             "optional": true,
4902             "field": "referer",
4903             "description": ""
4904           },
4905           {
4906             "group": "Body",
4907             "type": "String",
4908             "optional": true,
4909             "field": "customerIp",
4910             "description": ""
4911           },
4912           {
4913             "group": "Body",
4914             "type": "Text",
4915             "optional": true,
4916             "field": "formData",
4917             "description": ""
4918           },
4919           {
4920             "group": "Body",
4921             "type": "String",
4922             "optional": true,
4923             "field": "read1stAt",
4924             "description": ""
4925           },
4926           {
4927             "group": "Body",
4928             "type": "String",
4929             "optional": true,
4930             "field": "lastMsgAt",
4931             "description": ""
4932           },
4933           {
4934             "group": "Body",
4935             "type": "String",
4936             "allowedValues": [
4937               "\"in\"",
4938               "\"out\""
4939             ],
4940             "optional": false,
4941             "field": "lastMsgDirection",
4942             "description": ""
4943           },
4944           {
4945             "group": "Body",
4946             "type": "String",
4947             "optional": true,
4948             "field": "closeReason",
4949             "description": ""
4950           },
4951           {
4952             "group": "Body",
4953             "type": "String",
4954             "optional": true,
4955             "field": "customerPort",
4956             "description": ""
4957           },
4958           {
4959             "group": "Body",
4960             "type": "Text",
4961             "optional": true,
4962             "field": "vidaooSessionId",
4963             "description": ""
4964           }
4965         ]
4966       }
4967     },
4968     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4969     "version": "0.0.0",
4970     "filename": "server/api/chatWebsite/index.js",
4971     "groupTitle": "Chat_Websites"
4972   },
4973   {
4974     "type": "post",
4975     "url": "/api/chat/websites/{id}/logo",
4976     "title": "Add logo",
4977     "examples": [
4978       {
4979         "title": "Example usage:",
4980         "content": "curl https://{domain}/api/chat/websites/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
4981         "type": "json"
4982       }
4983     ],
4984     "name": "addLogo",
4985     "group": "Chat_Websites",
4986     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4987     "version": "0.0.0",
4988     "filename": "server/api/chatWebsite/index.js",
4989     "groupTitle": "Chat_Websites"
4990   },
4991   {
4992     "type": "post",
4993     "url": "/api/chat/websites/{id}/proactive_actions",
4994     "title": "Creates new Proactive Actions",
4995     "examples": [
4996       {
4997         "title": "Example usage:",
4998         "content": "curl https://{domain}/api/chat/websites/{id}/proactive_actions -d '[{\"name\": \"Satisfied\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4999         "type": "json"
5000       }
5001     ],
5002     "name": "addProactiveActions",
5003     "group": "Chat_Websites",
5004     "parameter": {
5005       "fields": {
5006         "Body": [
5007           {
5008             "group": "Body",
5009             "type": "String",
5010             "optional": false,
5011             "field": "name",
5012             "description": ""
5013           },
5014           {
5015             "group": "Body",
5016             "type": "String",
5017             "allowedValues": [
5018               "\"mouseOver\"",
5019               "\"timeout\""
5020             ],
5021             "optional": true,
5022             "field": "type",
5023             "description": ""
5024           },
5025           {
5026             "group": "Body",
5027             "type": "String",
5028             "optional": true,
5029             "field": "selector",
5030             "description": ""
5031           },
5032           {
5033             "group": "Body",
5034             "type": "Integer",
5035             "optional": true,
5036             "field": "timeout",
5037             "description": ""
5038           }
5039         ]
5040       }
5041     },
5042     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5043     "version": "0.0.0",
5044     "filename": "server/api/chatWebsite/index.js",
5045     "groupTitle": "Chat_Websites"
5046   },
5047   {
5048     "type": "post",
5049     "url": "/api/chat/websites/{id}/system_avatar",
5050     "title": "Add system avatar",
5051     "examples": [
5052       {
5053         "title": "Example usage:",
5054         "content": "curl https://{domain}/api/chat/websites/{id}/system_avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
5055         "type": "json"
5056       }
5057     ],
5058     "name": "addSystemAvatar",
5059     "group": "Chat_Websites",
5060     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5061     "version": "0.0.0",
5062     "filename": "server/api/chatWebsite/index.js",
5063     "groupTitle": "Chat_Websites"
5064   },
5065   {
5066     "type": "get",
5067     "url": "/api/chat/websites/{id}/canned_answers",
5068     "title": "Gets account canned answers",
5069     "examples": [
5070       {
5071         "title": "Example usage:",
5072         "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers -v -u {name}:{password} -X GET",
5073         "type": "json"
5074       }
5075     ],
5076     "name": "getAnswers",
5077     "group": "Chat_Websites",
5078     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5079     "version": "0.0.0",
5080     "filename": "server/api/chatWebsite/index.js",
5081     "groupTitle": "Chat_Websites"
5082   },
5083   {
5084     "type": "get",
5085     "url": "/api/chat/websites/{id}/applications",
5086     "title": "Gets Website Applications",
5087     "examples": [
5088       {
5089         "title": "Example usage:",
5090         "content": "curl https://{domain}/api/chat/websites/{id}/applications -v -u {name}:{password} -X GET",
5091         "type": "json"
5092       }
5093     ],
5094     "name": "getApplications",
5095     "group": "Chat_Websites",
5096     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5097     "version": "0.0.0",
5098     "filename": "server/api/chatWebsite/index.js",
5099     "groupTitle": "Chat_Websites"
5100   },
5101   {
5102     "type": "get",
5103     "url": "/api/chat/websites/{id}/avatar",
5104     "title": "Get avatar",
5105     "examples": [
5106       {
5107         "title": "Example usage:",
5108         "content": "curl https://{domain}/api/chat/websites/{id}/avatar -v -u {name}:{password} -X GET",
5109         "type": "json"
5110       }
5111     ],
5112     "name": "getAvatar",
5113     "group": "Chat_Websites",
5114     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5115     "version": "0.0.0",
5116     "filename": "server/api/chatWebsite/index.js",
5117     "groupTitle": "Chat_Websites"
5118   },
5119   {
5120     "type": "get",
5121     "url": "/api/chat/websites/{id}/customer_avatar",
5122     "title": "Get Customer Avatar",
5123     "examples": [
5124       {
5125         "title": "Example usage:",
5126         "content": "curl https://{domain}/api/chat/websites/{id}/customer_avatar -v -u {name}:{password} -X GET",
5127         "type": "json"
5128       }
5129     ],
5130     "name": "getCustomerAvatar",
5131     "group": "Chat_Websites",
5132     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5133     "version": "0.0.0",
5134     "filename": "server/api/chatWebsite/index.js",
5135     "groupTitle": "Chat_Websites"
5136   },
5137   {
5138     "type": "get",
5139     "url": "/api/chat/websites/{id}/dispositions",
5140     "title": "Gets account dispositions",
5141     "examples": [
5142       {
5143         "title": "Example usage:",
5144         "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -v -u {name}:{password} -X GET",
5145         "type": "json"
5146       }
5147     ],
5148     "name": "getDispositions",
5149     "group": "Chat_Websites",
5150     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5151     "version": "0.0.0",
5152     "filename": "server/api/chatWebsite/index.js",
5153     "groupTitle": "Chat_Websites"
5154   },
5155   {
5156     "type": "get",
5157     "url": "/api/chat/websites/{id}/fields",
5158     "title": "Gets Website Fields",
5159     "examples": [
5160       {
5161         "title": "Example usage:",
5162         "content": "curl https://{domain}/api/chat/websites/{id}/fields -v -u {name}:{password} -X GET",
5163         "type": "json"
5164       }
5165     ],
5166     "name": "getFields",
5167     "group": "Chat_Websites",
5168     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5169     "version": "0.0.0",
5170     "filename": "server/api/chatWebsite/index.js",
5171     "groupTitle": "Chat_Websites"
5172   },
5173   {
5174     "type": "get",
5175     "url": "/api/chat/websites/{id}/interactions",
5176     "title": "Gets Website Interactions",
5177     "examples": [
5178       {
5179         "title": "Example usage:",
5180         "content": "curl https://{domain}/api/chat/websites/{id}/interactions -v -u {name}:{password} -X GET",
5181         "type": "json"
5182       }
5183     ],
5184     "name": "getInteraction",
5185     "group": "Chat_Websites",
5186     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5187     "version": "0.0.0",
5188     "filename": "server/api/chatWebsite/index.js",
5189     "groupTitle": "Chat_Websites"
5190   },
5191   {
5192     "type": "get",
5193     "url": "/api/chat/websites/{id}/logo",
5194     "title": "Get logo",
5195     "examples": [
5196       {
5197         "title": "Example usage:",
5198         "content": "curl https://{domain}/api/chat/websites/{id}/logo -v -u {name}:{password} -X GET",
5199         "type": "json"
5200       }
5201     ],
5202     "name": "getLogo",
5203     "group": "Chat_Websites",
5204     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5205     "version": "0.0.0",
5206     "filename": "server/api/chatWebsite/index.js",
5207     "groupTitle": "Chat_Websites"
5208   },
5209   {
5210     "type": "get",
5211     "url": "/api/chat/websites/{id}/offline_messages",
5212     "title": "Gets Website Offline Messages",
5213     "examples": [
5214       {
5215         "title": "Example usage:",
5216         "content": "curl https://{domain}/api/chat/websites/{id}/offline_messages -v -u {name}:{password} -X GET",
5217         "type": "json"
5218       }
5219     ],
5220     "name": "getOfflineMessages",
5221     "group": "Chat_Websites",
5222     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5223     "version": "0.0.0",
5224     "filename": "server/api/chatWebsite/index.js",
5225     "groupTitle": "Chat_Websites"
5226   },
5227   {
5228     "type": "get",
5229     "url": "/api/chat/websites/{id}/proactive_actions",
5230     "title": "Gets Website Proactive Actions",
5231     "examples": [
5232       {
5233         "title": "Example usage:",
5234         "content": "curl https://{domain}/api/chat/websites/{id}/proactive_actions -v -u {name}:{password} -X GET",
5235         "type": "json"
5236       }
5237     ],
5238     "name": "getProactiveActions",
5239     "group": "Chat_Websites",
5240     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5241     "version": "0.0.0",
5242     "filename": "server/api/chatWebsite/index.js",
5243     "groupTitle": "Chat_Websites"
5244   },
5245   {
5246     "type": "get",
5247     "url": "/api/chat/websites/{id}/snippet",
5248     "title": "Gets Website Snippet",
5249     "examples": [
5250       {
5251         "title": "Example usage:",
5252         "content": "curl https://{domain}/api/chat/websites/{id}/snippet -v -u {name}:{password} -X GET",
5253         "type": "json"
5254       }
5255     ],
5256     "name": "getSnippet",
5257     "group": "Chat_Websites",
5258     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5259     "version": "0.0.0",
5260     "filename": "server/api/chatWebsite/index.js",
5261     "groupTitle": "Chat_Websites"
5262   },
5263   {
5264     "type": "get",
5265     "url": "/api/chat/websites/{id}/system_avatar",
5266     "title": "Get System Avatar",
5267     "examples": [
5268       {
5269         "title": "Example usage:",
5270         "content": "curl https://{domain}/api/chat/websites/{id}/system_avatar -v -u {name}:{password} -X GET",
5271         "type": "json"
5272       }
5273     ],
5274     "name": "getSystemAvatar",
5275     "group": "Chat_Websites",
5276     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5277     "version": "0.0.0",
5278     "filename": "server/api/chatWebsite/index.js",
5279     "groupTitle": "Chat_Websites"
5280   },
5281   {
5282     "type": "post",
5283     "url": "/api/chat/websites/{id}/notify",
5284     "title": "Notify new message",
5285     "examples": [
5286       {
5287         "title": "Example usage:",
5288         "content": "curl https://{domain}/api/chat/websites/{id}/notify -d '{\"body\": \"hello world\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
5289         "type": "json"
5290       }
5291     ],
5292     "name": "notify",
5293     "group": "Chat_Websites",
5294     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <p>This API is used to create a new chat message to be sent to the system.</p>",
5295     "version": "0.0.0",
5296     "filename": "server/api/chatWebsite/index.js",
5297     "groupTitle": "Chat_Websites"
5298   },
5299   {
5300     "type": "post",
5301     "url": "/api/chat/websites/{id}/offline",
5302     "title": "Offline message",
5303     "examples": [
5304       {
5305         "title": "Example usage:",
5306         "content": "curl https://{domain}/api/chat/websites/{id}/offline -d '{\"body\": \"hello world\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
5307         "type": "json"
5308       }
5309     ],
5310     "name": "offline",
5311     "group": "Chat_Websites",
5312     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5313     "version": "0.0.0",
5314     "filename": "server/api/chatWebsite/index.js",
5315     "groupTitle": "Chat_Websites"
5316   },
5317   {
5318     "type": "put",
5319     "url": "/api/chat/messages/{id}/reject",
5320     "title": "Rejects message",
5321     "examples": [
5322       {
5323         "title": "Example usage:",
5324         "content": "curl https://{domain}/api/chat/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
5325         "type": "json"
5326       }
5327     ],
5328     "name": "rejectMessage",
5329     "group": "Chat_Websites",
5330     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5331     "version": "0.0.0",
5332     "filename": "server/api/chatMessage/index.js",
5333     "groupTitle": "Chat_Websites"
5334   },
5335   {
5336     "type": "put",
5337     "url": "/api/chat/websites/{id}",
5338     "title": "Update an existing Website",
5339     "examples": [
5340       {
5341         "title": "Example usage:",
5342         "content": "curl https://{domain}/api/chat/websites/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
5343         "type": "json"
5344       }
5345     ],
5346     "name": "updateWebsites",
5347     "group": "Chat_Websites",
5348     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5349     "version": "0.0.0",
5350     "filename": "server/api/chatWebsite/index.js",
5351     "groupTitle": "Chat_Websites"
5352   },
5353   {
5354     "type": "post",
5355     "url": "/api/cloudProviders",
5356     "title": "Creates a new CloudProvider",
5357     "examples": [
5358       {
5359         "title": "Example usage:",
5360         "content": "curl https://{domain}/api/cloudProviders -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5361         "type": "json"
5362       }
5363     ],
5364     "name": "CreateCloudProviders",
5365     "group": "CloudProviders",
5366     "parameter": {
5367       "fields": {
5368         "Body": [
5369           {
5370             "group": "Body",
5371             "type": "String",
5372             "optional": false,
5373             "field": "name",
5374             "description": ""
5375           },
5376           {
5377             "group": "Body",
5378             "type": "String",
5379             "allowedValues": [
5380               "\"AmazonAWS\"",
5381               "\"Google\""
5382             ],
5383             "optional": false,
5384             "field": "service",
5385             "description": ""
5386           },
5387           {
5388             "group": "Body",
5389             "type": "String",
5390             "optional": true,
5391             "field": "data1",
5392             "description": ""
5393           },
5394           {
5395             "group": "Body",
5396             "type": "String",
5397             "optional": true,
5398             "field": "data2",
5399             "description": ""
5400           }
5401         ]
5402       }
5403     },
5404     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5405     "version": "0.0.0",
5406     "filename": "server/api/cloudProvider/index.js",
5407     "groupTitle": "CloudProviders"
5408   },
5409   {
5410     "type": "delete",
5411     "url": "/api/cloudProviders/{id}",
5412     "title": "Deletes a CloudProvider",
5413     "examples": [
5414       {
5415         "title": "Example usage:",
5416         "content": "curl https://{domain}/api/cloudProviders/{id} -v -u {name}:{password} -X DELETE",
5417         "type": "json"
5418       }
5419     ],
5420     "name": "DeleteCloudProviders",
5421     "group": "CloudProviders",
5422     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5423     "version": "0.0.0",
5424     "filename": "server/api/cloudProvider/index.js",
5425     "groupTitle": "CloudProviders"
5426   },
5427   {
5428     "type": "get",
5429     "url": "/api/cloudProviders",
5430     "title": "Gets a list of CloudProviders",
5431     "examples": [
5432       {
5433         "title": "Example usage:",
5434         "content": "curl https://{domain}/api/cloudProviders -v -u {name}:{password}",
5435         "type": "json"
5436       }
5437     ],
5438     "name": "GetCloudProviders",
5439     "group": "CloudProviders",
5440     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/cloudProviders?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/cloudProviders?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/cloudProviders?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/cloudProviders?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/cloudProviders?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
5441     "version": "0.0.0",
5442     "filename": "server/api/cloudProvider/index.js",
5443     "groupTitle": "CloudProviders"
5444   },
5445   {
5446     "type": "get",
5447     "url": "/api/cloudProviders/{id}",
5448     "title": "Gets a single CloudProvider",
5449     "examples": [
5450       {
5451         "title": "Example usage:",
5452         "content": "curl https://{domain}/api/cloudProviders/{id} -v -u {name}:{password}",
5453         "type": "json"
5454       }
5455     ],
5456     "name": "ShowCloudProviders",
5457     "group": "CloudProviders",
5458     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5459     "version": "0.0.0",
5460     "filename": "server/api/cloudProvider/index.js",
5461     "groupTitle": "CloudProviders"
5462   },
5463   {
5464     "type": "put",
5465     "url": "/api/cloudProviders/{id}",
5466     "title": "Update an existing CloudProvider",
5467     "examples": [
5468       {
5469         "title": "Example usage:",
5470         "content": "curl https://{domain}/api/cloudProviders/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
5471         "type": "json"
5472       }
5473     ],
5474     "name": "updateCloudProviders",
5475     "group": "CloudProviders",
5476     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5477     "version": "0.0.0",
5478     "filename": "server/api/cloudProvider/index.js",
5479     "groupTitle": "CloudProviders"
5480   },
5481   {
5482     "type": "post",
5483     "url": "/api/cm/companies",
5484     "title": "Creates a new Company",
5485     "examples": [
5486       {
5487         "title": "Example usage:",
5488         "content": "curl https://{domain}/api/cm/companies -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5489         "type": "json"
5490       }
5491     ],
5492     "name": "CreateCompanies",
5493     "group": "Cm_Companies",
5494     "parameter": {
5495       "fields": {
5496         "Body": [
5497           {
5498             "group": "Body",
5499             "type": "String",
5500             "optional": false,
5501             "field": "name",
5502             "description": ""
5503           },
5504           {
5505             "group": "Body",
5506             "type": "String",
5507             "optional": true,
5508             "field": "vat",
5509             "description": ""
5510           },
5511           {
5512             "group": "Body",
5513             "type": "String",
5514             "optional": true,
5515             "field": "companyId",
5516             "description": ""
5517           },
5518           {
5519             "group": "Body",
5520             "type": "String",
5521             "optional": true,
5522             "field": "website",
5523             "description": ""
5524           },
5525           {
5526             "group": "Body",
5527             "type": "String",
5528             "optional": true,
5529             "field": "phone",
5530             "description": ""
5531           },
5532           {
5533             "group": "Body",
5534             "type": "String",
5535             "optional": true,
5536             "field": "fax",
5537             "description": ""
5538           },
5539           {
5540             "group": "Body",
5541             "type": "String",
5542             "optional": true,
5543             "field": "type",
5544             "description": ""
5545           },
5546           {
5547             "group": "Body",
5548             "type": "String",
5549             "optional": true,
5550             "field": "street",
5551             "description": ""
5552           },
5553           {
5554             "group": "Body",
5555             "type": "String",
5556             "optional": true,
5557             "field": "postalCode",
5558             "description": ""
5559           },
5560           {
5561             "group": "Body",
5562             "type": "String",
5563             "optional": true,
5564             "field": "city",
5565             "description": ""
5566           },
5567           {
5568             "group": "Body",
5569             "type": "String",
5570             "optional": true,
5571             "field": "country",
5572             "description": ""
5573           },
5574           {
5575             "group": "Body",
5576             "type": "String",
5577             "optional": true,
5578             "field": "email",
5579             "description": ""
5580           },
5581           {
5582             "group": "Body",
5583             "type": "String",
5584             "optional": true,
5585             "field": "emailDomain",
5586             "description": ""
5587           },
5588           {
5589             "group": "Body",
5590             "type": "String",
5591             "optional": true,
5592             "field": "sStreet",
5593             "description": ""
5594           },
5595           {
5596             "group": "Body",
5597             "type": "String",
5598             "optional": true,
5599             "field": "sPostalCode",
5600             "description": ""
5601           },
5602           {
5603             "group": "Body",
5604             "type": "String",
5605             "optional": true,
5606             "field": "sCity",
5607             "description": ""
5608           },
5609           {
5610             "group": "Body",
5611             "type": "String",
5612             "optional": true,
5613             "field": "sCountry",
5614             "description": ""
5615           },
5616           {
5617             "group": "Body",
5618             "type": "String",
5619             "optional": true,
5620             "field": "description",
5621             "description": ""
5622           }
5623         ]
5624       }
5625     },
5626     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5627     "version": "0.0.0",
5628     "filename": "server/api/cmCompany/index.js",
5629     "groupTitle": "Cm_Companies"
5630   },
5631   {
5632     "type": "delete",
5633     "url": "/api/cm/companies/{id}",
5634     "title": "Deletes a Company",
5635     "examples": [
5636       {
5637         "title": "Example usage:",
5638         "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password} -X DELETE",
5639         "type": "json"
5640       }
5641     ],
5642     "name": "DeleteCompanies",
5643     "group": "Cm_Companies",
5644     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5645     "version": "0.0.0",
5646     "filename": "server/api/cmCompany/index.js",
5647     "groupTitle": "Cm_Companies"
5648   },
5649   {
5650     "type": "get",
5651     "url": "/api/cm/companies/describe",
5652     "title": "Gets table info about Companies",
5653     "examples": [
5654       {
5655         "title": "Example usage:",
5656         "content": "curl https://{domain}/api/cm/companies/describe -v -u {name}:{password}",
5657         "type": "json"
5658       }
5659     ],
5660     "name": "DescribeCompanies",
5661     "group": "Cm_Companies",
5662     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5663     "version": "0.0.0",
5664     "filename": "server/api/cmCompany/index.js",
5665     "groupTitle": "Cm_Companies"
5666   },
5667   {
5668     "type": "get",
5669     "url": "/api/cm/companies",
5670     "title": "Gets a list of Companies",
5671     "examples": [
5672       {
5673         "title": "Example usage:",
5674         "content": "curl https://{domain}/api/cm/companies -v -u {name}:{password}",
5675         "type": "json"
5676       }
5677     ],
5678     "name": "GetCompanies",
5679     "group": "Cm_Companies",
5680     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/cm/companies?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/cm/companies?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/cm/companies?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/cm/companies?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/cm/companies?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
5681     "version": "0.0.0",
5682     "filename": "server/api/cmCompany/index.js",
5683     "groupTitle": "Cm_Companies"
5684   },
5685   {
5686     "type": "get",
5687     "url": "/api/cm/companies/{id}",
5688     "title": "Gets a single Company",
5689     "examples": [
5690       {
5691         "title": "Example usage:",
5692         "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password}",
5693         "type": "json"
5694       }
5695     ],
5696     "name": "ShowCompanies",
5697     "group": "Cm_Companies",
5698     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5699     "version": "0.0.0",
5700     "filename": "server/api/cmCompany/index.js",
5701     "groupTitle": "Cm_Companies"
5702   },
5703   {
5704     "type": "post",
5705     "url": "/api/cm/companies/{id}/contacts",
5706     "title": "Creates new contacts",
5707     "examples": [
5708       {
5709         "title": "Example usage:",
5710         "content": "curl https://{domain}/api/cm/companies/{id}/contacts -d '[{\"firstName\": \"John Doe\", \"email\": \"john.doe@xcally.com\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
5711         "type": "json"
5712       }
5713     ],
5714     "name": "addContacts",
5715     "group": "Cm_Companies",
5716     "parameter": {
5717       "fields": {
5718         "Body": [
5719           {
5720             "group": "Body",
5721             "type": "String",
5722             "optional": false,
5723             "field": "firstName",
5724             "description": ""
5725           },
5726           {
5727             "group": "Body",
5728             "type": "String",
5729             "optional": true,
5730             "field": "lastName",
5731             "description": ""
5732           },
5733           {
5734             "group": "Body",
5735             "type": "String",
5736             "optional": true,
5737             "field": "street",
5738             "description": ""
5739           },
5740           {
5741             "group": "Body",
5742             "type": "String",
5743             "optional": true,
5744             "field": "postalCode",
5745             "description": ""
5746           },
5747           {
5748             "group": "Body",
5749             "type": "String",
5750             "optional": true,
5751             "field": "city",
5752             "description": ""
5753           },
5754           {
5755             "group": "Body",
5756             "type": "String",
5757             "optional": true,
5758             "field": "country",
5759             "description": ""
5760           },
5761           {
5762             "group": "Body",
5763             "type": "String",
5764             "optional": true,
5765             "field": "dateOfBirth",
5766             "description": ""
5767           },
5768           {
5769             "group": "Body",
5770             "type": "Text",
5771             "optional": true,
5772             "field": "description",
5773             "description": ""
5774           },
5775           {
5776             "group": "Body",
5777             "type": "String",
5778             "optional": true,
5779             "field": "phone",
5780             "description": ""
5781           },
5782           {
5783             "group": "Body",
5784             "type": "String",
5785             "optional": true,
5786             "field": "mobile",
5787             "description": ""
5788           },
5789           {
5790             "group": "Body",
5791             "type": "String",
5792             "optional": true,
5793             "field": "fax",
5794             "description": ""
5795           },
5796           {
5797             "group": "Body",
5798             "type": "String",
5799             "optional": true,
5800             "field": "email",
5801             "description": ""
5802           },
5803           {
5804             "group": "Body",
5805             "type": "String",
5806             "optional": true,
5807             "field": "url",
5808             "description": ""
5809           },
5810           {
5811             "group": "Body",
5812             "type": "String",
5813             "optional": true,
5814             "field": "facebook",
5815             "description": ""
5816           },
5817           {
5818             "group": "Body",
5819             "type": "String",
5820             "optional": true,
5821             "field": "fb_data",
5822             "description": ""
5823           },
5824           {
5825             "group": "Body",
5826             "type": "String",
5827             "optional": true,
5828             "field": "twitter",
5829             "description": ""
5830           },
5831           {
5832             "group": "Body",
5833             "type": "String",
5834             "optional": true,
5835             "field": "skype",
5836             "description": ""
5837           },
5838           {
5839             "group": "Body",
5840             "type": "String",
5841             "optional": true,
5842             "field": "teams",
5843             "description": ""
5844           },
5845           {
5846             "group": "Body",
5847             "type": "String",
5848             "optional": true,
5849             "field": "viber",
5850             "description": ""
5851           },
5852           {
5853             "group": "Body",
5854             "type": "String",
5855             "optional": true,
5856             "field": "line",
5857             "description": ""
5858           },
5859           {
5860             "group": "Body",
5861             "type": "String",
5862             "optional": true,
5863             "field": "wechat",
5864             "description": ""
5865           },
5866           {
5867             "group": "Body",
5868             "type": "String",
5869             "optional": true,
5870             "field": "telegram",
5871             "description": ""
5872           },
5873           {
5874             "group": "Body",
5875             "type": "Integer",
5876             "optional": true,
5877             "field": "UserId",
5878             "description": ""
5879           },
5880           {
5881             "group": "Body",
5882             "type": "Integer",
5883             "optional": true,
5884             "field": "priority",
5885             "description": ""
5886           },
5887           {
5888             "group": "Body",
5889             "type": "String",
5890             "optional": true,
5891             "field": "scheduledat",
5892             "description": ""
5893           }
5894         ]
5895       }
5896     },
5897     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5898     "version": "0.0.0",
5899     "filename": "server/api/cmCompany/index.js",
5900     "groupTitle": "Cm_Companies"
5901   },
5902   {
5903     "type": "get",
5904     "url": "/api/cm/companies/{id}/contacts",
5905     "title": "Gets List Contacts",
5906     "examples": [
5907       {
5908         "title": "Example usage:",
5909         "content": "curl https://{domain}/api/fax/companies/{id}/contacts -v -u {name}:{password} -X GET",
5910         "type": "json"
5911       }
5912     ],
5913     "name": "getContacts",
5914     "group": "Cm_Companies",
5915     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5916     "version": "0.0.0",
5917     "filename": "server/api/cmCompany/index.js",
5918     "groupTitle": "Cm_Companies"
5919   },
5920   {
5921     "type": "put",
5922     "url": "/api/cm/companies/{id}",
5923     "title": "Update an existing Company",
5924     "examples": [
5925       {
5926         "title": "Example usage:",
5927         "content": "curl https://{domain}/api/cm/companies/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
5928         "type": "json"
5929       }
5930     ],
5931     "name": "updateCompanies",
5932     "group": "Cm_Companies",
5933     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5934     "version": "0.0.0",
5935     "filename": "server/api/cmCompany/index.js",
5936     "groupTitle": "Cm_Companies"
5937   },
5938   {
5939     "type": "delete",
5940     "url": "/api/cm/contacts/{id}",
5941     "title": "Deletes a Contact",
5942     "examples": [
5943       {
5944         "title": "Example usage:",
5945         "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X DELETE",
5946         "type": "json"
5947       }
5948     ],
5949     "name": "DeleteContacts",
5950     "group": "Cm_Contacts",
5951     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5952     "version": "0.0.0",
5953     "filename": "server/api/cmContact/index.js",
5954     "groupTitle": "Cm_Contacts"
5955   },
5956   {
5957     "type": "get",
5958     "url": "/api/cm/contacts/describe",
5959     "title": "Gets table info about Contacts",
5960     "examples": [
5961       {
5962         "title": "Example usage:",
5963         "content": "curl https://{domain}/api/cm/contacts/describe -v -u {name}:{password}",
5964         "type": "json"
5965       }
5966     ],
5967     "name": "DescribeContacts",
5968     "group": "Cm_Contacts",
5969     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5970     "version": "0.0.0",
5971     "filename": "server/api/cmContact/index.js",
5972     "groupTitle": "Cm_Contacts"
5973   },
5974   {
5975     "type": "get",
5976     "url": "/api/cm/contacts",
5977     "title": "Gets a list of Contacts",
5978     "examples": [
5979       {
5980         "title": "Example usage:",
5981         "content": "curl https://{domain}/api/cm/contacts -v -u {name}:{password}",
5982         "type": "json"
5983       }
5984     ],
5985     "name": "GetContacts",
5986     "group": "Cm_Contacts",
5987     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/cm/contacts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/cm/contacts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/cm/contacts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/cm/contacts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/cm/contacts?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
5988     "version": "0.0.0",
5989     "filename": "server/api/cmContact/index.js",
5990     "groupTitle": "Cm_Contacts"
5991   },
5992   {
5993     "type": "get",
5994     "url": "/api/cm/contacts/{id}/finals",
5995     "title": "Gets contact hopper finals",
5996     "examples": [
5997       {
5998         "title": "Example usage:",
5999         "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_finals -v -u {name}:{password}  -X GET",
6000         "type": "json"
6001       }
6002     ],
6003     "name": "GetHopperFinals",
6004     "group": "Cm_Contacts",
6005     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6006     "version": "0.0.0",
6007     "filename": "server/api/cmContact/index.js",
6008     "groupTitle": "Cm_Contacts"
6009   },
6010   {
6011     "type": "get",
6012     "url": "/api/cm/contacts/{id}/hopper_histories",
6013     "title": "Gets contact hopper histories",
6014     "examples": [
6015       {
6016         "title": "Example usage:",
6017         "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_histories -v -u {name}:{password} -X GET",
6018         "type": "json"
6019       }
6020     ],
6021     "name": "GetHopperHistories",
6022     "group": "Cm_Contacts",
6023     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6024     "version": "0.0.0",
6025     "filename": "server/api/cmContact/index.js",
6026     "groupTitle": "Cm_Contacts"
6027   },
6028   {
6029     "type": "get",
6030     "url": "/api/cm/contacts/{id}/hoppers",
6031     "title": "Gets contact hoppers",
6032     "examples": [
6033       {
6034         "title": "Example usage:",
6035         "content": "curl https://{domain}/api/cm/contacts/{id}/hoppers -v -u {name}:{password} -X GET",
6036         "type": "json"
6037       }
6038     ],
6039     "name": "GetHoppers",
6040     "group": "Cm_Contacts",
6041     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6042     "version": "0.0.0",
6043     "filename": "server/api/cmContact/index.js",
6044     "groupTitle": "Cm_Contacts"
6045   },
6046   {
6047     "type": "post",
6048     "url": "/api/cm/contacts/create_many",
6049     "title": "Create Contacts",
6050     "examples": [
6051       {
6052         "title": "Example usage:",
6053         "content": "curl https://{domain}/api/cm/contacts/create_many -d '[{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",
6054         "type": "json"
6055       }
6056     ],
6057     "name": "bulkCreate",
6058     "group": "Cm_Contacts",
6059     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6060     "version": "0.0.0",
6061     "filename": "server/api/cmContact/index.js",
6062     "groupTitle": "Cm_Contacts"
6063   },
6064   {
6065     "type": "post",
6066     "url": "/api/cm/contacts",
6067     "title": "Create Contact",
6068     "examples": [
6069       {
6070         "title": "Example usage:",
6071         "content": "curl https://{domain}/api/cm/contacts -d '{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}' -v -u {name}:{password} -X POST",
6072         "type": "json"
6073       }
6074     ],
6075     "name": "create",
6076     "group": "Cm_Contacts",
6077     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6078     "version": "0.0.0",
6079     "filename": "server/api/cmContact/index.js",
6080     "groupTitle": "Cm_Contacts"
6081   },
6082   {
6083     "type": "get",
6084     "url": "/api/cm/contacts/{id}/journey",
6085     "title": "Gets customer journey",
6086     "examples": [
6087       {
6088         "title": "Example usage:",
6089         "content": "curl https://{domain}/api/cm/contacts/{id}/journey -v -u {name}:{password}  -X GET",
6090         "type": "json"
6091       }
6092     ],
6093     "name": "getJourney",
6094     "group": "Cm_Contacts",
6095     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6096     "version": "0.0.0",
6097     "filename": "server/api/cmContact/index.js",
6098     "groupTitle": "Cm_Contacts"
6099   },
6100   {
6101     "type": "get",
6102     "url": "/api/cm/contacts/{id}/jscripty_sessions",
6103     "title": "Gets contact hopper blacks",
6104     "examples": [
6105       {
6106         "title": "Example usage:",
6107         "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_black -v -u {name}:{password}  -X GET",
6108         "type": "json"
6109       }
6110     ],
6111     "name": "getJscriptySessions",
6112     "group": "Cm_Contacts",
6113     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6114     "version": "0.0.0",
6115     "filename": "server/api/cmContact/index.js",
6116     "groupTitle": "Cm_Contacts"
6117   },
6118   {
6119     "type": "get",
6120     "url": "/api/cm/contacts/{id}/tags",
6121     "title": "Gets configurations tags",
6122     "examples": [
6123       {
6124         "title": "Example usage:",
6125         "content": "curl https://{domain}/api/cm/contacts/{id}/tags -v -u {name}:{password} -X GET",
6126         "type": "json"
6127       }
6128     ],
6129     "name": "getTags",
6130     "group": "Cm_Contacts",
6131     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6132     "version": "0.0.0",
6133     "filename": "server/api/cmContact/index.js",
6134     "groupTitle": "Cm_Contacts"
6135   },
6136   {
6137     "type": "post",
6138     "url": "/api/cm/contacts/merge",
6139     "title": "Merge Contact",
6140     "examples": [
6141       {
6142         "title": "Example usage:",
6143         "content": "curl https://{domain}/api/cm/contacts/merge -d '{\"from\": 1, \"to\": 2}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6144         "type": "json"
6145       }
6146     ],
6147     "name": "merge",
6148     "group": "Cm_Contacts",
6149     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6150     "version": "0.0.0",
6151     "filename": "server/api/cmContact/index.js",
6152     "groupTitle": "Cm_Contacts"
6153   },
6154   {
6155     "type": "post",
6156     "url": "/api/cm/contacts/{id}/tags",
6157     "title": "Sets new tags",
6158     "examples": [
6159       {
6160         "title": "Example usage:",
6161         "content": "curl https://{domain}/api/cm/contacts/{id}/tags -d '{\"ids\": [1,12]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6162         "type": "json"
6163       }
6164     ],
6165     "name": "setTags",
6166     "group": "Cm_Contacts",
6167     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6168     "version": "0.0.0",
6169     "filename": "server/api/cmContact/index.js",
6170     "groupTitle": "Cm_Contacts"
6171   },
6172   {
6173     "type": "get",
6174     "url": "/api/cm/contacts/{id}",
6175     "title": "Gets a single Contact",
6176     "examples": [
6177       {
6178         "title": "Example usage:",
6179         "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X GET",
6180         "type": "json"
6181       }
6182     ],
6183     "name": "show",
6184     "group": "Cm_Contacts",
6185     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6186     "version": "0.0.0",
6187     "filename": "server/api/cmContact/index.js",
6188     "groupTitle": "Cm_Contacts"
6189   },
6190   {
6191     "type": "put",
6192     "url": "/api/cm/contacts/{id}",
6193     "title": "Update a single Contact",
6194     "examples": [
6195       {
6196         "title": "Example usage:",
6197         "content": "curl https://{domain}/api/cm/contacts/{id} -d '{\"firstName\": \"John\", \"lastName\": \"Doe\"}' -v -u {name}:{password} -X PUT",
6198         "type": "json"
6199       }
6200     ],
6201     "name": "update",
6202     "group": "Cm_Contacts",
6203     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6204     "version": "0.0.0",
6205     "filename": "server/api/cmContact/index.js",
6206     "groupTitle": "Cm_Contacts"
6207   },
6208   {
6209     "type": "delete",
6210     "url": "/api/cm/custom_fields/{id}",
6211     "title": "Deletes a Custom Field",
6212     "examples": [
6213       {
6214         "title": "Example usage:",
6215         "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password} -X DELETE",
6216         "type": "json"
6217       }
6218     ],
6219     "name": "DeleteCustom_Fields",
6220     "group": "Cm_Custom_Fields",
6221     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6222     "version": "0.0.0",
6223     "filename": "server/api/cmCustomField/index.js",
6224     "groupTitle": "Cm_Custom_Fields"
6225   },
6226   {
6227     "type": "get",
6228     "url": "/api/cm/custom_fields",
6229     "title": "Gets a list of Custom Fields",
6230     "examples": [
6231       {
6232         "title": "Example usage:",
6233         "content": "curl https://{domain}/api/cm/custom_fields -v -u {name}:{password}",
6234         "type": "json"
6235       }
6236     ],
6237     "name": "GetCustom_Fields",
6238     "group": "Cm_Custom_Fields",
6239     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/cm/custom_fields?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/cm/custom_fields?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/cm/custom_fields?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/cm/custom_fields?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/cm/custom_fields?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
6240     "version": "0.0.0",
6241     "filename": "server/api/cmCustomField/index.js",
6242     "groupTitle": "Cm_Custom_Fields"
6243   },
6244   {
6245     "type": "get",
6246     "url": "/api/cm/custom_fields/{id}",
6247     "title": "Gets a single Custom Field",
6248     "examples": [
6249       {
6250         "title": "Example usage:",
6251         "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password}",
6252         "type": "json"
6253       }
6254     ],
6255     "name": "ShowCustom_Fields",
6256     "group": "Cm_Custom_Fields",
6257     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6258     "version": "0.0.0",
6259     "filename": "server/api/cmCustomField/index.js",
6260     "groupTitle": "Cm_Custom_Fields"
6261   },
6262   {
6263     "type": "put",
6264     "url": "/api/cm/custom_fields/{id}",
6265     "title": "Update an existing Custom Field",
6266     "examples": [
6267       {
6268         "title": "Example usage:",
6269         "content": "curl https://{domain}/api/cm/custom_fields/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
6270         "type": "json"
6271       }
6272     ],
6273     "name": "updateCustom_Fields",
6274     "group": "Cm_Custom_Fields",
6275     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6276     "version": "0.0.0",
6277     "filename": "server/api/cmCustomField/index.js",
6278     "groupTitle": "Cm_Custom_Fields"
6279   },
6280   {
6281     "type": "post",
6282     "url": "/api/cm/hopper",
6283     "title": "Creates a new Hopper",
6284     "examples": [
6285       {
6286         "title": "Example usage:",
6287         "content": "curl https://{domain}/api/cm/hopper -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
6288         "type": "json"
6289       }
6290     ],
6291     "name": "CreateHopper",
6292     "group": "Cm_Hopper",
6293     "parameter": {
6294       "fields": {
6295         "Body": [
6296           {
6297             "group": "Body",
6298             "type": "String",
6299             "optional": false,
6300             "field": "phone",
6301             "description": ""
6302           },
6303           {
6304             "group": "Body",
6305             "type": "Boolean",
6306             "optional": true,
6307             "field": "active",
6308             "description": ""
6309           },
6310           {
6311             "group": "Body",
6312             "type": "String",
6313             "optional": true,
6314             "field": "scheduledat",
6315             "description": ""
6316           },
6317           {
6318             "group": "Body",
6319             "type": "Integer",
6320             "optional": true,
6321             "field": "countbusyretry",
6322             "description": ""
6323           },
6324           {
6325             "group": "Body",
6326             "type": "Integer",
6327             "optional": true,
6328             "field": "countcongestionretry",
6329             "description": ""
6330           },
6331           {
6332             "group": "Body",
6333             "type": "Integer",
6334             "optional": true,
6335             "field": "countnoanswerretry",
6336             "description": ""
6337           },
6338           {
6339             "group": "Body",
6340             "type": "Boolean",
6341             "optional": true,
6342             "field": "callback",
6343             "description": ""
6344           },
6345           {
6346             "group": "Body",
6347             "type": "String",
6348             "optional": true,
6349             "field": "callbackuniqueid",
6350             "description": ""
6351           },
6352           {
6353             "group": "Body",
6354             "type": "String",
6355             "optional": true,
6356             "field": "callbackat",
6357             "description": ""
6358           },
6359           {
6360             "group": "Body",
6361             "type": "Integer",
6362             "optional": true,
6363             "field": "priority",
6364             "description": ""
6365           },
6366           {
6367             "group": "Body",
6368             "type": "Boolean",
6369             "optional": true,
6370             "field": "recallme",
6371             "description": ""
6372           },
6373           {
6374             "group": "Body",
6375             "type": "Integer",
6376             "optional": true,
6377             "field": "ContactId",
6378             "description": ""
6379           },
6380           {
6381             "group": "Body",
6382             "type": "Integer",
6383             "optional": true,
6384             "field": "ListId",
6385             "description": ""
6386           },
6387           {
6388             "group": "Body",
6389             "type": "Integer",
6390             "optional": true,
6391             "field": "UserId",
6392             "description": ""
6393           },
6394           {
6395             "group": "Body",
6396             "type": "Integer",
6397             "optional": true,
6398             "field": "VoiceQueueId",
6399             "description": ""
6400           },
6401           {
6402             "group": "Body",
6403             "type": "Integer",
6404             "optional": true,
6405             "field": "CampaignId",
6406             "description": ""
6407           },
6408           {
6409             "group": "Body",
6410             "type": "Integer",
6411             "optional": true,
6412             "field": "countnosuchnumberretry",
6413             "description": ""
6414           },
6415           {
6416             "group": "Body",
6417             "type": "Integer",
6418             "optional": true,
6419             "field": "countdropretry",
6420             "description": ""
6421           },
6422           {
6423             "group": "Body",
6424             "type": "Integer",
6425             "optional": true,
6426             "field": "countabandonedretry",
6427             "description": ""
6428           },
6429           {
6430             "group": "Body",
6431             "type": "Integer",
6432             "optional": true,
6433             "field": "countmachineretry",
6434             "description": ""
6435           },
6436           {
6437             "group": "Body",
6438             "type": "Integer",
6439             "optional": true,
6440             "field": "countagentrejectretry",
6441             "description": ""
6442           }
6443         ]
6444       }
6445     },
6446     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6447     "version": "0.0.0",
6448     "filename": "server/api/cmHopper/index.js",
6449     "groupTitle": "Cm_Hopper"
6450   },
6451   {
6452     "type": "get",
6453     "url": "/api/cm/hopper/describe",
6454     "title": "Gets table info about Hopper",
6455     "examples": [
6456       {
6457         "title": "Example usage:",
6458         "content": "curl https://{domain}/api/cm/hopper/describe -v -u {name}:{password}",
6459         "type": "json"
6460       }
6461     ],
6462     "name": "DescribeHopper",
6463     "group": "Cm_Hopper",
6464     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6465     "version": "0.0.0",
6466     "filename": "server/api/cmHopper/index.js",
6467     "groupTitle": "Cm_Hopper"
6468   },
6469   {
6470     "type": "get",
6471     "url": "/api/cm/hopper",
6472     "title": "Gets a list of Hopper",
6473     "examples": [
6474       {
6475         "title": "Example usage:",
6476         "content": "curl https://{domain}/api/cm/hopper -v -u {name}:{password}",
6477         "type": "json"
6478       }
6479     ],
6480     "name": "GetHopper",
6481     "group": "Cm_Hopper",
6482     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/cm/hopper?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/cm/hopper?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/cm/hopper?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/cm/hopper?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/cm/hopper?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
6483     "version": "0.0.0",
6484     "filename": "server/api/cmHopper/index.js",
6485     "groupTitle": "Cm_Hopper"
6486   },
6487   {
6488     "type": "get",
6489     "url": "/api/cm/hopper/{id}",
6490     "title": "Gets a single Hopper",
6491     "examples": [
6492       {
6493         "title": "Example usage:",
6494         "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password}",
6495         "type": "json"
6496       }
6497     ],
6498     "name": "ShowHopper",
6499     "group": "Cm_Hopper",
6500     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6501     "version": "0.0.0",
6502     "filename": "server/api/cmHopper/index.js",
6503     "groupTitle": "Cm_Hopper"
6504   },
6505   {
6506     "type": "delete",
6507     "url": "/api/cm/hopper_black/{id}",
6508     "title": "Deletes a Hopper Black",
6509     "examples": [
6510       {
6511         "title": "Example usage:",
6512         "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password} -X DELETE",
6513         "type": "json"
6514       }
6515     ],
6516     "name": "DeleteHopper_Black",
6517     "group": "Cm_Hopper_Black",
6518     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6519     "version": "0.0.0",
6520     "filename": "server/api/cmHopperBlack/index.js",
6521     "groupTitle": "Cm_Hopper_Black"
6522   },
6523   {
6524     "type": "get",
6525     "url": "/api/cm/hopper_black/describe",
6526     "title": "Gets table info about Hopper Black",
6527     "examples": [
6528       {
6529         "title": "Example usage:",
6530         "content": "curl https://{domain}/api/cm/hopper_black/describe -v -u {name}:{password}",
6531         "type": "json"
6532       }
6533     ],
6534     "name": "DescribeHopper_Black",
6535     "group": "Cm_Hopper_Black",
6536     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6537     "version": "0.0.0",
6538     "filename": "server/api/cmHopperBlack/index.js",
6539     "groupTitle": "Cm_Hopper_Black"
6540   },
6541   {
6542     "type": "get",
6543     "url": "/api/cm/hopper_black",
6544     "title": "Gets a list of Hopper Black",
6545     "examples": [
6546       {
6547         "title": "Example usage:",
6548         "content": "curl https://{domain}/api/cm/hopper_black -v -u {name}:{password}",
6549         "type": "json"
6550       }
6551     ],
6552     "name": "GetHopper_Black",
6553     "group": "Cm_Hopper_Black",
6554     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/cm/hopper_black?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/cm/hopper_black?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/cm/hopper_black?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/cm/hopper_black?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/cm/hopper_black?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
6555     "version": "0.0.0",
6556     "filename": "server/api/cmHopperBlack/index.js",
6557     "groupTitle": "Cm_Hopper_Black"
6558   },
6559   {
6560     "type": "get",
6561     "url": "/api/cm/hopper_black/{id}",
6562     "title": "Gets a single Hopper Black",
6563     "examples": [
6564       {
6565         "title": "Example usage:",
6566         "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password}",
6567         "type": "json"
6568       }
6569     ],
6570     "name": "ShowHopper_Black",
6571     "group": "Cm_Hopper_Black",
6572     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6573     "version": "0.0.0",
6574     "filename": "server/api/cmHopperBlack/index.js",
6575     "groupTitle": "Cm_Hopper_Black"
6576   },
6577   {
6578     "type": "put",
6579     "url": "/api/cm/hopper_black/{id}",
6580     "title": "Update an existing Hopper Black",
6581     "examples": [
6582       {
6583         "title": "Example usage:",
6584         "content": "curl https://{domain}/api/cm/hopper_black/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
6585         "type": "json"
6586       }
6587     ],
6588     "name": "updateHopper_Black",
6589     "group": "Cm_Hopper_Black",
6590     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6591     "version": "0.0.0",
6592     "filename": "server/api/cmHopperBlack/index.js",
6593     "groupTitle": "Cm_Hopper_Black"
6594   },
6595   {
6596     "type": "post",
6597     "url": "/api/cm/hopper_final/checkContactHopper",
6598     "title": "Check if contact is in hopper",
6599     "examples": [
6600       {
6601         "title": "Example usage:",
6602         "content": "curl https://{domain}/api/hopper_final/checkContactHopper -d '{\"VoiceQueueId\": \"VoiceQueueId\", \"CampaignId\": \"CampaignId\", \"ContactId\": \"ContactId\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6603         "type": "json"
6604       }
6605     ],
6606     "name": "/checkContactHopper",
6607     "group": "Cm_Hopper_Final",
6608     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6609     "version": "0.0.0",
6610     "filename": "server/api/cmHopperFinal/index.js",
6611     "groupTitle": "Cm_Hopper_Final"
6612   },
6613   {
6614     "type": "get",
6615     "url": "/api/cm/hopper_final/describe",
6616     "title": "Gets table info about HopperFinal",
6617     "examples": [
6618       {
6619         "title": "Example usage:",
6620         "content": "curl https://{domain}/api/cm/hopper_final/describe -v -u {name}:{password}",
6621         "type": "json"
6622       }
6623     ],
6624     "name": "DescribeHopperFinal",
6625     "group": "Cm_Hopper_Final",
6626     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6627     "version": "0.0.0",
6628     "filename": "server/api/cmHopperFinal/index.js",
6629     "groupTitle": "Cm_Hopper_Final"
6630   },
6631   {
6632     "type": "get",
6633     "url": "/api/cm/hopper_final",
6634     "title": "Gets a list of HopperFinal",
6635     "examples": [
6636       {
6637         "title": "Example usage:",
6638         "content": "curl https://{domain}/api/cm/hopper_final -v -u {name}:{password}",
6639         "type": "json"
6640       }
6641     ],
6642     "name": "GetHopperFinal",
6643     "group": "Cm_Hopper_Final",
6644     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/cm/hopper_final?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/cm/hopper_final?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/cm/hopper_final?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/cm/hopper_final?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/cm/hopper_final?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
6645     "version": "0.0.0",
6646     "filename": "server/api/cmHopperFinal/index.js",
6647     "groupTitle": "Cm_Hopper_Final"
6648   },
6649   {
6650     "type": "get",
6651     "url": "/api/cm/hopper_final/{id}",
6652     "title": "Gets a single HopperFinal",
6653     "examples": [
6654       {
6655         "title": "Example usage:",
6656         "content": "curl https://{domain}/api/cm/hopper_final/{id} -v -u {name}:{password}",
6657         "type": "json"
6658       }
6659     ],
6660     "name": "ShowHopperFinal",
6661     "group": "Cm_Hopper_Final",
6662     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6663     "version": "0.0.0",
6664     "filename": "server/api/cmHopperFinal/index.js",
6665     "groupTitle": "Cm_Hopper_Final"
6666   },
6667   {
6668     "type": "get",
6669     "url": "/api/cm/hopper_final/campaign/countAttributes/{id}",
6670     "title": "Return number contacts for attributes",
6671     "examples": [
6672       {
6673         "title": "Example usage:",
6674         "content": "curl https://{domain}/api/hopper_final/campaign/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
6675         "type": "json"
6676       }
6677     ],
6678     "name": "countContactsIvrCampaignHopperFinal",
6679     "group": "Cm_Hopper_Final",
6680     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6681     "version": "0.0.0",
6682     "filename": "server/api/cmHopperFinal/index.js",
6683     "groupTitle": "Cm_Hopper_Final"
6684   },
6685   {
6686     "type": "get",
6687     "url": "/api/cm/hopper_final/voice/queue/countAttributes/{id}",
6688     "title": "Return number contacts for attributes",
6689     "examples": [
6690       {
6691         "title": "Example usage:",
6692         "content": "curl https://{domain}/api/hopper_final/voice/queue/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
6693         "type": "json"
6694       }
6695     ],
6696     "name": "countContactsQueueCampaignHopperFinal",
6697     "group": "Cm_Hopper_Final",
6698     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6699     "version": "0.0.0",
6700     "filename": "server/api/cmHopperFinal/index.js",
6701     "groupTitle": "Cm_Hopper_Final"
6702   },
6703   {
6704     "type": "post",
6705     "url": "/api/cm/hopper_final/campaign/{id}",
6706     "title": "Move contacts in hopper",
6707     "examples": [
6708       {
6709         "title": "Example usage:",
6710         "content": "curl https://{domain}/api/hopper_final/campaign/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6711         "type": "json"
6712       }
6713     ],
6714     "name": "moveContactsIvrCampaignHopperFinal",
6715     "group": "Cm_Hopper_Final",
6716     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6717     "version": "0.0.0",
6718     "filename": "server/api/cmHopperFinal/index.js",
6719     "groupTitle": "Cm_Hopper_Final"
6720   },
6721   {
6722     "type": "post",
6723     "url": "/api/cm/hopper_final/voice/queue/{id}",
6724     "title": "Move contacts in hopper",
6725     "examples": [
6726       {
6727         "title": "Example usage:",
6728         "content": "curl https://{domain}/api/hopper_final/voice/queue/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password}",
6729         "type": "json"
6730       }
6731     ],
6732     "name": "moveContactsQueueCampaignHopperFinal",
6733     "group": "Cm_Hopper_Final",
6734     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6735     "version": "0.0.0",
6736     "filename": "server/api/cmHopperFinal/index.js",
6737     "groupTitle": "Cm_Hopper_Final"
6738   },
6739   {
6740     "type": "put",
6741     "url": "/api/cm/hopper_final/{id}",
6742     "title": "Update a single hopper final",
6743     "examples": [
6744       {
6745         "title": "Example usage:",
6746         "content": "curl https://{domain}/api/hopper_final/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
6747         "type": "json"
6748       }
6749     ],
6750     "name": "update",
6751     "group": "Cm_Hopper_Final",
6752     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6753     "version": "0.0.0",
6754     "filename": "server/api/cmHopperFinal/index.js",
6755     "groupTitle": "Cm_Hopper_Final"
6756   },
6757   {
6758     "type": "post",
6759     "url": "/api/cm/hopper_history",
6760     "title": "Creates a new HopperHistory",
6761     "examples": [
6762       {
6763         "title": "Example usage:",
6764         "content": "curl https://{domain}/api/cm/hopper_history -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
6765         "type": "json"
6766       }
6767     ],
6768     "name": "CreateHopperHistory",
6769     "group": "Cm_Hopper_History",
6770     "parameter": {
6771       "fields": {
6772         "Body": [
6773           {
6774             "group": "Body",
6775             "type": "Integer",
6776             "optional": true,
6777             "field": "state",
6778             "description": ""
6779           },
6780           {
6781             "group": "Body",
6782             "type": "String",
6783             "optional": true,
6784             "field": "statedesc",
6785             "description": ""
6786           },
6787           {
6788             "group": "Body",
6789             "type": "String",
6790             "optional": true,
6791             "field": "scheduledat",
6792             "description": ""
6793           },
6794           {
6795             "group": "Body",
6796             "type": "Integer",
6797             "optional": true,
6798             "field": "countbusyretry",
6799             "description": ""
6800           },
6801           {
6802             "group": "Body",
6803             "type": "Integer",
6804             "optional": true,
6805             "field": "countcongestionretry",
6806             "description": ""
6807           },
6808           {
6809             "group": "Body",
6810             "type": "Integer",
6811             "optional": true,
6812             "field": "countnoanswerretry",
6813             "description": ""
6814           },
6815           {
6816             "group": "Body",
6817             "type": "Integer",
6818             "optional": true,
6819             "field": "countglobal",
6820             "description": ""
6821           },
6822           {
6823             "group": "Body",
6824             "type": "String",
6825             "optional": true,
6826             "field": "uniqueid",
6827             "description": ""
6828           },
6829           {
6830             "group": "Body",
6831             "type": "String",
6832             "optional": true,
6833             "field": "originatecalleridnum",
6834             "description": ""
6835           },
6836           {
6837             "group": "Body",
6838             "type": "String",
6839             "optional": true,
6840             "field": "originatecalleridname",
6841             "description": ""
6842           },
6843           {
6844             "group": "Body",
6845             "type": "String",
6846             "optional": true,
6847             "field": "calleridnum",
6848             "description": ""
6849           },
6850           {
6851             "group": "Body",
6852             "type": "String",
6853             "optional": true,
6854             "field": "calleridname",
6855             "description": ""
6856           },
6857           {
6858             "group": "Body",
6859             "type": "String",
6860             "optional": true,
6861             "field": "starttime",
6862             "description": ""
6863           },
6864           {
6865             "group": "Body",
6866             "type": "String",
6867             "optional": true,
6868             "field": "responsetime",
6869             "description": ""
6870           },
6871           {
6872             "group": "Body",
6873             "type": "String",
6874             "optional": true,
6875             "field": "answertime",
6876             "description": ""
6877           },
6878           {
6879             "group": "Body",
6880             "type": "String",
6881             "optional": true,
6882             "field": "droptime",
6883             "description": ""
6884           },
6885           {
6886             "group": "Body",
6887             "type": "String",
6888             "optional": true,
6889             "field": "endtime",
6890             "description": ""
6891           },
6892           {
6893             "group": "Body",
6894             "type": "Integer",
6895             "optional": true,
6896             "field": "ringtime",
6897             "description": ""
6898           },
6899           {
6900             "group": "Body",
6901             "type": "Integer",
6902             "optional": true,
6903             "field": "holdtime",
6904             "description": ""
6905           },
6906           {
6907             "group": "Body",
6908             "type": "Integer",
6909             "optional": true,
6910             "field": "talktime",
6911             "description": ""
6912           },
6913           {
6914             "group": "Body",
6915             "type": "Integer",
6916             "optional": true,
6917             "field": "followuptime",
6918             "description": ""
6919           },
6920           {
6921             "group": "Body",
6922             "type": "String",
6923             "optional": true,
6924             "field": "dropreason",
6925             "description": ""
6926           },
6927           {
6928             "group": "Body",
6929             "type": "String",
6930             "optional": true,
6931             "field": "campaign",
6932             "description": ""
6933           },
6934           {
6935             "group": "Body",
6936             "type": "String",
6937             "optional": true,
6938             "field": "campaigntype",
6939             "description": ""
6940           },
6941           {
6942             "group": "Body",
6943             "type": "String",
6944             "optional": true,
6945             "field": "membername",
6946             "description": ""
6947           },
6948           {
6949             "group": "Body",
6950             "type": "String",
6951             "optional": true,
6952             "field": "reason",
6953             "description": ""
6954           },
6955           {
6956             "group": "Body",
6957             "type": "Boolean",
6958             "optional": true,
6959             "field": "amd",
6960             "description": ""
6961           },
6962           {
6963             "group": "Body",
6964             "type": "Boolean",
6965             "optional": true,
6966             "field": "fax",
6967             "description": ""
6968           },
6969           {
6970             "group": "Body",
6971             "type": "Boolean",
6972             "optional": true,
6973             "field": "callback",
6974             "description": ""
6975           },
6976           {
6977             "group": "Body",
6978             "type": "String",
6979             "optional": true,
6980             "field": "callbackuniqueid",
6981             "description": ""
6982           },
6983           {
6984             "group": "Body",
6985             "type": "String",
6986             "optional": true,
6987             "field": "callbackat",
6988             "description": ""
6989           },
6990           {
6991             "group": "Body",
6992             "type": "Boolean",
6993             "optional": true,
6994             "field": "recallme",
6995             "description": ""
6996           },
6997           {
6998             "group": "Body",
6999             "type": "String",
7000             "optional": true,
7001             "field": "editedat",
7002             "description": ""
7003           },
7004           {
7005             "group": "Body",
7006             "type": "Boolean",
7007             "optional": true,
7008             "field": "edited",
7009             "description": ""
7010           },
7011           {
7012             "group": "Body",
7013             "type": "Integer",
7014             "optional": true,
7015             "field": "countnosuchnumberretry",
7016             "description": ""
7017           },
7018           {
7019             "group": "Body",
7020             "type": "Integer",
7021             "optional": true,
7022             "field": "countdropretry",
7023             "description": ""
7024           },
7025           {
7026             "group": "Body",
7027             "type": "Integer",
7028             "optional": true,
7029             "field": "countabandonedretry",
7030             "description": ""
7031           },
7032           {
7033             "group": "Body",
7034             "type": "Integer",
7035             "optional": true,
7036             "field": "countmachineretry",
7037             "description": ""
7038           },
7039           {
7040             "group": "Body",
7041             "type": "Integer",
7042             "optional": true,
7043             "field": "countagentrejectretry",
7044             "description": ""
7045           }
7046         ]
7047       }
7048     },
7049     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7050     "version": "0.0.0",
7051     "filename": "server/api/cmHopperHistory/index.js",
7052     "groupTitle": "Cm_Hopper_History"
7053   },
7054   {
7055     "type": "get",
7056     "url": "/api/cm/hopper_history/describe",
7057     "title": "Gets table info about HopperHistory",
7058     "examples": [
7059       {
7060         "title": "Example usage:",
7061         "content": "curl https://{domain}/api/cm/hopper_history/describe -v -u {name}:{password}",
7062         "type": "json"
7063       }
7064     ],
7065     "name": "DescribeHopperHistory",
7066     "group": "Cm_Hopper_History",
7067     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7068     "version": "0.0.0",
7069     "filename": "server/api/cmHopperHistory/index.js",
7070     "groupTitle": "Cm_Hopper_History"
7071   },
7072   {
7073     "type": "get",
7074     "url": "/api/cm/hopper_history",
7075     "title": "Gets a list of HopperHistory",
7076     "examples": [
7077       {
7078         "title": "Example usage:",
7079         "content": "curl https://{domain}/api/cm/hopper_history -v -u {name}:{password}",
7080         "type": "json"
7081       }
7082     ],
7083     "name": "GetHopperHistory",
7084     "group": "Cm_Hopper_History",
7085     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/cm/hopper_history?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/cm/hopper_history?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/cm/hopper_history?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/cm/hopper_history?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/cm/hopper_history?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
7086     "version": "0.0.0",
7087     "filename": "server/api/cmHopperHistory/index.js",
7088     "groupTitle": "Cm_Hopper_History"
7089   },
7090   {
7091     "type": "get",
7092     "url": "/api/cm/hopper_history/{id}",
7093     "title": "Gets a single HopperHistory",
7094     "examples": [
7095       {
7096         "title": "Example usage:",
7097         "content": "curl https://{domain}/api/cm/hopper_history/{id} -v -u {name}:{password}",
7098         "type": "json"
7099       }
7100     ],
7101     "name": "ShowHopperHistory",
7102     "group": "Cm_Hopper_History",
7103     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7104     "version": "0.0.0",
7105     "filename": "server/api/cmHopperHistory/index.js",
7106     "groupTitle": "Cm_Hopper_History"
7107   },
7108   {
7109     "type": "put",
7110     "url": "/api/cm/hopper_history/{id}",
7111     "title": "Update a single hopper history",
7112     "examples": [
7113       {
7114         "title": "Example usage:",
7115         "content": "curl https://{domain}/api/hopper_history/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
7116         "type": "json"
7117       }
7118     ],
7119     "name": "update",
7120     "group": "Cm_Hopper_History",
7121     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7122     "version": "0.0.0",
7123     "filename": "server/api/cmHopperHistory/index.js",
7124     "groupTitle": "Cm_Hopper_History"
7125   },
7126   {
7127     "type": "delete",
7128     "url": "/api/cm/hopper/{id}",
7129     "title": "Delete Hopper",
7130     "examples": [
7131       {
7132         "title": "Example usage:",
7133         "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password} -X DELETE",
7134         "type": "json"
7135       }
7136     ],
7137     "name": "destroy",
7138     "group": "Cm_Hopper",
7139     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7140     "version": "0.0.0",
7141     "filename": "server/api/cmHopper/index.js",
7142     "groupTitle": "Cm_Hopper"
7143   },
7144   {
7145     "type": "get",
7146     "url": "/api/cm/hopper/opencontacts",
7147     "title": "Gets Open Contacts",
7148     "examples": [
7149       {
7150         "title": "Example usage:",
7151         "content": "curl https://{domain}/api/cm/hopper/opencontacts -v -u {name}:{password} -X GET",
7152         "type": "json"
7153       }
7154     ],
7155     "name": "getOpenContacts",
7156     "group": "Cm_Hopper",
7157     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7158     "version": "0.0.0",
7159     "filename": "server/api/cmHopper/index.js",
7160     "groupTitle": "Cm_Hopper"
7161   },
7162   {
7163     "type": "post",
7164     "url": "/api/cm/hopper/preview",
7165     "title": "Gets Preview Dialer Contacts",
7166     "examples": [
7167       {
7168         "title": "Example usage:",
7169         "content": "curl https://{domain}/api/cm/hopper/preview -d '{\"hopperIds\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
7170         "type": "json"
7171       }
7172     ],
7173     "name": "getPreview",
7174     "group": "Cm_Hopper",
7175     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7176     "version": "0.0.0",
7177     "filename": "server/api/cmHopper/index.js",
7178     "groupTitle": "Cm_Hopper"
7179   },
7180   {
7181     "type": "put",
7182     "url": "/api/cm/hopper/{id}",
7183     "title": "Update an existing Hopper",
7184     "examples": [
7185       {
7186         "title": "Example usage:",
7187         "content": "curl https://{domain}/api/cm/hopper/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
7188         "type": "json"
7189       }
7190     ],
7191     "name": "updateHopper",
7192     "group": "Cm_Hopper",
7193     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7194     "version": "0.0.0",
7195     "filename": "server/api/cmHopper/index.js",
7196     "groupTitle": "Cm_Hopper"
7197   },
7198   {
7199     "type": "post",
7200     "url": "/api/cm/lists",
7201     "title": "Creates a new List",
7202     "examples": [
7203       {
7204         "title": "Example usage:",
7205         "content": "curl https://{domain}/api/cm/lists -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7206         "type": "json"
7207       }
7208     ],
7209     "name": "CreateLists",
7210     "group": "Cm_Lists",
7211     "parameter": {
7212       "fields": {
7213         "Body": [
7214           {
7215             "group": "Body",
7216             "type": "String",
7217             "optional": false,
7218             "field": "name",
7219             "description": ""
7220           },
7221           {
7222             "group": "Body",
7223             "type": "String",
7224             "optional": true,
7225             "field": "description",
7226             "description": ""
7227           },
7228           {
7229             "group": "Body",
7230             "type": "String",
7231             "optional": true,
7232             "field": "dialPrefix",
7233             "description": ""
7234           }
7235         ]
7236       }
7237     },
7238     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7239     "version": "0.0.0",
7240     "filename": "server/api/cmList/index.js",
7241     "groupTitle": "Cm_Lists"
7242   },
7243   {
7244     "type": "delete",
7245     "url": "/api/cm/lists/{id}",
7246     "title": "Deletes a List",
7247     "examples": [
7248       {
7249         "title": "Example usage:",
7250         "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password} -X DELETE",
7251         "type": "json"
7252       }
7253     ],
7254     "name": "DeleteLists",
7255     "group": "Cm_Lists",
7256     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7257     "version": "0.0.0",
7258     "filename": "server/api/cmList/index.js",
7259     "groupTitle": "Cm_Lists"
7260   },
7261   {
7262     "type": "get",
7263     "url": "/api/cm/lists/describe",
7264     "title": "Gets table info about Lists",
7265     "examples": [
7266       {
7267         "title": "Example usage:",
7268         "content": "curl https://{domain}/api/cm/lists/describe -v -u {name}:{password}",
7269         "type": "json"
7270       }
7271     ],
7272     "name": "DescribeLists",
7273     "group": "Cm_Lists",
7274     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7275     "version": "0.0.0",
7276     "filename": "server/api/cmList/index.js",
7277     "groupTitle": "Cm_Lists"
7278   },
7279   {
7280     "type": "get",
7281     "url": "/api/cm/lists/{id}/users",
7282     "title": "Gets agents from list",
7283     "examples": [
7284       {
7285         "title": "Example usage:",
7286         "content": "curl https://{domain}/api/cm/lists/{id}/users -v -u {name}:{password} -X GET",
7287         "type": "json"
7288       }
7289     ],
7290     "name": "GetAgents",
7291     "group": "Cm_Lists",
7292     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7293     "version": "0.0.0",
7294     "filename": "server/api/cmList/index.js",
7295     "groupTitle": "Cm_Lists"
7296   },
7297   {
7298     "type": "get",
7299     "url": "/api/cm/lists",
7300     "title": "Gets a list of Lists",
7301     "examples": [
7302       {
7303         "title": "Example usage:",
7304         "content": "curl https://{domain}/api/cm/lists -v -u {name}:{password}",
7305         "type": "json"
7306       }
7307     ],
7308     "name": "GetLists",
7309     "group": "Cm_Lists",
7310     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/cm/lists?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/cm/lists?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/cm/lists?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/cm/lists?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/cm/lists?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
7311     "version": "0.0.0",
7312     "filename": "server/api/cmList/index.js",
7313     "groupTitle": "Cm_Lists"
7314   },
7315   {
7316     "type": "delete",
7317     "url": "/api/cm/lists/{id}/users",
7318     "title": "Removes agents from a list",
7319     "examples": [
7320       {
7321         "title": "Example usage:",
7322         "content": "curl https://{domain}/api/cm/lists/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
7323         "type": "json"
7324       }
7325     ],
7326     "name": "RemoveAgents",
7327     "group": "Cm_Lists",
7328     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7329     "version": "0.0.0",
7330     "filename": "server/api/cmList/index.js",
7331     "groupTitle": "Cm_Lists"
7332   },
7333   {
7334     "type": "delete",
7335     "url": "/api/cm/lists/{id}/dispositions",
7336     "title": "Removes dispositions from account",
7337     "examples": [
7338       {
7339         "title": "Example usage:",
7340         "content": "curl https://{domain}/api/cm/lists/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
7341         "type": "json"
7342       }
7343     ],
7344     "name": "RemoveDispositions",
7345     "group": "Cm_Lists",
7346     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7347     "version": "0.0.0",
7348     "filename": "server/api/cmList/index.js",
7349     "groupTitle": "Cm_Lists"
7350   },
7351   {
7352     "type": "get",
7353     "url": "/api/cm/lists/{id}",
7354     "title": "Gets a single List",
7355     "examples": [
7356       {
7357         "title": "Example usage:",
7358         "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password}",
7359         "type": "json"
7360       }
7361     ],
7362     "name": "ShowLists",
7363     "group": "Cm_Lists",
7364     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7365     "version": "0.0.0",
7366     "filename": "server/api/cmList/index.js",
7367     "groupTitle": "Cm_Lists"
7368   },
7369   {
7370     "type": "post",
7371     "url": "/api/cm/lists/{id}/users",
7372     "title": "Adds agents to a list",
7373     "examples": [
7374       {
7375         "title": "Example usage:",
7376         "content": "curl https://{domain}/api/cm/lists/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7377         "type": "json"
7378       }
7379     ],
7380     "name": "addAgents",
7381     "group": "Cm_Lists",
7382     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7383     "version": "0.0.0",
7384     "filename": "server/api/cmList/index.js",
7385     "groupTitle": "Cm_Lists"
7386   },
7387   {
7388     "type": "post",
7389     "url": "/api/cm/lists/{id}/contacts",
7390     "title": "Creates new contacts",
7391     "examples": [
7392       {
7393         "title": "Example usage:",
7394         "content": "curl https://{domain}/api/cm/lists/{id}/contacts -d '[{\"firstName\": \"John Doe\", \"email\": \"john.doe@xcally.com\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7395         "type": "json"
7396       }
7397     ],
7398     "name": "addContacts",
7399     "group": "Cm_Lists",
7400     "parameter": {
7401       "fields": {
7402         "Body": [
7403           {
7404             "group": "Body",
7405             "type": "String",
7406             "optional": false,
7407             "field": "firstName",
7408             "description": ""
7409           },
7410           {
7411             "group": "Body",
7412             "type": "String",
7413             "optional": true,
7414             "field": "lastName",
7415             "description": ""
7416           },
7417           {
7418             "group": "Body",
7419             "type": "String",
7420             "optional": true,
7421             "field": "street",
7422             "description": ""
7423           },
7424           {
7425             "group": "Body",
7426             "type": "String",
7427             "optional": true,
7428             "field": "postalCode",
7429             "description": ""
7430           },
7431           {
7432             "group": "Body",
7433             "type": "String",
7434             "optional": true,
7435             "field": "city",
7436             "description": ""
7437           },
7438           {
7439             "group": "Body",
7440             "type": "String",
7441             "optional": true,
7442             "field": "country",
7443             "description": ""
7444           },
7445           {
7446             "group": "Body",
7447             "type": "String",
7448             "optional": true,
7449             "field": "dateOfBirth",
7450             "description": ""
7451           },
7452           {
7453             "group": "Body",
7454             "type": "Text",
7455             "optional": true,
7456             "field": "description",
7457             "description": ""
7458           },
7459           {
7460             "group": "Body",
7461             "type": "String",
7462             "optional": true,
7463             "field": "phone",
7464             "description": ""
7465           },
7466           {
7467             "group": "Body",
7468             "type": "String",
7469             "optional": true,
7470             "field": "mobile",
7471             "description": ""
7472           },
7473           {
7474             "group": "Body",
7475             "type": "String",
7476             "optional": true,
7477             "field": "fax",
7478             "description": ""
7479           },
7480           {
7481             "group": "Body",
7482             "type": "String",
7483             "optional": true,
7484             "field": "email",
7485             "description": ""
7486           },
7487           {
7488             "group": "Body",
7489             "type": "String",
7490             "optional": true,
7491             "field": "url",
7492             "description": ""
7493           },
7494           {
7495             "group": "Body",
7496             "type": "String",
7497             "optional": true,
7498             "field": "facebook",
7499             "description": ""
7500           },
7501           {
7502             "group": "Body",
7503             "type": "String",
7504             "optional": true,
7505             "field": "fb_data",
7506             "description": ""
7507           },
7508           {
7509             "group": "Body",
7510             "type": "String",
7511             "optional": true,
7512             "field": "twitter",
7513             "description": ""
7514           },
7515           {
7516             "group": "Body",
7517             "type": "String",
7518             "optional": true,
7519             "field": "skype",
7520             "description": ""
7521           },
7522           {
7523             "group": "Body",
7524             "type": "String",
7525             "optional": true,
7526             "field": "teams",
7527             "description": ""
7528           },
7529           {
7530             "group": "Body",
7531             "type": "String",
7532             "optional": true,
7533             "field": "viber",
7534             "description": ""
7535           },
7536           {
7537             "group": "Body",
7538             "type": "String",
7539             "optional": true,
7540             "field": "line",
7541             "description": ""
7542           },
7543           {
7544             "group": "Body",
7545             "type": "String",
7546             "optional": true,
7547             "field": "wechat",
7548             "description": ""
7549           },
7550           {
7551             "group": "Body",
7552             "type": "String",
7553             "optional": true,
7554             "field": "telegram",
7555             "description": ""
7556           },
7557           {
7558             "group": "Body",
7559             "type": "Integer",
7560             "optional": true,
7561             "field": "UserId",
7562             "description": ""
7563           },
7564           {
7565             "group": "Body",
7566             "type": "Integer",
7567             "optional": true,
7568             "field": "priority",
7569             "description": ""
7570           },
7571           {
7572             "group": "Body",
7573             "type": "String",
7574             "optional": true,
7575             "field": "scheduledat",
7576             "description": ""
7577           }
7578         ]
7579       }
7580     },
7581     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7582     "version": "0.0.0",
7583     "filename": "server/api/cmList/index.js",
7584     "groupTitle": "Cm_Lists"
7585   },
7586   {
7587     "type": "post",
7588     "url": "/api/cm/lists/{id}/fields",
7589     "title": "Creates a new custom field",
7590     "examples": [
7591       {
7592         "title": "Example usage:",
7593         "content": "curl https://{domain}/api/cm/lists/{id}/fields -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7594         "type": "json"
7595       }
7596     ],
7597     "name": "addCustomField",
7598     "group": "Cm_Lists",
7599     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7600     "version": "0.0.0",
7601     "filename": "server/api/cmList/index.js",
7602     "groupTitle": "Cm_Lists"
7603   },
7604   {
7605     "type": "post",
7606     "url": "/api/cm/lists/{id}/dispositions",
7607     "title": "Creates new disposition",
7608     "examples": [
7609       {
7610         "title": "Example usage:",
7611         "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7612         "type": "json"
7613       }
7614     ],
7615     "name": "addDisposition",
7616     "group": "Cm_Lists",
7617     "parameter": {
7618       "fields": {
7619         "Body": [
7620           {
7621             "group": "Body",
7622             "type": "String",
7623             "optional": false,
7624             "field": "name",
7625             "description": ""
7626           },
7627           {
7628             "group": "Body",
7629             "type": "String",
7630             "allowedValues": [
7631               "\"first\"",
7632               "\"second\"",
7633               "\"third\""
7634             ],
7635             "optional": false,
7636             "field": "level",
7637             "description": ""
7638           },
7639           {
7640             "group": "Body",
7641             "type": "String",
7642             "optional": true,
7643             "field": "description",
7644             "description": ""
7645           }
7646         ]
7647       }
7648     },
7649     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7650     "version": "0.0.0",
7651     "filename": "server/api/cmList/index.js",
7652     "groupTitle": "Cm_Lists"
7653   },
7654   {
7655     "type": "get",
7656     "url": "/api/cm/lists/{id}/contacts",
7657     "title": "Gets List Contacts",
7658     "examples": [
7659       {
7660         "title": "Example usage:",
7661         "content": "curl https://{domain}/api/cm/lists/{id}/contacts -v -u {name}:{password} -X GET",
7662         "type": "json"
7663       }
7664     ],
7665     "name": "getContacts",
7666     "group": "Cm_Lists",
7667     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7668     "version": "0.0.0",
7669     "filename": "server/api/cmList/index.js",
7670     "groupTitle": "Cm_Lists"
7671   },
7672   {
7673     "type": "get",
7674     "url": "/api/cm/lists/{id}/fields",
7675     "title": "Gets Custom Fields",
7676     "examples": [
7677       {
7678         "title": "Example usage:",
7679         "content": "curl https://{domain}/api/cm/lists/{id}/fields -v -u {name}:{password} -X GET",
7680         "type": "json"
7681       }
7682     ],
7683     "name": "getCustomFields",
7684     "group": "Cm_Lists",
7685     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7686     "version": "0.0.0",
7687     "filename": "server/api/cmList/index.js",
7688     "groupTitle": "Cm_Lists"
7689   },
7690   {
7691     "type": "get",
7692     "url": "/api/cm/lists/{id}/dispositions",
7693     "title": "Gets list dispositions",
7694     "examples": [
7695       {
7696         "title": "Example usage:",
7697         "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -v -u {name}:{password} -X GET",
7698         "type": "json"
7699       }
7700     ],
7701     "name": "getDispositions",
7702     "group": "Cm_Lists",
7703     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7704     "version": "0.0.0",
7705     "filename": "server/api/cmList/index.js",
7706     "groupTitle": "Cm_Lists"
7707   },
7708   {
7709     "type": "get",
7710     "url": "/api/cm/lists/{id}/contacts/csv",
7711     "title": "Gets CSV List Contacts",
7712     "examples": [
7713       {
7714         "title": "Example usage:",
7715         "content": "curl https://{domain}/api/cm/lists/{id}/contacts/csv -v -u {name}:{password} -X GET",
7716         "type": "json"
7717       }
7718     ],
7719     "name": "grunt",
7720     "group": "Cm_Lists",
7721     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7722     "version": "0.0.0",
7723     "filename": "server/api/cmList/index.js",
7724     "groupTitle": "Cm_Lists"
7725   },
7726   {
7727     "type": "put",
7728     "url": "/api/cm/lists/{id}",
7729     "title": "Update an existing List",
7730     "examples": [
7731       {
7732         "title": "Example usage:",
7733         "content": "curl https://{domain}/api/cm/lists/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
7734         "type": "json"
7735       }
7736     ],
7737     "name": "updateLists",
7738     "group": "Cm_Lists",
7739     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7740     "version": "0.0.0",
7741     "filename": "server/api/cmList/index.js",
7742     "groupTitle": "Cm_Lists"
7743   },
7744   {
7745     "type": "post",
7746     "url": "/api/cm/contacts/upload/:id",
7747     "title": "Import new contacts by csv",
7748     "examples": [
7749       {
7750         "title": "Example usage:",
7751         "content": "curl https://{domain}/api/cm/contacts/upload/:id -v -u {name}:{password} -X POST",
7752         "type": "json"
7753       }
7754     ],
7755     "name": "import",
7756     "group": "Cm_contacts",
7757     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7758     "version": "0.0.0",
7759     "filename": "server/api/cmContact/index.js",
7760     "groupTitle": "Cm_contacts"
7761   },
7762   {
7763     "type": "post",
7764     "url": "/api/cm/contacts/upload",
7765     "title": "Upload csv",
7766     "examples": [
7767       {
7768         "title": "Example usage:",
7769         "content": "curl https://{domain}/api/cm/contacts/upload -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
7770         "type": "json"
7771       }
7772     ],
7773     "name": "upload",
7774     "group": "Cm_contacts",
7775     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7776     "version": "0.0.0",
7777     "filename": "server/api/cmContact/index.js",
7778     "groupTitle": "Cm_contacts"
7779   },
7780   {
7781     "type": "post",
7782     "url": "/api/cm/contacts/csv",
7783     "title": "Create new contacts by csv",
7784     "examples": [
7785       {
7786         "title": "Example usage:",
7787         "content": "curl https://{domain}/api/cm/contacts/csv -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
7788         "type": "json"
7789       }
7790     ],
7791     "name": "uploadCsv",
7792     "group": "Cm_contacts",
7793     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7794     "version": "0.0.0",
7795     "filename": "server/api/cmContact/index.js",
7796     "groupTitle": "Cm_contacts"
7797   },
7798   {
7799     "type": "delete",
7800     "url": "/api/conditions/{id}",
7801     "title": "Deletes a Condition",
7802     "examples": [
7803       {
7804         "title": "Example usage:",
7805         "content": "curl https://{domain}/api/conditions/{id} -v -u {name}:{password} -X DELETE",
7806         "type": "json"
7807       }
7808     ],
7809     "name": "DeleteConditions",
7810     "group": "Conditions",
7811     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7812     "version": "0.0.0",
7813     "filename": "server/api/condition/index.js",
7814     "groupTitle": "Conditions"
7815   },
7816   {
7817     "type": "put",
7818     "url": "/api/conditions/{id}",
7819     "title": "Update an existing Condition",
7820     "examples": [
7821       {
7822         "title": "Example usage:",
7823         "content": "curl https://{domain}/api/conditions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
7824         "type": "json"
7825       }
7826     ],
7827     "name": "updateConditions",
7828     "group": "Conditions",
7829     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7830     "version": "0.0.0",
7831     "filename": "server/api/condition/index.js",
7832     "groupTitle": "Conditions"
7833   },
7834   {
7835     "type": "post",
7836     "url": "/api/cm/custom_field",
7837     "title": "Create a new custom field",
7838     "examples": [
7839       {
7840         "title": "Example usage:",
7841         "content": "curl https://{domain}/api/cm/custom_field  -d '{\"name\": \"mycf\", \"type\": \"text\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7842         "type": "json"
7843       }
7844     ],
7845     "name": "CreateCustomField",
7846     "group": "Custom_Fields",
7847     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7848     "version": "0.0.0",
7849     "filename": "server/api/cmCustomField/index.js",
7850     "groupTitle": "Custom_Fields"
7851   },
7852   {
7853     "type": "post",
7854     "url": "/api/dashboards/items",
7855     "title": "Create dasboard item",
7856     "examples": [
7857       {
7858         "title": "Example usage:",
7859         "content": "curl https://{domain}/api/dashboards/items \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
7860         "type": "json"
7861       }
7862     ],
7863     "name": "Create",
7864     "group": "Dashboard_Items",
7865     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7866     "version": "0.0.0",
7867     "filename": "server/api/dashboardItem/index.js",
7868     "groupTitle": "Dashboard_Items"
7869   },
7870   {
7871     "type": "delete",
7872     "url": "/api/dashboards/items/{id}",
7873     "title": "Deletes a Dashboard Item",
7874     "examples": [
7875       {
7876         "title": "Example usage:",
7877         "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X DELETE",
7878         "type": "json"
7879       }
7880     ],
7881     "name": "DeleteDashboard_Items",
7882     "group": "Dashboard_Items",
7883     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7884     "version": "0.0.0",
7885     "filename": "server/api/dashboardItem/index.js",
7886     "groupTitle": "Dashboard_Items"
7887   },
7888   {
7889     "type": "get",
7890     "url": "/api/dashboards/items/{id}",
7891     "title": "Gets a single Dashboard Item",
7892     "examples": [
7893       {
7894         "title": "Example usage:",
7895         "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password}",
7896         "type": "json"
7897       }
7898     ],
7899     "name": "ShowDashboard_Items",
7900     "group": "Dashboard_Items",
7901     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7902     "version": "0.0.0",
7903     "filename": "server/api/dashboardItem/index.js",
7904     "groupTitle": "Dashboard_Items"
7905   },
7906   {
7907     "type": "put",
7908     "url": "/api/dashboards/items/{id}",
7909     "title": "Update an existing item",
7910     "examples": [
7911       {
7912         "title": "Example usage:",
7913         "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X PUT",
7914         "type": "json"
7915       }
7916     ],
7917     "name": "Update",
7918     "group": "Dashboard_Items",
7919     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7920     "version": "0.0.0",
7921     "filename": "server/api/dashboardItem/index.js",
7922     "groupTitle": "Dashboard_Items"
7923   },
7924   {
7925     "type": "post",
7926     "url": "/api/dashboards/clone",
7927     "title": "Clone an existing Dashboard",
7928     "examples": [
7929       {
7930         "title": "Example usage:",
7931         "content": "curl https://{domain}/api/dashboards/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7932         "type": "json"
7933       }
7934     ],
7935     "name": "CloneDashboards",
7936     "group": "Dashboards",
7937     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7938     "version": "0.0.0",
7939     "filename": "server/api/dashboard/index.js",
7940     "groupTitle": "Dashboards"
7941   },
7942   {
7943     "type": "post",
7944     "url": "/api/dashboards",
7945     "title": "Creates a new Dashboard",
7946     "examples": [
7947       {
7948         "title": "Example usage:",
7949         "content": "curl https://{domain}/api/dashboards -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7950         "type": "json"
7951       }
7952     ],
7953     "name": "CreateDashboards",
7954     "group": "Dashboards",
7955     "parameter": {
7956       "fields": {
7957         "Body": [
7958           {
7959             "group": "Body",
7960             "type": "String",
7961             "optional": false,
7962             "field": "name",
7963             "description": ""
7964           },
7965           {
7966             "group": "Body",
7967             "type": "String",
7968             "optional": true,
7969             "field": "description",
7970             "description": ""
7971           }
7972         ]
7973       }
7974     },
7975     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7976     "version": "0.0.0",
7977     "filename": "server/api/dashboard/index.js",
7978     "groupTitle": "Dashboards"
7979   },
7980   {
7981     "type": "delete",
7982     "url": "/api/dashboards/{id}",
7983     "title": "Deletes a Dashboard",
7984     "examples": [
7985       {
7986         "title": "Example usage:",
7987         "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password} -X DELETE",
7988         "type": "json"
7989       }
7990     ],
7991     "name": "DeleteDashboards",
7992     "group": "Dashboards",
7993     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7994     "version": "0.0.0",
7995     "filename": "server/api/dashboard/index.js",
7996     "groupTitle": "Dashboards"
7997   },
7998   {
7999     "type": "get",
8000     "url": "/api/dashboards",
8001     "title": "Gets a list of Dashboards",
8002     "examples": [
8003       {
8004         "title": "Example usage:",
8005         "content": "curl https://{domain}/api/dashboards -v -u {name}:{password}",
8006         "type": "json"
8007       }
8008     ],
8009     "name": "GetDashboards",
8010     "group": "Dashboards",
8011     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/dashboards?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/dashboards?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/dashboards?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/dashboards?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/dashboards?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
8012     "version": "0.0.0",
8013     "filename": "server/api/dashboard/index.js",
8014     "groupTitle": "Dashboards"
8015   },
8016   {
8017     "type": "get",
8018     "url": "/api/dashboards/{id}",
8019     "title": "Gets a single Dashboard",
8020     "examples": [
8021       {
8022         "title": "Example usage:",
8023         "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password}",
8024         "type": "json"
8025       }
8026     ],
8027     "name": "ShowDashboards",
8028     "group": "Dashboards",
8029     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8030     "version": "0.0.0",
8031     "filename": "server/api/dashboard/index.js",
8032     "groupTitle": "Dashboards"
8033   },
8034   {
8035     "type": "post",
8036     "url": "/api/dashboards/{id}/items",
8037     "title": "Creates new item",
8038     "examples": [
8039       {
8040         "title": "Example usage:",
8041         "content": "curl https://{domain}/api/dashboards/{id}/items -d '{\"type\": \"counter\", \"...\": \"...\"}]' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
8042         "type": "json"
8043       }
8044     ],
8045     "name": "addItem",
8046     "group": "Dashboards",
8047     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8048     "version": "0.0.0",
8049     "filename": "server/api/dashboard/index.js",
8050     "groupTitle": "Dashboards"
8051   },
8052   {
8053     "type": "get",
8054     "url": "/api/dashboards/{id}/items",
8055     "title": "Gets items",
8056     "examples": [
8057       {
8058         "title": "Example usage:",
8059         "content": "curl https://{domain}/api/dashboards/{id}/items -v -u {name}:{password} -X GET",
8060         "type": "json"
8061       }
8062     ],
8063     "name": "getItems",
8064     "group": "Dashboards",
8065     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8066     "version": "0.0.0",
8067     "filename": "server/api/dashboard/index.js",
8068     "groupTitle": "Dashboards"
8069   },
8070   {
8071     "type": "put",
8072     "url": "/api/dashboards/{id}",
8073     "title": "Update an existing Dashboard",
8074     "examples": [
8075       {
8076         "title": "Example usage:",
8077         "content": "curl https://{domain}/api/dashboards/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8078         "type": "json"
8079       }
8080     ],
8081     "name": "updateDashboards",
8082     "group": "Dashboards",
8083     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8084     "version": "0.0.0",
8085     "filename": "server/api/dashboard/index.js",
8086     "groupTitle": "Dashboards"
8087   },
8088   {
8089     "type": "post",
8090     "url": "/api/integrations/desk/accounts",
8091     "title": "Creates a new Desk Account",
8092     "examples": [
8093       {
8094         "title": "Example usage:",
8095         "content": "curl https://{domain}/api/integrations/desk/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8096         "type": "json"
8097       }
8098     ],
8099     "name": "CreateDesk_Accounts",
8100     "group": "Desk_Accounts",
8101     "parameter": {
8102       "fields": {
8103         "Body": [
8104           {
8105             "group": "Body",
8106             "type": "String",
8107             "optional": true,
8108             "field": "name",
8109             "description": ""
8110           },
8111           {
8112             "group": "Body",
8113             "type": "String",
8114             "optional": true,
8115             "field": "description",
8116             "description": ""
8117           },
8118           {
8119             "group": "Body",
8120             "type": "String",
8121             "optional": true,
8122             "field": "username",
8123             "description": ""
8124           },
8125           {
8126             "group": "Body",
8127             "type": "String",
8128             "optional": true,
8129             "field": "remoteUri",
8130             "description": ""
8131           },
8132           {
8133             "group": "Body",
8134             "type": "String",
8135             "allowedValues": [
8136               "\"basic\""
8137             ],
8138             "optional": true,
8139             "field": "authType",
8140             "description": ""
8141           },
8142           {
8143             "group": "Body",
8144             "type": "String",
8145             "optional": true,
8146             "field": "password",
8147             "description": ""
8148           },
8149           {
8150             "group": "Body",
8151             "type": "String",
8152             "optional": true,
8153             "field": "consumerKey",
8154             "description": ""
8155           },
8156           {
8157             "group": "Body",
8158             "type": "String",
8159             "optional": true,
8160             "field": "consumerSecret",
8161             "description": ""
8162           },
8163           {
8164             "group": "Body",
8165             "type": "String",
8166             "optional": true,
8167             "field": "token",
8168             "description": ""
8169           },
8170           {
8171             "group": "Body",
8172             "type": "String",
8173             "optional": true,
8174             "field": "tokenSecret",
8175             "description": ""
8176           },
8177           {
8178             "group": "Body",
8179             "type": "String",
8180             "optional": false,
8181             "field": "serverUrl",
8182             "description": ""
8183           },
8184           {
8185             "group": "Body",
8186             "type": "String",
8187             "allowedValues": [
8188               "\"integrationTab\"",
8189               "\"newTab\""
8190             ],
8191             "optional": true,
8192             "field": "type",
8193             "description": ""
8194           }
8195         ]
8196       }
8197     },
8198     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8199     "version": "0.0.0",
8200     "filename": "server/api/intDeskAccount/index.js",
8201     "groupTitle": "Desk_Accounts"
8202   },
8203   {
8204     "type": "delete",
8205     "url": "/api/integrations/desk/accounts/{id}",
8206     "title": "Deletes a Desk Account",
8207     "examples": [
8208       {
8209         "title": "Example usage:",
8210         "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password} -X DELETE",
8211         "type": "json"
8212       }
8213     ],
8214     "name": "DeleteDesk_Accounts",
8215     "group": "Desk_Accounts",
8216     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8217     "version": "0.0.0",
8218     "filename": "server/api/intDeskAccount/index.js",
8219     "groupTitle": "Desk_Accounts"
8220   },
8221   {
8222     "type": "get",
8223     "url": "/api/integrations/desk/accounts",
8224     "title": "Gets a list of Desk Accounts",
8225     "examples": [
8226       {
8227         "title": "Example usage:",
8228         "content": "curl https://{domain}/api/integrations/desk/accounts -v -u {name}:{password}",
8229         "type": "json"
8230       }
8231     ],
8232     "name": "GetDesk_Accounts",
8233     "group": "Desk_Accounts",
8234     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/desk/accounts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/desk/accounts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/desk/accounts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/desk/accounts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/desk/accounts?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
8235     "version": "0.0.0",
8236     "filename": "server/api/intDeskAccount/index.js",
8237     "groupTitle": "Desk_Accounts"
8238   },
8239   {
8240     "type": "get",
8241     "url": "/api/integrations/desk/accounts/{id}",
8242     "title": "Gets a single Desk Account",
8243     "examples": [
8244       {
8245         "title": "Example usage:",
8246         "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password}",
8247         "type": "json"
8248       }
8249     ],
8250     "name": "ShowDesk_Accounts",
8251     "group": "Desk_Accounts",
8252     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8253     "version": "0.0.0",
8254     "filename": "server/api/intDeskAccount/index.js",
8255     "groupTitle": "Desk_Accounts"
8256   },
8257   {
8258     "type": "post",
8259     "url": "/api/integrations/desk/accounts/{id}/configurations",
8260     "title": "Creates new configuration",
8261     "examples": [
8262       {
8263         "title": "Example usage:",
8264         "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/configurations -d '{\"name\": \"conf1\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
8265         "type": "json"
8266       }
8267     ],
8268     "name": "addConfiguration",
8269     "group": "Desk_Accounts",
8270     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8271     "version": "0.0.0",
8272     "filename": "server/api/intDeskAccount/index.js",
8273     "groupTitle": "Desk_Accounts"
8274   },
8275   {
8276     "type": "get",
8277     "url": "/api/integrations/desk/accounts/{id}/configurations",
8278     "title": "Gets account configurations",
8279     "examples": [
8280       {
8281         "title": "Example usage:",
8282         "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
8283         "type": "json"
8284       }
8285     ],
8286     "name": "getConfigurations",
8287     "group": "Desk_Accounts",
8288     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8289     "version": "0.0.0",
8290     "filename": "server/api/intDeskAccount/index.js",
8291     "groupTitle": "Desk_Accounts"
8292   },
8293   {
8294     "type": "get",
8295     "url": "/api/integrations/desk/accounts/{id}/fields",
8296     "title": "Gets account fields",
8297     "examples": [
8298       {
8299         "title": "Example usage:",
8300         "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/fields -v -u {name}:{password} -X GET",
8301         "type": "json"
8302       }
8303     ],
8304     "name": "getFields",
8305     "group": "Desk_Accounts",
8306     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8307     "version": "0.0.0",
8308     "filename": "server/api/intDeskAccount/index.js",
8309     "groupTitle": "Desk_Accounts"
8310   },
8311   {
8312     "type": "put",
8313     "url": "/api/integrations/desk/accounts/{id}",
8314     "title": "Update an existing Desk Account",
8315     "examples": [
8316       {
8317         "title": "Example usage:",
8318         "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8319         "type": "json"
8320       }
8321     ],
8322     "name": "updateDesk_Accounts",
8323     "group": "Desk_Accounts",
8324     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8325     "version": "0.0.0",
8326     "filename": "server/api/intDeskAccount/index.js",
8327     "groupTitle": "Desk_Accounts"
8328   },
8329   {
8330     "type": "post",
8331     "url": "/api/integrations/desk/configurations",
8332     "title": "Creates a new Desk Configuration",
8333     "examples": [
8334       {
8335         "title": "Example usage:",
8336         "content": "curl https://{domain}/api/integrations/desk/configurations -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8337         "type": "json"
8338       }
8339     ],
8340     "name": "CreateDesk_Configurations",
8341     "group": "Desk_Configurations",
8342     "parameter": {
8343       "fields": {
8344         "Body": [
8345           {
8346             "group": "Body",
8347             "type": "String",
8348             "optional": true,
8349             "field": "name",
8350             "description": ""
8351           },
8352           {
8353             "group": "Body",
8354             "type": "String",
8355             "optional": true,
8356             "field": "description",
8357             "description": ""
8358           }
8359         ]
8360       }
8361     },
8362     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8363     "version": "0.0.0",
8364     "filename": "server/api/intDeskConfiguration/index.js",
8365     "groupTitle": "Desk_Configurations"
8366   },
8367   {
8368     "type": "delete",
8369     "url": "/api/integrations/desk/configurations/{id}",
8370     "title": "Deletes a Desk Configuration",
8371     "examples": [
8372       {
8373         "title": "Example usage:",
8374         "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password} -X DELETE",
8375         "type": "json"
8376       }
8377     ],
8378     "name": "DeleteDesk_Configurations",
8379     "group": "Desk_Configurations",
8380     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8381     "version": "0.0.0",
8382     "filename": "server/api/intDeskConfiguration/index.js",
8383     "groupTitle": "Desk_Configurations"
8384   },
8385   {
8386     "type": "get",
8387     "url": "/api/integrations/desk/configurations",
8388     "title": "Gets a list of Desk Configurations",
8389     "examples": [
8390       {
8391         "title": "Example usage:",
8392         "content": "curl https://{domain}/api/integrations/desk/configurations -v -u {name}:{password}",
8393         "type": "json"
8394       }
8395     ],
8396     "name": "GetDesk_Configurations",
8397     "group": "Desk_Configurations",
8398     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/desk/configurations?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/desk/configurations?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/desk/configurations?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/desk/configurations?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/desk/configurations?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
8399     "version": "0.0.0",
8400     "filename": "server/api/intDeskConfiguration/index.js",
8401     "groupTitle": "Desk_Configurations"
8402   },
8403   {
8404     "type": "get",
8405     "url": "/api/integrations/desk/configurations/{id}",
8406     "title": "Gets a single Desk Configuration",
8407     "examples": [
8408       {
8409         "title": "Example usage:",
8410         "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password}",
8411         "type": "json"
8412       }
8413     ],
8414     "name": "ShowDesk_Configurations",
8415     "group": "Desk_Configurations",
8416     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8417     "version": "0.0.0",
8418     "filename": "server/api/intDeskConfiguration/index.js",
8419     "groupTitle": "Desk_Configurations"
8420   },
8421   {
8422     "type": "get",
8423     "url": "/api/integrations/desk/configurations/{id}/descriptions",
8424     "title": "Gets configurations descriptions",
8425     "examples": [
8426       {
8427         "title": "Example usage:",
8428         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
8429         "type": "json"
8430       }
8431     ],
8432     "name": "getDescriptions",
8433     "group": "Desk_Configurations",
8434     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8435     "version": "0.0.0",
8436     "filename": "server/api/intDeskConfiguration/index.js",
8437     "groupTitle": "Desk_Configurations"
8438   },
8439   {
8440     "type": "get",
8441     "url": "/api/integrations/desk/configurations/{id}/fields",
8442     "title": "Gets configurations fields",
8443     "examples": [
8444       {
8445         "title": "Example usage:",
8446         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/fields -v -u {name}:{password} -X GET",
8447         "type": "json"
8448       }
8449     ],
8450     "name": "getFields",
8451     "group": "Desk_Configurations",
8452     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8453     "version": "0.0.0",
8454     "filename": "server/api/intDeskConfiguration/index.js",
8455     "groupTitle": "Desk_Configurations"
8456   },
8457   {
8458     "type": "get",
8459     "url": "/api/integrations/desk/configurations/{id}/subjects",
8460     "title": "Gets configurations subjects",
8461     "examples": [
8462       {
8463         "title": "Example usage:",
8464         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
8465         "type": "json"
8466       }
8467     ],
8468     "name": "getSubjects",
8469     "group": "Desk_Configurations",
8470     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8471     "version": "0.0.0",
8472     "filename": "server/api/intDeskConfiguration/index.js",
8473     "groupTitle": "Desk_Configurations"
8474   },
8475   {
8476     "type": "get",
8477     "url": "/api/integrations/desk/configurations/{id}/tags",
8478     "title": "Gets configurations tags",
8479     "examples": [
8480       {
8481         "title": "Example usage:",
8482         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/tags -v -u {name}:{password} -X GET",
8483         "type": "json"
8484       }
8485     ],
8486     "name": "getTags",
8487     "group": "Desk_Configurations",
8488     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8489     "version": "0.0.0",
8490     "filename": "server/api/intDeskConfiguration/index.js",
8491     "groupTitle": "Desk_Configurations"
8492   },
8493   {
8494     "type": "post",
8495     "url": "/api/integrations/desk/configurations/{id}/tags",
8496     "title": "Sets new tags",
8497     "examples": [
8498       {
8499         "title": "Example usage:",
8500         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/tags -d '{\"ids\": [1,12]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
8501         "type": "json"
8502       }
8503     ],
8504     "name": "setTags",
8505     "group": "Desk_Configurations",
8506     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8507     "version": "0.0.0",
8508     "filename": "server/api/intDeskConfiguration/index.js",
8509     "groupTitle": "Desk_Configurations"
8510   },
8511   {
8512     "type": "put",
8513     "url": "/api/integrations/desk/configurations/{id}",
8514     "title": "Update an existing Desk Configuration",
8515     "examples": [
8516       {
8517         "title": "Example usage:",
8518         "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8519         "type": "json"
8520       }
8521     ],
8522     "name": "updateDesk_Configurations",
8523     "group": "Desk_Configurations",
8524     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8525     "version": "0.0.0",
8526     "filename": "server/api/intDeskConfiguration/index.js",
8527     "groupTitle": "Desk_Configurations"
8528   },
8529   {
8530     "type": "post",
8531     "url": "/api/integrations/desk/fields",
8532     "title": "Creates a new Desk Field",
8533     "examples": [
8534       {
8535         "title": "Example usage:",
8536         "content": "curl https://{domain}/api/integrations/desk/fields -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8537         "type": "json"
8538       }
8539     ],
8540     "name": "CreateDesk_Fields",
8541     "group": "Desk_Fields",
8542     "parameter": {
8543       "fields": {
8544         "Body": [
8545           {
8546             "group": "Body",
8547             "type": "String",
8548             "allowedValues": [
8549               "\"string\"",
8550               "\"variable\"",
8551               "\"customVariable\"",
8552               "\"keyValue\""
8553             ],
8554             "optional": true,
8555             "field": "type",
8556             "description": ""
8557           },
8558           {
8559             "group": "Body",
8560             "type": "String",
8561             "optional": true,
8562             "field": "content",
8563             "description": ""
8564           },
8565           {
8566             "group": "Body",
8567             "type": "String",
8568             "optional": true,
8569             "field": "key",
8570             "description": ""
8571           },
8572           {
8573             "group": "Body",
8574             "type": "String",
8575             "allowedValues": [
8576               "\"string\"",
8577               "\"variable\"",
8578               "\"customVariable\""
8579             ],
8580             "optional": true,
8581             "field": "keyType",
8582             "description": ""
8583           },
8584           {
8585             "group": "Body",
8586             "type": "String",
8587             "optional": true,
8588             "field": "keyContent",
8589             "description": ""
8590           },
8591           {
8592             "group": "Body",
8593             "type": "String",
8594             "optional": true,
8595             "field": "idField",
8596             "description": ""
8597           },
8598           {
8599             "group": "Body",
8600             "type": "String",
8601             "optional": true,
8602             "field": "nameField",
8603             "description": ""
8604           },
8605           {
8606             "group": "Body",
8607             "type": "Boolean",
8608             "optional": true,
8609             "field": "customField",
8610             "description": ""
8611           },
8612           {
8613             "group": "Body",
8614             "type": "String",
8615             "optional": true,
8616             "field": "variableName",
8617             "description": ""
8618           }
8619         ]
8620       }
8621     },
8622     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8623     "version": "0.0.0",
8624     "filename": "server/api/intDeskField/index.js",
8625     "groupTitle": "Desk_Fields"
8626   },
8627   {
8628     "type": "delete",
8629     "url": "/api/integrations/desk/fields/{id}",
8630     "title": "Deletes a Desk Field",
8631     "examples": [
8632       {
8633         "title": "Example usage:",
8634         "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password} -X DELETE",
8635         "type": "json"
8636       }
8637     ],
8638     "name": "DeleteDesk_Fields",
8639     "group": "Desk_Fields",
8640     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8641     "version": "0.0.0",
8642     "filename": "server/api/intDeskField/index.js",
8643     "groupTitle": "Desk_Fields"
8644   },
8645   {
8646     "type": "get",
8647     "url": "/api/integrations/desk/fields",
8648     "title": "Gets a list of Desk Fields",
8649     "examples": [
8650       {
8651         "title": "Example usage:",
8652         "content": "curl https://{domain}/api/integrations/desk/fields -v -u {name}:{password}",
8653         "type": "json"
8654       }
8655     ],
8656     "name": "GetDesk_Fields",
8657     "group": "Desk_Fields",
8658     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/desk/fields?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/desk/fields?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/desk/fields?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/desk/fields?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/desk/fields?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
8659     "version": "0.0.0",
8660     "filename": "server/api/intDeskField/index.js",
8661     "groupTitle": "Desk_Fields"
8662   },
8663   {
8664     "type": "get",
8665     "url": "/api/integrations/desk/fields/{id}",
8666     "title": "Gets a single Desk Field",
8667     "examples": [
8668       {
8669         "title": "Example usage:",
8670         "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password}",
8671         "type": "json"
8672       }
8673     ],
8674     "name": "ShowDesk_Fields",
8675     "group": "Desk_Fields",
8676     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8677     "version": "0.0.0",
8678     "filename": "server/api/intDeskField/index.js",
8679     "groupTitle": "Desk_Fields"
8680   },
8681   {
8682     "type": "put",
8683     "url": "/api/integrations/desk/fields/{id}",
8684     "title": "Update an existing Desk Field",
8685     "examples": [
8686       {
8687         "title": "Example usage:",
8688         "content": "curl https://{domain}/api/integrations/desk/fields/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8689         "type": "json"
8690       }
8691     ],
8692     "name": "updateDesk_Fields",
8693     "group": "Desk_Fields",
8694     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8695     "version": "0.0.0",
8696     "filename": "server/api/intDeskField/index.js",
8697     "groupTitle": "Desk_Fields"
8698   },
8699   {
8700     "type": "post",
8701     "url": "/api/dispositions",
8702     "title": "Creates a new Disposition",
8703     "examples": [
8704       {
8705         "title": "Example usage:",
8706         "content": "curl https://{domain}/api/dispositions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8707         "type": "json"
8708       }
8709     ],
8710     "name": "CreateDispositions",
8711     "group": "Dispositions",
8712     "parameter": {
8713       "fields": {
8714         "Body": [
8715           {
8716             "group": "Body",
8717             "type": "String",
8718             "optional": false,
8719             "field": "name",
8720             "description": ""
8721           },
8722           {
8723             "group": "Body",
8724             "type": "String",
8725             "allowedValues": [
8726               "\"first\"",
8727               "\"second\"",
8728               "\"third\""
8729             ],
8730             "optional": false,
8731             "field": "level",
8732             "description": ""
8733           },
8734           {
8735             "group": "Body",
8736             "type": "String",
8737             "optional": true,
8738             "field": "description",
8739             "description": ""
8740           }
8741         ]
8742       }
8743     },
8744     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8745     "version": "0.0.0",
8746     "filename": "server/api/disposition/index.js",
8747     "groupTitle": "Dispositions"
8748   },
8749   {
8750     "type": "delete",
8751     "url": "/api/dispositions/{id}",
8752     "title": "Deletes a Disposition",
8753     "examples": [
8754       {
8755         "title": "Example usage:",
8756         "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password} -X DELETE",
8757         "type": "json"
8758       }
8759     ],
8760     "name": "DeleteDispositions",
8761     "group": "Dispositions",
8762     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8763     "version": "0.0.0",
8764     "filename": "server/api/disposition/index.js",
8765     "groupTitle": "Dispositions"
8766   },
8767   {
8768     "type": "get",
8769     "url": "/api/dispositions",
8770     "title": "Gets a list of Dispositions",
8771     "examples": [
8772       {
8773         "title": "Example usage:",
8774         "content": "curl https://{domain}/api/dispositions -v -u {name}:{password}",
8775         "type": "json"
8776       }
8777     ],
8778     "name": "GetDispositions",
8779     "group": "Dispositions",
8780     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/dispositions?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/dispositions?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/dispositions?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/dispositions?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/dispositions?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
8781     "version": "0.0.0",
8782     "filename": "server/api/disposition/index.js",
8783     "groupTitle": "Dispositions"
8784   },
8785   {
8786     "type": "get",
8787     "url": "/api/dispositions/{id}",
8788     "title": "Gets a single Disposition",
8789     "examples": [
8790       {
8791         "title": "Example usage:",
8792         "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password}",
8793         "type": "json"
8794       }
8795     ],
8796     "name": "ShowDispositions",
8797     "group": "Dispositions",
8798     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8799     "version": "0.0.0",
8800     "filename": "server/api/disposition/index.js",
8801     "groupTitle": "Dispositions"
8802   },
8803   {
8804     "type": "put",
8805     "url": "/api/dispositions/{id}",
8806     "title": "Update an existing Disposition",
8807     "examples": [
8808       {
8809         "title": "Example usage:",
8810         "content": "curl https://{domain}/api/dispositions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8811         "type": "json"
8812       }
8813     ],
8814     "name": "updateDispositions",
8815     "group": "Dispositions",
8816     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8817     "version": "0.0.0",
8818     "filename": "server/api/disposition/index.js",
8819     "groupTitle": "Dispositions"
8820   },
8821   {
8822     "type": "post",
8823     "url": "/api/integrations/dynamics365/accounts",
8824     "title": "Creates a new Dynamics365 Account",
8825     "examples": [
8826       {
8827         "title": "Example usage:",
8828         "content": "curl https://{domain}/api/integrations/dynamics365/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8829         "type": "json"
8830       }
8831     ],
8832     "name": "CreateDynamics365_Accounts",
8833     "group": "Dynamics365_Accounts",
8834     "parameter": {
8835       "fields": {
8836         "Body": [
8837           {
8838             "group": "Body",
8839             "type": "String",
8840             "optional": true,
8841             "field": "name",
8842             "description": ""
8843           },
8844           {
8845             "group": "Body",
8846             "type": "String",
8847             "optional": true,
8848             "field": "username",
8849             "description": ""
8850           },
8851           {
8852             "group": "Body",
8853             "type": "String",
8854             "optional": true,
8855             "field": "password",
8856             "description": ""
8857           },
8858           {
8859             "group": "Body",
8860             "type": "String",
8861             "optional": true,
8862             "field": "remoteUri",
8863             "description": ""
8864           },
8865           {
8866             "group": "Body",
8867             "type": "String",
8868             "optional": true,
8869             "field": "tenantId",
8870             "description": ""
8871           },
8872           {
8873             "group": "Body",
8874             "type": "String",
8875             "optional": true,
8876             "field": "clientId",
8877             "description": ""
8878           },
8879           {
8880             "group": "Body",
8881             "type": "String",
8882             "optional": true,
8883             "field": "clientSecret",
8884             "description": ""
8885           },
8886           {
8887             "group": "Body",
8888             "type": "String",
8889             "optional": false,
8890             "field": "serverUrl",
8891             "description": ""
8892           },
8893           {
8894             "group": "Body",
8895             "type": "String",
8896             "optional": true,
8897             "field": "description",
8898             "description": ""
8899           }
8900         ]
8901       }
8902     },
8903     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8904     "version": "0.0.0",
8905     "filename": "server/api/intDynamics365Account/index.js",
8906     "groupTitle": "Dynamics365_Accounts"
8907   },
8908   {
8909     "type": "delete",
8910     "url": "/api/integrations/dynamics365/accounts/{id}",
8911     "title": "Deletes a Dynamics365 Account",
8912     "examples": [
8913       {
8914         "title": "Example usage:",
8915         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password} -X DELETE",
8916         "type": "json"
8917       }
8918     ],
8919     "name": "DeleteDynamics365_Accounts",
8920     "group": "Dynamics365_Accounts",
8921     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8922     "version": "0.0.0",
8923     "filename": "server/api/intDynamics365Account/index.js",
8924     "groupTitle": "Dynamics365_Accounts"
8925   },
8926   {
8927     "type": "get",
8928     "url": "/api/integrations/dynamics365/accounts",
8929     "title": "Gets a list of Dynamics365 Accounts",
8930     "examples": [
8931       {
8932         "title": "Example usage:",
8933         "content": "curl https://{domain}/api/integrations/dynamics365/accounts -v -u {name}:{password}",
8934         "type": "json"
8935       }
8936     ],
8937     "name": "GetDynamics365_Accounts",
8938     "group": "Dynamics365_Accounts",
8939     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/dynamics365/accounts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/dynamics365/accounts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/dynamics365/accounts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/dynamics365/accounts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/dynamics365/accounts?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
8940     "version": "0.0.0",
8941     "filename": "server/api/intDynamics365Account/index.js",
8942     "groupTitle": "Dynamics365_Accounts"
8943   },
8944   {
8945     "type": "get",
8946     "url": "/api/integrations/dynamics365/accounts/{id}",
8947     "title": "Gets a single Dynamics365 Account",
8948     "examples": [
8949       {
8950         "title": "Example usage:",
8951         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password}",
8952         "type": "json"
8953       }
8954     ],
8955     "name": "ShowDynamics365_Accounts",
8956     "group": "Dynamics365_Accounts",
8957     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8958     "version": "0.0.0",
8959     "filename": "server/api/intDynamics365Account/index.js",
8960     "groupTitle": "Dynamics365_Accounts"
8961   },
8962   {
8963     "type": "post",
8964     "url": "/api/integrations/dynamics365/accounts/{id}/configurations",
8965     "title": "Creates new configuration",
8966     "examples": [
8967       {
8968         "title": "Example usage:",
8969         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/configurations -d '{\"name\": \"conf1\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
8970         "type": "json"
8971       }
8972     ],
8973     "name": "addConfiguration",
8974     "group": "Dynamics365_Accounts",
8975     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8976     "version": "0.0.0",
8977     "filename": "server/api/intDynamics365Account/index.js",
8978     "groupTitle": "Dynamics365_Accounts"
8979   },
8980   {
8981     "type": "get",
8982     "url": "/api/integrations/dynamics365/accounts/{id}/configurations",
8983     "title": "Gets account configurations",
8984     "examples": [
8985       {
8986         "title": "Example usage:",
8987         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/configurations -v -u {name}:{password} -X GET",
8988         "type": "json"
8989       }
8990     ],
8991     "name": "getConfigurations",
8992     "group": "Dynamics365_Accounts",
8993     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8994     "version": "0.0.0",
8995     "filename": "server/api/intDynamics365Account/index.js",
8996     "groupTitle": "Dynamics365_Accounts"
8997   },
8998   {
8999     "type": "get",
9000     "url": "/api/integrations/dynamics365/accounts/{id}/fields",
9001     "title": "Gets account fields",
9002     "examples": [
9003       {
9004         "title": "Example usage:",
9005         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/fields -v -u {name}:{password} -X GET",
9006         "type": "json"
9007       }
9008     ],
9009     "name": "getFields",
9010     "group": "Dynamics365_Accounts",
9011     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9012     "version": "0.0.0",
9013     "filename": "server/api/intDynamics365Account/index.js",
9014     "groupTitle": "Dynamics365_Accounts"
9015   },
9016   {
9017     "type": "put",
9018     "url": "/api/integrations/dynamics365/accounts/{id}",
9019     "title": "Update an existing Dynamics365 Account",
9020     "examples": [
9021       {
9022         "title": "Example usage:",
9023         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
9024         "type": "json"
9025       }
9026     ],
9027     "name": "updateDynamics365_Accounts",
9028     "group": "Dynamics365_Accounts",
9029     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9030     "version": "0.0.0",
9031     "filename": "server/api/intDynamics365Account/index.js",
9032     "groupTitle": "Dynamics365_Accounts"
9033   },
9034   {
9035     "type": "post",
9036     "url": "/api/integrations/dynamics365/configurations",
9037     "title": "Creates a new Dynamics365 Configuration",
9038     "examples": [
9039       {
9040         "title": "Example usage:",
9041         "content": "curl https://{domain}/api/integrations/dynamics365/configurations -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
9042         "type": "json"
9043       }
9044     ],
9045     "name": "CreateDynamics365_Configurations",
9046     "group": "Dynamics365_Configurations",
9047     "parameter": {
9048       "fields": {
9049         "Body": [
9050           {
9051             "group": "Body",
9052             "type": "String",
9053             "optional": true,
9054             "field": "name",
9055             "description": ""
9056           },
9057           {
9058             "group": "Body",
9059             "type": "String",
9060             "optional": true,
9061             "field": "description",
9062             "description": ""
9063           },
9064           {
9065             "group": "Body",
9066             "type": "String",
9067             "allowedValues": [
9068               "\"incident\"",
9069               "\"phonecall\""
9070             ],
9071             "optional": true,
9072             "field": "ticketType",
9073             "description": ""
9074           }
9075         ]
9076       }
9077     },
9078     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9079     "version": "0.0.0",
9080     "filename": "server/api/intDynamics365Configuration/index.js",
9081     "groupTitle": "Dynamics365_Configurations"
9082   },
9083   {
9084     "type": "delete",
9085     "url": "/api/integrations/dynamics365/configurations/{id}",
9086     "title": "Deletes a Dynamics365 Configuration",
9087     "examples": [
9088       {
9089         "title": "Example usage:",
9090         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password} -X DELETE",
9091         "type": "json"
9092       }
9093     ],
9094     "name": "DeleteDynamics365_Configurations",
9095     "group": "Dynamics365_Configurations",
9096     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9097     "version": "0.0.0",
9098     "filename": "server/api/intDynamics365Configuration/index.js",
9099     "groupTitle": "Dynamics365_Configurations"
9100   },
9101   {
9102     "type": "get",
9103     "url": "/api/integrations/dynamics365/configurations",
9104     "title": "Gets a list of Dynamics365 Configurations",
9105     "examples": [
9106       {
9107         "title": "Example usage:",
9108         "content": "curl https://{domain}/api/integrations/dynamics365/configurations -v -u {name}:{password}",
9109         "type": "json"
9110       }
9111     ],
9112     "name": "GetDynamics365_Configurations",
9113     "group": "Dynamics365_Configurations",
9114     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/dynamics365/configurations?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/dynamics365/configurations?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/dynamics365/configurations?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/dynamics365/configurations?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/dynamics365/configurations?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
9115     "version": "0.0.0",
9116     "filename": "server/api/intDynamics365Configuration/index.js",
9117     "groupTitle": "Dynamics365_Configurations"
9118   },
9119   {
9120     "type": "get",
9121     "url": "/api/integrations/dynamics365/configurations/{id}",
9122     "title": "Gets a single Dynamics365 Configuration",
9123     "examples": [
9124       {
9125         "title": "Example usage:",
9126         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password}",
9127         "type": "json"
9128       }
9129     ],
9130     "name": "ShowDynamics365_Configurations",
9131     "group": "Dynamics365_Configurations",
9132     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9133     "version": "0.0.0",
9134     "filename": "server/api/intDynamics365Configuration/index.js",
9135     "groupTitle": "Dynamics365_Configurations"
9136   },
9137   {
9138     "type": "get",
9139     "url": "/api/integrations/dynamics365/configurations/{id}/descriptions",
9140     "title": "Gets configurations descriptions",
9141     "examples": [
9142       {
9143         "title": "Example usage:",
9144         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
9145         "type": "json"
9146       }
9147     ],
9148     "name": "getDescriptions",
9149     "group": "Dynamics365_Configurations",
9150     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9151     "version": "0.0.0",
9152     "filename": "server/api/intDynamics365Configuration/index.js",
9153     "groupTitle": "Dynamics365_Configurations"
9154   },
9155   {
9156     "type": "get",
9157     "url": "/api/integrations/dynamics365/configurations/{id}/fields",
9158     "title": "Gets configurations fields",
9159     "examples": [
9160       {
9161         "title": "Example usage:",
9162         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
9163         "type": "json"
9164       }
9165     ],
9166     "name": "getFields",
9167     "group": "Dynamics365_Configurations",
9168     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9169     "version": "0.0.0",
9170     "filename": "server/api/intDynamics365Configuration/index.js",
9171     "groupTitle": "Dynamics365_Configurations"
9172   },
9173   {
9174     "type": "get",
9175     "url": "/api/integrations/zoho/configurations/{id}/subjects",
9176     "title": "Gets configurations subjects",
9177     "examples": [
9178       {
9179         "title": "Example usage:",
9180         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/subjects -v -u {name}:{password} -X GET",
9181         "type": "json"
9182       }
9183     ],
9184     "name": "getSubjects",
9185     "group": "Dynamics365_Configurations",
9186     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9187     "version": "0.0.0",
9188     "filename": "server/api/intDynamics365Configuration/index.js",
9189     "groupTitle": "Dynamics365_Configurations"
9190   },
9191   {
9192     "type": "put",
9193     "url": "/api/integrations/dynamics365/configurations/{id}",
9194     "title": "Update an existing Dynamics365 Configuration",
9195     "examples": [
9196       {
9197         "title": "Example usage:",
9198         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
9199         "type": "json"
9200       }
9201     ],
9202     "name": "updateDynamics365_Configurations",
9203     "group": "Dynamics365_Configurations",
9204     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9205     "version": "0.0.0",
9206     "filename": "server/api/intDynamics365Configuration/index.js",
9207     "groupTitle": "Dynamics365_Configurations"
9208   },
9209   {
9210     "type": "post",
9211     "url": "/api/integrations/dynamics365/fields",
9212     "title": "Creates a new Dynamics365 Field",
9213     "examples": [
9214       {
9215         "title": "Example usage:",
9216         "content": "curl https://{domain}/api/integrations/dynamics365/fields -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
9217         "type": "json"
9218       }
9219     ],
9220     "name": "CreateDynamics365_Fields",
9221     "group": "Dynamics365_Fields",
9222     "parameter": {
9223       "fields": {
9224         "Body": [
9225           {
9226             "group": "Body",
9227             "type": "String",
9228             "allowedValues": [
9229               "\"string\"",
9230               "\"variable\"",
9231               "\"customVariable\"",
9232               "\"keyValue\""
9233             ],
9234             "optional": true,
9235             "field": "type",
9236             "description": ""
9237           },
9238           {
9239             "group": "Body",
9240             "type": "String",
9241             "optional": true,
9242             "field": "content",
9243             "description": ""
9244           },
9245           {
9246             "group": "Body",
9247             "type": "String",
9248             "optional": true,
9249             "field": "key",
9250             "description": ""
9251           },
9252           {
9253             "group": "Body",
9254             "type": "String",
9255             "allowedValues": [
9256               "\"string\"",
9257               "\"variable\"",
9258               "\"customVariable\""
9259             ],
9260             "optional": true,
9261             "field": "keyType",
9262             "description": ""
9263           },
9264           {
9265             "group": "Body",
9266             "type": "String",
9267             "optional": true,
9268             "field": "keyContent",
9269             "description": ""
9270           },
9271           {
9272             "group": "Body",
9273             "type": "String",
9274             "optional": true,
9275             "field": "idField",
9276             "description": ""
9277           },
9278           {
9279             "group": "Body",
9280             "type": "String",
9281             "optional": true,
9282             "field": "nameField",
9283             "description": ""
9284           },
9285           {
9286             "group": "Body",
9287             "type": "Boolean",
9288             "optional": true,
9289             "field": "customField",
9290             "description": ""
9291           },
9292           {
9293             "group": "Body",
9294             "type": "String",
9295             "optional": true,
9296             "field": "variableName",
9297             "description": ""
9298           }
9299         ]
9300       }
9301     },
9302     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9303     "version": "0.0.0",
9304     "filename": "server/api/intDynamics365Field/index.js",
9305     "groupTitle": "Dynamics365_Fields"
9306   },
9307   {
9308     "type": "delete",
9309     "url": "/api/integrations/dynamics365/fields/{id}",
9310     "title": "Deletes a Dynamics365 Field",
9311     "examples": [
9312       {
9313         "title": "Example usage:",
9314         "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password} -X DELETE",
9315         "type": "json"
9316       }
9317     ],
9318     "name": "DeleteDynamics365_Fields",
9319     "group": "Dynamics365_Fields",
9320     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9321     "version": "0.0.0",
9322     "filename": "server/api/intDynamics365Field/index.js",
9323     "groupTitle": "Dynamics365_Fields"
9324   },
9325   {
9326     "type": "get",
9327     "url": "/api/integrations/dynamics365/fields",
9328     "title": "Gets a list of Dynamics365 Fields",
9329     "examples": [
9330       {
9331         "title": "Example usage:",
9332         "content": "curl https://{domain}/api/integrations/dynamics365/fields -v -u {name}:{password}",
9333         "type": "json"
9334       }
9335     ],
9336     "name": "GetDynamics365_Fields",
9337     "group": "Dynamics365_Fields",
9338     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/dynamics365/fields?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/dynamics365/fields?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/dynamics365/fields?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/dynamics365/fields?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/dynamics365/fields?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
9339     "version": "0.0.0",
9340     "filename": "server/api/intDynamics365Field/index.js",
9341     "groupTitle": "Dynamics365_Fields"
9342   },
9343   {
9344     "type": "get",
9345     "url": "/api/integrations/dynamics365/fields/{id}",
9346     "title": "Gets a single Dynamics365 Field",
9347     "examples": [
9348       {
9349         "title": "Example usage:",
9350         "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password}",
9351         "type": "json"
9352       }
9353     ],
9354     "name": "ShowDynamics365_Fields",
9355     "group": "Dynamics365_Fields",
9356     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9357     "version": "0.0.0",
9358     "filename": "server/api/intDynamics365Field/index.js",
9359     "groupTitle": "Dynamics365_Fields"
9360   },
9361   {
9362     "type": "put",
9363     "url": "/api/integrations/dynamics365/fields/{id}",
9364     "title": "Update an existing Dynamics365 Field",
9365     "examples": [
9366       {
9367         "title": "Example usage:",
9368         "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
9369         "type": "json"
9370       }
9371     ],
9372     "name": "updateDynamics365_Fields",
9373     "group": "Dynamics365_Fields",
9374     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9375     "version": "0.0.0",
9376     "filename": "server/api/intDynamics365Field/index.js",
9377     "groupTitle": "Dynamics365_Fields"
9378   },
9379   {
9380     "type": "post",
9381     "url": "/api/fax/accounts/{id}/users",
9382     "title": "Add agents to a fax account",
9383     "examples": [
9384       {
9385         "title": "Example usage:",
9386         "content": "curl https://{domain}/api/fax/accounts/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9387         "type": "json"
9388       }
9389     ],
9390     "name": "AddAgents",
9391     "group": "Fax_Accounts",
9392     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9393     "version": "0.0.0",
9394     "filename": "server/api/faxAccount/index.js",
9395     "groupTitle": "Fax_Accounts"
9396   },
9397   {
9398     "type": "post",
9399     "url": "/api/fax/accounts",
9400     "title": "Creates a new Account",
9401     "examples": [
9402       {
9403         "title": "Example usage:",
9404         "content": "curl https://{domain}/api/fax/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
9405         "type": "json"
9406       }
9407     ],
9408     "name": "CreateAccounts",
9409     "group": "Fax_Accounts",
9410     "parameter": {
9411       "fields": {
9412         "Body": [
9413           {
9414             "group": "Body",
9415             "type": "String",
9416             "optional": false,
9417             "field": "name",
9418             "description": ""
9419           },
9420           {
9421             "group": "Body",
9422             "type": "String",
9423             "optional": true,
9424             "field": "description",
9425             "description": ""
9426           },
9427           {
9428             "group": "Body",
9429             "type": "String",
9430             "allowedValues": [
9431               "\"yes\"",
9432               "\"no\""
9433             ],
9434             "optional": true,
9435             "field": "ecm",
9436             "description": ""
9437           },
9438           {
9439             "group": "Body",
9440             "type": "String",
9441             "optional": true,
9442             "field": "headerinfo",
9443             "description": ""
9444           },
9445           {
9446             "group": "Body",
9447             "type": "String",
9448             "optional": true,
9449             "field": "localstationid",
9450             "description": ""
9451           },
9452           {
9453             "group": "Body",
9454             "type": "String",
9455             "allowedValues": [
9456               "\"2400\"",
9457               "\"4800\"",
9458               "\"7200\"",
9459               "\"9600\"",
9460               "\"12000\"",
9461               "\"14400\""
9462             ],
9463             "optional": true,
9464             "field": "minrate",
9465             "description": ""
9466           },
9467           {
9468             "group": "Body",
9469             "type": "String",
9470             "allowedValues": [
9471               "\"2400\"",
9472               "\"4800\"",
9473               "\"7200\"",
9474               "\"9600\"",
9475               "\"12000\"",
9476               "\"14400\""
9477             ],
9478             "optional": true,
9479             "field": "maxrate",
9480             "description": ""
9481           },
9482           {
9483             "group": "Body",
9484             "type": "String",
9485             "optional": true,
9486             "field": "modem",
9487             "description": ""
9488           },
9489           {
9490             "group": "Body",
9491             "type": "String",
9492             "optional": true,
9493             "field": "gateway",
9494             "description": ""
9495           },
9496           {
9497             "group": "Body",
9498             "type": "String",
9499             "optional": true,
9500             "field": "faxdetect",
9501             "description": ""
9502           },
9503           {
9504             "group": "Body",
9505             "type": "Integer",
9506             "optional": true,
9507             "field": "t38timeout",
9508             "description": ""
9509           },
9510           {
9511             "group": "Body",
9512             "type": "String",
9513             "allowedValues": [
9514               "\"SIP\"",
9515               "\"IAX\"",
9516               "\"DADHI\"",
9517               "\"KHOMP\""
9518             ],
9519             "optional": true,
9520             "field": "tech",
9521             "description": ""
9522           },
9523           {
9524             "group": "Body",
9525             "type": "String",
9526             "optional": false,
9527             "field": "key",
9528             "description": ""
9529           },
9530           {
9531             "group": "Body",
9532             "type": "Text",
9533             "optional": true,
9534             "field": "notificationTemplate",
9535             "description": ""
9536           },
9537           {
9538             "group": "Body",
9539             "type": "Boolean",
9540             "optional": true,
9541             "field": "notificationSound",
9542             "description": ""
9543           },
9544           {
9545             "group": "Body",
9546             "type": "Boolean",
9547             "optional": true,
9548             "field": "notificationShake",
9549             "description": ""
9550           },
9551           {
9552             "group": "Body",
9553             "type": "Integer",
9554             "optional": true,
9555             "field": "waitForTheAssignedAgent",
9556             "description": ""
9557           },
9558           {
9559             "group": "Body",
9560             "type": "Boolean",
9561             "optional": true,
9562             "field": "queueTransfer",
9563             "description": ""
9564           },
9565           {
9566             "group": "Body",
9567             "type": "Integer",
9568             "optional": true,
9569             "field": "queueTransferTimeout",
9570             "description": ""
9571           },
9572           {
9573             "group": "Body",
9574             "type": "Boolean",
9575             "optional": true,
9576             "field": "agentTransfer",
9577             "description": ""
9578           },
9579           {
9580             "group": "Body",
9581             "type": "Integer",
9582             "optional": true,
9583             "field": "agentTransferTimeout",
9584             "description": ""
9585           },
9586           {
9587             "group": "Body",
9588             "type": "Integer",
9589             "optional": true,
9590             "field": "mandatoryDispositionPauseId",
9591             "description": "<p>Status to put when mandatory disposition is enabled</p>"
9592           },
9593           {
9594             "group": "Body",
9595             "type": "Boolean",
9596             "optional": true,
9597             "field": "mandatoryDisposition",
9598             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
9599           }
9600         ]
9601       }
9602     },
9603     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9604     "version": "0.0.0",
9605     "filename": "server/api/faxAccount/index.js",
9606     "groupTitle": "Fax_Accounts"
9607   },
9608   {
9609     "type": "delete",
9610     "url": "/api/fax/accounts/{id}",
9611     "title": "Deletes a Account",
9612     "examples": [
9613       {
9614         "title": "Example usage:",
9615         "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password} -X DELETE",
9616         "type": "json"
9617       }
9618     ],
9619     "name": "DeleteAccounts",
9620     "group": "Fax_Accounts",
9621     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9622     "version": "0.0.0",
9623     "filename": "server/api/faxAccount/index.js",
9624     "groupTitle": "Fax_Accounts"
9625   },
9626   {
9627     "type": "get",
9628     "url": "/api/fax/accounts/describe",
9629     "title": "Gets table info about Accounts",
9630     "examples": [
9631       {
9632         "title": "Example usage:",
9633         "content": "curl https://{domain}/api/fax/accounts/describe -v -u {name}:{password}",
9634         "type": "json"
9635       }
9636     ],
9637     "name": "DescribeAccounts",
9638     "group": "Fax_Accounts",
9639     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9640     "version": "0.0.0",
9641     "filename": "server/api/faxAccount/index.js",
9642     "groupTitle": "Fax_Accounts"
9643   },
9644   {
9645     "type": "get",
9646     "url": "/api/fax/accounts",
9647     "title": "Gets a list of Accounts",
9648     "examples": [
9649       {
9650         "title": "Example usage:",
9651         "content": "curl https://{domain}/api/fax/accounts -v -u {name}:{password}",
9652         "type": "json"
9653       }
9654     ],
9655     "name": "GetAccounts",
9656     "group": "Fax_Accounts",
9657     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/fax/accounts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/fax/accounts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/fax/accounts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/fax/accounts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/fax/accounts?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
9658     "version": "0.0.0",
9659     "filename": "server/api/faxAccount/index.js",
9660     "groupTitle": "Fax_Accounts"
9661   },
9662   {
9663     "type": "get",
9664     "url": "/api/fax/accounts/{id}/users",
9665     "title": "Gets agents from fax account",
9666     "examples": [
9667       {
9668         "title": "Example usage:",
9669         "content": "curl https://{domain}/api/fax/accounts/{id}/users -v -u {name}:{password} -X GET",
9670         "type": "json"
9671       }
9672     ],
9673     "name": "GetAgents",
9674     "group": "Fax_Accounts",
9675     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9676     "version": "0.0.0",
9677     "filename": "server/api/faxAccount/index.js",
9678     "groupTitle": "Fax_Accounts"
9679   },
9680   {
9681     "type": "delete",
9682     "url": "/api/fax/accounts/{id}/users",
9683     "title": "Removes agents from a fax account",
9684     "examples": [
9685       {
9686         "title": "Example usage:",
9687         "content": "curl https://{domain}/api/fax/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9688         "type": "json"
9689       }
9690     ],
9691     "name": "RemoveAgents",
9692     "group": "Fax_Accounts",
9693     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9694     "version": "0.0.0",
9695     "filename": "server/api/faxAccount/index.js",
9696     "groupTitle": "Fax_Accounts"
9697   },
9698   {
9699     "type": "delete",
9700     "url": "/api/fax/accounts/{id}/canned_answers",
9701     "title": "Removes canned answers from account",
9702     "examples": [
9703       {
9704         "title": "Example usage:",
9705         "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9706         "type": "json"
9707       }
9708     ],
9709     "name": "RemoveAnswers",
9710     "group": "Fax_Accounts",
9711     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9712     "version": "0.0.0",
9713     "filename": "server/api/faxAccount/index.js",
9714     "groupTitle": "Fax_Accounts"
9715   },
9716   {
9717     "type": "delete",
9718     "url": "/api/fax/accounts/{id}/dispositions",
9719     "title": "Removes dispositions from account",
9720     "examples": [
9721       {
9722         "title": "Example usage:",
9723         "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9724         "type": "json"
9725       }
9726     ],
9727     "name": "RemoveDispositions",
9728     "group": "Fax_Accounts",
9729     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9730     "version": "0.0.0",
9731     "filename": "server/api/faxAccount/index.js",
9732     "groupTitle": "Fax_Accounts"
9733   },
9734   {
9735     "type": "get",
9736     "url": "/api/fax/accounts/{id}",
9737     "title": "Gets a single Account",
9738     "examples": [
9739       {
9740         "title": "Example usage:",
9741         "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password}",
9742         "type": "json"
9743       }
9744     ],
9745     "name": "ShowAccounts",
9746     "group": "Fax_Accounts",
9747     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9748     "version": "0.0.0",
9749     "filename": "server/api/faxAccount/index.js",
9750     "groupTitle": "Fax_Accounts"
9751   },
9752   {
9753     "type": "post",
9754     "url": "/api/fax/accounts/{id}/canned_answers",
9755     "title": "Creates new canned answer",
9756     "examples": [
9757       {
9758         "title": "Example usage:",
9759         "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers -d '{\"name\": \"vip\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9760         "type": "json"
9761       }
9762     ],
9763     "name": "addAnswer",
9764     "group": "Fax_Accounts",
9765     "parameter": {
9766       "fields": {
9767         "Body": [
9768           {
9769             "group": "Body",
9770             "type": "String",
9771             "optional": false,
9772             "field": "key",
9773             "description": ""
9774           },
9775           {
9776             "group": "Body",
9777             "type": "Text",
9778             "optional": false,
9779             "field": "value",
9780             "description": ""
9781           },
9782           {
9783             "group": "Body",
9784             "type": "String",
9785             "optional": true,
9786             "field": "description",
9787             "description": ""
9788           },
9789           {
9790             "group": "Body",
9791             "type": "Virtual",
9792             "optional": true,
9793             "field": "name",
9794             "description": ""
9795           }
9796         ]
9797       }
9798     },
9799     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9800     "version": "0.0.0",
9801     "filename": "server/api/faxAccount/index.js",
9802     "groupTitle": "Fax_Accounts"
9803   },
9804   {
9805     "type": "post",
9806     "url": "/api/fax/accounts/{id}/applications",
9807     "title": "Creates new applications",
9808     "examples": [
9809       {
9810         "title": "Example usage:",
9811         "content": "curl https://{domain}/api/fax/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9812         "type": "json"
9813       }
9814     ],
9815     "name": "addApplications",
9816     "group": "Fax_Accounts",
9817     "parameter": {
9818       "fields": {
9819         "Body": [
9820           {
9821             "group": "Body",
9822             "type": "Integer",
9823             "optional": false,
9824             "field": "priority",
9825             "description": ""
9826           },
9827           {
9828             "group": "Body",
9829             "type": "String",
9830             "optional": false,
9831             "field": "app",
9832             "description": ""
9833           },
9834           {
9835             "group": "Body",
9836             "type": "Text",
9837             "optional": true,
9838             "field": "appdata",
9839             "description": ""
9840           },
9841           {
9842             "group": "Body",
9843             "type": "String",
9844             "optional": true,
9845             "field": "description",
9846             "description": ""
9847           },
9848           {
9849             "group": "Body",
9850             "type": "String",
9851             "optional": true,
9852             "field": "interval",
9853             "description": ""
9854           }
9855         ]
9856       }
9857     },
9858     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9859     "version": "0.0.0",
9860     "filename": "server/api/faxAccount/index.js",
9861     "groupTitle": "Fax_Accounts"
9862   },
9863   {
9864     "type": "post",
9865     "url": "/api/fax/accounts/addaccountapplications",
9866     "title": "Creates new account and applications",
9867     "examples": [
9868       {
9869         "title": "Example usage:",
9870         "content": "curl https://{domain}/api/fax/accounts/addaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9871         "type": "json"
9872       }
9873     ],
9874     "name": "addApplications",
9875     "group": "Fax_Accounts",
9876     "parameter": {
9877       "fields": {
9878         "Body": [
9879           {
9880             "group": "Body",
9881             "type": "Integer",
9882             "optional": false,
9883             "field": "priority",
9884             "description": ""
9885           },
9886           {
9887             "group": "Body",
9888             "type": "String",
9889             "optional": false,
9890             "field": "app",
9891             "description": ""
9892           },
9893           {
9894             "group": "Body",
9895             "type": "Text",
9896             "optional": true,
9897             "field": "appdata",
9898             "description": ""
9899           },
9900           {
9901             "group": "Body",
9902             "type": "String",
9903             "optional": true,
9904             "field": "description",
9905             "description": ""
9906           },
9907           {
9908             "group": "Body",
9909             "type": "String",
9910             "optional": true,
9911             "field": "interval",
9912             "description": ""
9913           }
9914         ]
9915       }
9916     },
9917     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9918     "version": "0.0.0",
9919     "filename": "server/api/faxAccount/index.js",
9920     "groupTitle": "Fax_Accounts"
9921   },
9922   {
9923     "type": "post",
9924     "url": "/api/fax/accounts/{id}/dispositions",
9925     "title": "Creates new disposition",
9926     "examples": [
9927       {
9928         "title": "Example usage:",
9929         "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9930         "type": "json"
9931       }
9932     ],
9933     "name": "addDisposition",
9934     "group": "Fax_Accounts",
9935     "parameter": {
9936       "fields": {
9937         "Body": [
9938           {
9939             "group": "Body",
9940             "type": "String",
9941             "optional": false,
9942             "field": "name",
9943             "description": ""
9944           },
9945           {
9946             "group": "Body",
9947             "type": "String",
9948             "allowedValues": [
9949               "\"first\"",
9950               "\"second\"",
9951               "\"third\""
9952             ],
9953             "optional": false,
9954             "field": "level",
9955             "description": ""
9956           },
9957           {
9958             "group": "Body",
9959             "type": "String",
9960             "optional": true,
9961             "field": "description",
9962             "description": ""
9963           }
9964         ]
9965       }
9966     },
9967     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9968     "version": "0.0.0",
9969     "filename": "server/api/faxAccount/index.js",
9970     "groupTitle": "Fax_Accounts"
9971   },
9972   {
9973     "type": "post",
9974     "url": "/api/fax/accounts/{id}/interactions",
9975     "title": "Creates new interactions",
9976     "examples": [
9977       {
9978         "title": "Example usage:",
9979         "content": "curl https://{domain}/api/fax/accounts/{id}/interactions -d '[{\"host\": \"host\", \"username\": \"username\", \"password\": \"password\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9980         "type": "json"
9981       }
9982     ],
9983     "name": "addInteraction",
9984     "group": "Fax_Accounts",
9985     "parameter": {
9986       "fields": {
9987         "Body": [
9988           {
9989             "group": "Body",
9990             "type": "Boolean",
9991             "optional": true,
9992             "field": "closed",
9993             "description": ""
9994           },
9995           {
9996             "group": "Body",
9997             "type": "String",
9998             "optional": true,
9999             "field": "closedAt",
10000             "description": ""
10001           },
10002           {
10003             "group": "Body",
10004             "type": "String",
10005             "optional": true,
10006             "field": "disposition",
10007             "description": ""
10008           },
10009           {
10010             "group": "Body",
10011             "type": "String",
10012             "optional": true,
10013             "field": "secondDisposition",
10014             "description": ""
10015           },
10016           {
10017             "group": "Body",
10018             "type": "String",
10019             "optional": true,
10020             "field": "thirdDisposition",
10021             "description": ""
10022           },
10023           {
10024             "group": "Body",
10025             "type": "String",
10026             "optional": true,
10027             "field": "note",
10028             "description": ""
10029           },
10030           {
10031             "group": "Body",
10032             "type": "String",
10033             "optional": true,
10034             "field": "read1stAt",
10035             "description": ""
10036           },
10037           {
10038             "group": "Body",
10039             "type": "String",
10040             "optional": true,
10041             "field": "fax",
10042             "description": ""
10043           },
10044           {
10045             "group": "Body",
10046             "type": "String",
10047             "allowedValues": [
10048               "\"in\"",
10049               "\"out\""
10050             ],
10051             "optional": false,
10052             "field": "firstMsgDirection",
10053             "description": ""
10054           },
10055           {
10056             "group": "Body",
10057             "type": "String",
10058             "optional": true,
10059             "field": "lastMsgAt",
10060             "description": ""
10061           },
10062           {
10063             "group": "Body",
10064             "type": "String",
10065             "allowedValues": [
10066               "\"in\"",
10067               "\"out\""
10068             ],
10069             "optional": false,
10070             "field": "lastMsgDirection",
10071             "description": ""
10072           }
10073         ]
10074       }
10075     },
10076     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10077     "version": "0.0.0",
10078     "filename": "server/api/faxAccount/index.js",
10079     "groupTitle": "Fax_Accounts"
10080   },
10081   {
10082     "type": "get",
10083     "url": "/api/fax/accounts/{id}/canned_answers",
10084     "title": "Gets account canned answers",
10085     "examples": [
10086       {
10087         "title": "Example usage:",
10088         "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
10089         "type": "json"
10090       }
10091     ],
10092     "name": "getAnswers",
10093     "group": "Fax_Accounts",
10094     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10095     "version": "0.0.0",
10096     "filename": "server/api/faxAccount/index.js",
10097     "groupTitle": "Fax_Accounts"
10098   },
10099   {
10100     "type": "get",
10101     "url": "/api/fax/accounts/{id}/applications",
10102     "title": "Gets account pplications",
10103     "examples": [
10104       {
10105         "title": "Example usage:",
10106         "content": "curl https://{domain}/api/fax/accounts/{id}/applications -v -u {name}:{password} -X GET",
10107         "type": "json"
10108       }
10109     ],
10110     "name": "getApplications",
10111     "group": "Fax_Accounts",
10112     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10113     "version": "0.0.0",
10114     "filename": "server/api/faxAccount/index.js",
10115     "groupTitle": "Fax_Accounts"
10116   },
10117   {
10118     "type": "get",
10119     "url": "/api/fax/accounts/{id}/dispositions",
10120     "title": "Gets account dispositions",
10121     "examples": [
10122       {
10123         "title": "Example usage:",
10124         "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
10125         "type": "json"
10126       }
10127     ],
10128     "name": "getDispositions",
10129     "group": "Fax_Accounts",
10130     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10131     "version": "0.0.0",
10132     "filename": "server/api/faxAccount/index.js",
10133     "groupTitle": "Fax_Accounts"
10134   },
10135   {
10136     "type": "get",
10137     "url": "/api/fax/accounts/{id}/interactions",
10138     "title": "Gets account interactions",
10139     "examples": [
10140       {
10141         "title": "Example usage:",
10142         "content": "curl https://{domain}/api/fax/accounts/{id}/interactions -v -u {name}:{password} -X GET",
10143         "type": "json"
10144       }
10145     ],
10146     "name": "getInteraction",
10147     "group": "Fax_Accounts",
10148     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10149     "version": "0.0.0",
10150     "filename": "server/api/faxAccount/index.js",
10151     "groupTitle": "Fax_Accounts"
10152   },
10153   {
10154     "type": "get",
10155     "url": "/api/fax/accounts/{id}/messages",
10156     "title": "Gets account messages",
10157     "examples": [
10158       {
10159         "title": "Example usage:",
10160         "content": "curl https://{domain}/api/fax/accounts/{id}/messages -v -u {name}:{password} -X GET",
10161         "type": "json"
10162       }
10163     ],
10164     "name": "getMessages",
10165     "group": "Fax_Accounts",
10166     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10167     "version": "0.0.0",
10168     "filename": "server/api/faxAccount/index.js",
10169     "groupTitle": "Fax_Accounts"
10170   },
10171   {
10172     "type": "post",
10173     "url": "/api/fax/accounts/{id}/send",
10174     "title": "Send new fax",
10175     "examples": [
10176       {
10177         "title": "Example usage:",
10178         "content": "curl https://{domain}/api/fax/accounts/{id}/send -d '{from: '\"John Doe\" <123456>'}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10179         "type": "json"
10180       }
10181     ],
10182     "name": "sendFax",
10183     "group": "Fax_Accounts",
10184     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10185     "version": "0.0.0",
10186     "filename": "server/api/faxAccount/index.js",
10187     "groupTitle": "Fax_Accounts"
10188   },
10189   {
10190     "type": "put",
10191     "url": "/api/fax/accounts/{id}",
10192     "title": "Update an existing Account",
10193     "examples": [
10194       {
10195         "title": "Example usage:",
10196         "content": "curl https://{domain}/api/fax/accounts/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
10197         "type": "json"
10198       }
10199     ],
10200     "name": "updateAccounts",
10201     "group": "Fax_Accounts",
10202     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10203     "version": "0.0.0",
10204     "filename": "server/api/faxAccount/index.js",
10205     "groupTitle": "Fax_Accounts"
10206   },
10207   {
10208     "type": "post",
10209     "url": "/api/fax/accounts/updateaccountapplications",
10210     "title": "Update account and applications",
10211     "examples": [
10212       {
10213         "title": "Example usage:",
10214         "content": "curl https://{domain}/api/fax/accounts/updateaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10215         "type": "json"
10216       }
10217     ],
10218     "name": "updateApplications",
10219     "group": "Fax_Accounts",
10220     "parameter": {
10221       "fields": {
10222         "Body": [
10223           {
10224             "group": "Body",
10225             "type": "Integer",
10226             "optional": false,
10227             "field": "priority",
10228             "description": ""
10229           },
10230           {
10231             "group": "Body",
10232             "type": "String",
10233             "optional": false,
10234             "field": "app",
10235             "description": ""
10236           },
10237           {
10238             "group": "Body",
10239             "type": "Text",
10240             "optional": true,
10241             "field": "appdata",
10242             "description": ""
10243           },
10244           {
10245             "group": "Body",
10246             "type": "String",
10247             "optional": true,
10248             "field": "description",
10249             "description": ""
10250           },
10251           {
10252             "group": "Body",
10253             "type": "String",
10254             "optional": true,
10255             "field": "interval",
10256             "description": ""
10257           }
10258         ]
10259       }
10260     },
10261     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10262     "version": "0.0.0",
10263     "filename": "server/api/faxAccount/index.js",
10264     "groupTitle": "Fax_Accounts"
10265   },
10266   {
10267     "type": "post",
10268     "url": "/api/fax/applications",
10269     "title": "Creates a new Application",
10270     "examples": [
10271       {
10272         "title": "Example usage:",
10273         "content": "curl https://{domain}/api/fax/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
10274         "type": "json"
10275       }
10276     ],
10277     "name": "CreateApplications",
10278     "group": "Fax_Applications",
10279     "parameter": {
10280       "fields": {
10281         "Body": [
10282           {
10283             "group": "Body",
10284             "type": "Integer",
10285             "optional": false,
10286             "field": "priority",
10287             "description": ""
10288           },
10289           {
10290             "group": "Body",
10291             "type": "String",
10292             "optional": false,
10293             "field": "app",
10294             "description": ""
10295           },
10296           {
10297             "group": "Body",
10298             "type": "Text",
10299             "optional": true,
10300             "field": "appdata",
10301             "description": ""
10302           },
10303           {
10304             "group": "Body",
10305             "type": "String",
10306             "optional": true,
10307             "field": "description",
10308             "description": ""
10309           },
10310           {
10311             "group": "Body",
10312             "type": "String",
10313             "optional": true,
10314             "field": "interval",
10315             "description": ""
10316           }
10317         ]
10318       }
10319     },
10320     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10321     "version": "0.0.0",
10322     "filename": "server/api/faxApplication/index.js",
10323     "groupTitle": "Fax_Applications"
10324   },
10325   {
10326     "type": "delete",
10327     "url": "/api/fax/applications/{id}",
10328     "title": "Deletes a Application",
10329     "examples": [
10330       {
10331         "title": "Example usage:",
10332         "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password} -X DELETE",
10333         "type": "json"
10334       }
10335     ],
10336     "name": "DeleteApplications",
10337     "group": "Fax_Applications",
10338     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10339     "version": "0.0.0",
10340     "filename": "server/api/faxApplication/index.js",
10341     "groupTitle": "Fax_Applications"
10342   },
10343   {
10344     "type": "get",
10345     "url": "/api/fax/applications",
10346     "title": "Gets a list of Applications",
10347     "examples": [
10348       {
10349         "title": "Example usage:",
10350         "content": "curl https://{domain}/api/fax/applications -v -u {name}:{password}",
10351         "type": "json"
10352       }
10353     ],
10354     "name": "GetApplications",
10355     "group": "Fax_Applications",
10356     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/fax/applications?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/fax/applications?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/fax/applications?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/fax/applications?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/fax/applications?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
10357     "version": "0.0.0",
10358     "filename": "server/api/faxApplication/index.js",
10359     "groupTitle": "Fax_Applications"
10360   },
10361   {
10362     "type": "get",
10363     "url": "/api/fax/applications/{id}",
10364     "title": "Gets a single Application",
10365     "examples": [
10366       {
10367         "title": "Example usage:",
10368         "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password}",
10369         "type": "json"
10370       }
10371     ],
10372     "name": "ShowApplications",
10373     "group": "Fax_Applications",
10374     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10375     "version": "0.0.0",
10376     "filename": "server/api/faxApplication/index.js",
10377     "groupTitle": "Fax_Applications"
10378   },
10379   {
10380     "type": "put",
10381     "url": "/api/fax/applications/{id}",
10382     "title": "Update an existing Application",
10383     "examples": [
10384       {
10385         "title": "Example usage:",
10386         "content": "curl https://{domain}/api/fax/applications/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
10387         "type": "json"
10388       }
10389     ],
10390     "name": "updateApplications",
10391     "group": "Fax_Applications",
10392     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10393     "version": "0.0.0",
10394     "filename": "server/api/faxApplication/index.js",
10395     "groupTitle": "Fax_Applications"
10396   },
10397   {
10398     "type": "post",
10399     "url": "/api/fax/interactions/{id}/tags",
10400     "title": "Add tags to the interaction",
10401     "examples": [
10402       {
10403         "title": "Example usage:",
10404         "content": "curl https://{domain}/api/fax/interaction/{id}/tags -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10405         "type": "json"
10406       }
10407     ],
10408     "name": "AddTags",
10409     "group": "Fax_Interactions",
10410     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10411     "version": "0.0.0",
10412     "filename": "server/api/faxInteraction/index.js",
10413     "groupTitle": "Fax_Interactions"
10414   },
10415   {
10416     "type": "post",
10417     "url": "/api/fax/interactions",
10418     "title": "Creates a new Interaction",
10419     "examples": [
10420       {
10421         "title": "Example usage:",
10422         "content": "curl https://{domain}/api/fax/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
10423         "type": "json"
10424       }
10425     ],
10426     "name": "CreateInteractions",
10427     "group": "Fax_Interactions",
10428     "parameter": {
10429       "fields": {
10430         "Body": [
10431           {
10432             "group": "Body",
10433             "type": "Boolean",
10434             "optional": true,
10435             "field": "closed",
10436             "description": ""
10437           },
10438           {
10439             "group": "Body",
10440             "type": "String",
10441             "optional": true,
10442             "field": "closedAt",
10443             "description": ""
10444           },
10445           {
10446             "group": "Body",
10447             "type": "String",
10448             "optional": true,
10449             "field": "disposition",
10450             "description": ""
10451           },
10452           {
10453             "group": "Body",
10454             "type": "String",
10455             "optional": true,
10456             "field": "secondDisposition",
10457             "description": ""
10458           },
10459           {
10460             "group": "Body",
10461             "type": "String",
10462             "optional": true,
10463             "field": "thirdDisposition",
10464             "description": ""
10465           },
10466           {
10467             "group": "Body",
10468             "type": "String",
10469             "optional": true,
10470             "field": "note",
10471             "description": ""
10472           },
10473           {
10474             "group": "Body",
10475             "type": "String",
10476             "optional": true,
10477             "field": "read1stAt",
10478             "description": ""
10479           },
10480           {
10481             "group": "Body",
10482             "type": "String",
10483             "optional": true,
10484             "field": "fax",
10485             "description": ""
10486           },
10487           {
10488             "group": "Body",
10489             "type": "String",
10490             "allowedValues": [
10491               "\"in\"",
10492               "\"out\""
10493             ],
10494             "optional": false,
10495             "field": "firstMsgDirection",
10496             "description": ""
10497           },
10498           {
10499             "group": "Body",
10500             "type": "String",
10501             "optional": true,
10502             "field": "lastMsgAt",
10503             "description": ""
10504           },
10505           {
10506             "group": "Body",
10507             "type": "String",
10508             "allowedValues": [
10509               "\"in\"",
10510               "\"out\""
10511             ],
10512             "optional": false,
10513             "field": "lastMsgDirection",
10514             "description": ""
10515           }
10516         ]
10517       }
10518     },
10519     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10520     "version": "0.0.0",
10521     "filename": "server/api/faxInteraction/index.js",
10522     "groupTitle": "Fax_Interactions"
10523   },
10524   {
10525     "type": "delete",
10526     "url": "/api/fax/interactions/{id}",
10527     "title": "Deletes a Interaction",
10528     "examples": [
10529       {
10530         "title": "Example usage:",
10531         "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password} -X DELETE",
10532         "type": "json"
10533       }
10534     ],
10535     "name": "DeleteInteractions",
10536     "group": "Fax_Interactions",
10537     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10538     "version": "0.0.0",
10539     "filename": "server/api/faxInteraction/index.js",
10540     "groupTitle": "Fax_Interactions"
10541   },
10542   {
10543     "type": "get",
10544     "url": "/api/fax/interactions/describe",
10545     "title": "Gets table info about Interactions",
10546     "examples": [
10547       {
10548         "title": "Example usage:",
10549         "content": "curl https://{domain}/api/fax/interactions/describe -v -u {name}:{password}",
10550         "type": "json"
10551       }
10552     ],
10553     "name": "DescribeInteractions",
10554     "group": "Fax_Interactions",
10555     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10556     "version": "0.0.0",
10557     "filename": "server/api/faxInteraction/index.js",
10558     "groupTitle": "Fax_Interactions"
10559   },
10560   {
10561     "type": "get",
10562     "url": "/api/fax/interactions",
10563     "title": "Gets a list of Interactions",
10564     "examples": [
10565       {
10566         "title": "Example usage:",
10567         "content": "curl https://{domain}/api/fax/interactions -v -u {name}:{password}",
10568         "type": "json"
10569       }
10570     ],
10571     "name": "GetInteractions",
10572     "group": "Fax_Interactions",
10573     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/fax/interactions?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/fax/interactions?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/fax/interactions?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/fax/interactions?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/fax/interactions?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
10574     "version": "0.0.0",
10575     "filename": "server/api/faxInteraction/index.js",
10576     "groupTitle": "Fax_Interactions"
10577   },
10578   {
10579     "type": "delete",
10580     "url": "/api/fax/interactions/{id}/tags",
10581     "title": "Removes tags from interaction",
10582     "examples": [
10583       {
10584         "title": "Example usage:",
10585         "content": "curl https://{domain}/api/fax/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
10586         "type": "json"
10587       }
10588     ],
10589     "name": "RemoveTags",
10590     "group": "Fax_Interactions",
10591     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10592     "version": "0.0.0",
10593     "filename": "server/api/faxInteraction/index.js",
10594     "groupTitle": "Fax_Interactions"
10595   },
10596   {
10597     "type": "get",
10598     "url": "/api/fax/interactions/{id}",
10599     "title": "Gets a single Interaction",
10600     "examples": [
10601       {
10602         "title": "Example usage:",
10603         "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password}",
10604         "type": "json"
10605       }
10606     ],
10607     "name": "ShowInteractions",
10608     "group": "Fax_Interactions",
10609     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10610     "version": "0.0.0",
10611     "filename": "server/api/faxInteraction/index.js",
10612     "groupTitle": "Fax_Interactions"
10613   },
10614   {
10615     "type": "post",
10616     "url": "/api/fax/interactions/{id}/messages",
10617     "title": "Creates new messages",
10618     "examples": [
10619       {
10620         "title": "Example usage:",
10621         "content": "curl https://{domain}/api/fax/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10622         "type": "json"
10623       }
10624     ],
10625     "name": "addMessage",
10626     "group": "Fax_Interactions",
10627     "parameter": {
10628       "fields": {
10629         "Body": [
10630           {
10631             "group": "Body",
10632             "type": "Text",
10633             "optional": false,
10634             "field": "body",
10635             "description": ""
10636           },
10637           {
10638             "group": "Body",
10639             "type": "Boolean",
10640             "optional": true,
10641             "field": "read",
10642             "description": ""
10643           },
10644           {
10645             "group": "Body",
10646             "type": "String",
10647             "allowedValues": [
10648               "\"in\"",
10649               "\"out\""
10650             ],
10651             "optional": false,
10652             "field": "direction",
10653             "description": ""
10654           },
10655           {
10656             "group": "Body",
10657             "type": "Text",
10658             "optional": true,
10659             "field": "failMessage",
10660             "description": ""
10661           },
10662           {
10663             "group": "Body",
10664             "type": "String",
10665             "optional": true,
10666             "field": "readAt",
10667             "description": ""
10668           }
10669         ]
10670       }
10671     },
10672     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10673     "version": "0.0.0",
10674     "filename": "server/api/faxInteraction/index.js",
10675     "groupTitle": "Fax_Interactions"
10676   },
10677   {
10678     "type": "get",
10679     "url": "/api/fax/interactions/{id}/download",
10680     "title": "Get interactions",
10681     "examples": [
10682       {
10683         "title": "Example usage:",
10684         "content": "curl https://{domain}/api/fax/interactions/{id}/download -v -u {name}:{password} -X GET",
10685         "type": "json"
10686       }
10687     ],
10688     "name": "download",
10689     "group": "Fax_Interactions",
10690     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10691     "version": "0.0.0",
10692     "filename": "server/api/faxInteraction/index.js",
10693     "groupTitle": "Fax_Interactions"
10694   },
10695   {
10696     "type": "get",
10697     "url": "/api/fax/interactions/{id}/messages",
10698     "title": "Gets interaction messages",
10699     "examples": [
10700       {
10701         "title": "Example usage:",
10702         "content": "curl https://{domain}/api/fax/interactions/{id}/messages -v -u {name}:{password} -X GET",
10703         "type": "json"
10704       }
10705     ],
10706     "name": "getMessages",
10707     "group": "Fax_Interactions",
10708     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10709     "version": "0.0.0",
10710     "filename": "server/api/faxInteraction/index.js",
10711     "groupTitle": "Fax_Interactions"
10712   },
10713   {
10714     "type": "put",
10715     "url": "/api/fax/interactions/{id}",
10716     "title": "Update an existing Interaction",
10717     "examples": [
10718       {
10719         "title": "Example usage:",
10720         "content": "curl https://{domain}/api/fax/interactions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
10721         "type": "json"
10722       }
10723     ],
10724     "name": "updateInteractions",
10725     "group": "Fax_Interactions",
10726     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10727     "version": "0.0.0",
10728     "filename": "server/api/faxInteraction/index.js",
10729     "groupTitle": "Fax_Interactions"
10730   },
10731   {
10732     "type": "get",
10733     "url": "/api/fax/messages/{id}/download",
10734     "title": "Get message",
10735     "examples": [
10736       {
10737         "title": "Example usage:",
10738         "content": "curl https://{domain}/api/fax/messages/{id}/download -v -u {name}:{password} -X GET",
10739         "type": "json"
10740       }
10741     ],
10742     "name": "download",
10743     "group": "Fax_Message",
10744     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10745     "version": "0.0.0",
10746     "filename": "server/api/faxMessage/index.js",
10747     "groupTitle": "Fax_Message"
10748   },
10749   {
10750     "type": "delete",
10751     "url": "/api/fax/messages/{id}",
10752     "title": "Deletes a Message",
10753     "examples": [
10754       {
10755         "title": "Example usage:",
10756         "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password} -X DELETE",
10757         "type": "json"
10758       }
10759     ],
10760     "name": "DeleteMessages",
10761     "group": "Fax_Messages",
10762     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10763     "version": "0.0.0",
10764     "filename": "server/api/faxMessage/index.js",
10765     "groupTitle": "Fax_Messages"
10766   },
10767   {
10768     "type": "get",
10769     "url": "/api/fax/messages/describe",
10770     "title": "Gets table info about Messages",
10771     "examples": [
10772       {
10773         "title": "Example usage:",
10774         "content": "curl https://{domain}/api/fax/messages/describe -v -u {name}:{password}",
10775         "type": "json"
10776       }
10777     ],
10778     "name": "DescribeMessages",
10779     "group": "Fax_Messages",
10780     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10781     "version": "0.0.0",
10782     "filename": "server/api/faxMessage/index.js",
10783     "groupTitle": "Fax_Messages"
10784   },
10785   {
10786     "type": "get",
10787     "url": "/api/fax/messages",
10788     "title": "Gets a list of Messages",
10789     "examples": [
10790       {
10791         "title": "Example usage:",
10792         "content": "curl https://{domain}/api/fax/messages -v -u {name}:{password}",
10793         "type": "json"
10794       }
10795     ],
10796     "name": "GetMessages",
10797     "group": "Fax_Messages",
10798     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/fax/messages?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/fax/messages?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/fax/messages?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/fax/messages?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/fax/messages?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
10799     "version": "0.0.0",
10800     "filename": "server/api/faxMessage/index.js",
10801     "groupTitle": "Fax_Messages"
10802   },
10803   {
10804     "type": "get",
10805     "url": "/api/fax/messages/{id}",
10806     "title": "Gets a single Message",
10807     "examples": [
10808       {
10809         "title": "Example usage:",
10810         "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password}",
10811         "type": "json"
10812       }
10813     ],
10814     "name": "ShowMessages",
10815     "group": "Fax_Messages",
10816     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10817     "version": "0.0.0",
10818     "filename": "server/api/faxMessage/index.js",
10819     "groupTitle": "Fax_Messages"
10820   },
10821   {
10822     "type": "put",
10823     "url": "/api/fax/messages/{id}/accept",
10824     "title": "Accepts message",
10825     "examples": [
10826       {
10827         "title": "Example usage:",
10828         "content": "curl https://{domain}/api/fax/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
10829         "type": "json"
10830       }
10831     ],
10832     "name": "acceptMessage",
10833     "group": "Fax_Messages",
10834     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10835     "version": "0.0.0",
10836     "filename": "server/api/faxMessage/index.js",
10837     "groupTitle": "Fax_Messages"
10838   },
10839   {
10840     "type": "post",
10841     "url": "/api/fax/messages",
10842     "title": "Create message and send Fax",
10843     "examples": [
10844       {
10845         "title": "Example usage:",
10846         "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
10847         "type": "json"
10848       }
10849     ],
10850     "name": "rejectMessage",
10851     "group": "Fax_Messages",
10852     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10853     "version": "0.0.0",
10854     "filename": "server/api/faxMessage/index.js",
10855     "groupTitle": "Fax_Messages"
10856   },
10857   {
10858     "type": "put",
10859     "url": "/api/fax/messages/{id}/reject",
10860     "title": "Rejects message",
10861     "examples": [
10862       {
10863         "title": "Example usage:",
10864         "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
10865         "type": "json"
10866       }
10867     ],
10868     "name": "rejectMessage",
10869     "group": "Fax_Messages",
10870     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10871     "version": "0.0.0",
10872     "filename": "server/api/faxMessage/index.js",
10873     "groupTitle": "Fax_Messages"
10874   },
10875   {
10876     "type": "put",
10877     "url": "/api/fax/messages/{id}",
10878     "title": "Update an existing Message",
10879     "examples": [
10880       {
10881         "title": "Example usage:",
10882         "content": "curl https://{domain}/api/fax/messages/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
10883         "type": "json"
10884       }
10885     ],
10886     "name": "updateMessages",
10887     "group": "Fax_Messages",
10888     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10889     "version": "0.0.0",
10890     "filename": "server/api/faxMessage/index.js",
10891     "groupTitle": "Fax_Messages"
10892   },
10893   {
10894     "type": "post",
10895     "url": "/api/fax/reports/queue",
10896     "title": "Creates a new Fax Queue Report",
10897     "examples": [
10898       {
10899         "title": "Example usage:",
10900         "content": "curl https://{domain}/api/fax/reports/queue -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
10901         "type": "json"
10902       }
10903     ],
10904     "name": "CreateFax_Queue_Reports",
10905     "group": "Fax_Queue_Reports",
10906     "parameter": {
10907       "fields": {
10908         "Body": [
10909           {
10910             "group": "Body",
10911             "type": "String",
10912             "optional": false,
10913             "field": "uniqueid",
10914             "description": ""
10915           },
10916           {
10917             "group": "Body",
10918             "type": "String",
10919             "optional": true,
10920             "field": "from",
10921             "description": ""
10922           },
10923           {
10924             "group": "Body",
10925             "type": "String",
10926             "optional": true,
10927             "field": "joinAt",
10928             "description": ""
10929           },
10930           {
10931             "group": "Body",
10932             "type": "String",
10933             "optional": true,
10934             "field": "leaveAt",
10935             "description": ""
10936           },
10937           {
10938             "group": "Body",
10939             "type": "String",
10940             "optional": true,
10941             "field": "acceptAt",
10942             "description": ""
10943           },
10944           {
10945             "group": "Body",
10946             "type": "String",
10947             "optional": true,
10948             "field": "exitAt",
10949             "description": ""
10950           },
10951           {
10952             "group": "Body",
10953             "type": "String",
10954             "optional": true,
10955             "field": "reason",
10956             "description": ""
10957           }
10958         ]
10959       }
10960     },
10961     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10962     "version": "0.0.0",
10963     "filename": "server/api/faxQueueReport/index.js",
10964     "groupTitle": "Fax_Queue_Reports"
10965   },
10966   {
10967     "type": "delete",
10968     "url": "/api/fax/reports/queue/{id}",
10969     "title": "Deletes a Fax Queue Report",
10970     "examples": [
10971       {
10972         "title": "Example usage:",
10973         "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password} -X DELETE",
10974         "type": "json"
10975       }
10976     ],
10977     "name": "DeleteFax_Queue_Reports",
10978     "group": "Fax_Queue_Reports",
10979     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10980     "version": "0.0.0",
10981     "filename": "server/api/faxQueueReport/index.js",
10982     "groupTitle": "Fax_Queue_Reports"
10983   },
10984   {
10985     "type": "get",
10986     "url": "/api/fax/reports/queue/describe",
10987     "title": "Gets table info about Fax Queue Reports",
10988     "examples": [
10989       {
10990         "title": "Example usage:",
10991         "content": "curl https://{domain}/api/fax/reports/queue/describe -v -u {name}:{password}",
10992         "type": "json"
10993       }
10994     ],
10995     "name": "DescribeFax_Queue_Reports",
10996     "group": "Fax_Queue_Reports",
10997     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10998     "version": "0.0.0",
10999     "filename": "server/api/faxQueueReport/index.js",
11000     "groupTitle": "Fax_Queue_Reports"
11001   },
11002   {
11003     "type": "get",
11004     "url": "/api/fax/reports/queue",
11005     "title": "Gets a list of Fax Queue Reports",
11006     "examples": [
11007       {
11008         "title": "Example usage:",
11009         "content": "curl https://{domain}/api/fax/reports/queue -v -u {name}:{password}",
11010         "type": "json"
11011       }
11012     ],
11013     "name": "GetFax_Queue_Reports",
11014     "group": "Fax_Queue_Reports",
11015     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/fax/reports/queue?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/fax/reports/queue?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/fax/reports/queue?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/fax/reports/queue?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/fax/reports/queue?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
11016     "version": "0.0.0",
11017     "filename": "server/api/faxQueueReport/index.js",
11018     "groupTitle": "Fax_Queue_Reports"
11019   },
11020   {
11021     "type": "get",
11022     "url": "/api/fax/reports/queue/{id}",
11023     "title": "Gets a single Fax Queue Report",
11024     "examples": [
11025       {
11026         "title": "Example usage:",
11027         "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password}",
11028         "type": "json"
11029       }
11030     ],
11031     "name": "ShowFax_Queue_Reports",
11032     "group": "Fax_Queue_Reports",
11033     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11034     "version": "0.0.0",
11035     "filename": "server/api/faxQueueReport/index.js",
11036     "groupTitle": "Fax_Queue_Reports"
11037   },
11038   {
11039     "type": "put",
11040     "url": "/api/fax/reports/queue/{id}",
11041     "title": "Update an existing Fax Queue Report",
11042     "examples": [
11043       {
11044         "title": "Example usage:",
11045         "content": "curl https://{domain}/api/fax/reports/queue/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
11046         "type": "json"
11047       }
11048     ],
11049     "name": "updateFax_Queue_Reports",
11050     "group": "Fax_Queue_Reports",
11051     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11052     "version": "0.0.0",
11053     "filename": "server/api/faxQueueReport/index.js",
11054     "groupTitle": "Fax_Queue_Reports"
11055   },
11056   {
11057     "type": "post",
11058     "url": "/api/fax/queues/{id}/users",
11059     "title": "Add agents to a queue",
11060     "examples": [
11061       {
11062         "title": "Example usage:",
11063         "content": "curl https://{domain}/api/fax/queues/{id}/users -d '{\"ids\": [1,2], \"penalty\": 2}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
11064         "type": "json"
11065       }
11066     ],
11067     "name": "AddAgents",
11068     "group": "Fax_Queues",
11069     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11070     "version": "0.0.0",
11071     "filename": "server/api/faxQueue/index.js",
11072     "groupTitle": "Fax_Queues"
11073   },
11074   {
11075     "type": "post",
11076     "url": "/api/fax/queues/{id}/teams",
11077     "title": "Add teams to a queue",
11078     "examples": [
11079       {
11080         "title": "Example usage:",
11081         "content": "curl https://{domain}/api/fax/queues/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
11082         "type": "json"
11083       }
11084     ],
11085     "name": "AddTeams",
11086     "group": "Fax_Queues",
11087     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11088     "version": "0.0.0",
11089     "filename": "server/api/faxQueue/index.js",
11090     "groupTitle": "Fax_Queues"
11091   },
11092   {
11093     "type": "post",
11094     "url": "/api/fax/queues",
11095     "title": "Creates a new Queue",
11096     "examples": [
11097       {
11098         "title": "Example usage:",
11099         "content": "curl https://{domain}/api/fax/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
11100         "type": "json"
11101       }
11102     ],
11103     "name": "CreateQueues",
11104     "group": "Fax_Queues",
11105     "parameter": {
11106       "fields": {
11107         "Body": [
11108           {
11109             "group": "Body",
11110             "type": "String",
11111             "optional": false,
11112             "field": "name",
11113             "description": ""
11114           },
11115           {
11116             "group": "Body",
11117             "type": "String",
11118             "optional": true,
11119             "field": "description",
11120             "description": ""
11121           },
11122           {
11123             "group": "Body",
11124             "type": "Integer",
11125             "optional": false,
11126             "field": "timeout",
11127             "description": ""
11128           },
11129           {
11130             "group": "Body",
11131             "type": "String",
11132             "allowedValues": [
11133               "\"rrmemory\"",
11134               "\"beepall\"",
11135               "\"roundrobin\""
11136             ],
11137             "optional": false,
11138             "field": "strategy",
11139             "description": ""
11140           },
11141           {
11142             "group": "Body",
11143             "type": "Integer",
11144             "optional": true,
11145             "field": "lastAgent",
11146             "description": ""
11147           }
11148         ]
11149       }
11150     },
11151     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11152     "version": "0.0.0",
11153     "filename": "server/api/faxQueue/index.js",
11154     "groupTitle": "Fax_Queues"
11155   },
11156   {
11157     "type": "delete",
11158     "url": "/api/fax/queues/{id}",
11159     "title": "Deletes a Queue",
11160     "examples": [
11161       {
11162         "title": "Example usage:",
11163         "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password} -X DELETE",
11164         "type": "json"
11165       }
11166     ],
11167     "name": "DeleteQueues",
11168     "group": "Fax_Queues",
11169     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11170     "version": "0.0.0",
11171     "filename": "server/api/faxQueue/index.js",
11172     "groupTitle": "Fax_Queues"
11173   },
11174   {
11175     "type": "get",
11176     "url": "/api/fax/queues/describe",
11177     "title": "Gets table info about Queues",
11178     "examples": [
11179       {
11180         "title": "Example usage:",
11181         "content": "curl https://{domain}/api/fax/queues/describe -v -u {name}:{password}",
11182         "type": "json"
11183       }
11184     ],
11185     "name": "DescribeQueues",
11186     "group": "Fax_Queues",
11187     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11188     "version": "0.0.0",
11189     "filename": "server/api/faxQueue/index.js",
11190     "groupTitle": "Fax_Queues"
11191   },
11192   {
11193     "type": "get",
11194     "url": "/api/fax/queues/{id}/users",
11195     "title": "Gets queue agents",
11196     "examples": [
11197       {
11198         "title": "Example usage:",
11199         "content": "curl https://{domain}/api/fax/queues/{id}/users -v -u {name}:{password} -X POST",
11200         "type": "json"
11201       }
11202     ],
11203     "name": "GetAgents",
11204     "group": "Fax_Queues",
11205     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11206     "version": "0.0.0",
11207     "filename": "server/api/faxQueue/index.js",
11208     "groupTitle": "Fax_Queues"
11209   },
11210   {
11211     "type": "get",
11212     "url": "/api/fax/queues/{id}/members",
11213     "title": "GetMembers",
11214     "examples": [
11215       {
11216         "title": "Example usage:",
11217         "content": "curl https://{domain}/api/fax/queues/{id}/members  -v -u {name}:{password}",
11218         "type": "json"
11219       }
11220     ],
11221     "name": "GetMembers",
11222     "group": "Fax_Queues",
11223     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11224     "version": "0.0.0",
11225     "filename": "server/api/faxQueue/index.js",
11226     "groupTitle": "Fax_Queues"
11227   },
11228   {
11229     "type": "get",
11230     "url": "/api/fax/queues",
11231     "title": "Gets a list of Queues",
11232     "examples": [
11233       {
11234         "title": "Example usage:",
11235         "content": "curl https://{domain}/api/fax/queues -v -u {name}:{password}",
11236         "type": "json"
11237       }
11238     ],
11239     "name": "GetQueues",
11240     "group": "Fax_Queues",
11241     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/fax/queues?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/fax/queues?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/fax/queues?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/fax/queues?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/fax/queues?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
11242     "version": "0.0.0",
11243     "filename": "server/api/faxQueue/index.js",
11244     "groupTitle": "Fax_Queues"
11245   },
11246   {
11247     "type": "get",
11248     "url": "/api/fax/queues/{id}/teams",
11249     "title": "Gets queues list",
11250     "examples": [
11251       {
11252         "title": "Example usage:",
11253         "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password}",
11254         "type": "json"
11255       }
11256     ],
11257     "name": "GetTeams",
11258     "group": "Fax_Queues",
11259     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11260     "version": "0.0.0",
11261     "filename": "server/api/faxQueue/index.js",
11262     "groupTitle": "Fax_Queues"
11263   },
11264   {
11265     "type": "delete",
11266     "url": "/api/fax/queues/{id}/users",
11267     "title": "Removes agents from a queue",
11268     "examples": [
11269       {
11270         "title": "Example usage:",
11271         "content": "curl https://{domain}/api/fax/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
11272         "type": "json"
11273       }
11274     ],
11275     "name": "RemoveAgents",
11276     "group": "Fax_Queues",
11277     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11278     "version": "0.0.0",
11279     "filename": "server/api/faxQueue/index.js",
11280     "groupTitle": "Fax_Queues"
11281   },
11282   {
11283     "type": "get",
11284     "url": "/api/fax/queues/{id}",
11285     "title": "Gets a single Queue",
11286     "examples": [
11287       {
11288         "title": "Example usage:",
11289         "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password}",
11290         "type": "json"
11291       }
11292     ],
11293     "name": "ShowQueues",
11294     "group": "Fax_Queues",
11295     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11296     "version": "0.0.0",
11297     "filename": "server/api/faxQueue/index.js",
11298     "groupTitle": "Fax_Queues"
11299   },
11300   {
11301     "type": "put",
11302     "url": "/api/fax/queues/{id}",
11303     "title": "Update an existing Queue",
11304     "examples": [
11305       {
11306         "title": "Example usage:",
11307         "content": "curl https://{domain}/api/fax/queues/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
11308         "type": "json"
11309       }
11310     ],
11311     "name": "updateQueues",
11312     "group": "Fax_Queues",
11313     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11314     "version": "0.0.0",
11315     "filename": "server/api/faxQueue/index.js",
11316     "groupTitle": "Fax_Queues"
11317   },
11318   {
11319     "type": "post",
11320     "url": "/api/fax/reports/transfer",
11321     "title": "Creates a new Fax Transfer Report",
11322     "examples": [
11323       {
11324         "title": "Example usage:",
11325         "content": "curl https://{domain}/api/fax/reports/transfer -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
11326         "type": "json"
11327       }
11328     ],
11329     "name": "CreateFax_Transfer_Reports",
11330     "group": "Fax_Transfer_Reports",
11331     "parameter": {
11332       "fields": {
11333         "Body": [
11334           {
11335             "group": "Body",
11336             "type": "String",
11337             "optional": false,
11338             "field": "uniqueid",
11339             "description": ""
11340           },
11341           {
11342             "group": "Body",
11343             "type": "String",
11344             "allowedValues": [
11345               "\"account\"",
11346               "\"agent\"",
11347               "\"queue\""
11348             ],
11349             "optional": false,
11350             "field": "type",
11351             "description": ""
11352           },
11353           {
11354             "group": "Body",
11355             "type": "String",
11356             "optional": false,
11357             "field": "transferredAt",
11358             "description": ""
11359           }
11360         ]
11361       }
11362     },
11363     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11364     "version": "0.0.0",
11365     "filename": "server/api/faxTransferReport/index.js",
11366     "groupTitle": "Fax_Transfer_Reports"
11367   },
11368   {
11369     "type": "delete",
11370     "url": "/api/fax/reports/transfer/{id}",
11371     "title": "Deletes a Fax Transfer Report",
11372     "examples": [
11373       {
11374         "title": "Example usage:",
11375         "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
11376         "type": "json"
11377       }
11378     ],
11379     "name": "DeleteFax_Transfer_Reports",
11380     "group": "Fax_Transfer_Reports",
11381     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11382     "version": "0.0.0",
11383     "filename": "server/api/faxTransferReport/index.js",
11384     "groupTitle": "Fax_Transfer_Reports"
11385   },
11386   {
11387     "type": "get",
11388     "url": "/api/fax/reports/transfer/describe",
11389     "title": "Gets table info about Fax Transfer Reports",
11390     "examples": [
11391       {
11392         "title": "Example usage:",
11393         "content": "curl https://{domain}/api/fax/reports/transfer/describe -v -u {name}:{password}",
11394         "type": "json"
11395       }
11396     ],
11397     "name": "DescribeFax_Transfer_Reports",
11398     "group": "Fax_Transfer_Reports",
11399     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11400     "version": "0.0.0",
11401     "filename": "server/api/faxTransferReport/index.js",
11402     "groupTitle": "Fax_Transfer_Reports"
11403   },
11404   {
11405     "type": "get",
11406     "url": "/api/fax/reports/transfer",
11407     "title": "Gets a list of Fax Transfer Reports",
11408     "examples": [
11409       {
11410         "title": "Example usage:",
11411         "content": "curl https://{domain}/api/fax/reports/transfer -v -u {name}:{password}",
11412         "type": "json"
11413       }
11414     ],
11415     "name": "GetFax_Transfer_Reports",
11416     "group": "Fax_Transfer_Reports",
11417     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/fax/reports/transfer?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/fax/reports/transfer?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/fax/reports/transfer?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/fax/reports/transfer?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/fax/reports/transfer?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
11418     "version": "0.0.0",
11419     "filename": "server/api/faxTransferReport/index.js",
11420     "groupTitle": "Fax_Transfer_Reports"
11421   },
11422   {
11423     "type": "get",
11424     "url": "/api/fax/reports/transfer/{id}",
11425     "title": "Gets a single Fax Transfer Report",
11426     "examples": [
11427       {
11428         "title": "Example usage:",
11429         "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password}",
11430         "type": "json"
11431       }
11432     ],
11433     "name": "ShowFax_Transfer_Reports",
11434     "group": "Fax_Transfer_Reports",
11435     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11436     "version": "0.0.0",
11437     "filename": "server/api/faxTransferReport/index.js",
11438     "groupTitle": "Fax_Transfer_Reports"
11439   },
11440   {
11441     "type": "put",
11442     "url": "/api/fax/reports/transfer/{id}",
11443     "title": "Update an existing Fax Transfer Report",
11444     "examples": [
11445       {
11446         "title": "Example usage:",
11447         "content": "curl https://{domain}/api/fax/reports/transfer/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
11448         "type": "json"
11449       }
11450     ],
11451     "name": "updateFax_Transfer_Reports",
11452     "group": "Fax_Transfer_Reports",
11453     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11454     "version": "0.0.0",
11455     "filename": "server/api/faxTransferReport/index.js",
11456     "groupTitle": "Fax_Transfer_Reports"
11457   },
11458   {
11459     "type": "post",
11460     "url": "/api/integrations/freshdesk/accounts",
11461     "title": "Creates a new Freshdesk Account",
11462     "examples": [
11463       {
11464         "title": "Example usage:",
11465         "content": "curl https://{domain}/api/integrations/freshdesk/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
11466         "type": "json"
11467       }
11468     ],
11469     "name": "CreateFreshdesk_Accounts",
11470     "group": "Freshdesk_Accounts",
11471     "parameter": {
11472       "fields": {
11473         "Body": [
11474           {
11475             "group": "Body",
11476             "type": "String",
11477             "optional": true,
11478             "field": "name",
11479             "description": ""
11480           },
11481           {
11482             "group": "Body",
11483             "type": "String",
11484             "optional": true,
11485             "field": "description",
11486             "description": ""
11487           },
11488           {
11489             "group": "Body",
11490             "type": "String",
11491             "optional": true,
11492             "field": "username",
11493             "description": ""
11494           },
11495           {
11496             "group": "Body",
11497             "type": "String",
11498             "optional": true,
11499             "field": "apiKey",
11500             "description": ""
11501           },
11502           {
11503             "group": "Body",
11504             "type": "String",
11505             "optional": true,
11506             "field": "remoteUri",
11507             "description": ""
11508           },
11509           {
11510             "group": "Body",
11511             "type": "String",
11512             "optional": false,
11513             "field": "serverUrl",
11514             "description": ""
11515           }
11516         ]
11517       }
11518     },
11519     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11520     "version": "0.0.0",
11521     "filename": "server/api/intFreshdeskAccount/index.js",
11522     "groupTitle": "Freshdesk_Accounts"
11523   },
11524   {
11525     "type": "delete",
11526     "url": "/api/integrations/freshdesk/accounts/{id}",
11527     "title": "Deletes a Freshdesk Account",
11528     "examples": [
11529       {
11530         "title": "Example usage:",
11531         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password} -X DELETE",
11532         "type": "json"
11533       }
11534     ],
11535     "name": "DeleteFreshdesk_Accounts",
11536     "group": "Freshdesk_Accounts",
11537     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11538     "version": "0.0.0",
11539     "filename": "server/api/intFreshdeskAccount/index.js",
11540     "groupTitle": "Freshdesk_Accounts"
11541   },
11542   {
11543     "type": "get",
11544     "url": "/api/integrations/freshdesk/accounts",
11545     "title": "Gets a list of Freshdesk Accounts",
11546     "examples": [
11547       {
11548         "title": "Example usage:",
11549         "content": "curl https://{domain}/api/integrations/freshdesk/accounts -v -u {name}:{password}",
11550         "type": "json"
11551       }
11552     ],
11553     "name": "GetFreshdesk_Accounts",
11554     "group": "Freshdesk_Accounts",
11555     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/freshdesk/accounts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/freshdesk/accounts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/freshdesk/accounts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/freshdesk/accounts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/freshdesk/accounts?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
11556     "version": "0.0.0",
11557     "filename": "server/api/intFreshdeskAccount/index.js",
11558     "groupTitle": "Freshdesk_Accounts"
11559   },
11560   {
11561     "type": "get",
11562     "url": "/api/integrations/freshdesk/accounts/{id}",
11563     "title": "Gets a single Freshdesk Account",
11564     "examples": [
11565       {
11566         "title": "Example usage:",
11567         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password}",
11568         "type": "json"
11569       }
11570     ],
11571     "name": "ShowFreshdesk_Accounts",
11572     "group": "Freshdesk_Accounts",
11573     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11574     "version": "0.0.0",
11575     "filename": "server/api/intFreshdeskAccount/index.js",
11576     "groupTitle": "Freshdesk_Accounts"
11577   },
11578   {
11579     "type": "post",
11580     "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
11581     "title": "Creates new configuration",
11582     "examples": [
11583       {
11584         "title": "Example usage:",
11585         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/configurations -d '{\"name\": \"conf1\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
11586         "type": "json"
11587       }
11588     ],
11589     "name": "addConfiguration",
11590     "group": "Freshdesk_Accounts",
11591     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11592     "version": "0.0.0",
11593     "filename": "server/api/intFreshdeskAccount/index.js",
11594     "groupTitle": "Freshdesk_Accounts"
11595   },
11596   {
11597     "type": "get",
11598     "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
11599     "title": "Gets account configurations",
11600     "examples": [
11601       {
11602         "title": "Example usage:",
11603         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
11604         "type": "json"
11605       }
11606     ],
11607     "name": "getConfigurations",
11608     "group": "Freshdesk_Accounts",
11609     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11610     "version": "0.0.0",
11611     "filename": "server/api/intFreshdeskAccount/index.js",
11612     "groupTitle": "Freshdesk_Accounts"
11613   },
11614   {
11615     "type": "get",
11616     "url": "/api/integrations/freshdesk/accounts/{id}/fields",
11617     "title": "Gets account fields",
11618     "examples": [
11619       {
11620         "title": "Example usage:",
11621         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
11622         "type": "json"
11623       }
11624     ],
11625     "name": "getFields",
11626     "group": "Freshdesk_Accounts",
11627     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11628     "version": "0.0.0",
11629     "filename": "server/api/intFreshdeskAccount/index.js",
11630     "groupTitle": "Freshdesk_Accounts"
11631   },
11632   {
11633     "type": "put",
11634     "url": "/api/integrations/freshdesk/accounts/{id}",
11635     "title": "Update an existing Freshdesk Account",
11636     "examples": [
11637       {
11638         "title": "Example usage:",
11639         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
11640         "type": "json"
11641       }
11642     ],
11643     "name": "updateFreshdesk_Accounts",
11644     "group": "Freshdesk_Accounts",
11645     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11646     "version": "0.0.0",
11647     "filename": "server/api/intFreshdeskAccount/index.js",
11648     "groupTitle": "Freshdesk_Accounts"
11649   },
11650   {
11651     "type": "post",
11652     "url": "/api/integrations/freshdesk/configurations",
11653     "title": "Creates a new Freshdesk Configuration",
11654     "examples": [
11655       {
11656         "title": "Example usage:",
11657         "content": "curl https://{domain}/api/integrations/freshdesk/configurations -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
11658         "type": "json"
11659       }
11660     ],
11661     "name": "CreateFreshdesk_Configurations",
11662     "group": "Freshdesk_Configurations",
11663     "parameter": {
11664       "fields": {
11665         "Body": [
11666           {
11667             "group": "Body",
11668             "type": "String",
11669             "optional": true,
11670             "field": "name",
11671             "description": ""
11672           },
11673           {
11674             "group": "Body",
11675             "type": "String",
11676             "optional": true,
11677             "field": "description",
11678             "description": ""
11679           }
11680         ]
11681       }
11682     },
11683     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11684     "version": "0.0.0",
11685     "filename": "server/api/intFreshdeskConfiguration/index.js",
11686     "groupTitle": "Freshdesk_Configurations"
11687   },
11688   {
11689     "type": "delete",
11690     "url": "/api/integrations/freshdesk/configurations/{id}",
11691     "title": "Deletes a Freshdesk Configuration",
11692     "examples": [
11693       {
11694         "title": "Example usage:",
11695         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password} -X DELETE",
11696         "type": "json"
11697       }
11698     ],
11699     "name": "DeleteFreshdesk_Configurations",
11700     "group": "Freshdesk_Configurations",
11701     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11702     "version": "0.0.0",
11703     "filename": "server/api/intFreshdeskConfiguration/index.js",
11704     "groupTitle": "Freshdesk_Configurations"
11705   },
11706   {
11707     "type": "get",
11708     "url": "/api/integrations/freshdesk/configurations",
11709     "title": "Gets a list of Freshdesk Configurations",
11710     "examples": [
11711       {
11712         "title": "Example usage:",
11713         "content": "curl https://{domain}/api/integrations/freshdesk/configurations -v -u {name}:{password}",
11714         "type": "json"
11715       }
11716     ],
11717     "name": "GetFreshdesk_Configurations",
11718     "group": "Freshdesk_Configurations",
11719     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/freshdesk/configurations?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/freshdesk/configurations?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/freshdesk/configurations?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/freshdesk/configurations?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/freshdesk/configurations?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
11720     "version": "0.0.0",
11721     "filename": "server/api/intFreshdeskConfiguration/index.js",
11722     "groupTitle": "Freshdesk_Configurations"
11723   },
11724   {
11725     "type": "get",
11726     "url": "/api/integrations/freshdesk/configurations/{id}",
11727     "title": "Gets a single Freshdesk Configuration",
11728     "examples": [
11729       {
11730         "title": "Example usage:",
11731         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password}",
11732         "type": "json"
11733       }
11734     ],
11735     "name": "ShowFreshdesk_Configurations",
11736     "group": "Freshdesk_Configurations",
11737     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11738     "version": "0.0.0",
11739     "filename": "server/api/intFreshdeskConfiguration/index.js",
11740     "groupTitle": "Freshdesk_Configurations"
11741   },
11742   {
11743     "type": "get",
11744     "url": "/api/integrations/freshdesk/configurations/{id}/descriptions",
11745     "title": "Gets configurations descriptions",
11746     "examples": [
11747       {
11748         "title": "Example usage:",
11749         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
11750         "type": "json"
11751       }
11752     ],
11753     "name": "getDescriptions",
11754     "group": "Freshdesk_Configurations",
11755     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11756     "version": "0.0.0",
11757     "filename": "server/api/intFreshdeskConfiguration/index.js",
11758     "groupTitle": "Freshdesk_Configurations"
11759   },
11760   {
11761     "type": "get",
11762     "url": "/api/integrations/freshdesk/configurations/{id}/fields",
11763     "title": "Gets configurations fields",
11764     "examples": [
11765       {
11766         "title": "Example usage:",
11767         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
11768         "type": "json"
11769       }
11770     ],
11771     "name": "getFields",
11772     "group": "Freshdesk_Configurations",
11773     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11774     "version": "0.0.0",
11775     "filename": "server/api/intFreshdeskConfiguration/index.js",
11776     "groupTitle": "Freshdesk_Configurations"
11777   },
11778   {
11779     "type": "get",
11780     "url": "/api/integrations/freshdesk/configurations/{id}/subjects",
11781     "title": "Gets configurations subjects",
11782     "examples": [
11783       {
11784         "title": "Example usage:",
11785         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
11786         "type": "json"
11787       }
11788     ],
11789     "name": "getSubjects",
11790     "group": "Freshdesk_Configurations",
11791     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11792     "version": "0.0.0",
11793     "filename": "server/api/intFreshdeskConfiguration/index.js",
11794     "groupTitle": "Freshdesk_Configurations"
11795   },
11796   {
11797     "type": "get",
11798     "url": "/api/integrations/freshdesk/configurations/{id}/tags",
11799     "title": "Gets configurations tags",
11800     "examples": [
11801       {
11802         "title": "Example usage:",
11803         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
11804         "type": "json"
11805       }
11806     ],
11807     "name": "getTags",
11808     "group": "Freshdesk_Configurations",
11809     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11810     "version": "0.0.0",
11811     "filename": "server/api/intFreshdeskConfiguration/index.js",
11812     "groupTitle": "Freshdesk_Configurations"
11813   },
11814   {
11815     "type": "post",
11816     "url": "/api/integrations/freshdesk/configurations/{id}/tags",
11817     "title": "Sets new tags",
11818     "examples": [
11819       {
11820         "title": "Example usage:",
11821         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/tags -d '{\"ids\": [1,12]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
11822         "type": "json"
11823       }
11824     ],
11825     "name": "setTags",
11826     "group": "Freshdesk_Configurations",
11827     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11828     "version": "0.0.0",
11829     "filename": "server/api/intFreshdeskConfiguration/index.js",
11830     "groupTitle": "Freshdesk_Configurations"
11831   },
11832   {
11833     "type": "put",
11834     "url": "/api/integrations/freshdesk/configurations/{id}",
11835     "title": "Update an existing Freshdesk Configuration",
11836     "examples": [
11837       {
11838         "title": "Example usage:",
11839         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
11840         "type": "json"
11841       }
11842     ],
11843     "name": "updateFreshdesk_Configurations",
11844     "group": "Freshdesk_Configurations",
11845     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11846     "version": "0.0.0",
11847     "filename": "server/api/intFreshdeskConfiguration/index.js",
11848     "groupTitle": "Freshdesk_Configurations"
11849   },
11850   {
11851     "type": "post",
11852     "url": "/api/integrations/freshdesk/fields",
11853     "title": "Creates a new Freshdesk Field",
11854     "examples": [
11855       {
11856         "title": "Example usage:",
11857         "content": "curl https://{domain}/api/integrations/freshdesk/fields -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
11858         "type": "json"
11859       }
11860     ],
11861     "name": "CreateFreshdesk_Fields",
11862     "group": "Freshdesk_Fields",
11863     "parameter": {
11864       "fields": {
11865         "Body": [
11866           {
11867             "group": "Body",
11868             "type": "String",
11869             "allowedValues": [
11870               "\"string\"",
11871               "\"variable\"",
11872               "\"customVariable\"",
11873               "\"keyValue\""
11874             ],
11875             "optional": true,
11876             "field": "type",
11877             "description": ""
11878           },
11879           {
11880             "group": "Body",
11881             "type": "String",
11882             "optional": true,
11883             "field": "content",
11884             "description": ""
11885           },
11886           {
11887             "group": "Body",
11888             "type": "String",
11889             "optional": true,
11890             "field": "key",
11891             "description": ""
11892           },
11893           {
11894             "group": "Body",
11895             "type": "String",
11896             "allowedValues": [
11897               "\"string\"",
11898               "\"variable\"",
11899               "\"customVariable\""
11900             ],
11901             "optional": true,
11902             "field": "keyType",
11903             "description": ""
11904           },
11905           {
11906             "group": "Body",
11907             "type": "String",
11908             "optional": true,
11909             "field": "keyContent",
11910             "description": ""
11911           },
11912           {
11913             "group": "Body",
11914             "type": "String",
11915             "optional": true,
11916             "field": "idField",
11917             "description": ""
11918           },
11919           {
11920             "group": "Body",
11921             "type": "String",
11922             "optional": true,
11923             "field": "nameField",
11924             "description": ""
11925           },
11926           {
11927             "group": "Body",
11928             "type": "Boolean",
11929             "optional": true,
11930             "field": "customField",
11931             "description": ""
11932           },
11933           {
11934             "group": "Body",
11935             "type": "String",
11936             "optional": true,
11937             "field": "variableName",
11938             "description": ""
11939           }
11940         ]
11941       }
11942     },
11943     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11944     "version": "0.0.0",
11945     "filename": "server/api/intFreshdeskField/index.js",
11946     "groupTitle": "Freshdesk_Fields"
11947   },
11948   {
11949     "type": "delete",
11950     "url": "/api/integrations/freshdesk/fields/{id}",
11951     "title": "Deletes a Freshdesk Field",
11952     "examples": [
11953       {
11954         "title": "Example usage:",
11955         "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password} -X DELETE",
11956         "type": "json"
11957       }
11958     ],
11959     "name": "DeleteFreshdesk_Fields",
11960     "group": "Freshdesk_Fields",
11961     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11962     "version": "0.0.0",
11963     "filename": "server/api/intFreshdeskField/index.js",
11964     "groupTitle": "Freshdesk_Fields"
11965   },
11966   {
11967     "type": "get",
11968     "url": "/api/integrations/freshdesk/fields",
11969     "title": "Gets a list of Freshdesk Fields",
11970     "examples": [
11971       {
11972         "title": "Example usage:",
11973         "content": "curl https://{domain}/api/integrations/freshdesk/fields -v -u {name}:{password}",
11974         "type": "json"
11975       }
11976     ],
11977     "name": "GetFreshdesk_Fields",
11978     "group": "Freshdesk_Fields",
11979     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/freshdesk/fields?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/freshdesk/fields?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/freshdesk/fields?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/freshdesk/fields?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/freshdesk/fields?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
11980     "version": "0.0.0",
11981     "filename": "server/api/intFreshdeskField/index.js",
11982     "groupTitle": "Freshdesk_Fields"
11983   },
11984   {
11985     "type": "get",
11986     "url": "/api/integrations/freshdesk/fields/{id}",
11987     "title": "Gets a single Freshdesk Field",
11988     "examples": [
11989       {
11990         "title": "Example usage:",
11991         "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password}",
11992         "type": "json"
11993       }
11994     ],
11995     "name": "ShowFreshdesk_Fields",
11996     "group": "Freshdesk_Fields",
11997     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11998     "version": "0.0.0",
11999     "filename": "server/api/intFreshdeskField/index.js",
12000     "groupTitle": "Freshdesk_Fields"
12001   },
12002   {
12003     "type": "put",
12004     "url": "/api/integrations/freshdesk/fields/{id}",
12005     "title": "Update an existing Freshdesk Field",
12006     "examples": [
12007       {
12008         "title": "Example usage:",
12009         "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
12010         "type": "json"
12011       }
12012     ],
12013     "name": "updateFreshdesk_Fields",
12014     "group": "Freshdesk_Fields",
12015     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12016     "version": "0.0.0",
12017     "filename": "server/api/intFreshdeskField/index.js",
12018     "groupTitle": "Freshdesk_Fields"
12019   },
12020   {
12021     "type": "post",
12022     "url": "/api/integrations/freshsales/accounts",
12023     "title": "Creates a new Freshsales Account",
12024     "examples": [
12025       {
12026         "title": "Example usage:",
12027         "content": "curl https://{domain}/api/integrations/freshsales/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12028         "type": "json"
12029       }
12030     ],
12031     "name": "CreateFreshsales_Accounts",
12032     "group": "Freshsales_Accounts",
12033     "parameter": {
12034       "fields": {
12035         "Body": [
12036           {
12037             "group": "Body",
12038             "type": "String",
12039             "optional": true,
12040             "field": "name",
12041             "description": ""
12042           },
12043           {
12044             "group": "Body",
12045             "type": "String",
12046             "optional": true,
12047             "field": "description",
12048             "description": ""
12049           },
12050           {
12051             "group": "Body",
12052             "type": "String",
12053             "optional": true,
12054             "field": "username",
12055             "description": ""
12056           },
12057           {
12058             "group": "Body",
12059             "type": "String",
12060             "optional": true,
12061             "field": "apiKey",
12062             "description": ""
12063           },
12064           {
12065             "group": "Body",
12066             "type": "String",
12067             "optional": true,
12068             "field": "remoteUri",
12069             "description": ""
12070           },
12071           {
12072             "group": "Body",
12073             "type": "String",
12074             "optional": false,
12075             "field": "serverUrl",
12076             "description": ""
12077           }
12078         ]
12079       }
12080     },
12081     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12082     "version": "0.0.0",
12083     "filename": "server/api/intFreshsalesAccount/index.js",
12084     "groupTitle": "Freshsales_Accounts"
12085   },
12086   {
12087     "type": "delete",
12088     "url": "/api/integrations/freshsales/accounts/{id}",
12089     "title": "Deletes a Freshsales Account",
12090     "examples": [
12091       {
12092         "title": "Example usage:",
12093         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password} -X DELETE",
12094         "type": "json"
12095       }
12096     ],
12097     "name": "DeleteFreshsales_Accounts",
12098     "group": "Freshsales_Accounts",
12099     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12100     "version": "0.0.0",
12101     "filename": "server/api/intFreshsalesAccount/index.js",
12102     "groupTitle": "Freshsales_Accounts"
12103   },
12104   {
12105     "type": "get",
12106     "url": "/api/integrations/freshsales/accounts",
12107     "title": "Gets a list of Freshsales Accounts",
12108     "examples": [
12109       {
12110         "title": "Example usage:",
12111         "content": "curl https://{domain}/api/integrations/freshsales/accounts -v -u {name}:{password}",
12112         "type": "json"
12113       }
12114     ],
12115     "name": "GetFreshsales_Accounts",
12116     "group": "Freshsales_Accounts",
12117     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/freshsales/accounts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/freshsales/accounts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/freshsales/accounts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/freshsales/accounts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/freshsales/accounts?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
12118     "version": "0.0.0",
12119     "filename": "server/api/intFreshsalesAccount/index.js",
12120     "groupTitle": "Freshsales_Accounts"
12121   },
12122   {
12123     "type": "get",
12124     "url": "/api/integrations/freshsales/accounts/{id}",
12125     "title": "Gets a single Freshsales Account",
12126     "examples": [
12127       {
12128         "title": "Example usage:",
12129         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password}",
12130         "type": "json"
12131       }
12132     ],
12133     "name": "ShowFreshsales_Accounts",
12134     "group": "Freshsales_Accounts",
12135     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12136     "version": "0.0.0",
12137     "filename": "server/api/intFreshsalesAccount/index.js",
12138     "groupTitle": "Freshsales_Accounts"
12139   },
12140   {
12141     "type": "post",
12142     "url": "/api/integrations/freshsales/accounts/{id}/configurations",
12143     "title": "Creates new configuration",
12144     "examples": [
12145       {
12146         "title": "Example usage:",
12147         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/configurations -d '{\"name\": \"conf1\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
12148         "type": "json"
12149       }
12150     ],
12151     "name": "addConfiguration",
12152     "group": "Freshsales_Accounts",
12153     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12154     "version": "0.0.0",
12155     "filename": "server/api/intFreshsalesAccount/index.js",
12156     "groupTitle": "Freshsales_Accounts"
12157   },
12158   {
12159     "type": "get",
12160     "url": "/api/integrations/freshsales/accounts/{id}/configurations",
12161     "title": "Gets account configurations",
12162     "examples": [
12163       {
12164         "title": "Example usage:",
12165         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/configurations -v -u {name}:{password} -X GET",
12166         "type": "json"
12167       }
12168     ],
12169     "name": "getConfigurations",
12170     "group": "Freshsales_Accounts",
12171     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12172     "version": "0.0.0",
12173     "filename": "server/api/intFreshsalesAccount/index.js",
12174     "groupTitle": "Freshsales_Accounts"
12175   },
12176   {
12177     "type": "get",
12178     "url": "/api/integrations/freshsales/accounts/{id}/fields",
12179     "title": "Gets account fields",
12180     "examples": [
12181       {
12182         "title": "Example usage:",
12183         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/fields -v -u {name}:{password} -X GET",
12184         "type": "json"
12185       }
12186     ],
12187     "name": "getFields",
12188     "group": "Freshsales_Accounts",
12189     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12190     "version": "0.0.0",
12191     "filename": "server/api/intFreshsalesAccount/index.js",
12192     "groupTitle": "Freshsales_Accounts"
12193   },
12194   {
12195     "type": "put",
12196     "url": "/api/integrations/freshsales/accounts/{id}",
12197     "title": "Update an existing Freshsales Account",
12198     "examples": [
12199       {
12200         "title": "Example usage:",
12201         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
12202         "type": "json"
12203       }
12204     ],
12205     "name": "updateFreshsales_Accounts",
12206     "group": "Freshsales_Accounts",
12207     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12208     "version": "0.0.0",
12209     "filename": "server/api/intFreshsalesAccount/index.js",
12210     "groupTitle": "Freshsales_Accounts"
12211   },
12212   {
12213     "type": "post",
12214     "url": "/api/integrations/freshsales/configurations",
12215     "title": "Creates a new Freshsales Configuration",
12216     "examples": [
12217       {
12218         "title": "Example usage:",
12219         "content": "curl https://{domain}/api/integrations/freshsales/configurations -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12220         "type": "json"
12221       }
12222     ],
12223     "name": "CreateFreshsales_Configurations",
12224     "group": "Freshsales_Configurations",
12225     "parameter": {
12226       "fields": {
12227         "Body": [
12228           {
12229             "group": "Body",
12230             "type": "String",
12231             "optional": true,
12232             "field": "name",
12233             "description": ""
12234           },
12235           {
12236             "group": "Body",
12237             "type": "String",
12238             "optional": true,
12239             "field": "description",
12240             "description": ""
12241           }
12242         ]
12243       }
12244     },
12245     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12246     "version": "0.0.0",
12247     "filename": "server/api/intFreshsalesConfiguration/index.js",
12248     "groupTitle": "Freshsales_Configurations"
12249   },
12250   {
12251     "type": "delete",
12252     "url": "/api/integrations/freshsales/configurations/{id}",
12253     "title": "Deletes a Freshsales Configuration",
12254     "examples": [
12255       {
12256         "title": "Example usage:",
12257         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password} -X DELETE",
12258         "type": "json"
12259       }
12260     ],
12261     "name": "DeleteFreshsales_Configurations",
12262     "group": "Freshsales_Configurations",
12263     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12264     "version": "0.0.0",
12265     "filename": "server/api/intFreshsalesConfiguration/index.js",
12266     "groupTitle": "Freshsales_Configurations"
12267   },
12268   {
12269     "type": "get",
12270     "url": "/api/integrations/freshsales/configurations",
12271     "title": "Gets a list of Freshsales Configurations",
12272     "examples": [
12273       {
12274         "title": "Example usage:",
12275         "content": "curl https://{domain}/api/integrations/freshsales/configurations -v -u {name}:{password}",
12276         "type": "json"
12277       }
12278     ],
12279     "name": "GetFreshsales_Configurations",
12280     "group": "Freshsales_Configurations",
12281     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/freshsales/configurations?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/freshsales/configurations?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/freshsales/configurations?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/freshsales/configurations?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/freshsales/configurations?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
12282     "version": "0.0.0",
12283     "filename": "server/api/intFreshsalesConfiguration/index.js",
12284     "groupTitle": "Freshsales_Configurations"
12285   },
12286   {
12287     "type": "get",
12288     "url": "/api/integrations/freshsales/configurations/{id}",
12289     "title": "Gets a single Freshsales Configuration",
12290     "examples": [
12291       {
12292         "title": "Example usage:",
12293         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password}",
12294         "type": "json"
12295       }
12296     ],
12297     "name": "ShowFreshsales_Configurations",
12298     "group": "Freshsales_Configurations",
12299     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12300     "version": "0.0.0",
12301     "filename": "server/api/intFreshsalesConfiguration/index.js",
12302     "groupTitle": "Freshsales_Configurations"
12303   },
12304   {
12305     "type": "get",
12306     "url": "/api/integrations/freshsales/configurations/{id}/descriptions",
12307     "title": "Gets configurations descriptions",
12308     "examples": [
12309       {
12310         "title": "Example usage:",
12311         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
12312         "type": "json"
12313       }
12314     ],
12315     "name": "getDescriptions",
12316     "group": "Freshsales_Configurations",
12317     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12318     "version": "0.0.0",
12319     "filename": "server/api/intFreshsalesConfiguration/index.js",
12320     "groupTitle": "Freshsales_Configurations"
12321   },
12322   {
12323     "type": "get",
12324     "url": "/api/integrations/freshsales/configurations/{id}/fields",
12325     "title": "Gets configurations fields",
12326     "examples": [
12327       {
12328         "title": "Example usage:",
12329         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/fields -v -u {name}:{password} -X GET",
12330         "type": "json"
12331       }
12332     ],
12333     "name": "getFields",
12334     "group": "Freshsales_Configurations",
12335     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12336     "version": "0.0.0",
12337     "filename": "server/api/intFreshsalesConfiguration/index.js",
12338     "groupTitle": "Freshsales_Configurations"
12339   },
12340   {
12341     "type": "get",
12342     "url": "/api/integrations/freshsales/configurations/{id}/subjects",
12343     "title": "Gets configurations subjects",
12344     "examples": [
12345       {
12346         "title": "Example usage:",
12347         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/subjects -v -u {name}:{password} -X GET",
12348         "type": "json"
12349       }
12350     ],
12351     "name": "getSubjects",
12352     "group": "Freshsales_Configurations",
12353     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12354     "version": "0.0.0",
12355     "filename": "server/api/intFreshsalesConfiguration/index.js",
12356     "groupTitle": "Freshsales_Configurations"
12357   },
12358   {
12359     "type": "put",
12360     "url": "/api/integrations/freshsales/configurations/{id}",
12361     "title": "Update an existing Freshsales Configuration",
12362     "examples": [
12363       {
12364         "title": "Example usage:",
12365         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
12366         "type": "json"
12367       }
12368     ],
12369     "name": "updateFreshsales_Configurations",
12370     "group": "Freshsales_Configurations",
12371     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12372     "version": "0.0.0",
12373     "filename": "server/api/intFreshsalesConfiguration/index.js",
12374     "groupTitle": "Freshsales_Configurations"
12375   },
12376   {
12377     "type": "post",
12378     "url": "/api/integrations/freshsales/fields",
12379     "title": "Creates a new Freshsales Field",
12380     "examples": [
12381       {
12382         "title": "Example usage:",
12383         "content": "curl https://{domain}/api/integrations/freshsales/fields -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12384         "type": "json"
12385       }
12386     ],
12387     "name": "CreateFreshsales_Fields",
12388     "group": "Freshsales_Fields",
12389     "parameter": {
12390       "fields": {
12391         "Body": [
12392           {
12393             "group": "Body",
12394             "type": "String",
12395             "allowedValues": [
12396               "\"string\"",
12397               "\"variable\"",
12398               "\"customVariable\"",
12399               "\"keyValue\""
12400             ],
12401             "optional": true,
12402             "field": "type",
12403             "description": ""
12404           },
12405           {
12406             "group": "Body",
12407             "type": "String",
12408             "optional": true,
12409             "field": "content",
12410             "description": ""
12411           },
12412           {
12413             "group": "Body",
12414             "type": "String",
12415             "optional": true,
12416             "field": "key",
12417             "description": ""
12418           },
12419           {
12420             "group": "Body",
12421             "type": "String",
12422             "allowedValues": [
12423               "\"string\"",
12424               "\"variable\"",
12425               "\"customVariable\""
12426             ],
12427             "optional": true,
12428             "field": "keyType",
12429             "description": ""
12430           },
12431           {
12432             "group": "Body",
12433             "type": "String",
12434             "optional": true,
12435             "field": "keyContent",
12436             "description": ""
12437           },
12438           {
12439             "group": "Body",
12440             "type": "String",
12441             "optional": true,
12442             "field": "idField",
12443             "description": ""
12444           },
12445           {
12446             "group": "Body",
12447             "type": "String",
12448             "optional": true,
12449             "field": "nameField",
12450             "description": ""
12451           },
12452           {
12453             "group": "Body",
12454             "type": "Boolean",
12455             "optional": true,
12456             "field": "customField",
12457             "description": ""
12458           },
12459           {
12460             "group": "Body",
12461             "type": "String",
12462             "optional": true,
12463             "field": "variableName",
12464             "description": ""
12465           }
12466         ]
12467       }
12468     },
12469     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12470     "version": "0.0.0",
12471     "filename": "server/api/intFreshsalesField/index.js",
12472     "groupTitle": "Freshsales_Fields"
12473   },
12474   {
12475     "type": "delete",
12476     "url": "/api/integrations/freshsales/fields/{id}",
12477     "title": "Deletes a Freshsales Field",
12478     "examples": [
12479       {
12480         "title": "Example usage:",
12481         "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password} -X DELETE",
12482         "type": "json"
12483       }
12484     ],
12485     "name": "DeleteFreshsales_Fields",
12486     "group": "Freshsales_Fields",
12487     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12488     "version": "0.0.0",
12489     "filename": "server/api/intFreshsalesField/index.js",
12490     "groupTitle": "Freshsales_Fields"
12491   },
12492   {
12493     "type": "get",
12494     "url": "/api/integrations/freshsales/fields",
12495     "title": "Gets a list of Freshsales Fields",
12496     "examples": [
12497       {
12498         "title": "Example usage:",
12499         "content": "curl https://{domain}/api/integrations/freshsales/fields -v -u {name}:{password}",
12500         "type": "json"
12501       }
12502     ],
12503     "name": "GetFreshsales_Fields",
12504     "group": "Freshsales_Fields",
12505     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/freshsales/fields?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/freshsales/fields?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/freshsales/fields?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/freshsales/fields?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/freshsales/fields?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
12506     "version": "0.0.0",
12507     "filename": "server/api/intFreshsalesField/index.js",
12508     "groupTitle": "Freshsales_Fields"
12509   },
12510   {
12511     "type": "get",
12512     "url": "/api/integrations/freshsales/fields/{id}",
12513     "title": "Gets a single Freshsales Field",
12514     "examples": [
12515       {
12516         "title": "Example usage:",
12517         "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password}",
12518         "type": "json"
12519       }
12520     ],
12521     "name": "ShowFreshsales_Fields",
12522     "group": "Freshsales_Fields",
12523     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12524     "version": "0.0.0",
12525     "filename": "server/api/intFreshsalesField/index.js",
12526     "groupTitle": "Freshsales_Fields"
12527   },
12528   {
12529     "type": "put",
12530     "url": "/api/integrations/freshsales/fields/{id}",
12531     "title": "Update an existing Freshsales Field",
12532     "examples": [
12533       {
12534         "title": "Example usage:",
12535         "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
12536         "type": "json"
12537       }
12538     ],
12539     "name": "updateFreshsales_Fields",
12540     "group": "Freshsales_Fields",
12541     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12542     "version": "0.0.0",
12543     "filename": "server/api/intFreshsalesField/index.js",
12544     "groupTitle": "Freshsales_Fields"
12545   },
12546   {
12547     "type": "post",
12548     "url": "/api/campaigns/{id}/blacklists",
12549     "title": "Add blacklists to an IVR campaign",
12550     "examples": [
12551       {
12552         "title": "Example usage:",
12553         "content": "curl https://{domain}/api/campaigns/{id}/blacklists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
12554         "type": "json"
12555       }
12556     ],
12557     "name": "AddBlackLists",
12558     "group": "IVR_Campaigns",
12559     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12560     "version": "0.0.0",
12561     "filename": "server/api/campaign/index.js",
12562     "groupTitle": "IVR_Campaigns"
12563   },
12564   {
12565     "type": "post",
12566     "url": "/api/campaigns/{id}/lists",
12567     "title": "Add lists to an IVR campaign",
12568     "examples": [
12569       {
12570         "title": "Example usage:",
12571         "content": "curl https://{domain}/api/campaigns/{id}/lists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
12572         "type": "json"
12573       }
12574     ],
12575     "name": "AddLists",
12576     "group": "IVR_Campaigns",
12577     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12578     "version": "0.0.0",
12579     "filename": "server/api/campaign/index.js",
12580     "groupTitle": "IVR_Campaigns"
12581   },
12582   {
12583     "type": "post",
12584     "url": "/api/campaigns/clone",
12585     "title": "Clone an existing IVR Campaign",
12586     "examples": [
12587       {
12588         "title": "Example usage:",
12589         "content": "curl https://{domain}/api/campaigns/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12590         "type": "json"
12591       }
12592     ],
12593     "name": "CloneIVR_Campaigns",
12594     "group": "IVR_Campaigns",
12595     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12596     "version": "0.0.0",
12597     "filename": "server/api/campaign/index.js",
12598     "groupTitle": "IVR_Campaigns"
12599   },
12600   {
12601     "type": "post",
12602     "url": "/api/campaigns",
12603     "title": "Creates a new IVR Campaign",
12604     "examples": [
12605       {
12606         "title": "Example usage:",
12607         "content": "curl https://{domain}/api/campaigns -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12608         "type": "json"
12609       }
12610     ],
12611     "name": "CreateIVR_Campaigns",
12612     "group": "IVR_Campaigns",
12613     "parameter": {
12614       "fields": {
12615         "Body": [
12616           {
12617             "group": "Body",
12618             "type": "String",
12619             "optional": false,
12620             "field": "name",
12621             "description": ""
12622           },
12623           {
12624             "group": "Body",
12625             "type": "String",
12626             "allowedValues": [
12627               "\"ivr\""
12628             ],
12629             "optional": false,
12630             "field": "type",
12631             "description": ""
12632           },
12633           {
12634             "group": "Body",
12635             "type": "String",
12636             "optional": true,
12637             "field": "description",
12638             "description": ""
12639           },
12640           {
12641             "group": "Body",
12642             "type": "Boolean",
12643             "optional": true,
12644             "field": "active",
12645             "description": "<p>Active/Disactive Campaign</p>"
12646           },
12647           {
12648             "group": "Body",
12649             "type": "Integer",
12650             "optional": true,
12651             "field": "limitCalls",
12652             "description": "<p>Max 200 calls.</p>"
12653           },
12654           {
12655             "group": "Body",
12656             "type": "String",
12657             "optional": true,
12658             "field": "dialOriginateCallerIdName",
12659             "description": ""
12660           },
12661           {
12662             "group": "Body",
12663             "type": "String",
12664             "optional": true,
12665             "field": "dialOriginateCallerIdNumber",
12666             "description": ""
12667           },
12668           {
12669             "group": "Body",
12670             "type": "Integer",
12671             "optional": true,
12672             "field": "dialOriginateTimeout",
12673             "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
12674           },
12675           {
12676             "group": "Body",
12677             "type": "Integer",
12678             "optional": true,
12679             "field": "dialCongestionMaxRetry",
12680             "description": "<p>#Congestion Retry (min:1, max:999)</p>"
12681           },
12682           {
12683             "group": "Body",
12684             "type": "Integer",
12685             "optional": true,
12686             "field": "dialCongestionRetryFrequency",
12687             "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
12688           },
12689           {
12690             "group": "Body",
12691             "type": "Integer",
12692             "optional": true,
12693             "field": "dialBusyMaxRetry",
12694             "description": "<p>#Busy Retry (min:1, max:999)</p>"
12695           },
12696           {
12697             "group": "Body",
12698             "type": "Integer",
12699             "optional": true,
12700             "field": "dialBusyRetryFrequency",
12701             "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
12702           },
12703           {
12704             "group": "Body",
12705             "type": "Integer",
12706             "optional": true,
12707             "field": "dialNoAnswerMaxRetry",
12708             "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
12709           },
12710           {
12711             "group": "Body",
12712             "type": "Integer",
12713             "optional": true,
12714             "field": "dialNoAnswerRetryFrequency",
12715             "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
12716           },
12717           {
12718             "group": "Body",
12719             "type": "Integer",
12720             "optional": true,
12721             "field": "dialGlobalMaxRetry",
12722             "description": "<p>#Global Max Retry (min:1, max:999)</p>"
12723           },
12724           {
12725             "group": "Body",
12726             "type": "String",
12727             "optional": true,
12728             "field": "dialTimezone",
12729             "description": ""
12730           },
12731           {
12732             "group": "Body",
12733             "type": "String",
12734             "optional": true,
12735             "field": "dialGlobalInterval",
12736             "description": ""
12737           },
12738           {
12739             "group": "Body",
12740             "type": "String",
12741             "allowedValues": [
12742               "\"always\"",
12743               "\"never\"",
12744               "\"onlyIfOpen\""
12745             ],
12746             "optional": true,
12747             "field": "dialCheckDuplicateType",
12748             "description": ""
12749           },
12750           {
12751             "group": "Body",
12752             "type": "Boolean",
12753             "optional": true,
12754             "field": "dialAMDActive",
12755             "description": "<p>Active/Disactive AMD</p>"
12756           },
12757           {
12758             "group": "Body",
12759             "type": "Integer",
12760             "optional": true,
12761             "field": "dialAMDInitialSilence",
12762             "description": "<p>#AMD Initial Silence</p>"
12763           },
12764           {
12765             "group": "Body",
12766             "type": "Integer",
12767             "optional": true,
12768             "field": "dialAMDGreeting",
12769             "description": "<p>#AMD Greeting</p>"
12770           },
12771           {
12772             "group": "Body",
12773             "type": "Integer",
12774             "optional": true,
12775             "field": "dialAMDAfterGreetingSilence",
12776             "description": "<p>#AMD After Greeting Silence</p>"
12777           },
12778           {
12779             "group": "Body",
12780             "type": "Integer",
12781             "optional": true,
12782             "field": "dialAMDTotalAnalysisTime",
12783             "description": "<p>#AMD Total Analysis Time</p>"
12784           },
12785           {
12786             "group": "Body",
12787             "type": "Integer",
12788             "optional": true,
12789             "field": "dialAMDMinWordLength",
12790             "description": "<p>#AMD Min Word Length</p>"
12791           },
12792           {
12793             "group": "Body",
12794             "type": "Integer",
12795             "optional": true,
12796             "field": "dialAMDBetweenWordsSilence",
12797             "description": "<p>#AMD Between Words Silence</p>"
12798           },
12799           {
12800             "group": "Body",
12801             "type": "Integer",
12802             "optional": true,
12803             "field": "dialAMDMaximumNumberOfWords",
12804             "description": "<p>#AMD Maximum Number Of Words</p>"
12805           },
12806           {
12807             "group": "Body",
12808             "type": "Integer",
12809             "optional": true,
12810             "field": "dialAMDSilenceThreshold",
12811             "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
12812           },
12813           {
12814             "group": "Body",
12815             "type": "Integer",
12816             "optional": true,
12817             "field": "dialAMDMaximumWordLength",
12818             "description": "<p>#AMD Maximum Word Length</p>"
12819           },
12820           {
12821             "group": "Body",
12822             "type": "String",
12823             "allowedValues": [
12824               "\"DESC\"",
12825               "\"ASC\""
12826             ],
12827             "optional": true,
12828             "field": "dialOrderByScheduledAt",
12829             "description": ""
12830           },
12831           {
12832             "group": "Body",
12833             "type": "String",
12834             "optional": true,
12835             "field": "dialPrefix",
12836             "description": ""
12837           },
12838           {
12839             "group": "Body",
12840             "type": "Integer",
12841             "optional": true,
12842             "field": "dialRandomLastDigitCallerIdNumber",
12843             "description": "<p>Random Last Digit (min:1, max:15)</p>"
12844           },
12845           {
12846             "group": "Body",
12847             "type": "Integer",
12848             "optional": true,
12849             "field": "dialCutDigit",
12850             "description": "<p>Cut Digit (min:1, max:15)</p>"
12851           },
12852           {
12853             "group": "Body",
12854             "type": "Integer",
12855             "optional": true,
12856             "field": "dialNoSuchNumberMaxRetry",
12857             "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
12858           },
12859           {
12860             "group": "Body",
12861             "type": "Integer",
12862             "optional": true,
12863             "field": "dialNoSuchNumberRetryFrequency",
12864             "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
12865           },
12866           {
12867             "group": "Body",
12868             "type": "Integer",
12869             "optional": true,
12870             "field": "dialDropMaxRetry",
12871             "description": "<p>#Drop Retry (min:1, max:999)</p>"
12872           },
12873           {
12874             "group": "Body",
12875             "type": "Integer",
12876             "optional": true,
12877             "field": "dialDropRetryFrequency",
12878             "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
12879           },
12880           {
12881             "group": "Body",
12882             "type": "Integer",
12883             "optional": true,
12884             "field": "dialAbandonedMaxRetry",
12885             "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
12886           },
12887           {
12888             "group": "Body",
12889             "type": "Integer",
12890             "optional": true,
12891             "field": "dialAbandonedRetryFrequency",
12892             "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
12893           },
12894           {
12895             "group": "Body",
12896             "type": "Integer",
12897             "optional": true,
12898             "field": "dialMachineMaxRetry",
12899             "description": "<p>#Machine Retry (min:1, max:999)</p>"
12900           },
12901           {
12902             "group": "Body",
12903             "type": "Integer",
12904             "optional": true,
12905             "field": "dialMachineRetryFrequency",
12906             "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
12907           },
12908           {
12909             "group": "Body",
12910             "type": "Integer",
12911             "optional": true,
12912             "field": "dialAgentRejectMaxRetry",
12913             "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
12914           },
12915           {
12916             "group": "Body",
12917             "type": "Integer",
12918             "optional": true,
12919             "field": "dialAgentRejectRetryFrequency",
12920             "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
12921           }
12922         ]
12923       }
12924     },
12925     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12926     "version": "0.0.0",
12927     "filename": "server/api/campaign/index.js",
12928     "groupTitle": "IVR_Campaigns"
12929   },
12930   {
12931     "type": "delete",
12932     "url": "/api/campaigns/{id}",
12933     "title": "Deletes a IVR Campaign",
12934     "examples": [
12935       {
12936         "title": "Example usage:",
12937         "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password} -X DELETE",
12938         "type": "json"
12939       }
12940     ],
12941     "name": "DeleteIVR_Campaigns",
12942     "group": "IVR_Campaigns",
12943     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12944     "version": "0.0.0",
12945     "filename": "server/api/campaign/index.js",
12946     "groupTitle": "IVR_Campaigns"
12947   },
12948   {
12949     "type": "get",
12950     "url": "/api/campaigns/{id}/blacklists",
12951     "title": "Get IVR campaign blacklists",
12952     "examples": [
12953       {
12954         "title": "Example usage:",
12955         "content": "curl https://{domain}/api/campaigns/{id}/blacklists -v -u {name}:{password} -X GET",
12956         "type": "json"
12957       }
12958     ],
12959     "name": "GetBlackLists",
12960     "group": "IVR_Campaigns",
12961     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12962     "version": "0.0.0",
12963     "filename": "server/api/campaign/index.js",
12964     "groupTitle": "IVR_Campaigns"
12965   },
12966   {
12967     "type": "get",
12968     "url": "/api/campaigns/{id}/finals",
12969     "title": "Gets IVR campaign hopper finals",
12970     "examples": [
12971       {
12972         "title": "Example usage:",
12973         "content": "curl https://{domain}/api/campaigns/{id}/hopper_finals -v -u {name}:{password}  -X GET",
12974         "type": "json"
12975       }
12976     ],
12977     "name": "GetHopperFinals",
12978     "group": "IVR_Campaigns",
12979     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12980     "version": "0.0.0",
12981     "filename": "server/api/campaign/index.js",
12982     "groupTitle": "IVR_Campaigns"
12983   },
12984   {
12985     "type": "get",
12986     "url": "/api/campaigns/{id}/hopper_histories",
12987     "title": "Gets IVR campaign hopper histories",
12988     "examples": [
12989       {
12990         "title": "Example usage:",
12991         "content": "curl https://{domain}/api/campaigns/{id}/hopper_histories -v -u {name}:{password} -X GET",
12992         "type": "json"
12993       }
12994     ],
12995     "name": "GetHopperHistories",
12996     "group": "IVR_Campaigns",
12997     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12998     "version": "0.0.0",
12999     "filename": "server/api/campaign/index.js",
13000     "groupTitle": "IVR_Campaigns"
13001   },
13002   {
13003     "type": "get",
13004     "url": "/api/campaigns/{id}/hoppers",
13005     "title": "Gets IVR campaign hoppers",
13006     "examples": [
13007       {
13008         "title": "Example usage:",
13009         "content": "curl https://{domain}/api/campaigns/{id}/hoppers -v -u {name}:{password} -X GET",
13010         "type": "json"
13011       }
13012     ],
13013     "name": "GetHoppers",
13014     "group": "IVR_Campaigns",
13015     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13016     "version": "0.0.0",
13017     "filename": "server/api/campaign/index.js",
13018     "groupTitle": "IVR_Campaigns"
13019   },
13020   {
13021     "type": "get",
13022     "url": "/api/campaigns",
13023     "title": "Gets a list of IVR Campaigns",
13024     "examples": [
13025       {
13026         "title": "Example usage:",
13027         "content": "curl https://{domain}/api/campaigns -v -u {name}:{password}",
13028         "type": "json"
13029       }
13030     ],
13031     "name": "GetIVR_Campaigns",
13032     "group": "IVR_Campaigns",
13033     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/campaigns?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/campaigns?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/campaigns?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/campaigns?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/campaigns?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
13034     "version": "0.0.0",
13035     "filename": "server/api/campaign/index.js",
13036     "groupTitle": "IVR_Campaigns"
13037   },
13038   {
13039     "type": "get",
13040     "url": "/api/campaigns/{id}/lists",
13041     "title": "Get IVR campaign lists",
13042     "examples": [
13043       {
13044         "title": "Example usage:",
13045         "content": "curl https://{domain}/api/campaigns/{id}/lists -v -u {name}:{password} -X GET",
13046         "type": "json"
13047       }
13048     ],
13049     "name": "GetLists",
13050     "group": "IVR_Campaigns",
13051     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13052     "version": "0.0.0",
13053     "filename": "server/api/campaign/index.js",
13054     "groupTitle": "IVR_Campaigns"
13055   },
13056   {
13057     "type": "delete",
13058     "url": "/api/campaigns/{id}/blacklists",
13059     "title": "Remove blacklists from an IVR Campaign",
13060     "examples": [
13061       {
13062         "title": "Example usage:",
13063         "content": "curl https://{domain}/api/campaigns/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
13064         "type": "json"
13065       }
13066     ],
13067     "name": "RemoveBlackLists",
13068     "group": "IVR_Campaigns",
13069     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13070     "version": "0.0.0",
13071     "filename": "server/api/campaign/index.js",
13072     "groupTitle": "IVR_Campaigns"
13073   },
13074   {
13075     "type": "delete",
13076     "url": "/api/campaigns/{id}/lists",
13077     "title": "Remove lists from an IVR Campaign",
13078     "examples": [
13079       {
13080         "title": "Example usage:",
13081         "content": "curl https://{domain}/api/campaigns/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
13082         "type": "json"
13083       }
13084     ],
13085     "name": "RemoveLists",
13086     "group": "IVR_Campaigns",
13087     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13088     "version": "0.0.0",
13089     "filename": "server/api/campaign/index.js",
13090     "groupTitle": "IVR_Campaigns"
13091   },
13092   {
13093     "type": "get",
13094     "url": "/api/campaigns/{id}",
13095     "title": "Gets a single IVR Campaign",
13096     "examples": [
13097       {
13098         "title": "Example usage:",
13099         "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password}",
13100         "type": "json"
13101       }
13102     ],
13103     "name": "ShowIVR_Campaigns",
13104     "group": "IVR_Campaigns",
13105     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13106     "version": "0.0.0",
13107     "filename": "server/api/campaign/index.js",
13108     "groupTitle": "IVR_Campaigns"
13109   },
13110   {
13111     "type": "get",
13112     "url": "/api/campaigns/{id}/blacks",
13113     "title": "Gets IVR campaign hopper blacks",
13114     "examples": [
13115       {
13116         "title": "Example usage:",
13117         "content": "curl https://{domain}/api/campaigns/{id}/hopper_black -v -u {name}:{password}  -X GET",
13118         "type": "json"
13119       }
13120     ],
13121     "name": "getHopperBlacks",
13122     "group": "IVR_Campaigns",
13123     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13124     "version": "0.0.0",
13125     "filename": "server/api/campaign/index.js",
13126     "groupTitle": "IVR_Campaigns"
13127   },
13128   {
13129     "type": "put",
13130     "url": "/api/campaigns/{id}",
13131     "title": "Update an existing IVR Campaign",
13132     "examples": [
13133       {
13134         "title": "Example usage:",
13135         "content": "curl https://{domain}/api/campaigns/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
13136         "type": "json"
13137       }
13138     ],
13139     "name": "updateIVR_Campaigns",
13140     "group": "IVR_Campaigns",
13141     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13142     "version": "0.0.0",
13143     "filename": "server/api/campaign/index.js",
13144     "groupTitle": "IVR_Campaigns"
13145   },
13146   {
13147     "type": "post",
13148     "url": "/api/integrations/reports",
13149     "title": "Creates a new Integration Report",
13150     "examples": [
13151       {
13152         "title": "Example usage:",
13153         "content": "curl https://{domain}/api/integrations/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13154         "type": "json"
13155       }
13156     ],
13157     "name": "CreateIntegration_Reports",
13158     "group": "Integration_Reports",
13159     "parameter": {
13160       "fields": {
13161         "Body": [
13162           {
13163             "group": "Body",
13164             "type": "String",
13165             "optional": true,
13166             "field": "integration",
13167             "description": ""
13168           },
13169           {
13170             "group": "Body",
13171             "type": "String",
13172             "optional": true,
13173             "field": "eventChannel",
13174             "description": ""
13175           },
13176           {
13177             "group": "Body",
13178             "type": "String",
13179             "optional": true,
13180             "field": "exitStatus",
13181             "description": ""
13182           },
13183           {
13184             "group": "Body",
13185             "type": "String",
13186             "optional": true,
13187             "field": "ticketId",
13188             "description": ""
13189           },
13190           {
13191             "group": "Body",
13192             "type": "Integer",
13193             "optional": true,
13194             "field": "integrationId",
13195             "description": ""
13196           },
13197           {
13198             "group": "Body",
13199             "type": "String",
13200             "optional": true,
13201             "field": "contacts",
13202             "description": ""
13203           },
13204           {
13205             "group": "Body",
13206             "type": "String",
13207             "optional": true,
13208             "field": "uniqueid",
13209             "description": ""
13210           },
13211           {
13212             "group": "Body",
13213             "type": "String",
13214             "optional": true,
13215             "field": "calleridnum",
13216             "description": ""
13217           },
13218           {
13219             "group": "Body",
13220             "type": "String",
13221             "optional": true,
13222             "field": "calleridname",
13223             "description": ""
13224           },
13225           {
13226             "group": "Body",
13227             "type": "String",
13228             "optional": true,
13229             "field": "queue",
13230             "description": ""
13231           },
13232           {
13233             "group": "Body",
13234             "type": "String",
13235             "optional": true,
13236             "field": "interface",
13237             "description": ""
13238           },
13239           {
13240             "group": "Body",
13241             "type": "String",
13242             "optional": true,
13243             "field": "membername",
13244             "description": ""
13245           },
13246           {
13247             "group": "Body",
13248             "type": "String",
13249             "optional": true,
13250             "field": "agentcalledAt",
13251             "description": ""
13252           },
13253           {
13254             "group": "Body",
13255             "type": "String",
13256             "optional": true,
13257             "field": "agentconnectAt",
13258             "description": ""
13259           },
13260           {
13261             "group": "Body",
13262             "type": "Integer",
13263             "optional": true,
13264             "field": "holdtime",
13265             "description": ""
13266           },
13267           {
13268             "group": "Body",
13269             "type": "Boolean",
13270             "optional": true,
13271             "field": "agentcomplete",
13272             "description": ""
13273           },
13274           {
13275             "group": "Body",
13276             "type": "String",
13277             "optional": true,
13278             "field": "agentcompleteAt",
13279             "description": ""
13280           },
13281           {
13282             "group": "Body",
13283             "type": "Integer",
13284             "optional": true,
13285             "field": "talktime",
13286             "description": ""
13287           },
13288           {
13289             "group": "Body",
13290             "type": "Boolean",
13291             "optional": true,
13292             "field": "agentacw",
13293             "description": ""
13294           },
13295           {
13296             "group": "Body",
13297             "type": "Integer",
13298             "optional": true,
13299             "field": "acwtime",
13300             "description": ""
13301           },
13302           {
13303             "group": "Body",
13304             "type": "String",
13305             "optional": true,
13306             "field": "reason",
13307             "description": ""
13308           },
13309           {
13310             "group": "Body",
13311             "type": "Boolean",
13312             "optional": true,
13313             "field": "agentringnoanswer",
13314             "description": ""
13315           },
13316           {
13317             "group": "Body",
13318             "type": "String",
13319             "optional": true,
13320             "field": "agentringnoanswerAt",
13321             "description": ""
13322           },
13323           {
13324             "group": "Body",
13325             "type": "Boolean",
13326             "optional": true,
13327             "field": "agentdump",
13328             "description": ""
13329           },
13330           {
13331             "group": "Body",
13332             "type": "String",
13333             "optional": true,
13334             "field": "agentdumpAt",
13335             "description": ""
13336           },
13337           {
13338             "group": "Body",
13339             "type": "String",
13340             "optional": true,
13341             "field": "lastevent",
13342             "description": ""
13343           },
13344           {
13345             "group": "Body",
13346             "type": "String",
13347             "optional": true,
13348             "field": "channel",
13349             "description": ""
13350           },
13351           {
13352             "group": "Body",
13353             "type": "Integer",
13354             "optional": true,
13355             "field": "channelstate",
13356             "description": ""
13357           },
13358           {
13359             "group": "Body",
13360             "type": "String",
13361             "optional": true,
13362             "field": "channelstatedesc",
13363             "description": ""
13364           },
13365           {
13366             "group": "Body",
13367             "type": "String",
13368             "optional": true,
13369             "field": "connectedlinenum",
13370             "description": ""
13371           },
13372           {
13373             "group": "Body",
13374             "type": "String",
13375             "optional": true,
13376             "field": "connectedlinename",
13377             "description": ""
13378           },
13379           {
13380             "group": "Body",
13381             "type": "String",
13382             "optional": true,
13383             "field": "language",
13384             "description": ""
13385           },
13386           {
13387             "group": "Body",
13388             "type": "String",
13389             "optional": true,
13390             "field": "accountcode",
13391             "description": ""
13392           },
13393           {
13394             "group": "Body",
13395             "type": "String",
13396             "optional": true,
13397             "field": "context",
13398             "description": ""
13399           },
13400           {
13401             "group": "Body",
13402             "type": "String",
13403             "optional": true,
13404             "field": "exten",
13405             "description": ""
13406           },
13407           {
13408             "group": "Body",
13409             "type": "String",
13410             "optional": true,
13411             "field": "priority",
13412             "description": ""
13413           },
13414           {
13415             "group": "Body",
13416             "type": "String",
13417             "optional": true,
13418             "field": "destchannel",
13419             "description": ""
13420           },
13421           {
13422             "group": "Body",
13423             "type": "Integer",
13424             "optional": true,
13425             "field": "destchannelstate",
13426             "description": ""
13427           },
13428           {
13429             "group": "Body",
13430             "type": "String",
13431             "optional": true,
13432             "field": "destchannelstatedesc",
13433             "description": ""
13434           },
13435           {
13436             "group": "Body",
13437             "type": "String",
13438             "optional": true,
13439             "field": "destcalleridnum",
13440             "description": ""
13441           },
13442           {
13443             "group": "Body",
13444             "type": "String",
13445             "optional": true,
13446             "field": "destcalleridname",
13447             "description": ""
13448           },
13449           {
13450             "group": "Body",
13451             "type": "String",
13452             "optional": true,
13453             "field": "destconnectedlinenum",
13454             "description": ""
13455           },
13456           {
13457             "group": "Body",
13458             "type": "String",
13459             "optional": true,
13460             "field": "destconnectedlinename",
13461             "description": ""
13462           },
13463           {
13464             "group": "Body",
13465             "type": "String",
13466             "optional": true,
13467             "field": "destlanguage",
13468             "description": ""
13469           },
13470           {
13471             "group": "Body",
13472             "type": "String",
13473             "optional": true,
13474             "field": "destaccountcode",
13475             "description": ""
13476           },
13477           {
13478             "group": "Body",
13479             "type": "String",
13480             "optional": true,
13481             "field": "destcontext",
13482             "description": ""
13483           },
13484           {
13485             "group": "Body",
13486             "type": "String",
13487             "optional": true,
13488             "field": "destexten",
13489             "description": ""
13490           },
13491           {
13492             "group": "Body",
13493             "type": "String",
13494             "optional": true,
13495             "field": "destpriority",
13496             "description": ""
13497           },
13498           {
13499             "group": "Body",
13500             "type": "String",
13501             "optional": true,
13502             "field": "destuniqueid",
13503             "description": ""
13504           },
13505           {
13506             "group": "Body",
13507             "type": "String",
13508             "optional": true,
13509             "field": "messageId",
13510             "description": ""
13511           },
13512           {
13513             "group": "Body",
13514             "type": "String",
13515             "optional": true,
13516             "field": "inReplyTo",
13517             "description": ""
13518           },
13519           {
13520             "group": "Body",
13521             "type": "String",
13522             "optional": true,
13523             "field": "subject",
13524             "description": ""
13525           },
13526           {
13527             "group": "Body",
13528             "type": "String",
13529             "optional": true,
13530             "field": "from",
13531             "description": ""
13532           },
13533           {
13534             "group": "Body",
13535             "type": "String",
13536             "optional": true,
13537             "field": "to",
13538             "description": ""
13539           },
13540           {
13541             "group": "Body",
13542             "type": "String",
13543             "optional": true,
13544             "field": "cc",
13545             "description": ""
13546           },
13547           {
13548             "group": "Body",
13549             "type": "Text",
13550             "optional": true,
13551             "field": "attachment",
13552             "description": ""
13553           },
13554           {
13555             "group": "Body",
13556             "type": "Text",
13557             "optional": true,
13558             "field": "html",
13559             "description": ""
13560           },
13561           {
13562             "group": "Body",
13563             "type": "Text",
13564             "optional": true,
13565             "field": "text",
13566             "description": ""
13567           },
13568           {
13569             "group": "Body",
13570             "type": "String",
13571             "allowedValues": [
13572               "\"SENT\"",
13573               "\"SENDING\"",
13574               "\"RECEIVED\"",
13575               "\"FAILED\""
13576             ],
13577             "optional": true,
13578             "field": "status",
13579             "description": ""
13580           },
13581           {
13582             "group": "Body",
13583             "type": "String",
13584             "optional": true,
13585             "field": "url",
13586             "description": ""
13587           },
13588           {
13589             "group": "Body",
13590             "type": "String",
13591             "optional": true,
13592             "field": "app",
13593             "description": ""
13594           },
13595           {
13596             "group": "Body",
13597             "type": "String",
13598             "optional": true,
13599             "field": "appdata",
13600             "description": ""
13601           },
13602           {
13603             "group": "Body",
13604             "type": "Integer",
13605             "optional": true,
13606             "field": "projectId",
13607             "description": ""
13608           }
13609         ]
13610       }
13611     },
13612     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13613     "version": "0.0.0",
13614     "filename": "server/api/integrationReport/index.js",
13615     "groupTitle": "Integration_Reports"
13616   },
13617   {
13618     "type": "delete",
13619     "url": "/api/integrations/reports/{id}",
13620     "title": "Deletes a Integration Report",
13621     "examples": [
13622       {
13623         "title": "Example usage:",
13624         "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password} -X DELETE",
13625         "type": "json"
13626       }
13627     ],
13628     "name": "DeleteIntegration_Reports",
13629     "group": "Integration_Reports",
13630     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13631     "version": "0.0.0",
13632     "filename": "server/api/integrationReport/index.js",
13633     "groupTitle": "Integration_Reports"
13634   },
13635   {
13636     "type": "get",
13637     "url": "/api/integrations/reports/describe",
13638     "title": "Gets table info about Integration Reports",
13639     "examples": [
13640       {
13641         "title": "Example usage:",
13642         "content": "curl https://{domain}/api/integrations/reports/describe -v -u {name}:{password}",
13643         "type": "json"
13644       }
13645     ],
13646     "name": "DescribeIntegration_Reports",
13647     "group": "Integration_Reports",
13648     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13649     "version": "0.0.0",
13650     "filename": "server/api/integrationReport/index.js",
13651     "groupTitle": "Integration_Reports"
13652   },
13653   {
13654     "type": "get",
13655     "url": "/api/integrations/reports",
13656     "title": "Gets a list of Integration Reports",
13657     "examples": [
13658       {
13659         "title": "Example usage:",
13660         "content": "curl https://{domain}/api/integrations/reports -v -u {name}:{password}",
13661         "type": "json"
13662       }
13663     ],
13664     "name": "GetIntegration_Reports",
13665     "group": "Integration_Reports",
13666     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/reports?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
13667     "version": "0.0.0",
13668     "filename": "server/api/integrationReport/index.js",
13669     "groupTitle": "Integration_Reports"
13670   },
13671   {
13672     "type": "get",
13673     "url": "/api/integrations/reports/{id}",
13674     "title": "Gets a single Integration Report",
13675     "examples": [
13676       {
13677         "title": "Example usage:",
13678         "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password}",
13679         "type": "json"
13680       }
13681     ],
13682     "name": "ShowIntegration_Reports",
13683     "group": "Integration_Reports",
13684     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13685     "version": "0.0.0",
13686     "filename": "server/api/integrationReport/index.js",
13687     "groupTitle": "Integration_Reports"
13688   },
13689   {
13690     "type": "put",
13691     "url": "/api/integrations/reports/{id}",
13692     "title": "Update an existing Integration Report",
13693     "examples": [
13694       {
13695         "title": "Example usage:",
13696         "content": "curl https://{domain}/api/integrations/reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
13697         "type": "json"
13698       }
13699     ],
13700     "name": "updateIntegration_Reports",
13701     "group": "Integration_Reports",
13702     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13703     "version": "0.0.0",
13704     "filename": "server/api/integrationReport/index.js",
13705     "groupTitle": "Integration_Reports"
13706   },
13707   {
13708     "type": "post",
13709     "url": "/api/intervals",
13710     "title": "Creates a new Interval",
13711     "examples": [
13712       {
13713         "title": "Example usage:",
13714         "content": "curl https://{domain}/api/intervals -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13715         "type": "json"
13716       }
13717     ],
13718     "name": "CreateIntervals",
13719     "group": "Intervals",
13720     "parameter": {
13721       "fields": {
13722         "Body": [
13723           {
13724             "group": "Body",
13725             "type": "String",
13726             "optional": true,
13727             "field": "name",
13728             "description": ""
13729           },
13730           {
13731             "group": "Body",
13732             "type": "String",
13733             "optional": true,
13734             "field": "description",
13735             "description": ""
13736           },
13737           {
13738             "group": "Body",
13739             "type": "String",
13740             "optional": true,
13741             "field": "interval",
13742             "description": ""
13743           }
13744         ]
13745       }
13746     },
13747     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13748     "version": "0.0.0",
13749     "filename": "server/api/interval/index.js",
13750     "groupTitle": "Intervals"
13751   },
13752   {
13753     "type": "delete",
13754     "url": "/api/intervals/{id}",
13755     "title": "Deletes a Interval",
13756     "examples": [
13757       {
13758         "title": "Example usage:",
13759         "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password} -X DELETE",
13760         "type": "json"
13761       }
13762     ],
13763     "name": "DeleteIntervals",
13764     "group": "Intervals",
13765     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13766     "version": "0.0.0",
13767     "filename": "server/api/interval/index.js",
13768     "groupTitle": "Intervals"
13769   },
13770   {
13771     "type": "get",
13772     "url": "/api/intervals",
13773     "title": "Gets a list of Intervals",
13774     "examples": [
13775       {
13776         "title": "Example usage:",
13777         "content": "curl https://{domain}/api/intervals -v -u {name}:{password}",
13778         "type": "json"
13779       }
13780     ],
13781     "name": "GetIntervals",
13782     "group": "Intervals",
13783     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/intervals?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/intervals?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/intervals?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/intervals?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/intervals?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
13784     "version": "0.0.0",
13785     "filename": "server/api/interval/index.js",
13786     "groupTitle": "Intervals"
13787   },
13788   {
13789     "type": "get",
13790     "url": "/api/intervals/{id}",
13791     "title": "Gets a single Interval",
13792     "examples": [
13793       {
13794         "title": "Example usage:",
13795         "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password}",
13796         "type": "json"
13797       }
13798     ],
13799     "name": "ShowIntervals",
13800     "group": "Intervals",
13801     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13802     "version": "0.0.0",
13803     "filename": "server/api/interval/index.js",
13804     "groupTitle": "Intervals"
13805   },
13806   {
13807     "type": "post",
13808     "url": "/api/intervals/{id}/sub_intervals",
13809     "title": "Creates a new sub interval",
13810     "examples": [
13811       {
13812         "title": "Example usage:",
13813         "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -d '{\"interval\": \"00:00-08:30,mon-fri,*,*\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
13814         "type": "json"
13815       }
13816     ],
13817     "name": "addInterval",
13818     "group": "Intervals",
13819     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13820     "version": "0.0.0",
13821     "filename": "server/api/interval/index.js",
13822     "groupTitle": "Intervals"
13823   },
13824   {
13825     "type": "post",
13826     "url": "/api/intervals/{id}/sub_intervals/create_many",
13827     "title": "Create new sub intervals set",
13828     "examples": [
13829       {
13830         "title": "Example usage:",
13831         "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
13832         "type": "json"
13833       }
13834     ],
13835     "name": "addIntervals",
13836     "group": "Intervals",
13837     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13838     "version": "0.0.0",
13839     "filename": "server/api/interval/index.js",
13840     "groupTitle": "Intervals"
13841   },
13842   {
13843     "type": "get",
13844     "url": "/api/intervals/{id}/sub_intervals",
13845     "title": "Get sub intervals set",
13846     "examples": [
13847       {
13848         "title": "Example usage:",
13849         "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -v -u {name}:{password} -X GET",
13850         "type": "json"
13851       }
13852     ],
13853     "name": "getIntervals",
13854     "group": "Intervals",
13855     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13856     "version": "0.0.0",
13857     "filename": "server/api/interval/index.js",
13858     "groupTitle": "Intervals"
13859   },
13860   {
13861     "type": "put",
13862     "url": "/api/intervals/{id}",
13863     "title": "Update an existing Interval",
13864     "examples": [
13865       {
13866         "title": "Example usage:",
13867         "content": "curl https://{domain}/api/intervals/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
13868         "type": "json"
13869       }
13870     ],
13871     "name": "updateIntervals",
13872     "group": "Intervals",
13873     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13874     "version": "0.0.0",
13875     "filename": "server/api/interval/index.js",
13876     "groupTitle": "Intervals"
13877   },
13878   {
13879     "type": "post",
13880     "url": "/api/jira",
13881     "title": "Creates a new issue",
13882     "examples": [
13883       {
13884         "title": "Example usage:",
13885         "content": "curl https://{domain}/api/jira -d '{\"key\": \"Bug\", \"description\": \"I can't do it!\"}' \\\n -H \"Content-Type: application/json\" -X POST -v -u {name}:{password}",
13886         "type": "json"
13887       }
13888     ],
13889     "name": "Creates_Issue",
13890     "group": "Issue",
13891     "parameter": {
13892       "fields": {
13893         "Body": [
13894           {
13895             "group": "Body",
13896             "type": "String",
13897             "allowedValues": [
13898               "\"Bug\""
13899             ],
13900             "optional": true,
13901             "field": "issuetype",
13902             "description": ""
13903           },
13904           {
13905             "group": "Body",
13906             "type": "String",
13907             "optional": false,
13908             "field": "summary",
13909             "description": ""
13910           },
13911           {
13912             "group": "Body",
13913             "type": "String",
13914             "optional": false,
13915             "field": "description",
13916             "description": ""
13917           }
13918         ]
13919       }
13920     },
13921     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13922     "version": "0.0.0",
13923     "filename": "server/api/jira/index.js",
13924     "groupTitle": "Issue"
13925   },
13926   {
13927     "type": "post",
13928     "url": "/api/jscripty/answers/reports",
13929     "title": "Creates a new Report",
13930     "examples": [
13931       {
13932         "title": "Example usage:",
13933         "content": "curl https://{domain}/api/jscripty/answers/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13934         "type": "json"
13935       }
13936     ],
13937     "name": "CreateReports",
13938     "group": "JscriptyAnswerReport",
13939     "parameter": {
13940       "fields": {
13941         "Body": [
13942           {
13943             "group": "Body",
13944             "type": "Text",
13945             "optional": true,
13946             "field": "question",
13947             "description": ""
13948           },
13949           {
13950             "group": "Body",
13951             "type": "Text",
13952             "optional": true,
13953             "field": "answer",
13954             "description": ""
13955           },
13956           {
13957             "group": "Body",
13958             "type": "String",
13959             "optional": true,
13960             "field": "membername",
13961             "description": ""
13962           },
13963           {
13964             "group": "Body",
13965             "type": "String",
13966             "optional": true,
13967             "field": "projectname",
13968             "description": ""
13969           },
13970           {
13971             "group": "Body",
13972             "type": "String",
13973             "optional": true,
13974             "field": "queue",
13975             "description": ""
13976           },
13977           {
13978             "group": "Body",
13979             "type": "String",
13980             "optional": true,
13981             "field": "uniqueid",
13982             "description": ""
13983           },
13984           {
13985             "group": "Body",
13986             "type": "String",
13987             "optional": true,
13988             "field": "calleridname",
13989             "description": ""
13990           },
13991           {
13992             "group": "Body",
13993             "type": "String",
13994             "optional": true,
13995             "field": "calleridnum",
13996             "description": ""
13997           },
13998           {
13999             "group": "Body",
14000             "type": "String",
14001             "optional": true,
14002             "field": "questionId",
14003             "description": ""
14004           }
14005         ]
14006       }
14007     },
14008     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14009     "version": "0.0.0",
14010     "filename": "server/api/jscriptyAnswerReport/index.js",
14011     "groupTitle": "JscriptyAnswerReport"
14012   },
14013   {
14014     "type": "delete",
14015     "url": "/api/jscripty/answers/reports/{id}",
14016     "title": "Deletes a Report",
14017     "examples": [
14018       {
14019         "title": "Example usage:",
14020         "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password} -X DELETE",
14021         "type": "json"
14022       }
14023     ],
14024     "name": "DeleteReports",
14025     "group": "JscriptyAnswerReport",
14026     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14027     "version": "0.0.0",
14028     "filename": "server/api/jscriptyAnswerReport/index.js",
14029     "groupTitle": "JscriptyAnswerReport"
14030   },
14031   {
14032     "type": "get",
14033     "url": "/api/jscripty/answers/reports/describe",
14034     "title": "Gets table info about Reports",
14035     "examples": [
14036       {
14037         "title": "Example usage:",
14038         "content": "curl https://{domain}/api/jscripty/answers/reports/describe -v -u {name}:{password}",
14039         "type": "json"
14040       }
14041     ],
14042     "name": "DescribeReports",
14043     "group": "JscriptyAnswerReport",
14044     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14045     "version": "0.0.0",
14046     "filename": "server/api/jscriptyAnswerReport/index.js",
14047     "groupTitle": "JscriptyAnswerReport"
14048   },
14049   {
14050     "type": "get",
14051     "url": "/api/jscripty/answers/reports",
14052     "title": "Gets a list of Reports",
14053     "examples": [
14054       {
14055         "title": "Example usage:",
14056         "content": "curl https://{domain}/api/jscripty/answers/reports -v -u {name}:{password}",
14057         "type": "json"
14058       }
14059     ],
14060     "name": "GetReports",
14061     "group": "JscriptyAnswerReport",
14062     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/jscripty/answers/reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/jscripty/answers/reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/jscripty/answers/reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/jscripty/answers/reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/jscripty/answers/reports?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
14063     "version": "0.0.0",
14064     "filename": "server/api/jscriptyAnswerReport/index.js",
14065     "groupTitle": "JscriptyAnswerReport"
14066   },
14067   {
14068     "type": "get",
14069     "url": "/api/jscripty/answers/reports/{id}",
14070     "title": "Gets a single Report",
14071     "examples": [
14072       {
14073         "title": "Example usage:",
14074         "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password}",
14075         "type": "json"
14076       }
14077     ],
14078     "name": "ShowReports",
14079     "group": "JscriptyAnswerReport",
14080     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14081     "version": "0.0.0",
14082     "filename": "server/api/jscriptyAnswerReport/index.js",
14083     "groupTitle": "JscriptyAnswerReport"
14084   },
14085   {
14086     "type": "put",
14087     "url": "/api/jscripty/answers/reports/{id}",
14088     "title": "Update an existing Report",
14089     "examples": [
14090       {
14091         "title": "Example usage:",
14092         "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
14093         "type": "json"
14094       }
14095     ],
14096     "name": "updateReports",
14097     "group": "JscriptyAnswerReport",
14098     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14099     "version": "0.0.0",
14100     "filename": "server/api/jscriptyAnswerReport/index.js",
14101     "groupTitle": "JscriptyAnswerReport"
14102   },
14103   {
14104     "type": "post",
14105     "url": "/api/jscripty/questions/reports",
14106     "title": "Creates a new Report",
14107     "examples": [
14108       {
14109         "title": "Example usage:",
14110         "content": "curl https://{domain}/api/jscripty/questions/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
14111         "type": "json"
14112       }
14113     ],
14114     "name": "CreateReports",
14115     "group": "JscriptyQuestionReport",
14116     "parameter": {
14117       "fields": {
14118         "Body": [
14119           {
14120             "group": "Body",
14121             "type": "Text",
14122             "optional": true,
14123             "field": "question",
14124             "description": ""
14125           },
14126           {
14127             "group": "Body",
14128             "type": "Text",
14129             "optional": true,
14130             "field": "answer",
14131             "description": ""
14132           },
14133           {
14134             "group": "Body",
14135             "type": "String",
14136             "optional": true,
14137             "field": "membername",
14138             "description": ""
14139           },
14140           {
14141             "group": "Body",
14142             "type": "String",
14143             "optional": true,
14144             "field": "projectname",
14145             "description": ""
14146           },
14147           {
14148             "group": "Body",
14149             "type": "String",
14150             "optional": true,
14151             "field": "queue",
14152             "description": ""
14153           },
14154           {
14155             "group": "Body",
14156             "type": "String",
14157             "optional": true,
14158             "field": "uniqueid",
14159             "description": ""
14160           },
14161           {
14162             "group": "Body",
14163             "type": "String",
14164             "optional": true,
14165             "field": "calleridname",
14166             "description": ""
14167           },
14168           {
14169             "group": "Body",
14170             "type": "String",
14171             "optional": true,
14172             "field": "calleridnum",
14173             "description": ""
14174           },
14175           {
14176             "group": "Body",
14177             "type": "String",
14178             "optional": true,
14179             "field": "questionId",
14180             "description": ""
14181           }
14182         ]
14183       }
14184     },
14185     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14186     "version": "0.0.0",
14187     "filename": "server/api/jscriptyQuestionReport/index.js",
14188     "groupTitle": "JscriptyQuestionReport"
14189   },
14190   {
14191     "type": "delete",
14192     "url": "/api/jscripty/questions/reports/{id}",
14193     "title": "Deletes a Report",
14194     "examples": [
14195       {
14196         "title": "Example usage:",
14197         "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password} -X DELETE",
14198         "type": "json"
14199       }
14200     ],
14201     "name": "DeleteReports",
14202     "group": "JscriptyQuestionReport",
14203     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14204     "version": "0.0.0",
14205     "filename": "server/api/jscriptyQuestionReport/index.js",
14206     "groupTitle": "JscriptyQuestionReport"
14207   },
14208   {
14209     "type": "get",
14210     "url": "/api/jscripty/questions/reports/describe",
14211     "title": "Gets table info about Reports",
14212     "examples": [
14213       {
14214         "title": "Example usage:",
14215         "content": "curl https://{domain}/api/jscripty/questions/reports/describe -v -u {name}:{password}",
14216         "type": "json"
14217       }
14218     ],
14219     "name": "DescribeReports",
14220     "group": "JscriptyQuestionReport",
14221     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14222     "version": "0.0.0",
14223     "filename": "server/api/jscriptyQuestionReport/index.js",
14224     "groupTitle": "JscriptyQuestionReport"
14225   },
14226   {
14227     "type": "get",
14228     "url": "/api/jscripty/questions/reports",
14229     "title": "Gets a list of Reports",
14230     "examples": [
14231       {
14232         "title": "Example usage:",
14233         "content": "curl https://{domain}/api/jscripty/questions/reports -v -u {name}:{password}",
14234         "type": "json"
14235       }
14236     ],
14237     "name": "GetReports",
14238     "group": "JscriptyQuestionReport",
14239     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/jscripty/questions/reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/jscripty/questions/reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/jscripty/questions/reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/jscripty/questions/reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/jscripty/questions/reports?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
14240     "version": "0.0.0",
14241     "filename": "server/api/jscriptyQuestionReport/index.js",
14242     "groupTitle": "JscriptyQuestionReport"
14243   },
14244   {
14245     "type": "get",
14246     "url": "/api/jscripty/questions/reports/{id}",
14247     "title": "Gets a single Report",
14248     "examples": [
14249       {
14250         "title": "Example usage:",
14251         "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password}",
14252         "type": "json"
14253       }
14254     ],
14255     "name": "ShowReports",
14256     "group": "JscriptyQuestionReport",
14257     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14258     "version": "0.0.0",
14259     "filename": "server/api/jscriptyQuestionReport/index.js",
14260     "groupTitle": "JscriptyQuestionReport"
14261   },
14262   {
14263     "type": "put",
14264     "url": "/api/jscripty/questions/reports/{id}",
14265     "title": "Update an existing Report",
14266     "examples": [
14267       {
14268         "title": "Example usage:",
14269         "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
14270         "type": "json"
14271       }
14272     ],
14273     "name": "updateReports",
14274     "group": "JscriptyQuestionReport",
14275     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14276     "version": "0.0.0",
14277     "filename": "server/api/jscriptyQuestionReport/index.js",
14278     "groupTitle": "JscriptyQuestionReport"
14279   },
14280   {
14281     "type": "post",
14282     "url": "/api/jscripty/sessions/reports",
14283     "title": "Creates a new Report",
14284     "examples": [
14285       {
14286         "title": "Example usage:",
14287         "content": "curl https://{domain}/api/jscripty/sessions/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
14288         "type": "json"
14289       }
14290     ],
14291     "name": "CreateReports",
14292     "group": "JscriptySessionReport",
14293     "parameter": {
14294       "fields": {
14295         "Body": [
14296           {
14297             "group": "Body",
14298             "type": "String",
14299             "optional": true,
14300             "field": "starttime",
14301             "description": ""
14302           },
14303           {
14304             "group": "Body",
14305             "type": "String",
14306             "optional": true,
14307             "field": "endtime",
14308             "description": ""
14309           },
14310           {
14311             "group": "Body",
14312             "type": "String",
14313             "optional": true,
14314             "field": "membername",
14315             "description": ""
14316           },
14317           {
14318             "group": "Body",
14319             "type": "String",
14320             "optional": true,
14321             "field": "projectname",
14322             "description": ""
14323           },
14324           {
14325             "group": "Body",
14326             "type": "String",
14327             "optional": true,
14328             "field": "queue",
14329             "description": ""
14330           },
14331           {
14332             "group": "Body",
14333             "type": "String",
14334             "optional": true,
14335             "field": "uniqueid",
14336             "description": ""
14337           },
14338           {
14339             "group": "Body",
14340             "type": "String",
14341             "optional": true,
14342             "field": "calleridname",
14343             "description": ""
14344           },
14345           {
14346             "group": "Body",
14347             "type": "String",
14348             "optional": true,
14349             "field": "calleridnum",
14350             "description": ""
14351           },
14352           {
14353             "group": "Body",
14354             "type": "Boolean",
14355             "optional": true,
14356             "field": "completed",
14357             "description": ""
14358           }
14359         ]
14360       }
14361     },
14362     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14363     "version": "0.0.0",
14364     "filename": "server/api/jscriptySessionReport/index.js",
14365     "groupTitle": "JscriptySessionReport"
14366   },
14367   {
14368     "type": "delete",
14369     "url": "/api/jscripty/sessions/reports/{id}",
14370     "title": "Deletes a Report",
14371     "examples": [
14372       {
14373         "title": "Example usage:",
14374         "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password} -X DELETE",
14375         "type": "json"
14376       }
14377     ],
14378     "name": "DeleteReports",
14379     "group": "JscriptySessionReport",
14380     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14381     "version": "0.0.0",
14382     "filename": "server/api/jscriptySessionReport/index.js",
14383     "groupTitle": "JscriptySessionReport"
14384   },
14385   {
14386     "type": "get",
14387     "url": "/api/jscripty/sessions/reports/describe",
14388     "title": "Gets table info about Reports",
14389     "examples": [
14390       {
14391         "title": "Example usage:",
14392         "content": "curl https://{domain}/api/jscripty/sessions/reports/describe -v -u {name}:{password}",
14393         "type": "json"
14394       }
14395     ],
14396     "name": "DescribeReports",
14397     "group": "JscriptySessionReport",
14398     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14399     "version": "0.0.0",
14400     "filename": "server/api/jscriptySessionReport/index.js",
14401     "groupTitle": "JscriptySessionReport"
14402   },
14403   {
14404     "type": "get",
14405     "url": "/api/jscripty/sessions/reports",
14406     "title": "Gets a list of Reports",
14407     "examples": [
14408       {
14409         "title": "Example usage:",
14410         "content": "curl https://{domain}/api/jscripty/sessions/reports -v -u {name}:{password}",
14411         "type": "json"
14412       }
14413     ],
14414     "name": "GetReports",
14415     "group": "JscriptySessionReport",
14416     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/jscripty/sessions/reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/jscripty/sessions/reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/jscripty/sessions/reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/jscripty/sessions/reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/jscripty/sessions/reports?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
14417     "version": "0.0.0",
14418     "filename": "server/api/jscriptySessionReport/index.js",
14419     "groupTitle": "JscriptySessionReport"
14420   },
14421   {
14422     "type": "get",
14423     "url": "/api/jscripty/sessions/reports/{id}",
14424     "title": "Gets a single Report",
14425     "examples": [
14426       {
14427         "title": "Example usage:",
14428         "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password}",
14429         "type": "json"
14430       }
14431     ],
14432     "name": "ShowReports",
14433     "group": "JscriptySessionReport",
14434     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14435     "version": "0.0.0",
14436     "filename": "server/api/jscriptySessionReport/index.js",
14437     "groupTitle": "JscriptySessionReport"
14438   },
14439   {
14440     "type": "get",
14441     "url": "/api/jscripty/sessions/reports/{id}/questions",
14442     "title": "Gets Jscripty Session questions",
14443     "examples": [
14444       {
14445         "title": "Example usage:",
14446         "content": "curl https://{domain}/api/jscripty/sessions/reports/{id}/questions -v -u {name}:{password}  -X GET",
14447         "type": "json"
14448       }
14449     ],
14450     "name": "getQuestions",
14451     "group": "JscriptySessionReport",
14452     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14453     "version": "0.0.0",
14454     "filename": "server/api/jscriptySessionReport/index.js",
14455     "groupTitle": "JscriptySessionReport"
14456   },
14457   {
14458     "type": "put",
14459     "url": "/api/jscripty/sessions/reports/{id}",
14460     "title": "Update an existing Report",
14461     "examples": [
14462       {
14463         "title": "Example usage:",
14464         "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
14465         "type": "json"
14466       }
14467     ],
14468     "name": "updateReports",
14469     "group": "JscriptySessionReport",
14470     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14471     "version": "0.0.0",
14472     "filename": "server/api/jscriptySessionReport/index.js",
14473     "groupTitle": "JscriptySessionReport"
14474   },
14475   {
14476     "type": "post",
14477     "url": "/api/jscripty/projects/clone",
14478     "title": "Clone an existing Project",
14479     "examples": [
14480       {
14481         "title": "Example usage:",
14482         "content": "curl https://{domain}/api/jscripty/projects/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
14483         "type": "json"
14484       }
14485     ],
14486     "name": "CloneProjects",
14487     "group": "Jscripty_Projects",
14488     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14489     "version": "0.0.0",
14490     "filename": "server/api/jscriptyProject/index.js",
14491     "groupTitle": "Jscripty_Projects"
14492   },
14493   {
14494     "type": "post",
14495     "url": "/api/jscripty/projects",
14496     "title": "Creates a new Project",
14497     "examples": [
14498       {
14499         "title": "Example usage:",
14500         "content": "curl https://{domain}/api/jscripty/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
14501         "type": "json"
14502       }
14503     ],
14504     "name": "CreateProjects",
14505     "group": "Jscripty_Projects",
14506     "parameter": {
14507       "fields": {
14508         "Body": [
14509           {
14510             "group": "Body",
14511             "type": "String",
14512             "optional": true,
14513             "field": "name",
14514             "description": ""
14515           },
14516           {
14517             "group": "Body",
14518             "type": "String",
14519             "optional": true,
14520             "field": "description",
14521             "description": ""
14522           },
14523           {
14524             "group": "Body",
14525             "type": "Text",
14526             "optional": true,
14527             "field": "formData",
14528             "description": ""
14529           },
14530           {
14531             "group": "Body",
14532             "type": "Boolean",
14533             "optional": true,
14534             "field": "enableUncompleteSave",
14535             "description": ""
14536           },
14537           {
14538             "group": "Body",
14539             "type": "Boolean",
14540             "optional": true,
14541             "field": "sendUnpauseOnSubmit",
14542             "description": ""
14543           }
14544         ]
14545       }
14546     },
14547     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14548     "version": "0.0.0",
14549     "filename": "server/api/jscriptyProject/index.js",
14550     "groupTitle": "Jscripty_Projects"
14551   },
14552   {
14553     "type": "delete",
14554     "url": "/api/jscripty/projects/{id}",
14555     "title": "Deletes a Project",
14556     "examples": [
14557       {
14558         "title": "Example usage:",
14559         "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password} -X DELETE",
14560         "type": "json"
14561       }
14562     ],
14563     "name": "DeleteProjects",
14564     "group": "Jscripty_Projects",
14565     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14566     "version": "0.0.0",
14567     "filename": "server/api/jscriptyProject/index.js",
14568     "groupTitle": "Jscripty_Projects"
14569   },
14570   {
14571     "type": "get",
14572     "url": "/api/jscripty/projects",
14573     "title": "Gets a list of Projects",
14574     "examples": [
14575       {
14576         "title": "Example usage:",
14577         "content": "curl https://{domain}/api/jscripty/projects -v -u {name}:{password}",
14578         "type": "json"
14579       }
14580     ],
14581     "name": "GetProjects",
14582     "group": "Jscripty_Projects",
14583     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/jscripty/projects?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/jscripty/projects?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/jscripty/projects?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/jscripty/projects?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/jscripty/projects?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
14584     "version": "0.0.0",
14585     "filename": "server/api/jscriptyProject/index.js",
14586     "groupTitle": "Jscripty_Projects"
14587   },
14588   {
14589     "type": "get",
14590     "url": "/api/jscripty/projects/{id}",
14591     "title": "Gets a single Project",
14592     "examples": [
14593       {
14594         "title": "Example usage:",
14595         "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password}",
14596         "type": "json"
14597       }
14598     ],
14599     "name": "ShowProjects",
14600     "group": "Jscripty_Projects",
14601     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14602     "version": "0.0.0",
14603     "filename": "server/api/jscriptyProject/index.js",
14604     "groupTitle": "Jscripty_Projects"
14605   },
14606   {
14607     "type": "get",
14608     "url": "/api/jscripty/projects/{id}/answers",
14609     "title": "Gets jscripty project answers",
14610     "examples": [
14611       {
14612         "title": "Example usage:",
14613         "content": "curl https://{domain}/api/jscripty/projects/{id}/answers -v -u {name}:{password}  -X GET",
14614         "type": "json"
14615       }
14616     ],
14617     "name": "getAnswers",
14618     "group": "Jscripty_Projects",
14619     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14620     "version": "0.0.0",
14621     "filename": "server/api/jscriptyProject/index.js",
14622     "groupTitle": "Jscripty_Projects"
14623   },
14624   {
14625     "type": "get",
14626     "url": "/api/jscripty/projects/{id}/sessions",
14627     "title": "Gets jscripty project sessions",
14628     "examples": [
14629       {
14630         "title": "Example usage:",
14631         "content": "curl https://{domain}/api/jscripty/projects/{id}/sessions -v -u {name}:{password}  -X GET",
14632         "type": "json"
14633       }
14634     ],
14635     "name": "getSessions",
14636     "group": "Jscripty_Projects",
14637     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14638     "version": "0.0.0",
14639     "filename": "server/api/jscriptyProject/index.js",
14640     "groupTitle": "Jscripty_Projects"
14641   },
14642   {
14643     "type": "get",
14644     "url": "/api/jscripty/projects/{id}/summary",
14645     "title": "Gets jscripty project summary",
14646     "examples": [
14647       {
14648         "title": "Example usage:",
14649         "content": "curl https://{domain}/api/jscripty/projects/{id}/summary -v -u {name}:{password}  -X GET",
14650         "type": "json"
14651       }
14652     ],
14653     "name": "getSummary",
14654     "group": "Jscripty_Projects",
14655     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14656     "version": "0.0.0",
14657     "filename": "server/api/jscriptyProject/index.js",
14658     "groupTitle": "Jscripty_Projects"
14659   },
14660   {
14661     "type": "put",
14662     "url": "/api/jscripty/projects/{id}",
14663     "title": "Update an existing Project",
14664     "examples": [
14665       {
14666         "title": "Example usage:",
14667         "content": "curl https://{domain}/api/jscripty/projects/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
14668         "type": "json"
14669       }
14670     ],
14671     "name": "updateProjects",
14672     "group": "Jscripty_Projects",
14673     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14674     "version": "0.0.0",
14675     "filename": "server/api/jscriptyProject/index.js",
14676     "groupTitle": "Jscripty_Projects"
14677   },
14678   {
14679     "type": "get",
14680     "url": "/api/license",
14681     "title": "Gets License Info",
14682     "examples": [
14683       {
14684         "title": "Example usage:",
14685         "content": "curl https://{domain}/api/license -v -u {name}:{password} -X GET",
14686         "type": "json"
14687       }
14688     ],
14689     "name": "index",
14690     "group": "License",
14691     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14692     "version": "0.0.0",
14693     "filename": "server/api/license/index.js",
14694     "groupTitle": "License"
14695   },
14696   {
14697     "type": "put",
14698     "url": "/api/license/{id}",
14699     "title": "Update License Info",
14700     "examples": [
14701       {
14702         "title": "Example usage:",
14703         "content": "curl https://{domain}/api/license/{id} -v -u {name}:{password} -X PUT",
14704         "type": "json"
14705       }
14706     ],
14707     "name": "update",
14708     "group": "License",
14709     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14710     "version": "0.0.0",
14711     "filename": "server/api/license/index.js",
14712     "groupTitle": "License"
14713   },
14714   {
14715     "type": "post",
14716     "url": "/api/mail/accounts/{id}/users",
14717     "title": "Add agents to a mail account",
14718     "examples": [
14719       {
14720         "title": "Example usage:",
14721         "content": "curl https://{domain}/api/mail/accounts/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
14722         "type": "json"
14723       }
14724     ],
14725     "name": "AddAgents",
14726     "group": "Mail_Accounts",
14727     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14728     "version": "0.0.0",
14729     "filename": "server/api/mailAccount/index.js",
14730     "groupTitle": "Mail_Accounts"
14731   },
14732   {
14733     "type": "post",
14734     "url": "/api/mail/accounts/{id}/in_servers",
14735     "title": "Creates a new IMAP server",
14736     "examples": [
14737       {
14738         "title": "Example usage:",
14739         "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -d '{\"host\": \"host\", \"username\": \"username\", \"password\": \"password\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
14740         "type": "json"
14741       }
14742     ],
14743     "name": "AddImap",
14744     "group": "Mail_Accounts",
14745     "parameter": {
14746       "fields": {
14747         "Body": [
14748           {
14749             "group": "Body",
14750             "type": "String",
14751             "optional": true,
14752             "field": "description",
14753             "description": ""
14754           },
14755           {
14756             "group": "Body",
14757             "type": "String",
14758             "optional": true,
14759             "field": "host",
14760             "description": ""
14761           },
14762           {
14763             "group": "Body",
14764             "type": "Boolean",
14765             "optional": true,
14766             "field": "authentication",
14767             "description": ""
14768           },
14769           {
14770             "group": "Body",
14771             "type": "String",
14772             "optional": true,
14773             "field": "user",
14774             "description": ""
14775           },
14776           {
14777             "group": "Body",
14778             "type": "String",
14779             "optional": true,
14780             "field": "password",
14781             "description": ""
14782           },
14783           {
14784             "group": "Body",
14785             "type": "Integer",
14786             "optional": true,
14787             "field": "port",
14788             "description": ""
14789           },
14790           {
14791             "group": "Body",
14792             "type": "Boolean",
14793             "optional": true,
14794             "field": "tls",
14795             "description": ""
14796           },
14797           {
14798             "group": "Body",
14799             "type": "String",
14800             "optional": true,
14801             "field": "mailbox",
14802             "description": ""
14803           },
14804           {
14805             "group": "Body",
14806             "type": "Integer",
14807             "optional": true,
14808             "field": "connTimeout",
14809             "description": ""
14810           },
14811           {
14812             "group": "Body",
14813             "type": "Integer",
14814             "optional": true,
14815             "field": "authTimeout",
14816             "description": ""
14817           },
14818           {
14819             "group": "Body",
14820             "type": "String",
14821             "optional": true,
14822             "field": "service",
14823             "description": ""
14824           }
14825         ]
14826       }
14827     },
14828     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14829     "version": "0.0.0",
14830     "filename": "server/api/mailAccount/index.js",
14831     "groupTitle": "Mail_Accounts"
14832   },
14833   {
14834     "type": "post",
14835     "url": "/api/mail/accounts/{id}/out_servers",
14836     "title": "Creates a new SMTP server",
14837     "examples": [
14838       {
14839         "title": "Example usage:",
14840         "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -d '{\"host\": \"host\", \"username\": \"username\", \"password\": \"password\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
14841         "type": "json"
14842       }
14843     ],
14844     "name": "AddSmtp",
14845     "group": "Mail_Accounts",
14846     "parameter": {
14847       "fields": {
14848         "Body": [
14849           {
14850             "group": "Body",
14851             "type": "String",
14852             "optional": true,
14853             "field": "description",
14854             "description": ""
14855           },
14856           {
14857             "group": "Body",
14858             "type": "String",
14859             "optional": true,
14860             "field": "host",
14861             "description": ""
14862           },
14863           {
14864             "group": "Body",
14865             "type": "String",
14866             "optional": true,
14867             "field": "user",
14868             "description": ""
14869           },
14870           {
14871             "group": "Body",
14872             "type": "String",
14873             "optional": true,
14874             "field": "pass",
14875             "description": ""
14876           },
14877           {
14878             "group": "Body",
14879             "type": "Integer",
14880             "optional": true,
14881             "field": "port",
14882             "description": ""
14883           },
14884           {
14885             "group": "Body",
14886             "type": "Boolean",
14887             "optional": true,
14888             "field": "secure",
14889             "description": ""
14890           },
14891           {
14892             "group": "Body",
14893             "type": "String",
14894             "optional": true,
14895             "field": "service",
14896             "description": ""
14897           },
14898           {
14899             "group": "Body",
14900             "type": "Boolean",
14901             "optional": true,
14902             "field": "authentication",
14903             "description": ""
14904           }
14905         ]
14906       }
14907     },
14908     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14909     "version": "0.0.0",
14910     "filename": "server/api/mailAccount/index.js",
14911     "groupTitle": "Mail_Accounts"
14912   },
14913   {
14914     "type": "delete",
14915     "url": "/api/mail/accounts/{id}",
14916     "title": "Deletes a mail account",
14917     "examples": [
14918       {
14919         "title": "Example usage:",
14920         "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password} -X DELETE",
14921         "type": "json"
14922       }
14923     ],
14924     "name": "DeleteMailAccounts",
14925     "group": "Mail_Accounts",
14926     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14927     "version": "0.0.0",
14928     "filename": "server/api/mailAccount/index.js",
14929     "groupTitle": "Mail_Accounts"
14930   },
14931   {
14932     "type": "get",
14933     "url": "/api/mail/accounts/describe",
14934     "title": "Gets table info about Accounts",
14935     "examples": [
14936       {
14937         "title": "Example usage:",
14938         "content": "curl https://{domain}/api/mail/accounts/describe -v -u {name}:{password}",
14939         "type": "json"
14940       }
14941     ],
14942     "name": "DescribeAccounts",
14943     "group": "Mail_Accounts",
14944     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14945     "version": "0.0.0",
14946     "filename": "server/api/mailAccount/index.js",
14947     "groupTitle": "Mail_Accounts"
14948   },
14949   {
14950     "type": "get",
14951     "url": "/api/mail/accounts",
14952     "title": "Gets a list of Accounts",
14953     "examples": [
14954       {
14955         "title": "Example usage:",
14956         "content": "curl https://{domain}/api/mail/accounts -v -u {name}:{password}",
14957         "type": "json"
14958       }
14959     ],
14960     "name": "GetAccounts",
14961     "group": "Mail_Accounts",
14962     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/mail/accounts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/mail/accounts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/mail/accounts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/mail/accounts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/mail/accounts?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
14963     "version": "0.0.0",
14964     "filename": "server/api/mailAccount/index.js",
14965     "groupTitle": "Mail_Accounts"
14966   },
14967   {
14968     "type": "get",
14969     "url": "/api/mail/accounts/{id}/users",
14970     "title": "Gets agents from mail account",
14971     "examples": [
14972       {
14973         "title": "Example usage:",
14974         "content": "curl https://{domain}/api/mail/accounts/{id}/users -v -u {name}:{password} -X GET",
14975         "type": "json"
14976       }
14977     ],
14978     "name": "GetAgents",
14979     "group": "Mail_Accounts",
14980     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14981     "version": "0.0.0",
14982     "filename": "server/api/mailAccount/index.js",
14983     "groupTitle": "Mail_Accounts"
14984   },
14985   {
14986     "type": "get",
14987     "url": "/api/mail/accounts/{id}/in_servers",
14988     "title": "Gets account IMAP server",
14989     "examples": [
14990       {
14991         "title": "Example usage:",
14992         "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X GET",
14993         "type": "json"
14994       }
14995     ],
14996     "name": "GetImap",
14997     "group": "Mail_Accounts",
14998     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14999     "version": "0.0.0",
15000     "filename": "server/api/mailAccount/index.js",
15001     "groupTitle": "Mail_Accounts"
15002   },
15003   {
15004     "type": "get",
15005     "url": "/api/mail/accounts/{id}/out_servers",
15006     "title": "Gets account SMTP server",
15007     "examples": [
15008       {
15009         "title": "Example usage:",
15010         "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X GET",
15011         "type": "json"
15012       }
15013     ],
15014     "name": "GetSmtp",
15015     "group": "Mail_Accounts",
15016     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15017     "version": "0.0.0",
15018     "filename": "server/api/mailAccount/index.js",
15019     "groupTitle": "Mail_Accounts"
15020   },
15021   {
15022     "type": "delete",
15023     "url": "/api/mail/accounts/{id}/users",
15024     "title": "Removes agents from a mail account",
15025     "examples": [
15026       {
15027         "title": "Example usage:",
15028         "content": "curl https://{domain}/api/mail/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15029         "type": "json"
15030       }
15031     ],
15032     "name": "RemoveAgents",
15033     "group": "Mail_Accounts",
15034     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15035     "version": "0.0.0",
15036     "filename": "server/api/mailAccount/index.js",
15037     "groupTitle": "Mail_Accounts"
15038   },
15039   {
15040     "type": "delete",
15041     "url": "/api/mail/accounts/{id}/canned_answers",
15042     "title": "Removes canned answers from account",
15043     "examples": [
15044       {
15045         "title": "Example usage:",
15046         "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15047         "type": "json"
15048       }
15049     ],
15050     "name": "RemoveAnswers",
15051     "group": "Mail_Accounts",
15052     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15053     "version": "0.0.0",
15054     "filename": "server/api/mailAccount/index.js",
15055     "groupTitle": "Mail_Accounts"
15056   },
15057   {
15058     "type": "delete",
15059     "url": "/api/mail/accounts/{id}/dispositions",
15060     "title": "Removes dispositions from account",
15061     "examples": [
15062       {
15063         "title": "Example usage:",
15064         "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15065         "type": "json"
15066       }
15067     ],
15068     "name": "RemoveDispositions",
15069     "group": "Mail_Accounts",
15070     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15071     "version": "0.0.0",
15072     "filename": "server/api/mailAccount/index.js",
15073     "groupTitle": "Mail_Accounts"
15074   },
15075   {
15076     "type": "delete",
15077     "url": "/api/mail/accounts/{id}/in_servers",
15078     "title": "Removes IMAP server from an account",
15079     "examples": [
15080       {
15081         "title": "Example usage:",
15082         "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X DELETE",
15083         "type": "json"
15084       }
15085     ],
15086     "name": "RemoveImmap",
15087     "group": "Mail_Accounts",
15088     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15089     "version": "0.0.0",
15090     "filename": "server/api/mailAccount/index.js",
15091     "groupTitle": "Mail_Accounts"
15092   },
15093   {
15094     "type": "delete",
15095     "url": "/api/mail/accounts/{id}/out_servers",
15096     "title": "Removes SMTP server from an account",
15097     "examples": [
15098       {
15099         "title": "Example usage:",
15100         "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X DELETE",
15101         "type": "json"
15102       }
15103     ],
15104     "name": "RemoveSmtp",
15105     "group": "Mail_Accounts",
15106     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15107     "version": "0.0.0",
15108     "filename": "server/api/mailAccount/index.js",
15109     "groupTitle": "Mail_Accounts"
15110   },
15111   {
15112     "type": "get",
15113     "url": "/api/mail/accounts/{id}",
15114     "title": "Gets a single Account",
15115     "examples": [
15116       {
15117         "title": "Example usage:",
15118         "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password}",
15119         "type": "json"
15120       }
15121     ],
15122     "name": "ShowAccounts",
15123     "group": "Mail_Accounts",
15124     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15125     "version": "0.0.0",
15126     "filename": "server/api/mailAccount/index.js",
15127     "groupTitle": "Mail_Accounts"
15128   },
15129   {
15130     "type": "post",
15131     "url": "/api/mail/accounts/{id}/canned_answers",
15132     "title": "Creates new canned answer",
15133     "examples": [
15134       {
15135         "title": "Example usage:",
15136         "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers -d '{\"name\": \"vip\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15137         "type": "json"
15138       }
15139     ],
15140     "name": "addAnswer",
15141     "group": "Mail_Accounts",
15142     "parameter": {
15143       "fields": {
15144         "Body": [
15145           {
15146             "group": "Body",
15147             "type": "String",
15148             "optional": false,
15149             "field": "key",
15150             "description": ""
15151           },
15152           {
15153             "group": "Body",
15154             "type": "Text",
15155             "optional": false,
15156             "field": "value",
15157             "description": ""
15158           },
15159           {
15160             "group": "Body",
15161             "type": "String",
15162             "optional": true,
15163             "field": "description",
15164             "description": ""
15165           },
15166           {
15167             "group": "Body",
15168             "type": "Virtual",
15169             "optional": true,
15170             "field": "name",
15171             "description": ""
15172           }
15173         ]
15174       }
15175     },
15176     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15177     "version": "0.0.0",
15178     "filename": "server/api/mailAccount/index.js",
15179     "groupTitle": "Mail_Accounts"
15180   },
15181   {
15182     "type": "post",
15183     "url": "/api/mail/accounts/{id}/applications",
15184     "title": "Creates new applications",
15185     "examples": [
15186       {
15187         "title": "Example usage:",
15188         "content": "curl https://{domain}/api/mail/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15189         "type": "json"
15190       }
15191     ],
15192     "name": "addApplications",
15193     "group": "Mail_Accounts",
15194     "parameter": {
15195       "fields": {
15196         "Body": [
15197           {
15198             "group": "Body",
15199             "type": "Integer",
15200             "optional": false,
15201             "field": "priority",
15202             "description": ""
15203           },
15204           {
15205             "group": "Body",
15206             "type": "String",
15207             "optional": false,
15208             "field": "app",
15209             "description": ""
15210           },
15211           {
15212             "group": "Body",
15213             "type": "Text",
15214             "optional": true,
15215             "field": "appdata",
15216             "description": ""
15217           },
15218           {
15219             "group": "Body",
15220             "type": "String",
15221             "optional": true,
15222             "field": "description",
15223             "description": ""
15224           },
15225           {
15226             "group": "Body",
15227             "type": "String",
15228             "optional": true,
15229             "field": "interval",
15230             "description": ""
15231           }
15232         ]
15233       }
15234     },
15235     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15236     "version": "0.0.0",
15237     "filename": "server/api/mailAccount/index.js",
15238     "groupTitle": "Mail_Accounts"
15239   },
15240   {
15241     "type": "post",
15242     "url": "/api/mail/accounts/{id}/dispositions",
15243     "title": "Creates new disposition",
15244     "examples": [
15245       {
15246         "title": "Example usage:",
15247         "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15248         "type": "json"
15249       }
15250     ],
15251     "name": "addDisposition",
15252     "group": "Mail_Accounts",
15253     "parameter": {
15254       "fields": {
15255         "Body": [
15256           {
15257             "group": "Body",
15258             "type": "String",
15259             "optional": false,
15260             "field": "name",
15261             "description": ""
15262           },
15263           {
15264             "group": "Body",
15265             "type": "String",
15266             "allowedValues": [
15267               "\"first\"",
15268               "\"second\"",
15269               "\"third\""
15270             ],
15271             "optional": false,
15272             "field": "level",
15273             "description": ""
15274           },
15275           {
15276             "group": "Body",
15277             "type": "String",
15278             "optional": true,
15279             "field": "description",
15280             "description": ""
15281           }
15282         ]
15283       }
15284     },
15285     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15286     "version": "0.0.0",
15287     "filename": "server/api/mailAccount/index.js",
15288     "groupTitle": "Mail_Accounts"
15289   },
15290   {
15291     "type": "post",
15292     "url": "/api/mail/accounts/{id}/interactions",
15293     "title": "Creates new interactions",
15294     "examples": [
15295       {
15296         "title": "Example usage:",
15297         "content": "curl https://{domain}/api/mail/accounts/{id}/interactions -d '[{\"subject\": \"My printer is on fire!\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15298         "type": "json"
15299       }
15300     ],
15301     "name": "addInteraction",
15302     "group": "Mail_Accounts",
15303     "parameter": {
15304       "fields": {
15305         "Body": [
15306           {
15307             "group": "Body",
15308             "type": "Boolean",
15309             "optional": true,
15310             "field": "closed",
15311             "description": ""
15312           },
15313           {
15314             "group": "Body",
15315             "type": "String",
15316             "optional": true,
15317             "field": "closedAt",
15318             "description": ""
15319           },
15320           {
15321             "group": "Body",
15322             "type": "String",
15323             "optional": true,
15324             "field": "disposition",
15325             "description": ""
15326           },
15327           {
15328             "group": "Body",
15329             "type": "String",
15330             "optional": true,
15331             "field": "secondDisposition",
15332             "description": ""
15333           },
15334           {
15335             "group": "Body",
15336             "type": "String",
15337             "optional": true,
15338             "field": "thirdDisposition",
15339             "description": ""
15340           },
15341           {
15342             "group": "Body",
15343             "type": "String",
15344             "optional": true,
15345             "field": "note",
15346             "description": ""
15347           },
15348           {
15349             "group": "Body",
15350             "type": "String",
15351             "optional": true,
15352             "field": "inReplyTo",
15353             "description": ""
15354           },
15355           {
15356             "group": "Body",
15357             "type": "String",
15358             "optional": true,
15359             "field": "to",
15360             "description": ""
15361           },
15362           {
15363             "group": "Body",
15364             "type": "Text",
15365             "optional": true,
15366             "field": "cc",
15367             "description": ""
15368           },
15369           {
15370             "group": "Body",
15371             "type": "Text",
15372             "optional": true,
15373             "field": "subject",
15374             "description": ""
15375           },
15376           {
15377             "group": "Body",
15378             "type": "Boolean",
15379             "optional": true,
15380             "field": "attach",
15381             "description": ""
15382           },
15383           {
15384             "group": "Body",
15385             "type": "String",
15386             "optional": true,
15387             "field": "read1stAt",
15388             "description": ""
15389           },
15390           {
15391             "group": "Body",
15392             "type": "String",
15393             "optional": true,
15394             "field": "substatus",
15395             "description": ""
15396           },
15397           {
15398             "group": "Body",
15399             "type": "String",
15400             "optional": true,
15401             "field": "substatusAt",
15402             "description": ""
15403           },
15404           {
15405             "group": "Body",
15406             "type": "String",
15407             "allowedValues": [
15408               "\"in\"",
15409               "\"out\""
15410             ],
15411             "optional": false,
15412             "field": "firstMsgDirection",
15413             "description": ""
15414           },
15415           {
15416             "group": "Body",
15417             "type": "String",
15418             "optional": true,
15419             "field": "lastMsgAt",
15420             "description": ""
15421           },
15422           {
15423             "group": "Body",
15424             "type": "String",
15425             "allowedValues": [
15426               "\"in\"",
15427               "\"out\""
15428             ],
15429             "optional": false,
15430             "field": "lastMsgDirection",
15431             "description": ""
15432           },
15433           {
15434             "group": "Body",
15435             "type": "Text",
15436             "optional": true,
15437             "field": "lastMsgBody",
15438             "description": ""
15439           },
15440           {
15441             "group": "Body",
15442             "type": "Text",
15443             "optional": true,
15444             "field": "lastMsgText",
15445             "description": ""
15446           }
15447         ]
15448       }
15449     },
15450     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15451     "version": "0.0.0",
15452     "filename": "server/api/mailAccount/index.js",
15453     "groupTitle": "Mail_Accounts"
15454   },
15455   {
15456     "type": "post",
15457     "url": "/api/mail/accounts",
15458     "title": "Create a mail account",
15459     "examples": [
15460       {
15461         "title": "Example usage:",
15462         "content": "curl https://{domain}/api/mail/accounts \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15463         "type": "json"
15464       }
15465     ],
15466     "name": "create",
15467     "group": "Mail_Accounts",
15468     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15469     "version": "0.0.0",
15470     "filename": "server/api/mailAccount/index.js",
15471     "groupTitle": "Mail_Accounts"
15472   },
15473   {
15474     "type": "get",
15475     "url": "/api/mail/accounts/{id}/canned_answers",
15476     "title": "Gets account canned answers",
15477     "examples": [
15478       {
15479         "title": "Example usage:",
15480         "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
15481         "type": "json"
15482       }
15483     ],
15484     "name": "getAnswers",
15485     "group": "Mail_Accounts",
15486     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15487     "version": "0.0.0",
15488     "filename": "server/api/mailAccount/index.js",
15489     "groupTitle": "Mail_Accounts"
15490   },
15491   {
15492     "type": "get",
15493     "url": "/api/mail/accounts/{id}/applications",
15494     "title": "Gets account applications",
15495     "examples": [
15496       {
15497         "title": "Example usage:",
15498         "content": "curl https://{domain}/api/mail/accounts/{id}/applications -v -u {name}:{password} -X GET",
15499         "type": "json"
15500       }
15501     ],
15502     "name": "getApplications",
15503     "group": "Mail_Accounts",
15504     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15505     "version": "0.0.0",
15506     "filename": "server/api/mailAccount/index.js",
15507     "groupTitle": "Mail_Accounts"
15508   },
15509   {
15510     "type": "get",
15511     "url": "/api/mail/accounts/{id}/dispositions",
15512     "title": "Gets account dispositions",
15513     "examples": [
15514       {
15515         "title": "Example usage:",
15516         "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
15517         "type": "json"
15518       }
15519     ],
15520     "name": "getDispositions",
15521     "group": "Mail_Accounts",
15522     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15523     "version": "0.0.0",
15524     "filename": "server/api/mailAccount/index.js",
15525     "groupTitle": "Mail_Accounts"
15526   },
15527   {
15528     "type": "get",
15529     "url": "/api/mail/accounts/{id}/interactions",
15530     "title": "Gets account interactions",
15531     "examples": [
15532       {
15533         "title": "Example usage:",
15534         "content": "curl https://{domain}/api/mail/accounts/{id}/interactions -v -u {name}:{password} -X GET",
15535         "type": "json"
15536       }
15537     ],
15538     "name": "getInteraction",
15539     "group": "Mail_Accounts",
15540     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15541     "version": "0.0.0",
15542     "filename": "server/api/mailAccount/index.js",
15543     "groupTitle": "Mail_Accounts"
15544   },
15545   {
15546     "type": "get",
15547     "url": "/api/mail/accounts/{id}/messages",
15548     "title": "Gets account messages",
15549     "examples": [
15550       {
15551         "title": "Example usage:",
15552         "content": "curl https://{domain}/api/mail/accounts/{id}/messages -v -u {name}:{password} -X GET",
15553         "type": "json"
15554       }
15555     ],
15556     "name": "getMessages",
15557     "group": "Mail_Accounts",
15558     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15559     "version": "0.0.0",
15560     "filename": "server/api/mailAccount/index.js",
15561     "groupTitle": "Mail_Accounts"
15562   },
15563   {
15564     "type": "post",
15565     "url": "/api/mail/accounts/{id}/send",
15566     "title": "Send new mail",
15567     "examples": [
15568       {
15569         "title": "Example usage:",
15570         "content": "curl https://{domain}/api/mail/accounts/{id}/send -d '{from: '\"John Doe\" <john.doe@xcally.com>'}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15571         "type": "json"
15572       }
15573     ],
15574     "name": "sendMail",
15575     "group": "Mail_Accounts",
15576     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15577     "version": "0.0.0",
15578     "filename": "server/api/mailAccount/index.js",
15579     "groupTitle": "Mail_Accounts"
15580   },
15581   {
15582     "type": "put",
15583     "url": "/api/mail/accounts/{id}",
15584     "title": "Update an existing Account",
15585     "examples": [
15586       {
15587         "title": "Example usage:",
15588         "content": "curl https://{domain}/api/mail/accounts/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
15589         "type": "json"
15590       }
15591     ],
15592     "name": "updateAccounts",
15593     "group": "Mail_Accounts",
15594     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15595     "version": "0.0.0",
15596     "filename": "server/api/mailAccount/index.js",
15597     "groupTitle": "Mail_Accounts"
15598   },
15599   {
15600     "type": "get",
15601     "url": "/api/mail/accounts/{id}/verify",
15602     "title": "Verify mail account",
15603     "examples": [
15604       {
15605         "title": "Example usage:",
15606         "content": "curl https://{domain}/api/mail/accounts/{id}/verify -v -u {name}:{password} -X GET",
15607         "type": "json"
15608       }
15609     ],
15610     "name": "verifySmtp",
15611     "group": "Mail_Accounts",
15612     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15613     "version": "0.0.0",
15614     "filename": "server/api/mailAccount/index.js",
15615     "groupTitle": "Mail_Accounts"
15616   },
15617   {
15618     "type": "delete",
15619     "url": "/api/mail/applications/{id}",
15620     "title": "Deletes a Application",
15621     "examples": [
15622       {
15623         "title": "Example usage:",
15624         "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password} -X DELETE",
15625         "type": "json"
15626       }
15627     ],
15628     "name": "DeleteApplications",
15629     "group": "Mail_Applications",
15630     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15631     "version": "0.0.0",
15632     "filename": "server/api/mailApplication/index.js",
15633     "groupTitle": "Mail_Applications"
15634   },
15635   {
15636     "type": "get",
15637     "url": "/api/mail/applications/{id}",
15638     "title": "Gets a single Application",
15639     "examples": [
15640       {
15641         "title": "Example usage:",
15642         "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password}",
15643         "type": "json"
15644       }
15645     ],
15646     "name": "ShowApplications",
15647     "group": "Mail_Applications",
15648     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15649     "version": "0.0.0",
15650     "filename": "server/api/mailApplication/index.js",
15651     "groupTitle": "Mail_Applications"
15652   },
15653   {
15654     "type": "put",
15655     "url": "/api/mail/applications/{id}",
15656     "title": "Update an existing Application",
15657     "examples": [
15658       {
15659         "title": "Example usage:",
15660         "content": "curl https://{domain}/api/mail/applications/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
15661         "type": "json"
15662       }
15663     ],
15664     "name": "updateApplications",
15665     "group": "Mail_Applications",
15666     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15667     "version": "0.0.0",
15668     "filename": "server/api/mailApplication/index.js",
15669     "groupTitle": "Mail_Applications"
15670   },
15671   {
15672     "type": "post",
15673     "url": "/api/mail/interactions/{id}/tags",
15674     "title": "Add tags to the interaction",
15675     "examples": [
15676       {
15677         "title": "Example usage:",
15678         "content": "curl https://{domain}/api/mail/interaction/{id}/tags -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15679         "type": "json"
15680       }
15681     ],
15682     "name": "AddTags",
15683     "group": "Mail_Interactions",
15684     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15685     "version": "0.0.0",
15686     "filename": "server/api/mailInteraction/index.js",
15687     "groupTitle": "Mail_Interactions"
15688   },
15689   {
15690     "type": "post",
15691     "url": "/api/mail/interactions",
15692     "title": "Creates a new Interaction",
15693     "examples": [
15694       {
15695         "title": "Example usage:",
15696         "content": "curl https://{domain}/api/mail/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
15697         "type": "json"
15698       }
15699     ],
15700     "name": "CreateInteractions",
15701     "group": "Mail_Interactions",
15702     "parameter": {
15703       "fields": {
15704         "Body": [
15705           {
15706             "group": "Body",
15707             "type": "Boolean",
15708             "optional": true,
15709             "field": "closed",
15710             "description": ""
15711           },
15712           {
15713             "group": "Body",
15714             "type": "String",
15715             "optional": true,
15716             "field": "closedAt",
15717             "description": ""
15718           },
15719           {
15720             "group": "Body",
15721             "type": "String",
15722             "optional": true,
15723             "field": "disposition",
15724             "description": ""
15725           },
15726           {
15727             "group": "Body",
15728             "type": "String",
15729             "optional": true,
15730             "field": "secondDisposition",
15731             "description": ""
15732           },
15733           {
15734             "group": "Body",
15735             "type": "String",
15736             "optional": true,
15737             "field": "thirdDisposition",
15738             "description": ""
15739           },
15740           {
15741             "group": "Body",
15742             "type": "String",
15743             "optional": true,
15744             "field": "note",
15745             "description": ""
15746           },
15747           {
15748             "group": "Body",
15749             "type": "String",
15750             "optional": true,
15751             "field": "inReplyTo",
15752             "description": ""
15753           },
15754           {
15755             "group": "Body",
15756             "type": "String",
15757             "optional": true,
15758             "field": "to",
15759             "description": ""
15760           },
15761           {
15762             "group": "Body",
15763             "type": "Text",
15764             "optional": true,
15765             "field": "cc",
15766             "description": ""
15767           },
15768           {
15769             "group": "Body",
15770             "type": "Text",
15771             "optional": true,
15772             "field": "subject",
15773             "description": ""
15774           },
15775           {
15776             "group": "Body",
15777             "type": "Boolean",
15778             "optional": true,
15779             "field": "attach",
15780             "description": ""
15781           },
15782           {
15783             "group": "Body",
15784             "type": "String",
15785             "optional": true,
15786             "field": "read1stAt",
15787             "description": ""
15788           },
15789           {
15790             "group": "Body",
15791             "type": "String",
15792             "optional": true,
15793             "field": "substatus",
15794             "description": ""
15795           },
15796           {
15797             "group": "Body",
15798             "type": "String",
15799             "optional": true,
15800             "field": "substatusAt",
15801             "description": ""
15802           },
15803           {
15804             "group": "Body",
15805             "type": "String",
15806             "allowedValues": [
15807               "\"in\"",
15808               "\"out\""
15809             ],
15810             "optional": false,
15811             "field": "firstMsgDirection",
15812             "description": ""
15813           },
15814           {
15815             "group": "Body",
15816             "type": "String",
15817             "optional": true,
15818             "field": "lastMsgAt",
15819             "description": ""
15820           },
15821           {
15822             "group": "Body",
15823             "type": "String",
15824             "allowedValues": [
15825               "\"in\"",
15826               "\"out\""
15827             ],
15828             "optional": false,
15829             "field": "lastMsgDirection",
15830             "description": ""
15831           },
15832           {
15833             "group": "Body",
15834             "type": "Text",
15835             "optional": true,
15836             "field": "lastMsgBody",
15837             "description": ""
15838           },
15839           {
15840             "group": "Body",
15841             "type": "Text",
15842             "optional": true,
15843             "field": "lastMsgText",
15844             "description": ""
15845           }
15846         ]
15847       }
15848     },
15849     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15850     "version": "0.0.0",
15851     "filename": "server/api/mailInteraction/index.js",
15852     "groupTitle": "Mail_Interactions"
15853   },
15854   {
15855     "type": "delete",
15856     "url": "/api/mail/interactions/{id}",
15857     "title": "Deletes a Interaction",
15858     "examples": [
15859       {
15860         "title": "Example usage:",
15861         "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password} -X DELETE",
15862         "type": "json"
15863       }
15864     ],
15865     "name": "DeleteInteractions",
15866     "group": "Mail_Interactions",
15867     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15868     "version": "0.0.0",
15869     "filename": "server/api/mailInteraction/index.js",
15870     "groupTitle": "Mail_Interactions"
15871   },
15872   {
15873     "type": "get",
15874     "url": "/api/mail/interactions/describe",
15875     "title": "Gets table info about Interactions",
15876     "examples": [
15877       {
15878         "title": "Example usage:",
15879         "content": "curl https://{domain}/api/mail/interactions/describe -v -u {name}:{password}",
15880         "type": "json"
15881       }
15882     ],
15883     "name": "DescribeInteractions",
15884     "group": "Mail_Interactions",
15885     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15886     "version": "0.0.0",
15887     "filename": "server/api/mailInteraction/index.js",
15888     "groupTitle": "Mail_Interactions"
15889   },
15890   {
15891     "type": "get",
15892     "url": "/api/mail/interactions",
15893     "title": "Gets a list of Interactions",
15894     "examples": [
15895       {
15896         "title": "Example usage:",
15897         "content": "curl https://{domain}/api/mail/interactions -v -u {name}:{password}",
15898         "type": "json"
15899       }
15900     ],
15901     "name": "GetInteractions",
15902     "group": "Mail_Interactions",
15903     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/mail/interactions?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/mail/interactions?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/mail/interactions?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/mail/interactions?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/mail/interactions?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
15904     "version": "0.0.0",
15905     "filename": "server/api/mailInteraction/index.js",
15906     "groupTitle": "Mail_Interactions"
15907   },
15908   {
15909     "type": "delete",
15910     "url": "/api/mail/interactions/{id}/tags",
15911     "title": "Removes tags from interaction",
15912     "examples": [
15913       {
15914         "title": "Example usage:",
15915         "content": "curl https://{domain}/api/mail/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15916         "type": "json"
15917       }
15918     ],
15919     "name": "RemoveTags",
15920     "group": "Mail_Interactions",
15921     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15922     "version": "0.0.0",
15923     "filename": "server/api/mailInteraction/index.js",
15924     "groupTitle": "Mail_Interactions"
15925   },
15926   {
15927     "type": "get",
15928     "url": "/api/mail/interactions/{id}",
15929     "title": "Gets a single Interaction",
15930     "examples": [
15931       {
15932         "title": "Example usage:",
15933         "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password}",
15934         "type": "json"
15935       }
15936     ],
15937     "name": "ShowInteractions",
15938     "group": "Mail_Interactions",
15939     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15940     "version": "0.0.0",
15941     "filename": "server/api/mailInteraction/index.js",
15942     "groupTitle": "Mail_Interactions"
15943   },
15944   {
15945     "type": "post",
15946     "url": "/api/mail/interactions/{id}/messages",
15947     "title": "Creates new message",
15948     "examples": [
15949       {
15950         "title": "Example usage:",
15951         "content": "curl https://{domain}/api/mail/interactions/{id}/messages -d '[{\"to\": \"sales@xcally.com\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15952         "type": "json"
15953       }
15954     ],
15955     "name": "addMessage",
15956     "group": "Mail_Interactions",
15957     "parameter": {
15958       "fields": {
15959         "Body": [
15960           {
15961             "group": "Body",
15962             "type": "Text",
15963             "optional": false,
15964             "field": "body",
15965             "description": ""
15966           },
15967           {
15968             "group": "Body",
15969             "type": "Text",
15970             "optional": true,
15971             "field": "plainBody",
15972             "description": ""
15973           },
15974           {
15975             "group": "Body",
15976             "type": "Boolean",
15977             "optional": true,
15978             "field": "read",
15979             "description": ""
15980           },
15981           {
15982             "group": "Body",
15983             "type": "String",
15984             "allowedValues": [
15985               "\"in\"",
15986               "\"out\""
15987             ],
15988             "optional": false,
15989             "field": "direction",
15990             "description": ""
15991           },
15992           {
15993             "group": "Body",
15994             "type": "String",
15995             "optional": true,
15996             "field": "messageId",
15997             "description": ""
15998           },
15999           {
16000             "group": "Body",
16001             "type": "String",
16002             "optional": true,
16003             "field": "from",
16004             "description": ""
16005           },
16006           {
16007             "group": "Body",
16008             "type": "Text",
16009             "optional": true,
16010             "field": "to",
16011             "description": ""
16012           },
16013           {
16014             "group": "Body",
16015             "type": "Text",
16016             "optional": true,
16017             "field": "cc",
16018             "description": ""
16019           },
16020           {
16021             "group": "Body",
16022             "type": "Text",
16023             "optional": true,
16024             "field": "bcc",
16025             "description": ""
16026           },
16027           {
16028             "group": "Body",
16029             "type": "Text",
16030             "optional": true,
16031             "field": "subject",
16032             "description": ""
16033           },
16034           {
16035             "group": "Body",
16036             "type": "String",
16037             "optional": true,
16038             "field": "sentAt",
16039             "description": ""
16040           },
16041           {
16042             "group": "Body",
16043             "type": "Integer",
16044             "optional": true,
16045             "field": "attach",
16046             "description": ""
16047           },
16048           {
16049             "group": "Body",
16050             "type": "Boolean",
16051             "optional": true,
16052             "field": "secret",
16053             "description": ""
16054           },
16055           {
16056             "group": "Body",
16057             "type": "String",
16058             "optional": true,
16059             "field": "readAt",
16060             "description": ""
16061           },
16062           {
16063             "group": "Body",
16064             "type": "Text",
16065             "optional": true,
16066             "field": "originTo",
16067             "description": ""
16068           },
16069           {
16070             "group": "Body",
16071             "type": "Text",
16072             "optional": true,
16073             "field": "originCc",
16074             "description": ""
16075           }
16076         ]
16077       }
16078     },
16079     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16080     "version": "0.0.0",
16081     "filename": "server/api/mailInteraction/index.js",
16082     "groupTitle": "Mail_Interactions"
16083   },
16084   {
16085     "type": "get",
16086     "url": "/api/mail/interactions/{id}/download",
16087     "title": "Gets interaction",
16088     "examples": [
16089       {
16090         "title": "Example usage:",
16091         "content": "curl https://{domain}/api/mail/interactions/{id}/download -v -u {name}:{password} -X GET",
16092         "type": "json"
16093       }
16094     ],
16095     "name": "download",
16096     "group": "Mail_Interactions",
16097     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16098     "version": "0.0.0",
16099     "filename": "server/api/mailInteraction/index.js",
16100     "groupTitle": "Mail_Interactions"
16101   },
16102   {
16103     "type": "get",
16104     "url": "/api/mail/interactions/{id}/messages",
16105     "title": "Gets interaction messages",
16106     "examples": [
16107       {
16108         "title": "Example usage:",
16109         "content": "curl https://{domain}/api/mail/interactions/{id}/messages -v -u {name}:{password} -X GET",
16110         "type": "json"
16111       }
16112     ],
16113     "name": "getMessages",
16114     "group": "Mail_Interactions",
16115     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16116     "version": "0.0.0",
16117     "filename": "server/api/mailInteraction/index.js",
16118     "groupTitle": "Mail_Interactions"
16119   },
16120   {
16121     "type": "put",
16122     "url": "/api/mail/interactions/{id}",
16123     "title": "Update an existing Interaction",
16124     "examples": [
16125       {
16126         "title": "Example usage:",
16127         "content": "curl https://{domain}/api/mail/interactions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
16128         "type": "json"
16129       }
16130     ],
16131     "name": "updateInteractions",
16132     "group": "Mail_Interactions",
16133     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16134     "version": "0.0.0",
16135     "filename": "server/api/mailInteraction/index.js",
16136     "groupTitle": "Mail_Interactions"
16137   },
16138   {
16139     "type": "delete",
16140     "url": "/api/mail/messages/{id}",
16141     "title": "Deletes a Message",
16142     "examples": [
16143       {
16144         "title": "Example usage:",
16145         "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password} -X DELETE",
16146         "type": "json"
16147       }
16148     ],
16149     "name": "DeleteMessages",
16150     "group": "Mail_Messages",
16151     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16152     "version": "0.0.0",
16153     "filename": "server/api/mailMessage/index.js",
16154     "groupTitle": "Mail_Messages"
16155   },
16156   {
16157     "type": "get",
16158     "url": "/api/mail/messages/describe",
16159     "title": "Gets table info about Messages",
16160     "examples": [
16161       {
16162         "title": "Example usage:",
16163         "content": "curl https://{domain}/api/mail/messages/describe -v -u {name}:{password}",
16164         "type": "json"
16165       }
16166     ],
16167     "name": "DescribeMessages",
16168     "group": "Mail_Messages",
16169     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16170     "version": "0.0.0",
16171     "filename": "server/api/mailMessage/index.js",
16172     "groupTitle": "Mail_Messages"
16173   },
16174   {
16175     "type": "get",
16176     "url": "/api/mail/messages",
16177     "title": "Gets a list of Messages",
16178     "examples": [
16179       {
16180         "title": "Example usage:",
16181         "content": "curl https://{domain}/api/mail/messages -v -u {name}:{password}",
16182         "type": "json"
16183       }
16184     ],
16185     "name": "GetMessages",
16186     "group": "Mail_Messages",
16187     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/mail/messages?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/mail/messages?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/mail/messages?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/mail/messages?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/mail/messages?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
16188     "version": "0.0.0",
16189     "filename": "server/api/mailMessage/index.js",
16190     "groupTitle": "Mail_Messages"
16191   },
16192   {
16193     "type": "get",
16194     "url": "/api/mail/messages/{id}",
16195     "title": "Gets a single Message",
16196     "examples": [
16197       {
16198         "title": "Example usage:",
16199         "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password}",
16200         "type": "json"
16201       }
16202     ],
16203     "name": "ShowMessages",
16204     "group": "Mail_Messages",
16205     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16206     "version": "0.0.0",
16207     "filename": "server/api/mailMessage/index.js",
16208     "groupTitle": "Mail_Messages"
16209   },
16210   {
16211     "type": "put",
16212     "url": "/api/mail/messages/{id}/accept",
16213     "title": "Accepts message",
16214     "examples": [
16215       {
16216         "title": "Example usage:",
16217         "content": "curl https://{domain}/api/mail/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
16218         "type": "json"
16219       }
16220     ],
16221     "name": "acceptMessage",
16222     "group": "Mail_Messages",
16223     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16224     "version": "0.0.0",
16225     "filename": "server/api/mailMessage/index.js",
16226     "groupTitle": "Mail_Messages"
16227   },
16228   {
16229     "type": "post",
16230     "url": "/api/mail/messages",
16231     "title": "Create a message",
16232     "examples": [
16233       {
16234         "title": "Example usage:",
16235         "content": "curl https://{domain}/api/mail/messages \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
16236         "type": "json"
16237       }
16238     ],
16239     "name": "createMessage",
16240     "group": "Mail_Messages",
16241     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16242     "version": "0.0.0",
16243     "filename": "server/api/mailMessage/index.js",
16244     "groupTitle": "Mail_Messages"
16245   },
16246   {
16247     "type": "get",
16248     "url": "/api/mail/messages/{id}/download",
16249     "title": "Gets message",
16250     "examples": [
16251       {
16252         "title": "Example usage:",
16253         "content": "curl https://{domain}/api/mail/messages/{id}/download -v -u {name}:{password} -X GET",
16254         "type": "json"
16255       }
16256     ],
16257     "name": "download",
16258     "group": "Mail_Messages",
16259     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16260     "version": "0.0.0",
16261     "filename": "server/api/mailMessage/index.js",
16262     "groupTitle": "Mail_Messages"
16263   },
16264   {
16265     "type": "put",
16266     "url": "/api/mail/messages/{id}/reject",
16267     "title": "Rejects message",
16268     "examples": [
16269       {
16270         "title": "Example usage:",
16271         "content": "curl https://{domain}/api/mail/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
16272         "type": "json"
16273       }
16274     ],
16275     "name": "rejectMessage",
16276     "group": "Mail_Messages",
16277     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16278     "version": "0.0.0",
16279     "filename": "server/api/mailMessage/index.js",
16280     "groupTitle": "Mail_Messages"
16281   },
16282   {
16283     "type": "put",
16284     "url": "/api/mail/messages/{id}",
16285     "title": "Update an existing Message",
16286     "examples": [
16287       {
16288         "title": "Example usage:",
16289         "content": "curl https://{domain}/api/mail/messages/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
16290         "type": "json"
16291       }
16292     ],
16293     "name": "updateMessages",
16294     "group": "Mail_Messages",
16295     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16296     "version": "0.0.0",
16297     "filename": "server/api/mailMessage/index.js",
16298     "groupTitle": "Mail_Messages"
16299   },
16300   {
16301     "type": "post",
16302     "url": "/api/mail/reports/queue",
16303     "title": "Creates a new Mail Queue Report",
16304     "examples": [
16305       {
16306         "title": "Example usage:",
16307         "content": "curl https://{domain}/api/mail/reports/queue -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
16308         "type": "json"
16309       }
16310     ],
16311     "name": "CreateMail_Queue_Reports",
16312     "group": "Mail_Queue_Reports",
16313     "parameter": {
16314       "fields": {
16315         "Body": [
16316           {
16317             "group": "Body",
16318             "type": "String",
16319             "optional": false,
16320             "field": "uniqueid",
16321             "description": ""
16322           },
16323           {
16324             "group": "Body",
16325             "type": "String",
16326             "optional": true,
16327             "field": "from",
16328             "description": ""
16329           },
16330           {
16331             "group": "Body",
16332             "type": "String",
16333             "optional": true,
16334             "field": "joinAt",
16335             "description": ""
16336           },
16337           {
16338             "group": "Body",
16339             "type": "String",
16340             "optional": true,
16341             "field": "leaveAt",
16342             "description": ""
16343           },
16344           {
16345             "group": "Body",
16346             "type": "String",
16347             "optional": true,
16348             "field": "acceptAt",
16349             "description": ""
16350           },
16351           {
16352             "group": "Body",
16353             "type": "String",
16354             "optional": true,
16355             "field": "exitAt",
16356             "description": ""
16357           },
16358           {
16359             "group": "Body",
16360             "type": "String",
16361             "optional": true,
16362             "field": "reason",
16363             "description": ""
16364           }
16365         ]
16366       }
16367     },
16368     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16369     "version": "0.0.0",
16370     "filename": "server/api/mailQueueReport/index.js",
16371     "groupTitle": "Mail_Queue_Reports"
16372   },
16373   {
16374     "type": "delete",
16375     "url": "/api/mail/reports/queue/{id}",
16376     "title": "Deletes a Mail Queue Report",
16377     "examples": [
16378       {
16379         "title": "Example usage:",
16380         "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password} -X DELETE",
16381         "type": "json"
16382       }
16383     ],
16384     "name": "DeleteMail_Queue_Reports",
16385     "group": "Mail_Queue_Reports",
16386     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16387     "version": "0.0.0",
16388     "filename": "server/api/mailQueueReport/index.js",
16389     "groupTitle": "Mail_Queue_Reports"
16390   },
16391   {
16392     "type": "get",
16393     "url": "/api/mail/reports/queue/describe",
16394     "title": "Gets table info about Mail Queue Reports",
16395     "examples": [
16396       {
16397         "title": "Example usage:",
16398         "content": "curl https://{domain}/api/mail/reports/queue/describe -v -u {name}:{password}",
16399         "type": "json"
16400       }
16401     ],
16402     "name": "DescribeMail_Queue_Reports",
16403     "group": "Mail_Queue_Reports",
16404     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16405     "version": "0.0.0",
16406     "filename": "server/api/mailQueueReport/index.js",
16407     "groupTitle": "Mail_Queue_Reports"
16408   },
16409   {
16410     "type": "get",
16411     "url": "/api/mail/reports/queue",
16412     "title": "Gets a list of Mail Queue Reports",
16413     "examples": [
16414       {
16415         "title": "Example usage:",
16416         "content": "curl https://{domain}/api/mail/reports/queue -v -u {name}:{password}",
16417         "type": "json"
16418       }
16419     ],
16420     "name": "GetMail_Queue_Reports",
16421     "group": "Mail_Queue_Reports",
16422     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/mail/reports/queue?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/mail/reports/queue?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/mail/reports/queue?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/mail/reports/queue?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/mail/reports/queue?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
16423     "version": "0.0.0",
16424     "filename": "server/api/mailQueueReport/index.js",
16425     "groupTitle": "Mail_Queue_Reports"
16426   },
16427   {
16428     "type": "get",
16429     "url": "/api/mail/reports/queue/{id}",
16430     "title": "Gets a single Mail Queue Report",
16431     "examples": [
16432       {
16433         "title": "Example usage:",
16434         "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password}",
16435         "type": "json"
16436       }
16437     ],
16438     "name": "ShowMail_Queue_Reports",
16439     "group": "Mail_Queue_Reports",
16440     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16441     "version": "0.0.0",
16442     "filename": "server/api/mailQueueReport/index.js",
16443     "groupTitle": "Mail_Queue_Reports"
16444   },
16445   {
16446     "type": "put",
16447     "url": "/api/mail/reports/queue/{id}",
16448     "title": "Update an existing Mail Queue Report",
16449     "examples": [
16450       {
16451         "title": "Example usage:",
16452         "content": "curl https://{domain}/api/mail/reports/queue/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
16453         "type": "json"
16454       }
16455     ],
16456     "name": "updateMail_Queue_Reports",
16457     "group": "Mail_Queue_Reports",
16458     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16459     "version": "0.0.0",
16460     "filename": "server/api/mailQueueReport/index.js",
16461     "groupTitle": "Mail_Queue_Reports"
16462   },
16463   {
16464     "type": "post",
16465     "url": "/api/mail/queues/{id}/users",
16466     "title": "Add agents to a queue",
16467     "examples": [
16468       {
16469         "title": "Example usage:",
16470         "content": "curl https://{domain}/api/mail/queues/{id}/users -d '{\"ids\": [1,2], \"penalty\": 2}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
16471         "type": "json"
16472       }
16473     ],
16474     "name": "AddAgents",
16475     "group": "Mail_Queues",
16476     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16477     "version": "0.0.0",
16478     "filename": "server/api/mailQueue/index.js",
16479     "groupTitle": "Mail_Queues"
16480   },
16481   {
16482     "type": "post",
16483     "url": "/api/mail/queues/{id}/teams",
16484     "title": "Add teams to a queue",
16485     "examples": [
16486       {
16487         "title": "Example usage:",
16488         "content": "curl https://{domain}/api/mail/queues/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
16489         "type": "json"
16490       }
16491     ],
16492     "name": "AddTeams",
16493     "group": "Mail_Queues",
16494     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16495     "version": "0.0.0",
16496     "filename": "server/api/mailQueue/index.js",
16497     "groupTitle": "Mail_Queues"
16498   },
16499   {
16500     "type": "post",
16501     "url": "/api/mail/queues",
16502     "title": "Creates a new Queue",
16503     "examples": [
16504       {
16505         "title": "Example usage:",
16506         "content": "curl https://{domain}/api/mail/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
16507         "type": "json"
16508       }
16509     ],
16510     "name": "CreateQueues",
16511     "group": "Mail_Queues",
16512     "parameter": {
16513       "fields": {
16514         "Body": [
16515           {
16516             "group": "Body",
16517             "type": "String",
16518             "optional": true,
16519             "field": "name",
16520             "description": ""
16521           },
16522           {
16523             "group": "Body",
16524             "type": "String",
16525             "optional": true,
16526             "field": "description",
16527             "description": ""
16528           },
16529           {
16530             "group": "Body",
16531             "type": "Integer",
16532             "optional": true,
16533             "field": "timeout",
16534             "description": ""
16535           },
16536           {
16537             "group": "Body",
16538             "type": "String",
16539             "allowedValues": [
16540               "\"rrmemory\"",
16541               "\"beepall\"",
16542               "\"roundrobin\""
16543             ],
16544             "optional": true,
16545             "field": "strategy",
16546             "description": ""
16547           }
16548         ]
16549       }
16550     },
16551     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16552     "version": "0.0.0",
16553     "filename": "server/api/mailQueue/index.js",
16554     "groupTitle": "Mail_Queues"
16555   },
16556   {
16557     "type": "delete",
16558     "url": "/api/mail/queues/{id}",
16559     "title": "Deletes a Queue",
16560     "examples": [
16561       {
16562         "title": "Example usage:",
16563         "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password} -X DELETE",
16564         "type": "json"
16565       }
16566     ],
16567     "name": "DeleteQueues",
16568     "group": "Mail_Queues",
16569     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16570     "version": "0.0.0",
16571     "filename": "server/api/mailQueue/index.js",
16572     "groupTitle": "Mail_Queues"
16573   },
16574   {
16575     "type": "get",
16576     "url": "/api/mail/queues/describe",
16577     "title": "Gets table info about Queues",
16578     "examples": [
16579       {
16580         "title": "Example usage:",
16581         "content": "curl https://{domain}/api/mail/queues/describe -v -u {name}:{password}",
16582         "type": "json"
16583       }
16584     ],
16585     "name": "DescribeQueues",
16586     "group": "Mail_Queues",
16587     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16588     "version": "0.0.0",
16589     "filename": "server/api/mailQueue/index.js",
16590     "groupTitle": "Mail_Queues"
16591   },
16592   {
16593     "type": "get",
16594     "url": "/api/mail/queues/{id}/users",
16595     "title": "Gets queue agents",
16596     "examples": [
16597       {
16598         "title": "Example usage:",
16599         "content": "curl https://{domain}/api/mail/queues/{id}/users -v -u {name}:{password} -X POST",
16600         "type": "json"
16601       }
16602     ],
16603     "name": "GetAgents",
16604     "group": "Mail_Queues",
16605     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16606     "version": "0.0.0",
16607     "filename": "server/api/mailQueue/index.js",
16608     "groupTitle": "Mail_Queues"
16609   },
16610   {
16611     "type": "get",
16612     "url": "/api/mail/queues/{id}/members",
16613     "title": "GetMembers",
16614     "examples": [
16615       {
16616         "title": "Example usage:",
16617         "content": "curl https://{domain}/api/mail/queues/{id}/members  -v -u {name}:{password}",
16618         "type": "json"
16619       }
16620     ],
16621     "name": "GetMembers",
16622     "group": "Mail_Queues",
16623     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16624     "version": "0.0.0",
16625     "filename": "server/api/mailQueue/index.js",
16626     "groupTitle": "Mail_Queues"
16627   },
16628   {
16629     "type": "get",
16630     "url": "/api/mail/queues",
16631     "title": "Gets a list of Queues",
16632     "examples": [
16633       {
16634         "title": "Example usage:",
16635         "content": "curl https://{domain}/api/mail/queues -v -u {name}:{password}",
16636         "type": "json"
16637       }
16638     ],
16639     "name": "GetQueues",
16640     "group": "Mail_Queues",
16641     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/mail/queues?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/mail/queues?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/mail/queues?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/mail/queues?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/mail/queues?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
16642     "version": "0.0.0",
16643     "filename": "server/api/mailQueue/index.js",
16644     "groupTitle": "Mail_Queues"
16645   },
16646   {
16647     "type": "get",
16648     "url": "/api/mail/queues/{id}/teams",
16649     "title": "Gets queues list",
16650     "examples": [
16651       {
16652         "title": "Example usage:",
16653         "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password}",
16654         "type": "json"
16655       }
16656     ],
16657     "name": "GetTeams",
16658     "group": "Mail_Queues",
16659     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16660     "version": "0.0.0",
16661     "filename": "server/api/mailQueue/index.js",
16662     "groupTitle": "Mail_Queues"
16663   },
16664   {
16665     "type": "delete",
16666     "url": "/api/mail/queues/{id}/users",
16667     "title": "Removes agents from a queue",
16668     "examples": [
16669       {
16670         "title": "Example usage:",
16671         "content": "curl https://{domain}/api/mail/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
16672         "type": "json"
16673       }
16674     ],
16675     "name": "RemoveAgents",
16676     "group": "Mail_Queues",
16677     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16678     "version": "0.0.0",
16679     "filename": "server/api/mailQueue/index.js",
16680     "groupTitle": "Mail_Queues"
16681   },
16682   {
16683     "type": "get",
16684     "url": "/api/mail/queues/{id}",
16685     "title": "Gets a single Queue",
16686     "examples": [
16687       {
16688         "title": "Example usage:",
16689         "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password}",
16690         "type": "json"
16691       }
16692     ],
16693     "name": "ShowQueues",
16694     "group": "Mail_Queues",
16695     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16696     "version": "0.0.0",
16697     "filename": "server/api/mailQueue/index.js",
16698     "groupTitle": "Mail_Queues"
16699   },
16700   {
16701     "type": "put",
16702     "url": "/api/mail/queues/{id}",
16703     "title": "Update an existing Queue",
16704     "examples": [
16705       {
16706         "title": "Example usage:",
16707         "content": "curl https://{domain}/api/mail/queues/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
16708         "type": "json"
16709       }
16710     ],
16711     "name": "updateQueues",
16712     "group": "Mail_Queues",
16713     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16714     "version": "0.0.0",
16715     "filename": "server/api/mailQueue/index.js",
16716     "groupTitle": "Mail_Queues"
16717   },
16718   {
16719     "type": "post",
16720     "url": "/api/mail/out_servers",
16721     "title": "Creates a new SMTP",
16722     "examples": [
16723       {
16724         "title": "Example usage:",
16725         "content": "curl https://{domain}/api/mail/out_servers -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
16726         "type": "json"
16727       }
16728     ],
16729     "name": "CreateSMTPs",
16730     "group": "Mail_SMTP",
16731     "parameter": {
16732       "fields": {
16733         "Body": [
16734           {
16735             "group": "Body",
16736             "type": "String",
16737             "optional": true,
16738             "field": "description",
16739             "description": ""
16740           },
16741           {
16742             "group": "Body",
16743             "type": "String",
16744             "optional": true,
16745             "field": "host",
16746             "description": ""
16747           },
16748           {
16749             "group": "Body",
16750             "type": "String",
16751             "optional": true,
16752             "field": "user",
16753             "description": ""
16754           },
16755           {
16756             "group": "Body",
16757             "type": "String",
16758             "optional": true,
16759             "field": "pass",
16760             "description": ""
16761           },
16762           {
16763             "group": "Body",
16764             "type": "Integer",
16765             "optional": true,
16766             "field": "port",
16767             "description": ""
16768           },
16769           {
16770             "group": "Body",
16771             "type": "Boolean",
16772             "optional": true,
16773             "field": "secure",
16774             "description": ""
16775           },
16776           {
16777             "group": "Body",
16778             "type": "String",
16779             "optional": true,
16780             "field": "service",
16781             "description": ""
16782           },
16783           {
16784             "group": "Body",
16785             "type": "Boolean",
16786             "optional": true,
16787             "field": "authentication",
16788             "description": ""
16789           }
16790         ]
16791       }
16792     },
16793     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16794     "version": "0.0.0",
16795     "filename": "server/api/mailServerOut/index.js",
16796     "groupTitle": "Mail_SMTP"
16797   },
16798   {
16799     "type": "delete",
16800     "url": "/api/mail/out_servers/{id}",
16801     "title": "Deletes a SMTP",
16802     "examples": [
16803       {
16804         "title": "Example usage:",
16805         "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password} -X DELETE",
16806         "type": "json"
16807       }
16808     ],
16809     "name": "DeleteSMTPs",
16810     "group": "Mail_SMTP",
16811     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16812     "version": "0.0.0",
16813     "filename": "server/api/mailServerOut/index.js",
16814     "groupTitle": "Mail_SMTP"
16815   },
16816   {
16817     "type": "get",
16818     "url": "/api/mail/out_servers",
16819     "title": "Gets a list of SMTPs",
16820     "examples": [
16821       {
16822         "title": "Example usage:",
16823         "content": "curl https://{domain}/api/mail/out_servers -v -u {name}:{password}",
16824         "type": "json"
16825       }
16826     ],
16827     "name": "GetSMTPs",
16828     "group": "Mail_SMTP",
16829     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/mail/out_servers?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/mail/out_servers?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/mail/out_servers?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/mail/out_servers?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/mail/out_servers?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
16830     "version": "0.0.0",
16831     "filename": "server/api/mailServerOut/index.js",
16832     "groupTitle": "Mail_SMTP"
16833   },
16834   {
16835     "type": "get",
16836     "url": "/api/mail/out_servers/{id}",
16837     "title": "Gets a single SMTP",
16838     "examples": [
16839       {
16840         "title": "Example usage:",
16841         "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password}",
16842         "type": "json"
16843       }
16844     ],
16845     "name": "ShowSMTPs",
16846     "group": "Mail_SMTP",
16847     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16848     "version": "0.0.0",
16849     "filename": "server/api/mailServerOut/index.js",
16850     "groupTitle": "Mail_SMTP"
16851   },
16852   {
16853     "type": "put",
16854     "url": "/api/mail/out_servers/{id}",
16855     "title": "Update an existing SMTP",
16856     "examples": [
16857       {
16858         "title": "Example usage:",
16859         "content": "curl https://{domain}/api/mail/out_servers/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
16860         "type": "json"
16861       }
16862     ],
16863     "name": "updateSMTPs",
16864     "group": "Mail_SMTP",
16865     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16866     "version": "0.0.0",
16867     "filename": "server/api/mailServerOut/index.js",
16868     "groupTitle": "Mail_SMTP"
16869   },
16870   {
16871     "type": "post",
16872     "url": "/api/mail/substatuses",
16873     "title": "Creates a new Queue",
16874     "examples": [
16875       {
16876         "title": "Example usage:",
16877         "content": "curl https://{domain}/api/mail/substatuses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
16878         "type": "json"
16879       }
16880     ],
16881     "name": "CreateSubstatuses",
16882     "group": "Mail_Substatuses",
16883     "parameter": {
16884       "fields": {
16885         "Body": [
16886           {
16887             "group": "Body",
16888             "type": "String",
16889             "optional": false,
16890             "field": "name",
16891             "description": ""
16892           },
16893           {
16894             "group": "Body",
16895             "type": "String",
16896             "optional": true,
16897             "field": "description",
16898             "description": ""
16899           }
16900         ]
16901       }
16902     },
16903     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16904     "version": "0.0.0",
16905     "filename": "server/api/mailSubstatus/index.js",
16906     "groupTitle": "Mail_Substatuses"
16907   },
16908   {
16909     "type": "delete",
16910     "url": "/api/mail/substatuses/{id}",
16911     "title": "Deletes a Queue",
16912     "examples": [
16913       {
16914         "title": "Example usage:",
16915         "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password} -X DELETE",
16916         "type": "json"
16917       }
16918     ],
16919     "name": "DeleteSubstatuses",
16920     "group": "Mail_Substatuses",
16921     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16922     "version": "0.0.0",
16923     "filename": "server/api/mailSubstatus/index.js",
16924     "groupTitle": "Mail_Substatuses"
16925   },
16926   {
16927     "type": "get",
16928     "url": "/api/mail/substatuses/describe",
16929     "title": "Gets table info about Substatuses",
16930     "examples": [
16931       {
16932         "title": "Example usage:",
16933         "content": "curl https://{domain}/api/mail/substatuses/describe -v -u {name}:{password}",
16934         "type": "json"
16935       }
16936     ],
16937     "name": "DescribeSubstatuses",
16938     "group": "Mail_Substatuses",
16939     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16940     "version": "0.0.0",
16941     "filename": "server/api/mailSubstatus/index.js",
16942     "groupTitle": "Mail_Substatuses"
16943   },
16944   {
16945     "type": "get",
16946     "url": "/api/mail/substatuses",
16947     "title": "Gets a list of Substatuses",
16948     "examples": [
16949       {
16950         "title": "Example usage:",
16951         "content": "curl https://{domain}/api/mail/substatuses -v -u {name}:{password}",
16952         "type": "json"
16953       }
16954     ],
16955     "name": "GetSubstatuses",
16956     "group": "Mail_Substatuses",
16957     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/mail/substatuses?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/mail/substatuses?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/mail/substatuses?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/mail/substatuses?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/mail/substatuses?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
16958     "version": "0.0.0",
16959     "filename": "server/api/mailSubstatus/index.js",
16960     "groupTitle": "Mail_Substatuses"
16961   },
16962   {
16963     "type": "get",
16964     "url": "/api/mail/substatuses/{id}",
16965     "title": "Gets a single Queue",
16966     "examples": [
16967       {
16968         "title": "Example usage:",
16969         "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password}",
16970         "type": "json"
16971       }
16972     ],
16973     "name": "ShowSubstatuses",
16974     "group": "Mail_Substatuses",
16975     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16976     "version": "0.0.0",
16977     "filename": "server/api/mailSubstatus/index.js",
16978     "groupTitle": "Mail_Substatuses"
16979   },
16980   {
16981     "type": "put",
16982     "url": "/api/mail/substatuses/{id}",
16983     "title": "Update an existing Queue",
16984     "examples": [
16985       {
16986         "title": "Example usage:",
16987         "content": "curl https://{domain}/api/mail/substatuses/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
16988         "type": "json"
16989       }
16990     ],
16991     "name": "updateSubstatuses",
16992     "group": "Mail_Substatuses",
16993     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16994     "version": "0.0.0",
16995     "filename": "server/api/mailSubstatus/index.js",
16996     "groupTitle": "Mail_Substatuses"
16997   },
16998   {
16999     "type": "post",
17000     "url": "/api/mail/reports/transfer",
17001     "title": "Creates a new Mail Transfer Report",
17002     "examples": [
17003       {
17004         "title": "Example usage:",
17005         "content": "curl https://{domain}/api/mail/reports/transfer -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17006         "type": "json"
17007       }
17008     ],
17009     "name": "CreateMail_Transfer_Reports",
17010     "group": "Mail_Transfer_Reports",
17011     "parameter": {
17012       "fields": {
17013         "Body": [
17014           {
17015             "group": "Body",
17016             "type": "String",
17017             "optional": false,
17018             "field": "uniqueid",
17019             "description": ""
17020           },
17021           {
17022             "group": "Body",
17023             "type": "String",
17024             "allowedValues": [
17025               "\"account\"",
17026               "\"agent\"",
17027               "\"queue\""
17028             ],
17029             "optional": false,
17030             "field": "type",
17031             "description": ""
17032           },
17033           {
17034             "group": "Body",
17035             "type": "String",
17036             "optional": false,
17037             "field": "transferredAt",
17038             "description": ""
17039           }
17040         ]
17041       }
17042     },
17043     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17044     "version": "0.0.0",
17045     "filename": "server/api/mailTransferReport/index.js",
17046     "groupTitle": "Mail_Transfer_Reports"
17047   },
17048   {
17049     "type": "delete",
17050     "url": "/api/mail/reports/transfer/{id}",
17051     "title": "Deletes a Mail Transfer Report",
17052     "examples": [
17053       {
17054         "title": "Example usage:",
17055         "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
17056         "type": "json"
17057       }
17058     ],
17059     "name": "DeleteMail_Transfer_Reports",
17060     "group": "Mail_Transfer_Reports",
17061     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17062     "version": "0.0.0",
17063     "filename": "server/api/mailTransferReport/index.js",
17064     "groupTitle": "Mail_Transfer_Reports"
17065   },
17066   {
17067     "type": "get",
17068     "url": "/api/mail/reports/transfer/describe",
17069     "title": "Gets table info about Mail Transfer Reports",
17070     "examples": [
17071       {
17072         "title": "Example usage:",
17073         "content": "curl https://{domain}/api/mail/reports/transfer/describe -v -u {name}:{password}",
17074         "type": "json"
17075       }
17076     ],
17077     "name": "DescribeMail_Transfer_Reports",
17078     "group": "Mail_Transfer_Reports",
17079     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17080     "version": "0.0.0",
17081     "filename": "server/api/mailTransferReport/index.js",
17082     "groupTitle": "Mail_Transfer_Reports"
17083   },
17084   {
17085     "type": "get",
17086     "url": "/api/mail/reports/transfer",
17087     "title": "Gets a list of Mail Transfer Reports",
17088     "examples": [
17089       {
17090         "title": "Example usage:",
17091         "content": "curl https://{domain}/api/mail/reports/transfer -v -u {name}:{password}",
17092         "type": "json"
17093       }
17094     ],
17095     "name": "GetMail_Transfer_Reports",
17096     "group": "Mail_Transfer_Reports",
17097     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/mail/reports/transfer?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/mail/reports/transfer?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/mail/reports/transfer?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/mail/reports/transfer?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/mail/reports/transfer?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
17098     "version": "0.0.0",
17099     "filename": "server/api/mailTransferReport/index.js",
17100     "groupTitle": "Mail_Transfer_Reports"
17101   },
17102   {
17103     "type": "get",
17104     "url": "/api/mail/reports/transfer/{id}",
17105     "title": "Gets a single Mail Transfer Report",
17106     "examples": [
17107       {
17108         "title": "Example usage:",
17109         "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password}",
17110         "type": "json"
17111       }
17112     ],
17113     "name": "ShowMail_Transfer_Reports",
17114     "group": "Mail_Transfer_Reports",
17115     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17116     "version": "0.0.0",
17117     "filename": "server/api/mailTransferReport/index.js",
17118     "groupTitle": "Mail_Transfer_Reports"
17119   },
17120   {
17121     "type": "put",
17122     "url": "/api/mail/reports/transfer/{id}",
17123     "title": "Update an existing Mail Transfer Report",
17124     "examples": [
17125       {
17126         "title": "Example usage:",
17127         "content": "curl https://{domain}/api/mail/reports/transfer/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
17128         "type": "json"
17129       }
17130     ],
17131     "name": "updateMail_Transfer_Reports",
17132     "group": "Mail_Transfer_Reports",
17133     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17134     "version": "0.0.0",
17135     "filename": "server/api/mailTransferReport/index.js",
17136     "groupTitle": "Mail_Transfer_Reports"
17137   },
17138   {
17139     "type": "get",
17140     "url": "/api/members/reports/describe",
17141     "title": "Gets table info about Member Reports",
17142     "examples": [
17143       {
17144         "title": "Example usage:",
17145         "content": "curl https://{domain}/api/members/reports/describe -v -u {name}:{password}",
17146         "type": "json"
17147       }
17148     ],
17149     "name": "DescribeMember_Reports",
17150     "group": "Member_Reports",
17151     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17152     "version": "0.0.0",
17153     "filename": "server/api/memberReport/index.js",
17154     "groupTitle": "Member_Reports"
17155   },
17156   {
17157     "type": "get",
17158     "url": "/api/members/reports",
17159     "title": "Gets a list of Member Reports",
17160     "examples": [
17161       {
17162         "title": "Example usage:",
17163         "content": "curl https://{domain}/api/members/reports -v -u {name}:{password}",
17164         "type": "json"
17165       }
17166     ],
17167     "name": "GetMember_Reports",
17168     "group": "Member_Reports",
17169     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/members/reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/members/reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/members/reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/members/reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/members/reports?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
17170     "version": "0.0.0",
17171     "filename": "server/api/memberReport/index.js",
17172     "groupTitle": "Member_Reports"
17173   },
17174   {
17175     "type": "get",
17176     "url": "/api/members/reports/{id}",
17177     "title": "Gets a single Member Report",
17178     "examples": [
17179       {
17180         "title": "Example usage:",
17181         "content": "curl https://{domain}/api/members/reports/{id} -v -u {name}:{password}",
17182         "type": "json"
17183       }
17184     ],
17185     "name": "ShowMember_Reports",
17186     "group": "Member_Reports",
17187     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17188     "version": "0.0.0",
17189     "filename": "server/api/memberReport/index.js",
17190     "groupTitle": "Member_Reports"
17191   },
17192   {
17193     "type": "get",
17194     "url": "/api/migrations",
17195     "title": "Gets a list of Migrations",
17196     "examples": [
17197       {
17198         "title": "Example usage:",
17199         "content": "curl https://{domain}/api/migrations -v -u {name}:{password}",
17200         "type": "json"
17201       }
17202     ],
17203     "name": "GetMigrations",
17204     "group": "Migrations",
17205     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/migrations?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/migrations?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/migrations?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/migrations?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/migrations?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
17206     "version": "0.0.0",
17207     "filename": "server/api/migration/index.js",
17208     "groupTitle": "Migrations"
17209   },
17210   {
17211     "type": "post",
17212     "url": "/api/voice/networks",
17213     "title": "Create a new network",
17214     "examples": [
17215       {
17216         "title": "Example usage:",
17217         "content": "curl https://{domain}/api/voice/networks -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17218         "type": "json"
17219       }
17220     ],
17221     "name": "Create",
17222     "group": "Networks",
17223     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17224     "version": "0.0.0",
17225     "filename": "server/api/network/index.js",
17226     "groupTitle": "Networks"
17227   },
17228   {
17229     "type": "delete",
17230     "url": "/api/voice/networks/{id}",
17231     "title": "Deletes a network",
17232     "examples": [
17233       {
17234         "title": "Example usage:",
17235         "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X DELETE",
17236         "type": "json"
17237       }
17238     ],
17239     "name": "Delete",
17240     "group": "Networks",
17241     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17242     "version": "0.0.0",
17243     "filename": "server/api/network/index.js",
17244     "groupTitle": "Networks"
17245   },
17246   {
17247     "type": "get",
17248     "url": "/api/networks",
17249     "title": "Gets a list of Networks",
17250     "examples": [
17251       {
17252         "title": "Example usage:",
17253         "content": "curl https://{domain}/api/networks -v -u {name}:{password}",
17254         "type": "json"
17255       }
17256     ],
17257     "name": "GetNetworks",
17258     "group": "Networks",
17259     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/networks?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/networks?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/networks?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/networks?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/networks?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
17260     "version": "0.0.0",
17261     "filename": "server/api/network/index.js",
17262     "groupTitle": "Networks"
17263   },
17264   {
17265     "type": "get",
17266     "url": "/api/networks/{id}",
17267     "title": "Gets a single Network",
17268     "examples": [
17269       {
17270         "title": "Example usage:",
17271         "content": "curl https://{domain}/api/networks/{id} -v -u {name}:{password}",
17272         "type": "json"
17273       }
17274     ],
17275     "name": "ShowNetworks",
17276     "group": "Networks",
17277     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17278     "version": "0.0.0",
17279     "filename": "server/api/network/index.js",
17280     "groupTitle": "Networks"
17281   },
17282   {
17283     "type": "put",
17284     "url": "/api/voice/networks/{id}",
17285     "title": "Update an existing network",
17286     "examples": [
17287       {
17288         "title": "Example usage:",
17289         "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X PUT",
17290         "type": "json"
17291       }
17292     ],
17293     "name": "Update",
17294     "group": "Networks",
17295     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17296     "version": "0.0.0",
17297     "filename": "server/api/network/index.js",
17298     "groupTitle": "Networks"
17299   },
17300   {
17301     "type": "post",
17302     "url": "/api/notifications",
17303     "title": "Send notification to user",
17304     "examples": [
17305       {
17306         "title": "Example usage:",
17307         "content": "curl https://{domain}/api/notifications -d '{\"text\": \"Hello!\", \"TemplateId\": 1}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17308         "type": "json"
17309       }
17310     ],
17311     "name": "Send",
17312     "group": "Notifications",
17313     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17314     "version": "0.0.0",
17315     "filename": "server/api/notification/index.js",
17316     "groupTitle": "Notifications"
17317   },
17318   {
17319     "type": "post",
17320     "url": "/api/openchannel/accounts/{id}/users",
17321     "title": "Add agents to a openchannel account",
17322     "examples": [
17323       {
17324         "title": "Example usage:",
17325         "content": "curl https://{domain}/api/openchannel/accounts/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17326         "type": "json"
17327       }
17328     ],
17329     "name": "AddAgents",
17330     "group": "Openchannel_Accounts",
17331     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17332     "version": "0.0.0",
17333     "filename": "server/api/openchannelAccount/index.js",
17334     "groupTitle": "Openchannel_Accounts"
17335   },
17336   {
17337     "type": "post",
17338     "url": "/api/openchannel/accounts",
17339     "title": "Creates a new Account",
17340     "examples": [
17341       {
17342         "title": "Example usage:",
17343         "content": "curl https://{domain}/api/openchannel/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17344         "type": "json"
17345       }
17346     ],
17347     "name": "CreateAccounts",
17348     "group": "Openchannel_Accounts",
17349     "parameter": {
17350       "fields": {
17351         "Body": [
17352           {
17353             "group": "Body",
17354             "type": "String",
17355             "optional": false,
17356             "field": "name",
17357             "description": ""
17358           },
17359           {
17360             "group": "Body",
17361             "type": "String",
17362             "optional": true,
17363             "field": "description",
17364             "description": ""
17365           },
17366           {
17367             "group": "Body",
17368             "type": "String",
17369             "optional": true,
17370             "field": "token",
17371             "description": ""
17372           },
17373           {
17374             "group": "Body",
17375             "type": "String",
17376             "optional": true,
17377             "field": "replyUri",
17378             "description": ""
17379           },
17380           {
17381             "group": "Body",
17382             "type": "String",
17383             "optional": false,
17384             "field": "key",
17385             "description": ""
17386           },
17387           {
17388             "group": "Body",
17389             "type": "Text",
17390             "optional": true,
17391             "field": "notificationTemplate",
17392             "description": ""
17393           },
17394           {
17395             "group": "Body",
17396             "type": "Boolean",
17397             "optional": true,
17398             "field": "notificationSound",
17399             "description": ""
17400           },
17401           {
17402             "group": "Body",
17403             "type": "Boolean",
17404             "optional": true,
17405             "field": "notificationShake",
17406             "description": ""
17407           },
17408           {
17409             "group": "Body",
17410             "type": "Integer",
17411             "optional": true,
17412             "field": "waitForTheAssignedAgent",
17413             "description": ""
17414           },
17415           {
17416             "group": "Body",
17417             "type": "String",
17418             "optional": true,
17419             "field": "mapKey",
17420             "description": ""
17421           },
17422           {
17423             "group": "Body",
17424             "type": "Boolean",
17425             "optional": true,
17426             "field": "queueTransfer",
17427             "description": ""
17428           },
17429           {
17430             "group": "Body",
17431             "type": "Integer",
17432             "optional": true,
17433             "field": "queueTransferTimeout",
17434             "description": ""
17435           },
17436           {
17437             "group": "Body",
17438             "type": "Boolean",
17439             "optional": true,
17440             "field": "agentTransfer",
17441             "description": ""
17442           },
17443           {
17444             "group": "Body",
17445             "type": "Integer",
17446             "optional": true,
17447             "field": "agentTransferTimeout",
17448             "description": ""
17449           },
17450           {
17451             "group": "Body",
17452             "type": "Integer",
17453             "optional": true,
17454             "field": "mandatoryDispositionPauseId",
17455             "description": "<p>Status to put when mandatory disposition is enabled</p>"
17456           },
17457           {
17458             "group": "Body",
17459             "type": "Boolean",
17460             "optional": true,
17461             "field": "mandatoryDisposition",
17462             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
17463           }
17464         ]
17465       }
17466     },
17467     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17468     "version": "0.0.0",
17469     "filename": "server/api/openchannelAccount/index.js",
17470     "groupTitle": "Openchannel_Accounts"
17471   },
17472   {
17473     "type": "delete",
17474     "url": "/api/openchannel/accounts/{id}",
17475     "title": "Deletes a Account",
17476     "examples": [
17477       {
17478         "title": "Example usage:",
17479         "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password} -X DELETE",
17480         "type": "json"
17481       }
17482     ],
17483     "name": "DeleteAccounts",
17484     "group": "Openchannel_Accounts",
17485     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17486     "version": "0.0.0",
17487     "filename": "server/api/openchannelAccount/index.js",
17488     "groupTitle": "Openchannel_Accounts"
17489   },
17490   {
17491     "type": "get",
17492     "url": "/api/openchannel/accounts/describe",
17493     "title": "Gets table info about Accounts",
17494     "examples": [
17495       {
17496         "title": "Example usage:",
17497         "content": "curl https://{domain}/api/openchannel/accounts/describe -v -u {name}:{password}",
17498         "type": "json"
17499       }
17500     ],
17501     "name": "DescribeAccounts",
17502     "group": "Openchannel_Accounts",
17503     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17504     "version": "0.0.0",
17505     "filename": "server/api/openchannelAccount/index.js",
17506     "groupTitle": "Openchannel_Accounts"
17507   },
17508   {
17509     "type": "get",
17510     "url": "/api/openchannel/accounts",
17511     "title": "Gets a list of Accounts",
17512     "examples": [
17513       {
17514         "title": "Example usage:",
17515         "content": "curl https://{domain}/api/openchannel/accounts -v -u {name}:{password}",
17516         "type": "json"
17517       }
17518     ],
17519     "name": "GetAccounts",
17520     "group": "Openchannel_Accounts",
17521     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/openchannel/accounts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/openchannel/accounts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/openchannel/accounts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/openchannel/accounts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/openchannel/accounts?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
17522     "version": "0.0.0",
17523     "filename": "server/api/openchannelAccount/index.js",
17524     "groupTitle": "Openchannel_Accounts"
17525   },
17526   {
17527     "type": "get",
17528     "url": "/api/openchannel/accounts/{id}/users",
17529     "title": "Gets agents from openchannel account",
17530     "examples": [
17531       {
17532         "title": "Example usage:",
17533         "content": "curl https://{domain}/api/openchannel/accounts/{id}/users -v -u {name}:{password} -X GET",
17534         "type": "json"
17535       }
17536     ],
17537     "name": "GetAgents",
17538     "group": "Openchannel_Accounts",
17539     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17540     "version": "0.0.0",
17541     "filename": "server/api/openchannelAccount/index.js",
17542     "groupTitle": "Openchannel_Accounts"
17543   },
17544   {
17545     "type": "delete",
17546     "url": "/api/openchannel/accounts/{id}/users",
17547     "title": "Removes agents from a openchannel account",
17548     "examples": [
17549       {
17550         "title": "Example usage:",
17551         "content": "curl https://{domain}/api/openchannel/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17552         "type": "json"
17553       }
17554     ],
17555     "name": "RemoveAgents",
17556     "group": "Openchannel_Accounts",
17557     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17558     "version": "0.0.0",
17559     "filename": "server/api/openchannelAccount/index.js",
17560     "groupTitle": "Openchannel_Accounts"
17561   },
17562   {
17563     "type": "delete",
17564     "url": "/api/openchannel/accounts/{id}/canned_answers",
17565     "title": "Removes canned answers from account",
17566     "examples": [
17567       {
17568         "title": "Example usage:",
17569         "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17570         "type": "json"
17571       }
17572     ],
17573     "name": "RemoveAnswers",
17574     "group": "Openchannel_Accounts",
17575     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17576     "version": "0.0.0",
17577     "filename": "server/api/openchannelAccount/index.js",
17578     "groupTitle": "Openchannel_Accounts"
17579   },
17580   {
17581     "type": "delete",
17582     "url": "/api/openchannel/accounts/{id}/dispositions",
17583     "title": "Removes dispositions from account",
17584     "examples": [
17585       {
17586         "title": "Example usage:",
17587         "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17588         "type": "json"
17589       }
17590     ],
17591     "name": "RemoveDispositions",
17592     "group": "Openchannel_Accounts",
17593     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17594     "version": "0.0.0",
17595     "filename": "server/api/openchannelAccount/index.js",
17596     "groupTitle": "Openchannel_Accounts"
17597   },
17598   {
17599     "type": "get",
17600     "url": "/api/openchannel/accounts/{id}",
17601     "title": "Gets a single Account",
17602     "examples": [
17603       {
17604         "title": "Example usage:",
17605         "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password}",
17606         "type": "json"
17607       }
17608     ],
17609     "name": "ShowAccounts",
17610     "group": "Openchannel_Accounts",
17611     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17612     "version": "0.0.0",
17613     "filename": "server/api/openchannelAccount/index.js",
17614     "groupTitle": "Openchannel_Accounts"
17615   },
17616   {
17617     "type": "post",
17618     "url": "/api/openchannel/accounts/{id}/canned_answers",
17619     "title": "Creates new canned answer",
17620     "examples": [
17621       {
17622         "title": "Example usage:",
17623         "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers -d '{\"name\": \"vip\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17624         "type": "json"
17625       }
17626     ],
17627     "name": "addAnswer",
17628     "group": "Openchannel_Accounts",
17629     "parameter": {
17630       "fields": {
17631         "Body": [
17632           {
17633             "group": "Body",
17634             "type": "String",
17635             "optional": false,
17636             "field": "key",
17637             "description": ""
17638           },
17639           {
17640             "group": "Body",
17641             "type": "Text",
17642             "optional": false,
17643             "field": "value",
17644             "description": ""
17645           },
17646           {
17647             "group": "Body",
17648             "type": "String",
17649             "optional": true,
17650             "field": "description",
17651             "description": ""
17652           },
17653           {
17654             "group": "Body",
17655             "type": "Virtual",
17656             "optional": true,
17657             "field": "name",
17658             "description": ""
17659           }
17660         ]
17661       }
17662     },
17663     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17664     "version": "0.0.0",
17665     "filename": "server/api/openchannelAccount/index.js",
17666     "groupTitle": "Openchannel_Accounts"
17667   },
17668   {
17669     "type": "post",
17670     "url": "/api/openchannel/accounts/{id}/applications",
17671     "title": "Creates new applications",
17672     "examples": [
17673       {
17674         "title": "Example usage:",
17675         "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17676         "type": "json"
17677       }
17678     ],
17679     "name": "addApplications",
17680     "group": "Openchannel_Accounts",
17681     "parameter": {
17682       "fields": {
17683         "Body": [
17684           {
17685             "group": "Body",
17686             "type": "Integer",
17687             "optional": false,
17688             "field": "priority",
17689             "description": ""
17690           },
17691           {
17692             "group": "Body",
17693             "type": "String",
17694             "optional": false,
17695             "field": "app",
17696             "description": ""
17697           },
17698           {
17699             "group": "Body",
17700             "type": "Text",
17701             "optional": true,
17702             "field": "appdata",
17703             "description": ""
17704           },
17705           {
17706             "group": "Body",
17707             "type": "String",
17708             "optional": true,
17709             "field": "description",
17710             "description": ""
17711           },
17712           {
17713             "group": "Body",
17714             "type": "String",
17715             "optional": true,
17716             "field": "interval",
17717             "description": ""
17718           }
17719         ]
17720       }
17721     },
17722     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17723     "version": "0.0.0",
17724     "filename": "server/api/openchannelAccount/index.js",
17725     "groupTitle": "Openchannel_Accounts"
17726   },
17727   {
17728     "type": "post",
17729     "url": "/api/openchannel/accounts/{id}/dispositions",
17730     "title": "Creates new disposition",
17731     "examples": [
17732       {
17733         "title": "Example usage:",
17734         "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17735         "type": "json"
17736       }
17737     ],
17738     "name": "addDisposition",
17739     "group": "Openchannel_Accounts",
17740     "parameter": {
17741       "fields": {
17742         "Body": [
17743           {
17744             "group": "Body",
17745             "type": "String",
17746             "optional": false,
17747             "field": "name",
17748             "description": ""
17749           },
17750           {
17751             "group": "Body",
17752             "type": "String",
17753             "allowedValues": [
17754               "\"first\"",
17755               "\"second\"",
17756               "\"third\""
17757             ],
17758             "optional": false,
17759             "field": "level",
17760             "description": ""
17761           },
17762           {
17763             "group": "Body",
17764             "type": "String",
17765             "optional": true,
17766             "field": "description",
17767             "description": ""
17768           }
17769         ]
17770       }
17771     },
17772     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17773     "version": "0.0.0",
17774     "filename": "server/api/openchannelAccount/index.js",
17775     "groupTitle": "Openchannel_Accounts"
17776   },
17777   {
17778     "type": "get",
17779     "url": "/api/openchannel/accounts/{id}/canned_answers",
17780     "title": "Gets account canned answers",
17781     "examples": [
17782       {
17783         "title": "Example usage:",
17784         "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
17785         "type": "json"
17786       }
17787     ],
17788     "name": "getAnswers",
17789     "group": "Openchannel_Accounts",
17790     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17791     "version": "0.0.0",
17792     "filename": "server/api/openchannelAccount/index.js",
17793     "groupTitle": "Openchannel_Accounts"
17794   },
17795   {
17796     "type": "get",
17797     "url": "/api/openchannel/accounts/{id}/applications",
17798     "title": "Gets account applications",
17799     "examples": [
17800       {
17801         "title": "Example usage:",
17802         "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -v -u {name}:{password} -X GET",
17803         "type": "json"
17804       }
17805     ],
17806     "name": "getApplications",
17807     "group": "Openchannel_Accounts",
17808     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17809     "version": "0.0.0",
17810     "filename": "server/api/openchannelAccount/index.js",
17811     "groupTitle": "Openchannel_Accounts"
17812   },
17813   {
17814     "type": "get",
17815     "url": "/api/openchannel/accounts/{id}/dispositions",
17816     "title": "Gets account dispositions",
17817     "examples": [
17818       {
17819         "title": "Example usage:",
17820         "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
17821         "type": "json"
17822       }
17823     ],
17824     "name": "getDispositions",
17825     "group": "Openchannel_Accounts",
17826     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17827     "version": "0.0.0",
17828     "filename": "server/api/openchannelAccount/index.js",
17829     "groupTitle": "Openchannel_Accounts"
17830   },
17831   {
17832     "type": "get",
17833     "url": "/api/openchannel/accounts/{id}/interactions",
17834     "title": "Gets Openchannel Account Interactions",
17835     "examples": [
17836       {
17837         "title": "Example usage:",
17838         "content": "curl https://{domain}/api/openchannel/accounts/{id}/interactions -v -u {name}:{password} -X GET",
17839         "type": "json"
17840       }
17841     ],
17842     "name": "getInteractions",
17843     "group": "Openchannel_Accounts",
17844     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17845     "version": "0.0.0",
17846     "filename": "server/api/openchannelAccount/index.js",
17847     "groupTitle": "Openchannel_Accounts"
17848   },
17849   {
17850     "type": "post",
17851     "url": "/api/openchannel/accounts/{id}/notify",
17852     "title": "Notify new message",
17853     "examples": [
17854       {
17855         "title": "Example usage:",
17856         "content": "curl https://{domain}/api/openchannel/accounts/{id}/notify -d '{\"body\": \"hello world\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17857         "type": "json"
17858       }
17859     ],
17860     "name": "notify",
17861     "group": "Openchannel_Accounts",
17862     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <p>Follow this link to check the documentation: <pre><a target=\"_blank\" href=\"https://wiki.xcallymotion.com/display/XMV/New+Channels+Configuration+Steps#NewChannelsConfigurationSteps-BuildyourownChannelservice\">https://wiki.xcallymotion.com/display/XMV/New+Channels+Configuration+Steps#NewChannelsConfigurationSteps-BuildyourownChannelservice</a></pre></p>",
17863     "version": "0.0.0",
17864     "filename": "server/api/openchannelAccount/index.js",
17865     "groupTitle": "Openchannel_Accounts"
17866   },
17867   {
17868     "type": "post",
17869     "url": "/api/openchannel/accounts/{id}/send",
17870     "title": "Send new openchannel message",
17871     "examples": [
17872       {
17873         "title": "Example usage:",
17874         "content": "curl https://{domain}/api/openchannel/accounts/{id}/send -d '{from: 'John Doe', body: 'This is a test'}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17875         "type": "json"
17876       }
17877     ],
17878     "name": "sendOpenchannel",
17879     "group": "Openchannel_Accounts",
17880     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17881     "version": "0.0.0",
17882     "filename": "server/api/openchannelAccount/index.js",
17883     "groupTitle": "Openchannel_Accounts"
17884   },
17885   {
17886     "type": "put",
17887     "url": "/api/openchannel/accounts/{id}",
17888     "title": "Update an existing Account",
17889     "examples": [
17890       {
17891         "title": "Example usage:",
17892         "content": "curl https://{domain}/api/openchannel/accounts/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
17893         "type": "json"
17894       }
17895     ],
17896     "name": "updateAccounts",
17897     "group": "Openchannel_Accounts",
17898     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17899     "version": "0.0.0",
17900     "filename": "server/api/openchannelAccount/index.js",
17901     "groupTitle": "Openchannel_Accounts"
17902   },
17903   {
17904     "type": "post",
17905     "url": "/api/openchannel/applications",
17906     "title": "Creates a new Application",
17907     "examples": [
17908       {
17909         "title": "Example usage:",
17910         "content": "curl https://{domain}/api/openchannel/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17911         "type": "json"
17912       }
17913     ],
17914     "name": "CreateApplications",
17915     "group": "Openchannel_Applications",
17916     "parameter": {
17917       "fields": {
17918         "Body": [
17919           {
17920             "group": "Body",
17921             "type": "Integer",
17922             "optional": false,
17923             "field": "priority",
17924             "description": ""
17925           },
17926           {
17927             "group": "Body",
17928             "type": "String",
17929             "optional": false,
17930             "field": "app",
17931             "description": ""
17932           },
17933           {
17934             "group": "Body",
17935             "type": "Text",
17936             "optional": true,
17937             "field": "appdata",
17938             "description": ""
17939           },
17940           {
17941             "group": "Body",
17942             "type": "String",
17943             "optional": true,
17944             "field": "description",
17945             "description": ""
17946           },
17947           {
17948             "group": "Body",
17949             "type": "String",
17950             "optional": true,
17951             "field": "interval",
17952             "description": ""
17953           }
17954         ]
17955       }
17956     },
17957     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17958     "version": "0.0.0",
17959     "filename": "server/api/openchannelApplication/index.js",
17960     "groupTitle": "Openchannel_Applications"
17961   },
17962   {
17963     "type": "delete",
17964     "url": "/api/openchannel/applications/{id}",
17965     "title": "Deletes a Application",
17966     "examples": [
17967       {
17968         "title": "Example usage:",
17969         "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password} -X DELETE",
17970         "type": "json"
17971       }
17972     ],
17973     "name": "DeleteApplications",
17974     "group": "Openchannel_Applications",
17975     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17976     "version": "0.0.0",
17977     "filename": "server/api/openchannelApplication/index.js",
17978     "groupTitle": "Openchannel_Applications"
17979   },
17980   {
17981     "type": "get",
17982     "url": "/api/openchannel/applications",
17983     "title": "Gets a list of Applications",
17984     "examples": [
17985       {
17986         "title": "Example usage:",
17987         "content": "curl https://{domain}/api/openchannel/applications -v -u {name}:{password}",
17988         "type": "json"
17989       }
17990     ],
17991     "name": "GetApplications",
17992     "group": "Openchannel_Applications",
17993     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/openchannel/applications?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/openchannel/applications?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/openchannel/applications?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/openchannel/applications?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/openchannel/applications?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
17994     "version": "0.0.0",
17995     "filename": "server/api/openchannelApplication/index.js",
17996     "groupTitle": "Openchannel_Applications"
17997   },
17998   {
17999     "type": "get",
18000     "url": "/api/openchannel/applications/{id}",
18001     "title": "Gets a single Application",
18002     "examples": [
18003       {
18004         "title": "Example usage:",
18005         "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password}",
18006         "type": "json"
18007       }
18008     ],
18009     "name": "ShowApplications",
18010     "group": "Openchannel_Applications",
18011     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18012     "version": "0.0.0",
18013     "filename": "server/api/openchannelApplication/index.js",
18014     "groupTitle": "Openchannel_Applications"
18015   },
18016   {
18017     "type": "put",
18018     "url": "/api/openchannel/applications/{id}",
18019     "title": "Update an existing Application",
18020     "examples": [
18021       {
18022         "title": "Example usage:",
18023         "content": "curl https://{domain}/api/openchannel/applications/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
18024         "type": "json"
18025       }
18026     ],
18027     "name": "updateApplications",
18028     "group": "Openchannel_Applications",
18029     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18030     "version": "0.0.0",
18031     "filename": "server/api/openchannelApplication/index.js",
18032     "groupTitle": "Openchannel_Applications"
18033   },
18034   {
18035     "type": "post",
18036     "url": "/api/openchannel/interactions/{id}/tags",
18037     "title": "Add tags to the interaction",
18038     "examples": [
18039       {
18040         "title": "Example usage:",
18041         "content": "curl https://{domain}/api/openchannel/interaction/{id}/tags -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
18042         "type": "json"
18043       }
18044     ],
18045     "name": "AddTags",
18046     "group": "Openchannel_Interactions",
18047     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18048     "version": "0.0.0",
18049     "filename": "server/api/openchannelInteraction/index.js",
18050     "groupTitle": "Openchannel_Interactions"
18051   },
18052   {
18053     "type": "post",
18054     "url": "/api/openchannel/interactions",
18055     "title": "Creates a new Interaction",
18056     "examples": [
18057       {
18058         "title": "Example usage:",
18059         "content": "curl https://{domain}/api/openchannel/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18060         "type": "json"
18061       }
18062     ],
18063     "name": "CreateInteractions",
18064     "group": "Openchannel_Interactions",
18065     "parameter": {
18066       "fields": {
18067         "Body": [
18068           {
18069             "group": "Body",
18070             "type": "Boolean",
18071             "optional": true,
18072             "field": "closed",
18073             "description": ""
18074           },
18075           {
18076             "group": "Body",
18077             "type": "String",
18078             "optional": true,
18079             "field": "closedAt",
18080             "description": ""
18081           },
18082           {
18083             "group": "Body",
18084             "type": "String",
18085             "optional": true,
18086             "field": "disposition",
18087             "description": ""
18088           },
18089           {
18090             "group": "Body",
18091             "type": "String",
18092             "optional": true,
18093             "field": "secondDisposition",
18094             "description": ""
18095           },
18096           {
18097             "group": "Body",
18098             "type": "String",
18099             "optional": true,
18100             "field": "thirdDisposition",
18101             "description": ""
18102           },
18103           {
18104             "group": "Body",
18105             "type": "String",
18106             "optional": true,
18107             "field": "note",
18108             "description": ""
18109           },
18110           {
18111             "group": "Body",
18112             "type": "String",
18113             "optional": true,
18114             "field": "read1stAt",
18115             "description": ""
18116           },
18117           {
18118             "group": "Body",
18119             "type": "String",
18120             "optional": true,
18121             "field": "threadId",
18122             "description": ""
18123           },
18124           {
18125             "group": "Body",
18126             "type": "String",
18127             "optional": true,
18128             "field": "externalUrl",
18129             "description": ""
18130           },
18131           {
18132             "group": "Body",
18133             "type": "String",
18134             "optional": true,
18135             "field": "lastMsgAt",
18136             "description": ""
18137           },
18138           {
18139             "group": "Body",
18140             "type": "String",
18141             "allowedValues": [
18142               "\"in\"",
18143               "\"out\""
18144             ],
18145             "optional": false,
18146             "field": "lastMsgDirection",
18147             "description": ""
18148           },
18149           {
18150             "group": "Body",
18151             "type": "String",
18152             "optional": true,
18153             "field": "from",
18154             "description": ""
18155           }
18156         ]
18157       }
18158     },
18159     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18160     "version": "0.0.0",
18161     "filename": "server/api/openchannelInteraction/index.js",
18162     "groupTitle": "Openchannel_Interactions"
18163   },
18164   {
18165     "type": "delete",
18166     "url": "/api/openchannel/interactions/{id}",
18167     "title": "Deletes a Interaction",
18168     "examples": [
18169       {
18170         "title": "Example usage:",
18171         "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password} -X DELETE",
18172         "type": "json"
18173       }
18174     ],
18175     "name": "DeleteInteractions",
18176     "group": "Openchannel_Interactions",
18177     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18178     "version": "0.0.0",
18179     "filename": "server/api/openchannelInteraction/index.js",
18180     "groupTitle": "Openchannel_Interactions"
18181   },
18182   {
18183     "type": "get",
18184     "url": "/api/openchannel/interactions/describe",
18185     "title": "Gets table info about Interactions",
18186     "examples": [
18187       {
18188         "title": "Example usage:",
18189         "content": "curl https://{domain}/api/openchannel/interactions/describe -v -u {name}:{password}",
18190         "type": "json"
18191       }
18192     ],
18193     "name": "DescribeInteractions",
18194     "group": "Openchannel_Interactions",
18195     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18196     "version": "0.0.0",
18197     "filename": "server/api/openchannelInteraction/index.js",
18198     "groupTitle": "Openchannel_Interactions"
18199   },
18200   {
18201     "type": "get",
18202     "url": "/api/openchannel/interactions",
18203     "title": "Gets a list of Interactions",
18204     "examples": [
18205       {
18206         "title": "Example usage:",
18207         "content": "curl https://{domain}/api/openchannel/interactions -v -u {name}:{password}",
18208         "type": "json"
18209       }
18210     ],
18211     "name": "GetInteractions",
18212     "group": "Openchannel_Interactions",
18213     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/openchannel/interactions?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/openchannel/interactions?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/openchannel/interactions?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/openchannel/interactions?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/openchannel/interactions?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
18214     "version": "0.0.0",
18215     "filename": "server/api/openchannelInteraction/index.js",
18216     "groupTitle": "Openchannel_Interactions"
18217   },
18218   {
18219     "type": "delete",
18220     "url": "/api/openchannel/interactions/{id}/tags",
18221     "title": "Removes tags from interaction",
18222     "examples": [
18223       {
18224         "title": "Example usage:",
18225         "content": "curl https://{domain}/api/openchannel/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
18226         "type": "json"
18227       }
18228     ],
18229     "name": "RemoveTags",
18230     "group": "Openchannel_Interactions",
18231     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18232     "version": "0.0.0",
18233     "filename": "server/api/openchannelInteraction/index.js",
18234     "groupTitle": "Openchannel_Interactions"
18235   },
18236   {
18237     "type": "get",
18238     "url": "/api/openchannel/interactions/{id}",
18239     "title": "Gets a single Interaction",
18240     "examples": [
18241       {
18242         "title": "Example usage:",
18243         "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password}",
18244         "type": "json"
18245       }
18246     ],
18247     "name": "ShowInteractions",
18248     "group": "Openchannel_Interactions",
18249     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18250     "version": "0.0.0",
18251     "filename": "server/api/openchannelInteraction/index.js",
18252     "groupTitle": "Openchannel_Interactions"
18253   },
18254   {
18255     "type": "post",
18256     "url": "/api/openchannel/interactions/{id}/messages",
18257     "title": "Creates new messages",
18258     "examples": [
18259       {
18260         "title": "Example usage:",
18261         "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
18262         "type": "json"
18263       }
18264     ],
18265     "name": "addMessage",
18266     "group": "Openchannel_Interactions",
18267     "parameter": {
18268       "fields": {
18269         "Body": [
18270           {
18271             "group": "Body",
18272             "type": "Text",
18273             "optional": false,
18274             "field": "body",
18275             "description": ""
18276           },
18277           {
18278             "group": "Body",
18279             "type": "Boolean",
18280             "optional": true,
18281             "field": "read",
18282             "description": ""
18283           },
18284           {
18285             "group": "Body",
18286             "type": "Boolean",
18287             "optional": true,
18288             "field": "secret",
18289             "description": ""
18290           },
18291           {
18292             "group": "Body",
18293             "type": "String",
18294             "allowedValues": [
18295               "\"in\"",
18296               "\"out\""
18297             ],
18298             "optional": false,
18299             "field": "direction",
18300             "description": ""
18301           },
18302           {
18303             "group": "Body",
18304             "type": "String",
18305             "optional": true,
18306             "field": "readAt",
18307             "description": ""
18308           },
18309           {
18310             "group": "Body",
18311             "type": "String",
18312             "optional": true,
18313             "field": "providerName",
18314             "description": ""
18315           },
18316           {
18317             "group": "Body",
18318             "type": "Text",
18319             "optional": true,
18320             "field": "providerResponse",
18321             "description": ""
18322           }
18323         ]
18324       }
18325     },
18326     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18327     "version": "0.0.0",
18328     "filename": "server/api/openchannelInteraction/index.js",
18329     "groupTitle": "Openchannel_Interactions"
18330   },
18331   {
18332     "type": "get",
18333     "url": "/api/openchannel/interactions/{id}/download",
18334     "title": "Gets interaction",
18335     "examples": [
18336       {
18337         "title": "Example usage:",
18338         "content": "curl https://{domain}/api/openchannel/interactions/{id}/download -v -u {name}:{password} -X GET",
18339         "type": "json"
18340       }
18341     ],
18342     "name": "download",
18343     "group": "Openchannel_Interactions",
18344     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18345     "version": "0.0.0",
18346     "filename": "server/api/openchannelInteraction/index.js",
18347     "groupTitle": "Openchannel_Interactions"
18348   },
18349   {
18350     "type": "get",
18351     "url": "/api/openchannel/interactions/{id}/messages",
18352     "title": "Gets interaction messages",
18353     "examples": [
18354       {
18355         "title": "Example usage:",
18356         "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -v -u {name}:{password} -X GET",
18357         "type": "json"
18358       }
18359     ],
18360     "name": "getMessages",
18361     "group": "Openchannel_Interactions",
18362     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18363     "version": "0.0.0",
18364     "filename": "server/api/openchannelInteraction/index.js",
18365     "groupTitle": "Openchannel_Interactions"
18366   },
18367   {
18368     "type": "put",
18369     "url": "/api/openchannel/interactions/{id}",
18370     "title": "Update an existing Interaction",
18371     "examples": [
18372       {
18373         "title": "Example usage:",
18374         "content": "curl https://{domain}/api/openchannel/interactions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
18375         "type": "json"
18376       }
18377     ],
18378     "name": "updateInteractions",
18379     "group": "Openchannel_Interactions",
18380     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18381     "version": "0.0.0",
18382     "filename": "server/api/openchannelInteraction/index.js",
18383     "groupTitle": "Openchannel_Interactions"
18384   },
18385   {
18386     "type": "post",
18387     "url": "/api/openchannel/messages",
18388     "title": "Creates a new Message",
18389     "examples": [
18390       {
18391         "title": "Example usage:",
18392         "content": "curl https://{domain}/api/openchannel/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18393         "type": "json"
18394       }
18395     ],
18396     "name": "CreateMessages",
18397     "group": "Openchannel_Messages",
18398     "parameter": {
18399       "fields": {
18400         "Body": [
18401           {
18402             "group": "Body",
18403             "type": "Text",
18404             "optional": false,
18405             "field": "body",
18406             "description": ""
18407           },
18408           {
18409             "group": "Body",
18410             "type": "Boolean",
18411             "optional": true,
18412             "field": "read",
18413             "description": ""
18414           },
18415           {
18416             "group": "Body",
18417             "type": "Boolean",
18418             "optional": true,
18419             "field": "secret",
18420             "description": ""
18421           },
18422           {
18423             "group": "Body",
18424             "type": "String",
18425             "allowedValues": [
18426               "\"in\"",
18427               "\"out\""
18428             ],
18429             "optional": false,
18430             "field": "direction",
18431             "description": ""
18432           },
18433           {
18434             "group": "Body",
18435             "type": "String",
18436             "optional": true,
18437             "field": "readAt",
18438             "description": ""
18439           },
18440           {
18441             "group": "Body",
18442             "type": "String",
18443             "optional": true,
18444             "field": "providerName",
18445             "description": ""
18446           },
18447           {
18448             "group": "Body",
18449             "type": "Text",
18450             "optional": true,
18451             "field": "providerResponse",
18452             "description": ""
18453           }
18454         ]
18455       }
18456     },
18457     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18458     "version": "0.0.0",
18459     "filename": "server/api/openchannelMessage/index.js",
18460     "groupTitle": "Openchannel_Messages"
18461   },
18462   {
18463     "type": "delete",
18464     "url": "/api/openchannel/messages/{id}",
18465     "title": "Deletes a Message",
18466     "examples": [
18467       {
18468         "title": "Example usage:",
18469         "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password} -X DELETE",
18470         "type": "json"
18471       }
18472     ],
18473     "name": "DeleteMessages",
18474     "group": "Openchannel_Messages",
18475     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18476     "version": "0.0.0",
18477     "filename": "server/api/openchannelMessage/index.js",
18478     "groupTitle": "Openchannel_Messages"
18479   },
18480   {
18481     "type": "get",
18482     "url": "/api/openchannel/messages/describe",
18483     "title": "Gets table info about Messages",
18484     "examples": [
18485       {
18486         "title": "Example usage:",
18487         "content": "curl https://{domain}/api/openchannel/messages/describe -v -u {name}:{password}",
18488         "type": "json"
18489       }
18490     ],
18491     "name": "DescribeMessages",
18492     "group": "Openchannel_Messages",
18493     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18494     "version": "0.0.0",
18495     "filename": "server/api/openchannelMessage/index.js",
18496     "groupTitle": "Openchannel_Messages"
18497   },
18498   {
18499     "type": "get",
18500     "url": "/api/openchannel/messages",
18501     "title": "Gets a list of Messages",
18502     "examples": [
18503       {
18504         "title": "Example usage:",
18505         "content": "curl https://{domain}/api/openchannel/messages -v -u {name}:{password}",
18506         "type": "json"
18507       }
18508     ],
18509     "name": "GetMessages",
18510     "group": "Openchannel_Messages",
18511     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/openchannel/messages?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/openchannel/messages?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/openchannel/messages?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/openchannel/messages?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/openchannel/messages?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
18512     "version": "0.0.0",
18513     "filename": "server/api/openchannelMessage/index.js",
18514     "groupTitle": "Openchannel_Messages"
18515   },
18516   {
18517     "type": "get",
18518     "url": "/api/openchannel/messages/{id}",
18519     "title": "Gets a single Message",
18520     "examples": [
18521       {
18522         "title": "Example usage:",
18523         "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password}",
18524         "type": "json"
18525       }
18526     ],
18527     "name": "ShowMessages",
18528     "group": "Openchannel_Messages",
18529     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18530     "version": "0.0.0",
18531     "filename": "server/api/openchannelMessage/index.js",
18532     "groupTitle": "Openchannel_Messages"
18533   },
18534   {
18535     "type": "put",
18536     "url": "/api/openchannel/messages/{id}/accept",
18537     "title": "Accepts message",
18538     "examples": [
18539       {
18540         "title": "Example usage:",
18541         "content": "curl https://{domain}/api/openchannel/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
18542         "type": "json"
18543       }
18544     ],
18545     "name": "acceptMessage",
18546     "group": "Openchannel_Messages",
18547     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18548     "version": "0.0.0",
18549     "filename": "server/api/openchannelMessage/index.js",
18550     "groupTitle": "Openchannel_Messages"
18551   },
18552   {
18553     "type": "put",
18554     "url": "/api/openchannel/messages/{id}/reject",
18555     "title": "Rejects message",
18556     "examples": [
18557       {
18558         "title": "Example usage:",
18559         "content": "curl https://{domain}/api/openchannel/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
18560         "type": "json"
18561       }
18562     ],
18563     "name": "rejectMessage",
18564     "group": "Openchannel_Messages",
18565     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18566     "version": "0.0.0",
18567     "filename": "server/api/openchannelMessage/index.js",
18568     "groupTitle": "Openchannel_Messages"
18569   },
18570   {
18571     "type": "put",
18572     "url": "/api/openchannel/messages/{id}",
18573     "title": "Update an existing Message",
18574     "examples": [
18575       {
18576         "title": "Example usage:",
18577         "content": "curl https://{domain}/api/openchannel/messages/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
18578         "type": "json"
18579       }
18580     ],
18581     "name": "updateMessages",
18582     "group": "Openchannel_Messages",
18583     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18584     "version": "0.0.0",
18585     "filename": "server/api/openchannelMessage/index.js",
18586     "groupTitle": "Openchannel_Messages"
18587   },
18588   {
18589     "type": "post",
18590     "url": "/api/openchannel/reports/queue",
18591     "title": "Creates a new Openchannel Queue Report",
18592     "examples": [
18593       {
18594         "title": "Example usage:",
18595         "content": "curl https://{domain}/api/openchannel/reports/queue -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18596         "type": "json"
18597       }
18598     ],
18599     "name": "CreateOpenchannel_Queue_Reports",
18600     "group": "Openchannel_Queue_Reports",
18601     "parameter": {
18602       "fields": {
18603         "Body": [
18604           {
18605             "group": "Body",
18606             "type": "String",
18607             "optional": false,
18608             "field": "uniqueid",
18609             "description": ""
18610           },
18611           {
18612             "group": "Body",
18613             "type": "String",
18614             "optional": true,
18615             "field": "from",
18616             "description": ""
18617           },
18618           {
18619             "group": "Body",
18620             "type": "String",
18621             "optional": true,
18622             "field": "joinAt",
18623             "description": ""
18624           },
18625           {
18626             "group": "Body",
18627             "type": "String",
18628             "optional": true,
18629             "field": "leaveAt",
18630             "description": ""
18631           },
18632           {
18633             "group": "Body",
18634             "type": "String",
18635             "optional": true,
18636             "field": "acceptAt",
18637             "description": ""
18638           },
18639           {
18640             "group": "Body",
18641             "type": "String",
18642             "optional": true,
18643             "field": "exitAt",
18644             "description": ""
18645           },
18646           {
18647             "group": "Body",
18648             "type": "String",
18649             "optional": true,
18650             "field": "reason",
18651             "description": ""
18652           }
18653         ]
18654       }
18655     },
18656     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18657     "version": "0.0.0",
18658     "filename": "server/api/openchannelQueueReport/index.js",
18659     "groupTitle": "Openchannel_Queue_Reports"
18660   },
18661   {
18662     "type": "delete",
18663     "url": "/api/openchannel/reports/queue/{id}",
18664     "title": "Deletes a Openchannel Queue Report",
18665     "examples": [
18666       {
18667         "title": "Example usage:",
18668         "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password} -X DELETE",
18669         "type": "json"
18670       }
18671     ],
18672     "name": "DeleteOpenchannel_Queue_Reports",
18673     "group": "Openchannel_Queue_Reports",
18674     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18675     "version": "0.0.0",
18676     "filename": "server/api/openchannelQueueReport/index.js",
18677     "groupTitle": "Openchannel_Queue_Reports"
18678   },
18679   {
18680     "type": "get",
18681     "url": "/api/openchannel/reports/queue/describe",
18682     "title": "Gets table info about Openchannel Queue Reports",
18683     "examples": [
18684       {
18685         "title": "Example usage:",
18686         "content": "curl https://{domain}/api/openchannel/reports/queue/describe -v -u {name}:{password}",
18687         "type": "json"
18688       }
18689     ],
18690     "name": "DescribeOpenchannel_Queue_Reports",
18691     "group": "Openchannel_Queue_Reports",
18692     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18693     "version": "0.0.0",
18694     "filename": "server/api/openchannelQueueReport/index.js",
18695     "groupTitle": "Openchannel_Queue_Reports"
18696   },
18697   {
18698     "type": "get",
18699     "url": "/api/openchannel/reports/queue",
18700     "title": "Gets a list of Openchannel Queue Reports",
18701     "examples": [
18702       {
18703         "title": "Example usage:",
18704         "content": "curl https://{domain}/api/openchannel/reports/queue -v -u {name}:{password}",
18705         "type": "json"
18706       }
18707     ],
18708     "name": "GetOpenchannel_Queue_Reports",
18709     "group": "Openchannel_Queue_Reports",
18710     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/openchannel/reports/queue?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/openchannel/reports/queue?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/openchannel/reports/queue?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/openchannel/reports/queue?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/openchannel/reports/queue?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
18711     "version": "0.0.0",
18712     "filename": "server/api/openchannelQueueReport/index.js",
18713     "groupTitle": "Openchannel_Queue_Reports"
18714   },
18715   {
18716     "type": "get",
18717     "url": "/api/openchannel/reports/queue/{id}",
18718     "title": "Gets a single Openchannel Queue Report",
18719     "examples": [
18720       {
18721         "title": "Example usage:",
18722         "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password}",
18723         "type": "json"
18724       }
18725     ],
18726     "name": "ShowOpenchannel_Queue_Reports",
18727     "group": "Openchannel_Queue_Reports",
18728     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18729     "version": "0.0.0",
18730     "filename": "server/api/openchannelQueueReport/index.js",
18731     "groupTitle": "Openchannel_Queue_Reports"
18732   },
18733   {
18734     "type": "put",
18735     "url": "/api/openchannel/reports/queue/{id}",
18736     "title": "Update an existing Openchannel Queue Report",
18737     "examples": [
18738       {
18739         "title": "Example usage:",
18740         "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
18741         "type": "json"
18742       }
18743     ],
18744     "name": "updateOpenchannel_Queue_Reports",
18745     "group": "Openchannel_Queue_Reports",
18746     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18747     "version": "0.0.0",
18748     "filename": "server/api/openchannelQueueReport/index.js",
18749     "groupTitle": "Openchannel_Queue_Reports"
18750   },
18751   {
18752     "type": "post",
18753     "url": "/api/openchannel/queues/{id}/users",
18754     "title": "Add agents to a queue",
18755     "examples": [
18756       {
18757         "title": "Example usage:",
18758         "content": "curl https://{domain}/api/openchannel/queues/{id}/users -d '{\"ids\": [1,2], \"penalty\": 2}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
18759         "type": "json"
18760       }
18761     ],
18762     "name": "AddAgents",
18763     "group": "Openchannel_Queues",
18764     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18765     "version": "0.0.0",
18766     "filename": "server/api/openchannelQueue/index.js",
18767     "groupTitle": "Openchannel_Queues"
18768   },
18769   {
18770     "type": "post",
18771     "url": "/api/openchannel/queues/{id}/teams",
18772     "title": "Add teams to a queue",
18773     "examples": [
18774       {
18775         "title": "Example usage:",
18776         "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
18777         "type": "json"
18778       }
18779     ],
18780     "name": "AddTeams",
18781     "group": "Openchannel_Queues",
18782     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18783     "version": "0.0.0",
18784     "filename": "server/api/openchannelQueue/index.js",
18785     "groupTitle": "Openchannel_Queues"
18786   },
18787   {
18788     "type": "post",
18789     "url": "/api/openchannel/queues",
18790     "title": "Creates a new Queue",
18791     "examples": [
18792       {
18793         "title": "Example usage:",
18794         "content": "curl https://{domain}/api/openchannel/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18795         "type": "json"
18796       }
18797     ],
18798     "name": "CreateQueues",
18799     "group": "Openchannel_Queues",
18800     "parameter": {
18801       "fields": {
18802         "Body": [
18803           {
18804             "group": "Body",
18805             "type": "String",
18806             "optional": true,
18807             "field": "name",
18808             "description": ""
18809           },
18810           {
18811             "group": "Body",
18812             "type": "String",
18813             "optional": true,
18814             "field": "description",
18815             "description": ""
18816           },
18817           {
18818             "group": "Body",
18819             "type": "Integer",
18820             "optional": true,
18821             "field": "timeout",
18822             "description": ""
18823           },
18824           {
18825             "group": "Body",
18826             "type": "String",
18827             "allowedValues": [
18828               "\"rrmemory\"",
18829               "\"beepall\"",
18830               "\"roundrobin\""
18831             ],
18832             "optional": true,
18833             "field": "strategy",
18834             "description": ""
18835           }
18836         ]
18837       }
18838     },
18839     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18840     "version": "0.0.0",
18841     "filename": "server/api/openchannelQueue/index.js",
18842     "groupTitle": "Openchannel_Queues"
18843   },
18844   {
18845     "type": "delete",
18846     "url": "/api/openchannel/queues/{id}",
18847     "title": "Deletes a Queue",
18848     "examples": [
18849       {
18850         "title": "Example usage:",
18851         "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password} -X DELETE",
18852         "type": "json"
18853       }
18854     ],
18855     "name": "DeleteQueues",
18856     "group": "Openchannel_Queues",
18857     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18858     "version": "0.0.0",
18859     "filename": "server/api/openchannelQueue/index.js",
18860     "groupTitle": "Openchannel_Queues"
18861   },
18862   {
18863     "type": "get",
18864     "url": "/api/openchannel/queues/describe",
18865     "title": "Gets table info about Queues",
18866     "examples": [
18867       {
18868         "title": "Example usage:",
18869         "content": "curl https://{domain}/api/openchannel/queues/describe -v -u {name}:{password}",
18870         "type": "json"
18871       }
18872     ],
18873     "name": "DescribeQueues",
18874     "group": "Openchannel_Queues",
18875     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18876     "version": "0.0.0",
18877     "filename": "server/api/openchannelQueue/index.js",
18878     "groupTitle": "Openchannel_Queues"
18879   },
18880   {
18881     "type": "get",
18882     "url": "/api/openchannel/queues/{id}/users",
18883     "title": "Gets queue agents",
18884     "examples": [
18885       {
18886         "title": "Example usage:",
18887         "content": "curl https://{domain}/api/openchannel/queues/{id}/users -v -u {name}:{password} -X POST",
18888         "type": "json"
18889       }
18890     ],
18891     "name": "GetAgents",
18892     "group": "Openchannel_Queues",
18893     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18894     "version": "0.0.0",
18895     "filename": "server/api/openchannelQueue/index.js",
18896     "groupTitle": "Openchannel_Queues"
18897   },
18898   {
18899     "type": "get",
18900     "url": "/api/openchannel/queues/{id}/members",
18901     "title": "GetMembers",
18902     "examples": [
18903       {
18904         "title": "Example usage:",
18905         "content": "curl https://{domain}/api/openchannel/queues/{id}/members  -v -u {name}:{password}",
18906         "type": "json"
18907       }
18908     ],
18909     "name": "GetMembers",
18910     "group": "Openchannel_Queues",
18911     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18912     "version": "0.0.0",
18913     "filename": "server/api/openchannelQueue/index.js",
18914     "groupTitle": "Openchannel_Queues"
18915   },
18916   {
18917     "type": "get",
18918     "url": "/api/openchannel/queues",
18919     "title": "Gets a list of Queues",
18920     "examples": [
18921       {
18922         "title": "Example usage:",
18923         "content": "curl https://{domain}/api/openchannel/queues -v -u {name}:{password}",
18924         "type": "json"
18925       }
18926     ],
18927     "name": "GetQueues",
18928     "group": "Openchannel_Queues",
18929     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/openchannel/queues?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/openchannel/queues?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/openchannel/queues?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/openchannel/queues?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/openchannel/queues?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
18930     "version": "0.0.0",
18931     "filename": "server/api/openchannelQueue/index.js",
18932     "groupTitle": "Openchannel_Queues"
18933   },
18934   {
18935     "type": "get",
18936     "url": "/api/openchannel/queues/{id}/teams",
18937     "title": "Gets queues list",
18938     "examples": [
18939       {
18940         "title": "Example usage:",
18941         "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password}",
18942         "type": "json"
18943       }
18944     ],
18945     "name": "GetTeams",
18946     "group": "Openchannel_Queues",
18947     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18948     "version": "0.0.0",
18949     "filename": "server/api/openchannelQueue/index.js",
18950     "groupTitle": "Openchannel_Queues"
18951   },
18952   {
18953     "type": "delete",
18954     "url": "/api/openchannel/queues/{id}/users",
18955     "title": "Removes agents from a queue",
18956     "examples": [
18957       {
18958         "title": "Example usage:",
18959         "content": "curl https://{domain}/api/openchannel/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
18960         "type": "json"
18961       }
18962     ],
18963     "name": "RemoveAgents",
18964     "group": "Openchannel_Queues",
18965     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18966     "version": "0.0.0",
18967     "filename": "server/api/openchannelQueue/index.js",
18968     "groupTitle": "Openchannel_Queues"
18969   },
18970   {
18971     "type": "get",
18972     "url": "/api/openchannel/queues/{id}",
18973     "title": "Gets a single Queue",
18974     "examples": [
18975       {
18976         "title": "Example usage:",
18977         "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password}",
18978         "type": "json"
18979       }
18980     ],
18981     "name": "ShowQueues",
18982     "group": "Openchannel_Queues",
18983     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18984     "version": "0.0.0",
18985     "filename": "server/api/openchannelQueue/index.js",
18986     "groupTitle": "Openchannel_Queues"
18987   },
18988   {
18989     "type": "put",
18990     "url": "/api/openchannel/queues/{id}",
18991     "title": "Update an existing Queue",
18992     "examples": [
18993       {
18994         "title": "Example usage:",
18995         "content": "curl https://{domain}/api/openchannel/queues/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
18996         "type": "json"
18997       }
18998     ],
18999     "name": "updateQueues",
19000     "group": "Openchannel_Queues",
19001     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19002     "version": "0.0.0",
19003     "filename": "server/api/openchannelQueue/index.js",
19004     "groupTitle": "Openchannel_Queues"
19005   },
19006   {
19007     "type": "post",
19008     "url": "/api/openchannel/reports/transfer",
19009     "title": "Creates a new Openchannel Transfer Report",
19010     "examples": [
19011       {
19012         "title": "Example usage:",
19013         "content": "curl https://{domain}/api/openchannel/reports/transfer -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
19014         "type": "json"
19015       }
19016     ],
19017     "name": "CreateOpenchannel_Transfer_Reports",
19018     "group": "Openchannel_Transfer_Reports",
19019     "parameter": {
19020       "fields": {
19021         "Body": [
19022           {
19023             "group": "Body",
19024             "type": "String",
19025             "optional": false,
19026             "field": "uniqueid",
19027             "description": ""
19028           },
19029           {
19030             "group": "Body",
19031             "type": "String",
19032             "allowedValues": [
19033               "\"account\"",
19034               "\"agent\"",
19035               "\"queue\""
19036             ],
19037             "optional": false,
19038             "field": "type",
19039             "description": ""
19040           },
19041           {
19042             "group": "Body",
19043             "type": "String",
19044             "optional": false,
19045             "field": "transferredAt",
19046             "description": ""
19047           }
19048         ]
19049       }
19050     },
19051     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19052     "version": "0.0.0",
19053     "filename": "server/api/openchannelTransferReport/index.js",
19054     "groupTitle": "Openchannel_Transfer_Reports"
19055   },
19056   {
19057     "type": "delete",
19058     "url": "/api/openchannel/reports/transfer/{id}",
19059     "title": "Deletes a Openchannel Transfer Report",
19060     "examples": [
19061       {
19062         "title": "Example usage:",
19063         "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
19064         "type": "json"
19065       }
19066     ],
19067     "name": "DeleteOpenchannel_Transfer_Reports",
19068     "group": "Openchannel_Transfer_Reports",
19069     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19070     "version": "0.0.0",
19071     "filename": "server/api/openchannelTransferReport/index.js",
19072     "groupTitle": "Openchannel_Transfer_Reports"
19073   },
19074   {
19075     "type": "get",
19076     "url": "/api/openchannel/reports/transfer/describe",
19077     "title": "Gets table info about Openchannel Transfer Reports",
19078     "examples": [
19079       {
19080         "title": "Example usage:",
19081         "content": "curl https://{domain}/api/openchannel/reports/transfer/describe -v -u {name}:{password}",
19082         "type": "json"
19083       }
19084     ],
19085     "name": "DescribeOpenchannel_Transfer_Reports",
19086     "group": "Openchannel_Transfer_Reports",
19087     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19088     "version": "0.0.0",
19089     "filename": "server/api/openchannelTransferReport/index.js",
19090     "groupTitle": "Openchannel_Transfer_Reports"
19091   },
19092   {
19093     "type": "get",
19094     "url": "/api/openchannel/reports/transfer",
19095     "title": "Gets a list of Openchannel Transfer Reports",
19096     "examples": [
19097       {
19098         "title": "Example usage:",
19099         "content": "curl https://{domain}/api/openchannel/reports/transfer -v -u {name}:{password}",
19100         "type": "json"
19101       }
19102     ],
19103     "name": "GetOpenchannel_Transfer_Reports",
19104     "group": "Openchannel_Transfer_Reports",
19105     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/openchannel/reports/transfer?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/openchannel/reports/transfer?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/openchannel/reports/transfer?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/openchannel/reports/transfer?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/openchannel/reports/transfer?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
19106     "version": "0.0.0",
19107     "filename": "server/api/openchannelTransferReport/index.js",
19108     "groupTitle": "Openchannel_Transfer_Reports"
19109   },
19110   {
19111     "type": "get",
19112     "url": "/api/openchannel/reports/transfer/{id}",
19113     "title": "Gets a single Openchannel Transfer Report",
19114     "examples": [
19115       {
19116         "title": "Example usage:",
19117         "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password}",
19118         "type": "json"
19119       }
19120     ],
19121     "name": "ShowOpenchannel_Transfer_Reports",
19122     "group": "Openchannel_Transfer_Reports",
19123     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19124     "version": "0.0.0",
19125     "filename": "server/api/openchannelTransferReport/index.js",
19126     "groupTitle": "Openchannel_Transfer_Reports"
19127   },
19128   {
19129     "type": "put",
19130     "url": "/api/openchannel/reports/transfer/{id}",
19131     "title": "Update an existing Openchannel Transfer Report",
19132     "examples": [
19133       {
19134         "title": "Example usage:",
19135         "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
19136         "type": "json"
19137       }
19138     ],
19139     "name": "updateOpenchannel_Transfer_Reports",
19140     "group": "Openchannel_Transfer_Reports",
19141     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19142     "version": "0.0.0",
19143     "filename": "server/api/openchannelTransferReport/index.js",
19144     "groupTitle": "Openchannel_Transfer_Reports"
19145   },
19146   {
19147     "type": "post",
19148     "url": "/api/pauses",
19149     "title": "Creates a new Pause",
19150     "examples": [
19151       {
19152         "title": "Example usage:",
19153         "content": "curl https://{domain}/api/pauses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
19154         "type": "json"
19155       }
19156     ],
19157     "name": "CreatePauses",
19158     "group": "Pauses",
19159     "parameter": {
19160       "fields": {
19161         "Body": [
19162           {
19163             "group": "Body",
19164             "type": "String",
19165             "optional": false,
19166             "field": "name",
19167             "description": ""
19168           },
19169           {
19170             "group": "Body",
19171             "type": "String",
19172             "optional": true,
19173             "field": "description",
19174             "description": ""
19175           }
19176         ]
19177       }
19178     },
19179     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19180     "version": "0.0.0",
19181     "filename": "server/api/pause/index.js",
19182     "groupTitle": "Pauses"
19183   },
19184   {
19185     "type": "delete",
19186     "url": "/api/pauses/{id}",
19187     "title": "Deletes a Pause",
19188     "examples": [
19189       {
19190         "title": "Example usage:",
19191         "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password} -X DELETE",
19192         "type": "json"
19193       }
19194     ],
19195     "name": "DeletePauses",
19196     "group": "Pauses",
19197     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19198     "version": "0.0.0",
19199     "filename": "server/api/pause/index.js",
19200     "groupTitle": "Pauses"
19201   },
19202   {
19203     "type": "get",
19204     "url": "/api/pauses",
19205     "title": "Gets a list of Pauses",
19206     "examples": [
19207       {
19208         "title": "Example usage:",
19209         "content": "curl https://{domain}/api/pauses -v -u {name}:{password}",
19210         "type": "json"
19211       }
19212     ],
19213     "name": "GetPauses",
19214     "group": "Pauses",
19215     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/pauses?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/pauses?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/pauses?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/pauses?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/pauses?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
19216     "version": "0.0.0",
19217     "filename": "server/api/pause/index.js",
19218     "groupTitle": "Pauses"
19219   },
19220   {
19221     "type": "get",
19222     "url": "/api/pauses/{id}",
19223     "title": "Gets a single Pause",
19224     "examples": [
19225       {
19226         "title": "Example usage:",
19227         "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password}",
19228         "type": "json"
19229       }
19230     ],
19231     "name": "ShowPauses",
19232     "group": "Pauses",
19233     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19234     "version": "0.0.0",
19235     "filename": "server/api/pause/index.js",
19236     "groupTitle": "Pauses"
19237   },
19238   {
19239     "type": "put",
19240     "url": "/api/pauses/{id}",
19241     "title": "Update an existing Pause",
19242     "examples": [
19243       {
19244         "title": "Example usage:",
19245         "content": "curl https://{domain}/api/pauses/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
19246         "type": "json"
19247       }
19248     ],
19249     "name": "updatePauses",
19250     "group": "Pauses",
19251     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19252     "version": "0.0.0",
19253     "filename": "server/api/pause/index.js",
19254     "groupTitle": "Pauses"
19255   },
19256   {
19257     "type": "get",
19258     "url": "/api/plugins",
19259     "title": "Gets a list of Plugins",
19260     "examples": [
19261       {
19262         "title": "Example usage:",
19263         "content": "curl https://{domain}/api/plugins -v -u {name}:{password}",
19264         "type": "json"
19265       }
19266     ],
19267     "name": "GetPlugins",
19268     "group": "Plugins",
19269     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/plugins?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/plugins?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/plugins?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/plugins?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/plugins?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
19270     "version": "0.0.0",
19271     "filename": "server/api/plugin/index.js",
19272     "groupTitle": "Plugins"
19273   },
19274   {
19275     "type": "get",
19276     "url": "/api/plugins/{id}",
19277     "title": "Gets a single Plugin",
19278     "examples": [
19279       {
19280         "title": "Example usage:",
19281         "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password}",
19282         "type": "json"
19283       }
19284     ],
19285     "name": "ShowPlugins",
19286     "group": "Plugins",
19287     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19288     "version": "0.0.0",
19289     "filename": "server/api/plugin/index.js",
19290     "groupTitle": "Plugins"
19291   },
19292   {
19293     "type": "delete",
19294     "url": "/api/plugins/{id}",
19295     "title": "Delete a plugin",
19296     "examples": [
19297       {
19298         "title": "Example usage:",
19299         "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X DELETE",
19300         "type": "json"
19301       }
19302     ],
19303     "name": "destroyPlugin",
19304     "group": "Plugins",
19305     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19306     "version": "0.0.0",
19307     "filename": "server/api/plugin/index.js",
19308     "groupTitle": "Plugins"
19309   },
19310   {
19311     "type": "get",
19312     "url": "/api/plugins/{id}/download",
19313     "title": "Download plugin source code",
19314     "examples": [
19315       {
19316         "title": "Example usage:",
19317         "content": "curl https://{domain}/api/plugins/{id}/download -v -u {name}:{password} -X GET",
19318         "type": "json"
19319       }
19320     ],
19321     "name": "download",
19322     "group": "Plugins",
19323     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19324     "version": "0.0.0",
19325     "filename": "server/api/plugin/index.js",
19326     "groupTitle": "Plugins"
19327   },
19328   {
19329     "type": "put",
19330     "url": "/api/plugins/{id}",
19331     "title": "Update an existing plugin",
19332     "examples": [
19333       {
19334         "title": "Example usage:",
19335         "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X PUT",
19336         "type": "json"
19337       }
19338     ],
19339     "name": "updatePlugin",
19340     "group": "Plugins",
19341     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19342     "version": "0.0.0",
19343     "filename": "server/api/plugin/index.js",
19344     "groupTitle": "Plugins"
19345   },
19346   {
19347     "type": "post",
19348     "url": "/api/plugins",
19349     "title": "Upload new plugin",
19350     "examples": [
19351       {
19352         "title": "Example usage:",
19353         "content": "curl https://{domain}/api/plugins -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
19354         "type": "json"
19355       }
19356     ],
19357     "name": "uploadPlugin",
19358     "group": "Plugins",
19359     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19360     "version": "0.0.0",
19361     "filename": "server/api/plugin/index.js",
19362     "groupTitle": "Plugins"
19363   },
19364   {
19365     "type": "get",
19366     "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
19367     "title": "Redirect a plugin request to the specified path",
19368     "examples": [
19369       {
19370         "title": "Example usage:",
19371         "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -v -u {name}:{password} -X GET",
19372         "type": "json"
19373       }
19374     ],
19375     "name": "webhookPlugin",
19376     "group": "Plugins",
19377     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19378     "version": "0.0.0",
19379     "filename": "server/api/plugin/index.js",
19380     "groupTitle": "Plugins"
19381   },
19382   {
19383     "type": "post",
19384     "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
19385     "title": "Redirect a plugin request to the specified path",
19386     "examples": [
19387       {
19388         "title": "Example usage:",
19389         "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -H 'Content-Type: application/json' -X POST",
19390         "type": "json"
19391       }
19392     ],
19393     "name": "webhookPlugin",
19394     "group": "Plugins",
19395     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19396     "version": "0.0.0",
19397     "filename": "server/api/plugin/index.js",
19398     "groupTitle": "Plugins"
19399   },
19400   {
19401     "type": "delete",
19402     "url": "/api/pm2/{id}",
19403     "title": "Deletes an existing process",
19404     "examples": [
19405       {
19406         "title": "Example usage:",
19407         "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password} -X DELETE",
19408         "type": "json"
19409       }
19410     ],
19411     "name": "DeletePm2Process",
19412     "group": "Pm2",
19413     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19414     "version": "0.0.0",
19415     "filename": "server/api/pm2/index.js",
19416     "groupTitle": "Pm2"
19417   },
19418   {
19419     "type": "get",
19420     "url": "/api/pm2/{id}",
19421     "title": "Gets a single pm2 process",
19422     "examples": [
19423       {
19424         "title": "Example usage:",
19425         "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password}",
19426         "type": "json"
19427       }
19428     ],
19429     "name": "GetPm2Process",
19430     "group": "Pm2",
19431     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19432     "version": "0.0.0",
19433     "filename": "server/api/pm2/index.js",
19434     "groupTitle": "Pm2"
19435   },
19436   {
19437     "type": "get",
19438     "url": "/api/pm2",
19439     "title": "Gets pm2 processes",
19440     "examples": [
19441       {
19442         "title": "Example usage:",
19443         "content": "curl https://{domain}/api/pm2 -v -u {name}:{password}",
19444         "type": "json"
19445       }
19446     ],
19447     "name": "GetPm2Processes",
19448     "group": "Pm2",
19449     "description": "<p>Motion returns the pm2 processes list.</p>",
19450     "version": "0.0.0",
19451     "filename": "server/api/pm2/index.js",
19452     "groupTitle": "Pm2"
19453   },
19454   {
19455     "type": "post",
19456     "url": "/api/pm2",
19457     "title": "Start a single pm2 process",
19458     "examples": [
19459       {
19460         "title": "Example usage:",
19461         "content": "curl https://{domain}/api/pm2 -d '{\"name\": \"process_name\", \"script\": \"/index.js\"}'\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
19462         "type": "json"
19463       }
19464     ],
19465     "name": "StartPm2Process",
19466     "group": "Pm2",
19467     "parameter": {
19468       "fields": {
19469         "Body": [
19470           {
19471             "group": "Body",
19472             "type": "String",
19473             "optional": false,
19474             "field": "name",
19475             "description": ""
19476           },
19477           {
19478             "group": "Body",
19479             "type": "String",
19480             "optional": false,
19481             "field": "script",
19482             "description": ""
19483           }
19484         ]
19485       }
19486     },
19487     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19488     "version": "0.0.0",
19489     "filename": "server/api/pm2/index.js",
19490     "groupTitle": "Pm2"
19491   },
19492   {
19493     "type": "put",
19494     "url": "/api/pm2/{id}",
19495     "title": "Update an existing process",
19496     "examples": [
19497       {
19498         "title": "Example usage:",
19499         "content": "curl https://{domain}/api/pm2/{id} -d '{\"status\": \"online\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
19500         "type": "json"
19501       }
19502     ],
19503     "name": "UpdatePm2Process",
19504     "group": "Pm2",
19505     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19506     "version": "0.0.0",
19507     "filename": "server/api/pm2/index.js",
19508     "groupTitle": "Pm2"
19509   },
19510   {
19511     "type": "get",
19512     "url": "/api/rpc/campaigns/",
19513     "title": "Gets a list of campaigns",
19514     "examples": [
19515       {
19516         "title": "Example usage:",
19517         "content": "curl https://{domain}/api/rpc/campaigns -v -u {name}:{password}",
19518         "type": "json"
19519       }
19520     ],
19521     "name": "Campaigns",
19522     "group": "RPC_Realtime",
19523     "description": "<p>Motion will return a list of realtime campaigns parameters.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19524     "version": "0.0.0",
19525     "filename": "server/api/rpc/index.js",
19526     "groupTitle": "RPC_Realtime"
19527   },
19528   {
19529     "type": "get",
19530     "url": "/api/rpc/fax/accounts",
19531     "title": "Gets a list of FaxAccounts",
19532     "examples": [
19533       {
19534         "title": "Example usage:",
19535         "content": "curl https://{domain}/api/rpc/fax/accounts -v -u {name}:{password}",
19536         "type": "json"
19537       }
19538     ],
19539     "name": "FaxAccounts",
19540     "group": "RPC_Realtime",
19541     "description": "<p>Motion will return a list of realtime fax account parameters.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19542     "version": "0.0.0",
19543     "filename": "server/api/rpc/index.js",
19544     "groupTitle": "RPC_Realtime"
19545   },
19546   {
19547     "type": "put",
19548     "url": "/api/rpc/agents/:id/capacity",
19549     "title": "Sets agent capacity",
19550     "examples": [
19551       {
19552         "title": "Example usage:",
19553         "content": "curl https://{domain}/api/rpc/agents/:id/capacity -v -u {name}:{password}",
19554         "type": "json"
19555       }
19556     ],
19557     "name": "RTAgentCapacity",
19558     "group": "RPC_Realtime",
19559     "description": "<p>Motion will return the current agent capacity.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19560     "version": "0.0.0",
19561     "filename": "server/api/rpc/index.js",
19562     "groupTitle": "RPC_Realtime"
19563   },
19564   {
19565     "type": "get",
19566     "url": "/api/rpc/agents",
19567     "title": "Gets a list of RTAgents",
19568     "examples": [
19569       {
19570         "title": "Example usage:",
19571         "content": "curl https://{domain}/api/rpc/agents -v -u {name}:{password}",
19572         "type": "json"
19573       }
19574     ],
19575     "name": "RTAgents",
19576     "group": "RPC_Realtime",
19577     "description": "<p>Motion will return a list of realtime agents parameters.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19578     "version": "0.0.0",
19579     "filename": "server/api/rpc/index.js",
19580     "groupTitle": "RPC_Realtime"
19581   },
19582   {
19583     "type": "get",
19584     "url": "/api/rpc/chat/queues",
19585     "title": "Gets a list of RTChatQueues",
19586     "examples": [
19587       {
19588         "title": "Example usage:",
19589         "content": "curl https://{domain}/api/rpc/chat/queues -v -u {name}:{password}",
19590         "type": "json"
19591       }
19592     ],
19593     "name": "RTChatQueues",
19594     "group": "RPC_Realtime",
19595     "description": "<p>Motion will return a list of realtime chat queues parameters.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19596     "version": "0.0.0",
19597     "filename": "server/api/rpc/index.js",
19598     "groupTitle": "RPC_Realtime"
19599   },
19600   {
19601     "type": "get",
19602     "url": "/api/rpc/fax/queues",
19603     "title": "Gets a list of RTFaxQueues",
19604     "examples": [
19605       {
19606         "title": "Example usage:",
19607         "content": "curl https://{domain}/api/rpc/fax/queues -v -u {name}:{password}",
19608         "type": "json"
19609       }
19610     ],
19611     "name": "RTFaxQueues",
19612     "group": "RPC_Realtime",
19613     "description": "<p>Motion will return a list of realtime fax queues parameters.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19614     "version": "0.0.0",
19615     "filename": "server/api/rpc/index.js",
19616     "groupTitle": "RPC_Realtime"
19617   },
19618   {
19619     "type": "get",
19620     "url": "/api/rpc/mail/accounts",
19621     "title": "Gets a list of RTMailAccounts",
19622     "examples": [
19623       {
19624         "title": "Example usage:",
19625         "content": "curl https://{domain}/api/rpc/mail/accounts -v -u {name}:{password}",
19626         "type": "json"
19627       }
19628     ],
19629     "name": "RTMailAccounts",
19630     "group": "RPC_Realtime",
19631     "description": "<p>Motion will return a list of realtime mail account parameters.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19632     "version": "0.0.0",
19633     "filename": "server/api/rpc/index.js",
19634     "groupTitle": "RPC_Realtime"
19635   },
19636   {
19637     "type": "get",
19638     "url": "/api/rpc/mail/queues",
19639     "title": "Gets a list of RTMailQueues",
19640     "examples": [
19641       {
19642         "title": "Example usage:",
19643         "content": "curl https://{domain}/api/rpc/mail/queues -v -u {name}:{password}",
19644         "type": "json"
19645       }
19646     ],
19647     "name": "RTMailQueues",
19648     "group": "RPC_Realtime",
19649     "description": "<p>Motion will return a list of realtime mail queues parameters.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19650     "version": "0.0.0",
19651     "filename": "server/api/rpc/index.js",
19652     "groupTitle": "RPC_Realtime"
19653   },
19654   {
19655     "type": "get",
19656     "url": "/api/rpc/openchannel/queues",
19657     "title": "Gets a list of RTOpenchannelQueues",
19658     "examples": [
19659       {
19660         "title": "Example usage:",
19661         "content": "curl https://{domain}/api/rpc/openchannel/queues -v -u {name}:{password}",
19662         "type": "json"
19663       }
19664     ],
19665     "name": "RTOpenchannelQueues",
19666     "group": "RPC_Realtime",
19667     "description": "<p>Motion will return a list of realtime openchannel queues parameters.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19668     "version": "0.0.0",
19669     "filename": "server/api/rpc/index.js",
19670     "groupTitle": "RPC_Realtime"
19671   },
19672   {
19673     "type": "get",
19674     "url": "/api/rpc/outbound/channels",
19675     "title": "Gets a list of RTOutboundChannels",
19676     "examples": [
19677       {
19678         "title": "Example usage:",
19679         "content": "curl https://{domain}/api/rpc/outbound/channels -v -u {name}:{password}",
19680         "type": "json"
19681       }
19682     ],
19683     "name": "RTOutboundChannels",
19684     "group": "RPC_Realtime",
19685     "description": "<p>Motion will return a list of realtime outbound channels.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19686     "version": "0.0.0",
19687     "filename": "server/api/rpc/index.js",
19688     "groupTitle": "RPC_Realtime"
19689   },
19690   {
19691     "type": "get",
19692     "url": "/api/rpc/sms/queues",
19693     "title": "Gets a list of RTSmsQueues",
19694     "examples": [
19695       {
19696         "title": "Example usage:",
19697         "content": "curl https://{domain}/api/rpc/sms/queues -v -u {name}:{password}",
19698         "type": "json"
19699       }
19700     ],
19701     "name": "RTSmsQueues",
19702     "group": "RPC_Realtime",
19703     "description": "<p>Motion will return a list of realtime sms queues parameters.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19704     "version": "0.0.0",
19705     "filename": "server/api/rpc/index.js",
19706     "groupTitle": "RPC_Realtime"
19707   },
19708   {
19709     "type": "get",
19710     "url": "/api/rpc/telephones",
19711     "title": "Gets a list of RTTelephones",
19712     "examples": [
19713       {
19714         "title": "Example usage:",
19715         "content": "curl https://{domain}/api/rpc/telephones -v -u {name}:{password}",
19716         "type": "json"
19717       }
19718     ],
19719     "name": "RTTelephones",
19720     "group": "RPC_Realtime",
19721     "description": "<p>Motion will return a list of telephones parameters.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19722     "version": "0.0.0",
19723     "filename": "server/api/rpc/index.js",
19724     "groupTitle": "RPC_Realtime"
19725   },
19726   {
19727     "type": "get",
19728     "url": "/api/rpc/trunks",
19729     "title": "Gets a list of RTTrunks",
19730     "examples": [
19731       {
19732         "title": "Example usage:",
19733         "content": "curl https://{domain}/api/rpc/trunks -v -u {name}:{password}",
19734         "type": "json"
19735       }
19736     ],
19737     "name": "RTTrunks",
19738     "group": "RPC_Realtime",
19739     "description": "<p>Motion will return a list of realtime trunks parameters.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19740     "version": "0.0.0",
19741     "filename": "server/api/rpc/index.js",
19742     "groupTitle": "RPC_Realtime"
19743   },
19744   {
19745     "type": "get",
19746     "url": "/api/rpc/voice/channels",
19747     "title": "Gets a list of RTVoiceChannelMixMonitor",
19748     "examples": [
19749       {
19750         "title": "Example usage:",
19751         "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/mixmonitor -v -u {name}:{password}",
19752         "type": "json"
19753       }
19754     ],
19755     "name": "RTVoiceChannelMixMonitor",
19756     "group": "RPC_Realtime",
19757     "description": "<p>Motion will return a list of realtime voice channel mixmonitor.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19758     "version": "0.0.0",
19759     "filename": "server/api/rpc/index.js",
19760     "groupTitle": "RPC_Realtime"
19761   },
19762   {
19763     "type": "get",
19764     "url": "/api/rpc/voice/channels",
19765     "title": "Gets a list of RTVoiceChannelStopMixMonitor",
19766     "examples": [
19767       {
19768         "title": "Example usage:",
19769         "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/stopmixmonitor -v -u {name}:{password}",
19770         "type": "json"
19771       }
19772     ],
19773     "name": "RTVoiceChannelStopMixMonitor",
19774     "group": "RPC_Realtime",
19775     "description": "<p>Motion will return a list of realtime voice channel stopmixmonitor.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19776     "version": "0.0.0",
19777     "filename": "server/api/rpc/index.js",
19778     "groupTitle": "RPC_Realtime"
19779   },
19780   {
19781     "type": "get",
19782     "url": "/api/rpc/voice/channels",
19783     "title": "Gets a list of RTVoiceChannels",
19784     "examples": [
19785       {
19786         "title": "Example usage:",
19787         "content": "curl https://{domain}/api/rpc/voice/channels -v -u {name}:{password}",
19788         "type": "json"
19789       }
19790     ],
19791     "name": "RTVoiceChannels",
19792     "group": "RPC_Realtime",
19793     "description": "<p>Motion will return a list of realtime voice channels.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19794     "version": "0.0.0",
19795     "filename": "server/api/rpc/index.js",
19796     "groupTitle": "RPC_Realtime"
19797   },
19798   {
19799     "type": "get",
19800     "url": "/api/rpc/voice/queues/channels/{uniqueid}",
19801     "title": "Gets a single RTVoiceQueueChannel",
19802     "examples": [
19803       {
19804         "title": "Example usage:",
19805         "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid} -v -u {name}:{password}",
19806         "type": "json"
19807       }
19808     ],
19809     "name": "RTVoiceQueueChannel",
19810     "group": "RPC_Realtime",
19811     "description": "<p>Motion will return a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19812     "version": "0.0.0",
19813     "filename": "server/api/rpc/index.js",
19814     "groupTitle": "RPC_Realtime"
19815   },
19816   {
19817     "type": "get",
19818     "url": "/api/rpc/voice/queues/channels/{uniqueid}/hangup",
19819     "title": "Hangup a single RTVoiceQueueChannel",
19820     "examples": [
19821       {
19822         "title": "Example usage:",
19823         "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/hangup -v -u {name}:{password}",
19824         "type": "json"
19825       }
19826     ],
19827     "name": "RTVoiceQueueChannelHangup",
19828     "group": "RPC_Realtime",
19829     "description": "<p>Motion will hangup a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19830     "version": "0.0.0",
19831     "filename": "server/api/rpc/index.js",
19832     "groupTitle": "RPC_Realtime"
19833   },
19834   {
19835     "type": "get",
19836     "url": "/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten}",
19837     "title": "Hangup a single RTVoiceQueueChannel",
19838     "examples": [
19839       {
19840         "title": "Example usage:",
19841         "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten} -v -u {name}:{password}",
19842         "type": "json"
19843       }
19844     ],
19845     "name": "RTVoiceQueueChannelRedirect",
19846     "group": "RPC_Realtime",
19847     "description": "<p>Motion will redirect a specific realtime voice queue channel to a specific extension.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19848     "version": "0.0.0",
19849     "filename": "server/api/rpc/index.js",
19850     "groupTitle": "RPC_Realtime"
19851   },
19852   {
19853     "type": "get",
19854     "url": "/api/rpc/voice/queues/preview/{id}",
19855     "title": "Gets a single preview contact",
19856     "examples": [
19857       {
19858         "title": "Example usage:",
19859         "content": "curl https://{domain}/api/rpc/voice/queues/preview/{id} -v -u {name}:{password}",
19860         "type": "json"
19861       }
19862     ],
19863     "name": "RTVoiceQueuePreview",
19864     "group": "RPC_Realtime",
19865     "description": "<p>Motion will return a specific preview contact.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19866     "version": "0.0.0",
19867     "filename": "server/api/rpc/index.js",
19868     "groupTitle": "RPC_Realtime"
19869   },
19870   {
19871     "type": "get",
19872     "url": "/api/rpc/voice/queues",
19873     "title": "Gets a list of RTVoiceQueues",
19874     "examples": [
19875       {
19876         "title": "Example usage:",
19877         "content": "curl https://{domain}/api/rpc/voice/queues -v -u {name}:{password}",
19878         "type": "json"
19879       }
19880     ],
19881     "name": "RTVoiceQueues",
19882     "group": "RPC_Realtime",
19883     "description": "<p>Motion will return a list of realtime 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>",
19884     "version": "0.0.0",
19885     "filename": "server/api/rpc/index.js",
19886     "groupTitle": "RPC_Realtime"
19887   },
19888   {
19889     "type": "get",
19890     "url": "/api/rpc/outbound",
19891     "title": "Gets a list of RTOutbound",
19892     "examples": [
19893       {
19894         "title": "Example usage:",
19895         "content": "curl https://{domain}/api/rpc/outbound -v -u {name}:{password}",
19896         "type": "json"
19897       }
19898     ],
19899     "name": "RTVoiceQueues",
19900     "group": "RPC_Realtime",
19901     "description": "<p>Motion will return a list of realtime 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>",
19902     "version": "0.0.0",
19903     "filename": "server/api/rpc/index.js",
19904     "groupTitle": "RPC_Realtime"
19905   },
19906   {
19907     "type": "get",
19908     "url": "/api/rpc/voice/queues/channels",
19909     "title": "Gets a list of RTVoiceQueuesChannels",
19910     "examples": [
19911       {
19912         "title": "Example usage:",
19913         "content": "curl https://{domain}/api/rpc/voice/queues/channels -v -u {name}:{password}",
19914         "type": "json"
19915       }
19916     ],
19917     "name": "RTVoiceQueuesChannels",
19918     "group": "RPC_Realtime",
19919     "description": "<p>Motion will return a list of realtime voice queues channels.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19920     "version": "0.0.0",
19921     "filename": "server/api/rpc/index.js",
19922     "groupTitle": "RPC_Realtime"
19923   },
19924   {
19925     "type": "get",
19926     "url": "/api/rpc/chat/queues/{id}",
19927     "title": "Gets a single RTChatQueue",
19928     "examples": [
19929       {
19930         "title": "Example usage:",
19931         "content": "curl https://{domain}/api/rpc/chat/queues/{id} -v -u {name}:{password}",
19932         "type": "json"
19933       }
19934     ],
19935     "name": "ShowRTChatQueues",
19936     "group": "RPC_Realtime",
19937     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19938     "version": "0.0.0",
19939     "filename": "server/api/rpc/index.js",
19940     "groupTitle": "RPC_Realtime"
19941   },
19942   {
19943     "type": "get",
19944     "url": "/api/rpc/fax/queues/{id}",
19945     "title": "Gets a single RTFaxQueue",
19946     "examples": [
19947       {
19948         "title": "Example usage:",
19949         "content": "curl https://{domain}/api/rpc/fax/queues/{id} -v -u {name}:{password}",
19950         "type": "json"
19951       }
19952     ],
19953     "name": "ShowRTFaxQueues",
19954     "group": "RPC_Realtime",
19955     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19956     "version": "0.0.0",
19957     "filename": "server/api/rpc/index.js",
19958     "groupTitle": "RPC_Realtime"
19959   },
19960   {
19961     "type": "get",
19962     "url": "/api/rpc/mail/queues/{id}",
19963     "title": "Gets a single RTMailQueue",
19964     "examples": [
19965       {
19966         "title": "Example usage:",
19967         "content": "curl https://{domain}/api/rpc/mail/queues/{id} -v -u {name}:{password}",
19968         "type": "json"
19969       }
19970     ],
19971     "name": "ShowRTMailQueues",
19972     "group": "RPC_Realtime",
19973     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19974     "version": "0.0.0",
19975     "filename": "server/api/rpc/index.js",
19976     "groupTitle": "RPC_Realtime"
19977   },
19978   {
19979     "type": "get",
19980     "url": "/api/rpc/openchannel/queues/{id}",
19981     "title": "Gets a single RTOpenchannelQueue",
19982     "examples": [
19983       {
19984         "title": "Example usage:",
19985         "content": "curl https://{domain}/api/rpc/openchannel/queues/{id} -v -u {name}:{password}",
19986         "type": "json"
19987       }
19988     ],
19989     "name": "ShowRTOpenchannelQueues",
19990     "group": "RPC_Realtime",
19991     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19992     "version": "0.0.0",
19993     "filename": "server/api/rpc/index.js",
19994     "groupTitle": "RPC_Realtime"
19995   },
19996   {
19997     "type": "get",
19998     "url": "/api/rpc/sms/queues/{id}",
19999     "title": "Gets a single RTSmsQueue",
20000     "examples": [
20001       {
20002         "title": "Example usage:",
20003         "content": "curl https://{domain}/api/rpc/sms/queues/{id} -v -u {name}:{password}",
20004         "type": "json"
20005       }
20006     ],
20007     "name": "ShowRTSmsQueues",
20008     "group": "RPC_Realtime",
20009     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20010     "version": "0.0.0",
20011     "filename": "server/api/rpc/index.js",
20012     "groupTitle": "RPC_Realtime"
20013   },
20014   {
20015     "type": "get",
20016     "url": "/api/rpc/voice/queues/{id}",
20017     "title": "Gets a single RTVoiceQueue",
20018     "examples": [
20019       {
20020         "title": "Example usage:",
20021         "content": "curl https://{domain}/api/rpc/voice/queues/{id} -v -u {name}:{password}",
20022         "type": "json"
20023       }
20024     ],
20025     "name": "ShowRTVoiceQueues",
20026     "group": "RPC_Realtime",
20027     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20028     "version": "0.0.0",
20029     "filename": "server/api/rpc/index.js",
20030     "groupTitle": "RPC_Realtime"
20031   },
20032   {
20033     "type": "post",
20034     "url": "/api/rpc/agents/:id/notify",
20035     "title": "Notify message to a specific agent",
20036     "examples": [
20037       {
20038         "title": "Example usage:",
20039         "content": "curl https://{domain}/api/rpc/agents/:id/notify -d '{\"messageId\": \"5080\", \"channel\": \"mail\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
20040         "type": "json"
20041       }
20042     ],
20043     "name": "agentNotify",
20044     "group": "RPC_Realtime",
20045     "description": "<p>Notify message to a specific agent.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20046     "version": "0.0.0",
20047     "filename": "server/api/rpc/index.js",
20048     "groupTitle": "RPC_Realtime"
20049   },
20050   {
20051     "type": "post",
20052     "url": "/api/rpc/chat/queues/:id/notify",
20053     "title": "Notify message to a specific queue",
20054     "examples": [
20055       {
20056         "title": "Example usage:",
20057         "content": "curl https://{domain}/api/rpc/chat/queues/:id/notify -d '{\"messageId\": \"5080\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
20058         "type": "json"
20059       }
20060     ],
20061     "name": "chatQueueNotify",
20062     "group": "RPC_Realtime",
20063     "description": "<p>Notify message to a specific queue.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20064     "version": "0.0.0",
20065     "filename": "server/api/rpc/index.js",
20066     "groupTitle": "RPC_Realtime"
20067   },
20068   {
20069     "type": "get",
20070     "url": "/api/rpc/chat/queues/waitinginteractions",
20071     "title": "Gets a list of chatQueuesWaitingInteractions",
20072     "examples": [
20073       {
20074         "title": "Example usage:",
20075         "content": "curl https://{domain}/api/rpc/chat/queues/waitinginteractions -v -u {name}:{password}",
20076         "type": "json"
20077       }
20078     ],
20079     "name": "chatQueuesWaitingInteractions",
20080     "group": "RPC_Realtime",
20081     "description": "<p>Motion will return a list of realtime waiting chat queues interctions.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20082     "version": "0.0.0",
20083     "filename": "server/api/rpc/index.js",
20084     "groupTitle": "RPC_Realtime"
20085   },
20086   {
20087     "type": "post",
20088     "url": "/api/rpc/fax/queues/:id/notify",
20089     "title": "Notify message to a specific queue",
20090     "examples": [
20091       {
20092         "title": "Example usage:",
20093         "content": "curl https://{domain}/api/rpc/fax/queues/:id/notify -d '{\"messageId\": \"5080\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
20094         "type": "json"
20095       }
20096     ],
20097     "name": "faxQueueNotify",
20098     "group": "RPC_Realtime",
20099     "description": "<p>Notify message to a specific queue.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20100     "version": "0.0.0",
20101     "filename": "server/api/rpc/index.js",
20102     "groupTitle": "RPC_Realtime"
20103   },
20104   {
20105     "type": "get",
20106     "url": "/api/rpc/fax/queues/waitinginteractions",
20107     "title": "Gets a list of faxQueuesWaitingInteractions",
20108     "examples": [
20109       {
20110         "title": "Example usage:",
20111         "content": "curl https://{domain}/api/rpc/fax/queues/waitinginteractions -v -u {name}:{password}",
20112         "type": "json"
20113       }
20114     ],
20115     "name": "faxQueuesWaitingInteractions",
20116     "group": "RPC_Realtime",
20117     "description": "<p>Motion will return a list of realtime waiting fax queues interctions.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20118     "version": "0.0.0",
20119     "filename": "server/api/rpc/index.js",
20120     "groupTitle": "RPC_Realtime"
20121   },
20122   {
20123     "type": "post",
20124     "url": "/api/rpc/mail/queues/:id/notify",
20125     "title": "Notify message to a specific queue",
20126     "examples": [
20127       {
20128         "title": "Example usage:",
20129         "content": "curl https://{domain}/api/rpc/mail/queues/:id/notify -d '{\"messageId\": \"5080\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
20130         "type": "json"
20131       }
20132     ],
20133     "name": "mailQueueNotify",
20134     "group": "RPC_Realtime",
20135     "description": "<p>Notify message to a specific queue.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20136     "version": "0.0.0",
20137     "filename": "server/api/rpc/index.js",
20138     "groupTitle": "RPC_Realtime"
20139   },
20140   {
20141     "type": "get",
20142     "url": "/api/rpc/mail/queues/waitinginteractions",
20143     "title": "Gets a list of mailQueuesWaitingInteractions",
20144     "examples": [
20145       {
20146         "title": "Example usage:",
20147         "content": "curl https://{domain}/api/rpc/mail/queues/waitinginteractions -v -u {name}:{password}",
20148         "type": "json"
20149       }
20150     ],
20151     "name": "mailQueuesWaitingInteractions",
20152     "group": "RPC_Realtime",
20153     "description": "<p>Motion will return a list of realtime waiting mail queues interctions.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20154     "version": "0.0.0",
20155     "filename": "server/api/rpc/index.js",
20156     "groupTitle": "RPC_Realtime"
20157   },
20158   {
20159     "type": "post",
20160     "url": "/api/rpc/openchannel/queues/:id/notify",
20161     "title": "Notify message to a specific queue",
20162     "examples": [
20163       {
20164         "title": "Example usage:",
20165         "content": "curl https://{domain}/api/rpc/openchannel/queues/:id/notify -d '{\"messageId\": \"5080\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
20166         "type": "json"
20167       }
20168     ],
20169     "name": "openchannelQueueNotify",
20170     "group": "RPC_Realtime",
20171     "description": "<p>Notify message to a specific queue.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20172     "version": "0.0.0",
20173     "filename": "server/api/rpc/index.js",
20174     "groupTitle": "RPC_Realtime"
20175   },
20176   {
20177     "type": "get",
20178     "url": "/api/rpc/openchannel/queues/:id/waitinginteractions",
20179     "title": "Gets a list of openchannelQueuesIdWaitingInteractions",
20180     "examples": [
20181       {
20182         "title": "Example usage:",
20183         "content": "curl https://{domain}/api/rpc/openchannel/queues/:id/waitinginteractions -v -u {name}:{password}",
20184         "type": "json"
20185       }
20186     ],
20187     "name": "openchannelQueuesIdWaitingInteractions",
20188     "group": "RPC_Realtime",
20189     "description": "<p>Motion will return a list of realtime waiting openchannel queues interctions.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20190     "version": "0.0.0",
20191     "filename": "server/api/rpc/index.js",
20192     "groupTitle": "RPC_Realtime"
20193   },
20194   {
20195     "type": "get",
20196     "url": "/api/rpc/openchannel/queues/waitinginteractions",
20197     "title": "Gets a list of openchannelQueuesWaitingInteractions",
20198     "examples": [
20199       {
20200         "title": "Example usage:",
20201         "content": "curl https://{domain}/api/rpc/openchannel/queues/waitinginteractions -v -u {name}:{password}",
20202         "type": "json"
20203       }
20204     ],
20205     "name": "openchannelQueuesWaitingInteractions",
20206     "group": "RPC_Realtime",
20207     "description": "<p>Motion will return a list of realtime waiting openchannel queues interctions.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20208     "version": "0.0.0",
20209     "filename": "server/api/rpc/index.js",
20210     "groupTitle": "RPC_Realtime"
20211   },
20212   {
20213     "type": "post",
20214     "url": "/api/rpc/sms/queues/:id/notify",
20215     "title": "Notify message to a specific queue",
20216     "examples": [
20217       {
20218         "title": "Example usage:",
20219         "content": "curl https://{domain}/api/rpc/sms/queues/:id/notify -d '{\"messageId\": \"5080\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
20220         "type": "json"
20221       }
20222     ],
20223     "name": "smsQueueNotify",
20224     "group": "RPC_Realtime",
20225     "description": "<p>Notify message to a specific queue.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20226     "version": "0.0.0",
20227     "filename": "server/api/rpc/index.js",
20228     "groupTitle": "RPC_Realtime"
20229   },
20230   {
20231     "type": "get",
20232     "url": "/api/rpc/sms/queues/waitinginteractions",
20233     "title": "Gets a list of smsQueuesWaitingInteractions",
20234     "examples": [
20235       {
20236         "title": "Example usage:",
20237         "content": "curl https://{domain}/api/rpc/sms/queues/waitinginteractions -v -u {name}:{password}",
20238         "type": "json"
20239       }
20240     ],
20241     "name": "smsQueuesWaitingInteractions",
20242     "group": "RPC_Realtime",
20243     "description": "<p>Motion will return a list of realtime waiting sms queues interctions.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20244     "version": "0.0.0",
20245     "filename": "server/api/rpc/index.js",
20246     "groupTitle": "RPC_Realtime"
20247   },
20248   {
20249     "type": "post",
20250     "url": "/api/integrations/salesforce/accounts",
20251     "title": "Creates a new Salesforce Account",
20252     "examples": [
20253       {
20254         "title": "Example usage:",
20255         "content": "curl https://{domain}/api/integrations/salesforce/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
20256         "type": "json"
20257       }
20258     ],
20259     "name": "CreateSalesforce_Accounts",
20260     "group": "Salesforce_Accounts",
20261     "parameter": {
20262       "fields": {
20263         "Body": [
20264           {
20265             "group": "Body",
20266             "type": "String",
20267             "optional": true,
20268             "field": "name",
20269             "description": ""
20270           },
20271           {
20272             "group": "Body",
20273             "type": "String",
20274             "optional": true,
20275             "field": "description",
20276             "description": ""
20277           },
20278           {
20279             "group": "Body",
20280             "type": "String",
20281             "optional": true,
20282             "field": "username",
20283             "description": ""
20284           },
20285           {
20286             "group": "Body",
20287             "type": "String",
20288             "optional": true,
20289             "field": "remoteUri",
20290             "description": ""
20291           },
20292           {
20293             "group": "Body",
20294             "type": "String",
20295             "optional": true,
20296             "field": "password",
20297             "description": ""
20298           },
20299           {
20300             "group": "Body",
20301             "type": "String",
20302             "optional": true,
20303             "field": "clientId",
20304             "description": ""
20305           },
20306           {
20307             "group": "Body",
20308             "type": "String",
20309             "optional": true,
20310             "field": "clientSecret",
20311             "description": ""
20312           },
20313           {
20314             "group": "Body",
20315             "type": "String",
20316             "optional": true,
20317             "field": "securityToken",
20318             "description": ""
20319           },
20320           {
20321             "group": "Body",
20322             "type": "String",
20323             "optional": false,
20324             "field": "serverUrl",
20325             "description": ""
20326           },
20327           {
20328             "group": "Body",
20329             "type": "String",
20330             "allowedValues": [
20331               "\"integrationTab\"",
20332               "\"newTab\""
20333             ],
20334             "optional": true,
20335             "field": "type",
20336             "description": ""
20337           }
20338         ]
20339       }
20340     },
20341     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20342     "version": "0.0.0",
20343     "filename": "server/api/intSalesforceAccount/index.js",
20344     "groupTitle": "Salesforce_Accounts"
20345   },
20346   {
20347     "type": "delete",
20348     "url": "/api/integrations/salesforce/accounts/{id}",
20349     "title": "Deletes a Salesforce Account",
20350     "examples": [
20351       {
20352         "title": "Example usage:",
20353         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password} -X DELETE",
20354         "type": "json"
20355       }
20356     ],
20357     "name": "DeleteSalesforce_Accounts",
20358     "group": "Salesforce_Accounts",
20359     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20360     "version": "0.0.0",
20361     "filename": "server/api/intSalesforceAccount/index.js",
20362     "groupTitle": "Salesforce_Accounts"
20363   },
20364   {
20365     "type": "get",
20366     "url": "/api/integrations/salesforce/accounts",
20367     "title": "Gets a list of Salesforce Accounts",
20368     "examples": [
20369       {
20370         "title": "Example usage:",
20371         "content": "curl https://{domain}/api/integrations/salesforce/accounts -v -u {name}:{password}",
20372         "type": "json"
20373       }
20374     ],
20375     "name": "GetSalesforce_Accounts",
20376     "group": "Salesforce_Accounts",
20377     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/salesforce/accounts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/salesforce/accounts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/salesforce/accounts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/salesforce/accounts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/salesforce/accounts?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
20378     "version": "0.0.0",
20379     "filename": "server/api/intSalesforceAccount/index.js",
20380     "groupTitle": "Salesforce_Accounts"
20381   },
20382   {
20383     "type": "get",
20384     "url": "/api/integrations/salesforce/accounts/{id}",
20385     "title": "Gets a single Salesforce Account",
20386     "examples": [
20387       {
20388         "title": "Example usage:",
20389         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password}",
20390         "type": "json"
20391       }
20392     ],
20393     "name": "ShowSalesforce_Accounts",
20394     "group": "Salesforce_Accounts",
20395     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20396     "version": "0.0.0",
20397     "filename": "server/api/intSalesforceAccount/index.js",
20398     "groupTitle": "Salesforce_Accounts"
20399   },
20400   {
20401     "type": "post",
20402     "url": "/api/integrations/salesforce/accounts/{id}/configurations",
20403     "title": "Creates new configuration",
20404     "examples": [
20405       {
20406         "title": "Example usage:",
20407         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/configurations -d '{\"name\": \"conf1\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
20408         "type": "json"
20409       }
20410     ],
20411     "name": "addConfiguration",
20412     "group": "Salesforce_Accounts",
20413     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20414     "version": "0.0.0",
20415     "filename": "server/api/intSalesforceAccount/index.js",
20416     "groupTitle": "Salesforce_Accounts"
20417   },
20418   {
20419     "type": "get",
20420     "url": "/api/integrations/salesforce/accounts/{id}/configurations",
20421     "title": "Gets account configurations",
20422     "examples": [
20423       {
20424         "title": "Example usage:",
20425         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/configurations -v -u {name}:{password} -X GET",
20426         "type": "json"
20427       }
20428     ],
20429     "name": "getConfigurations",
20430     "group": "Salesforce_Accounts",
20431     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20432     "version": "0.0.0",
20433     "filename": "server/api/intSalesforceAccount/index.js",
20434     "groupTitle": "Salesforce_Accounts"
20435   },
20436   {
20437     "type": "get",
20438     "url": "/api/integrations/salesforce/accounts/{id}/fields",
20439     "title": "Gets account fields",
20440     "examples": [
20441       {
20442         "title": "Example usage:",
20443         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/fields -v -u {name}:{password} -X GET",
20444         "type": "json"
20445       }
20446     ],
20447     "name": "getFields",
20448     "group": "Salesforce_Accounts",
20449     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20450     "version": "0.0.0",
20451     "filename": "server/api/intSalesforceAccount/index.js",
20452     "groupTitle": "Salesforce_Accounts"
20453   },
20454   {
20455     "type": "put",
20456     "url": "/api/integrations/salesforce/accounts/{id}",
20457     "title": "Update an existing Salesforce Account",
20458     "examples": [
20459       {
20460         "title": "Example usage:",
20461         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
20462         "type": "json"
20463       }
20464     ],
20465     "name": "updateSalesforce_Accounts",
20466     "group": "Salesforce_Accounts",
20467     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20468     "version": "0.0.0",
20469     "filename": "server/api/intSalesforceAccount/index.js",
20470     "groupTitle": "Salesforce_Accounts"
20471   },
20472   {
20473     "type": "post",
20474     "url": "/api/integrations/salesforce/configurations",
20475     "title": "Creates a new Salesforce Configuration",
20476     "examples": [
20477       {
20478         "title": "Example usage:",
20479         "content": "curl https://{domain}/api/integrations/salesforce/configurations -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
20480         "type": "json"
20481       }
20482     ],
20483     "name": "CreateSalesforce_Configurations",
20484     "group": "Salesforce_Configurations",
20485     "parameter": {
20486       "fields": {
20487         "Body": [
20488           {
20489             "group": "Body",
20490             "type": "String",
20491             "optional": true,
20492             "field": "name",
20493             "description": ""
20494           },
20495           {
20496             "group": "Body",
20497             "type": "String",
20498             "optional": true,
20499             "field": "description",
20500             "description": ""
20501           },
20502           {
20503             "group": "Body",
20504             "type": "String",
20505             "allowedValues": [
20506               "\"Task\"",
20507               "\"Case\""
20508             ],
20509             "optional": true,
20510             "field": "ticketType",
20511             "description": ""
20512           },
20513           {
20514             "group": "Body",
20515             "type": "String",
20516             "allowedValues": [
20517               "\"contact_lead\"",
20518               "\"contact\"",
20519               "\"lead\""
20520             ],
20521             "optional": true,
20522             "field": "moduleSearch",
20523             "description": ""
20524           },
20525           {
20526             "group": "Body",
20527             "type": "String",
20528             "allowedValues": [
20529               "\"nothing\"",
20530               "\"contact\"",
20531               "\"lead\""
20532             ],
20533             "optional": true,
20534             "field": "moduleCreate",
20535             "description": ""
20536           }
20537         ]
20538       }
20539     },
20540     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20541     "version": "0.0.0",
20542     "filename": "server/api/intSalesforceConfiguration/index.js",
20543     "groupTitle": "Salesforce_Configurations"
20544   },
20545   {
20546     "type": "delete",
20547     "url": "/api/integrations/salesforce/configurations/{id}",
20548     "title": "Deletes a Salesforce Configuration",
20549     "examples": [
20550       {
20551         "title": "Example usage:",
20552         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password} -X DELETE",
20553         "type": "json"
20554       }
20555     ],
20556     "name": "DeleteSalesforce_Configurations",
20557     "group": "Salesforce_Configurations",
20558     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20559     "version": "0.0.0",
20560     "filename": "server/api/intSalesforceConfiguration/index.js",
20561     "groupTitle": "Salesforce_Configurations"
20562   },
20563   {
20564     "type": "get",
20565     "url": "/api/integrations/salesforce/configurations",
20566     "title": "Gets a list of Salesforce Configurations",
20567     "examples": [
20568       {
20569         "title": "Example usage:",
20570         "content": "curl https://{domain}/api/integrations/salesforce/configurations -v -u {name}:{password}",
20571         "type": "json"
20572       }
20573     ],
20574     "name": "GetSalesforce_Configurations",
20575     "group": "Salesforce_Configurations",
20576     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/salesforce/configurations?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/salesforce/configurations?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/salesforce/configurations?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/salesforce/configurations?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/salesforce/configurations?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
20577     "version": "0.0.0",
20578     "filename": "server/api/intSalesforceConfiguration/index.js",
20579     "groupTitle": "Salesforce_Configurations"
20580   },
20581   {
20582     "type": "get",
20583     "url": "/api/integrations/salesforce/configurations/{id}",
20584     "title": "Gets a single Salesforce Configuration",
20585     "examples": [
20586       {
20587         "title": "Example usage:",
20588         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password}",
20589         "type": "json"
20590       }
20591     ],
20592     "name": "ShowSalesforce_Configurations",
20593     "group": "Salesforce_Configurations",
20594     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20595     "version": "0.0.0",
20596     "filename": "server/api/intSalesforceConfiguration/index.js",
20597     "groupTitle": "Salesforce_Configurations"
20598   },
20599   {
20600     "type": "get",
20601     "url": "/api/integrations/salesforce/configurations/{id}/descriptions",
20602     "title": "Gets configurations descriptions",
20603     "examples": [
20604       {
20605         "title": "Example usage:",
20606         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
20607         "type": "json"
20608       }
20609     ],
20610     "name": "getDescriptions",
20611     "group": "Salesforce_Configurations",
20612     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20613     "version": "0.0.0",
20614     "filename": "server/api/intSalesforceConfiguration/index.js",
20615     "groupTitle": "Salesforce_Configurations"
20616   },
20617   {
20618     "type": "get",
20619     "url": "/api/integrations/salesforce/configurations/{id}/fields",
20620     "title": "Gets configurations fields",
20621     "examples": [
20622       {
20623         "title": "Example usage:",
20624         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/fields -v -u {name}:{password} -X GET",
20625         "type": "json"
20626       }
20627     ],
20628     "name": "getFields",
20629     "group": "Salesforce_Configurations",
20630     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20631     "version": "0.0.0",
20632     "filename": "server/api/intSalesforceConfiguration/index.js",
20633     "groupTitle": "Salesforce_Configurations"
20634   },
20635   {
20636     "type": "get",
20637     "url": "/api/integrations/salesforce/configurations/{id}/subjects",
20638     "title": "Gets configurations subjects",
20639     "examples": [
20640       {
20641         "title": "Example usage:",
20642         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/subjects -v -u {name}:{password} -X GET",
20643         "type": "json"
20644       }
20645     ],
20646     "name": "getSubjects",
20647     "group": "Salesforce_Configurations",
20648     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20649     "version": "0.0.0",
20650     "filename": "server/api/intSalesforceConfiguration/index.js",
20651     "groupTitle": "Salesforce_Configurations"
20652   },
20653   {
20654     "type": "put",
20655     "url": "/api/integrations/salesforce/configurations/{id}",
20656     "title": "Update an existing Salesforce Configuration",
20657     "examples": [
20658       {
20659         "title": "Example usage:",
20660         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
20661         "type": "json"
20662       }
20663     ],
20664     "name": "updateSalesforce_Configurations",
20665     "group": "Salesforce_Configurations",
20666     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20667     "version": "0.0.0",
20668     "filename": "server/api/intSalesforceConfiguration/index.js",
20669     "groupTitle": "Salesforce_Configurations"
20670   },
20671   {
20672     "type": "post",
20673     "url": "/api/integrations/salesforce/fields",
20674     "title": "Creates a new Salesforce Field",
20675     "examples": [
20676       {
20677         "title": "Example usage:",
20678         "content": "curl https://{domain}/api/integrations/salesforce/fields -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
20679         "type": "json"
20680       }
20681     ],
20682     "name": "CreateSalesforce_Fields",
20683     "group": "Salesforce_Fields",
20684     "parameter": {
20685       "fields": {
20686         "Body": [
20687           {
20688             "group": "Body",
20689             "type": "String",
20690             "allowedValues": [
20691               "\"string\"",
20692               "\"variable\"",
20693               "\"customVariable\"",
20694               "\"keyValue\""
20695             ],
20696             "optional": true,
20697             "field": "type",
20698             "description": ""
20699           },
20700           {
20701             "group": "Body",
20702             "type": "String",
20703             "optional": true,
20704             "field": "content",
20705             "description": ""
20706           },
20707           {
20708             "group": "Body",
20709             "type": "String",
20710             "optional": true,
20711             "field": "key",
20712             "description": ""
20713           },
20714           {
20715             "group": "Body",
20716             "type": "String",
20717             "allowedValues": [
20718               "\"string\"",
20719               "\"variable\"",
20720               "\"customVariable\""
20721             ],
20722             "optional": true,
20723             "field": "keyType",
20724             "description": ""
20725           },
20726           {
20727             "group": "Body",
20728             "type": "String",
20729             "optional": true,
20730             "field": "keyContent",
20731             "description": ""
20732           },
20733           {
20734             "group": "Body",
20735             "type": "String",
20736             "optional": true,
20737             "field": "idField",
20738             "description": ""
20739           },
20740           {
20741             "group": "Body",
20742             "type": "String",
20743             "optional": true,
20744             "field": "variableName",
20745             "description": ""
20746           }
20747         ]
20748       }
20749     },
20750     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20751     "version": "0.0.0",
20752     "filename": "server/api/intSalesforceField/index.js",
20753     "groupTitle": "Salesforce_Fields"
20754   },
20755   {
20756     "type": "delete",
20757     "url": "/api/integrations/salesforce/fields/{id}",
20758     "title": "Deletes a Salesforce Field",
20759     "examples": [
20760       {
20761         "title": "Example usage:",
20762         "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password} -X DELETE",
20763         "type": "json"
20764       }
20765     ],
20766     "name": "DeleteSalesforce_Fields",
20767     "group": "Salesforce_Fields",
20768     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20769     "version": "0.0.0",
20770     "filename": "server/api/intSalesforceField/index.js",
20771     "groupTitle": "Salesforce_Fields"
20772   },
20773   {
20774     "type": "get",
20775     "url": "/api/integrations/salesforce/fields",
20776     "title": "Gets a list of Salesforce Fields",
20777     "examples": [
20778       {
20779         "title": "Example usage:",
20780         "content": "curl https://{domain}/api/integrations/salesforce/fields -v -u {name}:{password}",
20781         "type": "json"
20782       }
20783     ],
20784     "name": "GetSalesforce_Fields",
20785     "group": "Salesforce_Fields",
20786     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/salesforce/fields?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/salesforce/fields?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/salesforce/fields?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/salesforce/fields?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/salesforce/fields?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
20787     "version": "0.0.0",
20788     "filename": "server/api/intSalesforceField/index.js",
20789     "groupTitle": "Salesforce_Fields"
20790   },
20791   {
20792     "type": "get",
20793     "url": "/api/integrations/salesforce/fields/{id}",
20794     "title": "Gets a single Salesforce Field",
20795     "examples": [
20796       {
20797         "title": "Example usage:",
20798         "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password}",
20799         "type": "json"
20800       }
20801     ],
20802     "name": "ShowSalesforce_Fields",
20803     "group": "Salesforce_Fields",
20804     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20805     "version": "0.0.0",
20806     "filename": "server/api/intSalesforceField/index.js",
20807     "groupTitle": "Salesforce_Fields"
20808   },
20809   {
20810     "type": "put",
20811     "url": "/api/integrations/salesforce/fields/{id}",
20812     "title": "Update an existing Salesforce Field",
20813     "examples": [
20814       {
20815         "title": "Example usage:",
20816         "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
20817         "type": "json"
20818       }
20819     ],
20820     "name": "updateSalesforce_Fields",
20821     "group": "Salesforce_Fields",
20822     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20823     "version": "0.0.0",
20824     "filename": "server/api/intSalesforceField/index.js",
20825     "groupTitle": "Salesforce_Fields"
20826   },
20827   {
20828     "type": "post",
20829     "url": "/api/schedules",
20830     "title": "Creates a new Schedule",
20831     "examples": [
20832       {
20833         "title": "Example usage:",
20834         "content": "curl https://{domain}/api/schedules -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
20835         "type": "json"
20836       }
20837     ],
20838     "name": "CreateSchedules",
20839     "group": "Schedules",
20840     "parameter": {
20841       "fields": {
20842         "Body": [
20843           {
20844             "group": "Body",
20845             "type": "String",
20846             "optional": false,
20847             "field": "name",
20848             "description": ""
20849           },
20850           {
20851             "group": "Body",
20852             "type": "String",
20853             "optional": true,
20854             "field": "description",
20855             "description": ""
20856           },
20857           {
20858             "group": "Body",
20859             "type": "Boolean",
20860             "optional": false,
20861             "field": "active",
20862             "description": ""
20863           },
20864           {
20865             "group": "Body",
20866             "type": "String",
20867             "optional": false,
20868             "field": "cron",
20869             "description": ""
20870           },
20871           {
20872             "group": "Body",
20873             "type": "String",
20874             "optional": false,
20875             "field": "startAt",
20876             "description": ""
20877           },
20878           {
20879             "group": "Body",
20880             "type": "String",
20881             "optional": false,
20882             "field": "endAt",
20883             "description": ""
20884           },
20885           {
20886             "group": "Body",
20887             "type": "Integer",
20888             "optional": false,
20889             "field": "subtractNumber",
20890             "description": ""
20891           },
20892           {
20893             "group": "Body",
20894             "type": "String",
20895             "allowedValues": [
20896               "\"years\"",
20897               "\"quarters\"",
20898               "\"months\"",
20899               "\"weeks\"",
20900               "\"days\"",
20901               "\"hours\"",
20902               "\"minutes\""
20903             ],
20904             "optional": false,
20905             "field": "subtractUnit",
20906             "description": ""
20907           },
20908           {
20909             "group": "Body",
20910             "type": "String",
20911             "allowedValues": [
20912               "\"csv\"",
20913               "\"pdf\"",
20914               "\"xlsx\""
20915             ],
20916             "optional": false,
20917             "field": "output",
20918             "description": ""
20919           },
20920           {
20921             "group": "Body",
20922             "type": "String",
20923             "allowedValues": [
20924               "\"custom\"",
20925               "\"default\""
20926             ],
20927             "optional": false,
20928             "field": "type",
20929             "description": ""
20930           },
20931           {
20932             "group": "Body",
20933             "type": "Boolean",
20934             "optional": true,
20935             "field": "sendMail",
20936             "description": ""
20937           },
20938           {
20939             "group": "Body",
20940             "type": "String",
20941             "optional": true,
20942             "field": "email",
20943             "description": ""
20944           },
20945           {
20946             "group": "Body",
20947             "type": "Text",
20948             "optional": true,
20949             "field": "cc",
20950             "description": ""
20951           },
20952           {
20953             "group": "Body",
20954             "type": "Text",
20955             "optional": true,
20956             "field": "bcc",
20957             "description": ""
20958           },
20959           {
20960             "group": "Body",
20961             "type": "Boolean",
20962             "optional": true,
20963             "field": "sendIfEmpty",
20964             "description": ""
20965           }
20966         ]
20967       }
20968     },
20969     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20970     "version": "0.0.0",
20971     "filename": "server/api/schedule/index.js",
20972     "groupTitle": "Schedules"
20973   },
20974   {
20975     "type": "delete",
20976     "url": "/api/schedules/{id}",
20977     "title": "Deletes a Schedule",
20978     "examples": [
20979       {
20980         "title": "Example usage:",
20981         "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password} -X DELETE",
20982         "type": "json"
20983       }
20984     ],
20985     "name": "DeleteSchedules",
20986     "group": "Schedules",
20987     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20988     "version": "0.0.0",
20989     "filename": "server/api/schedule/index.js",
20990     "groupTitle": "Schedules"
20991   },
20992   {
20993     "type": "get",
20994     "url": "/api/schedules",
20995     "title": "Gets a list of Schedules",
20996     "examples": [
20997       {
20998         "title": "Example usage:",
20999         "content": "curl https://{domain}/api/schedules -v -u {name}:{password}",
21000         "type": "json"
21001       }
21002     ],
21003     "name": "GetSchedules",
21004     "group": "Schedules",
21005     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/schedules?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/schedules?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/schedules?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/schedules?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/schedules?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
21006     "version": "0.0.0",
21007     "filename": "server/api/schedule/index.js",
21008     "groupTitle": "Schedules"
21009   },
21010   {
21011     "type": "get",
21012     "url": "/api/schedules/{id}",
21013     "title": "Gets a single Schedule",
21014     "examples": [
21015       {
21016         "title": "Example usage:",
21017         "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password}",
21018         "type": "json"
21019       }
21020     ],
21021     "name": "ShowSchedules",
21022     "group": "Schedules",
21023     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21024     "version": "0.0.0",
21025     "filename": "server/api/schedule/index.js",
21026     "groupTitle": "Schedules"
21027   },
21028   {
21029     "type": "get",
21030     "url": "/api/schedules/{id}/run",
21031     "title": "Run Scheduler",
21032     "examples": [
21033       {
21034         "title": "Example usage:",
21035         "content": "curl https://{domain}/api/schedules/{id}/run -v -u {name}:{password} -X GET",
21036         "type": "json"
21037       }
21038     ],
21039     "name": "run",
21040     "group": "Schedules",
21041     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21042     "version": "0.0.0",
21043     "filename": "server/api/schedule/index.js",
21044     "groupTitle": "Schedules"
21045   },
21046   {
21047     "type": "put",
21048     "url": "/api/schedules/{id}",
21049     "title": "Update an existing Schedule",
21050     "examples": [
21051       {
21052         "title": "Example usage:",
21053         "content": "curl https://{domain}/api/schedules/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
21054         "type": "json"
21055       }
21056     ],
21057     "name": "updateSchedules",
21058     "group": "Schedules",
21059     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21060     "version": "0.0.0",
21061     "filename": "server/api/schedule/index.js",
21062     "groupTitle": "Schedules"
21063   },
21064   {
21065     "type": "post",
21066     "url": "/api/screen/recordings",
21067     "title": "Creates a new Recording",
21068     "examples": [
21069       {
21070         "title": "Example usage:",
21071         "content": "curl https://{domain}/api/screen/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
21072         "type": "json"
21073       }
21074     ],
21075     "name": "CreateRecordings",
21076     "group": "Screen_Recordings",
21077     "parameter": {
21078       "fields": {
21079         "Body": [
21080           {
21081             "group": "Body",
21082             "type": "Virtual",
21083             "optional": true,
21084             "field": "format",
21085             "description": ""
21086           },
21087           {
21088             "group": "Body",
21089             "type": "String",
21090             "optional": true,
21091             "field": "interactionid",
21092             "description": ""
21093           },
21094           {
21095             "group": "Body",
21096             "type": "String",
21097             "optional": true,
21098             "field": "channel",
21099             "description": ""
21100           },
21101           {
21102             "group": "Body",
21103             "type": "String",
21104             "optional": true,
21105             "field": "value",
21106             "description": ""
21107           },
21108           {
21109             "group": "Body",
21110             "type": "Integer",
21111             "optional": true,
21112             "field": "rating",
21113             "description": ""
21114           },
21115           {
21116             "group": "Body",
21117             "type": "Integer",
21118             "optional": true,
21119             "field": "duration",
21120             "description": ""
21121           },
21122           {
21123             "group": "Body",
21124             "type": "String",
21125             "optional": true,
21126             "field": "startedAt",
21127             "description": ""
21128           },
21129           {
21130             "group": "Body",
21131             "type": "String",
21132             "optional": true,
21133             "field": "closedAt",
21134             "description": ""
21135           },
21136           {
21137             "group": "Body",
21138             "type": "String",
21139             "optional": true,
21140             "field": "createdAt",
21141             "description": ""
21142           },
21143           {
21144             "group": "Body",
21145             "type": "String",
21146             "optional": true,
21147             "field": "updatedAt",
21148             "description": ""
21149           }
21150         ]
21151       }
21152     },
21153     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21154     "version": "0.0.0",
21155     "filename": "server/api/screenRecording/index.js",
21156     "groupTitle": "Screen_Recordings"
21157   },
21158   {
21159     "type": "get",
21160     "url": "/api/screen/recordings/describe",
21161     "title": "Gets table info about Recordings",
21162     "examples": [
21163       {
21164         "title": "Example usage:",
21165         "content": "curl https://{domain}/api/screen/recordings/describe -v -u {name}:{password}",
21166         "type": "json"
21167       }
21168     ],
21169     "name": "DescribeRecordings",
21170     "group": "Screen_Recordings",
21171     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21172     "version": "0.0.0",
21173     "filename": "server/api/screenRecording/index.js",
21174     "groupTitle": "Screen_Recordings"
21175   },
21176   {
21177     "type": "get",
21178     "url": "/api/screen/recordings",
21179     "title": "Gets a list of Recordings",
21180     "examples": [
21181       {
21182         "title": "Example usage:",
21183         "content": "curl https://{domain}/api/screen/recordings -v -u {name}:{password}",
21184         "type": "json"
21185       }
21186     ],
21187     "name": "GetRecordings",
21188     "group": "Screen_Recordings",
21189     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/screen/recordings?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/screen/recordings?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/screen/recordings?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/screen/recordings?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/screen/recordings?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
21190     "version": "0.0.0",
21191     "filename": "server/api/screenRecording/index.js",
21192     "groupTitle": "Screen_Recordings"
21193   },
21194   {
21195     "type": "get",
21196     "url": "/api/screen/recordings/{id}",
21197     "title": "Gets a single Recording",
21198     "examples": [
21199       {
21200         "title": "Example usage:",
21201         "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password}",
21202         "type": "json"
21203       }
21204     ],
21205     "name": "ShowRecordings",
21206     "group": "Screen_Recordings",
21207     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21208     "version": "0.0.0",
21209     "filename": "server/api/screenRecording/index.js",
21210     "groupTitle": "Screen_Recordings"
21211   },
21212   {
21213     "type": "delete",
21214     "url": "/api/screen/recordings/{id}",
21215     "title": "Delete screen recording",
21216     "examples": [
21217       {
21218         "title": "Example usage:",
21219         "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password} -X DELETE",
21220         "type": "json"
21221       }
21222     ],
21223     "name": "destroy",
21224     "group": "Screen_Recordings",
21225     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21226     "version": "0.0.0",
21227     "filename": "server/api/screenRecording/index.js",
21228     "groupTitle": "Screen_Recordings"
21229   },
21230   {
21231     "type": "get",
21232     "url": "/api/screen/recordings/{id}/download",
21233     "title": "Download Recording",
21234     "examples": [
21235       {
21236         "title": "Example usage:",
21237         "content": "curl https://{domain}/api/screen/recordings/{id}/download -v -u {name}:{password} -X GET",
21238         "type": "json"
21239       }
21240     ],
21241     "name": "download",
21242     "group": "Screen_Recordings",
21243     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21244     "version": "0.0.0",
21245     "filename": "server/api/screenRecording/index.js",
21246     "groupTitle": "Screen_Recordings"
21247   },
21248   {
21249     "type": "put",
21250     "url": "/api/screen/recordings/{id}",
21251     "title": "Update an existing Recording",
21252     "examples": [
21253       {
21254         "title": "Example usage:",
21255         "content": "curl https://{domain}/api/screen/recordings/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
21256         "type": "json"
21257       }
21258     ],
21259     "name": "updateRecordings",
21260     "group": "Screen_Recordings",
21261     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21262     "version": "0.0.0",
21263     "filename": "server/api/screenRecording/index.js",
21264     "groupTitle": "Screen_Recordings"
21265   },
21266   {
21267     "type": "post",
21268     "url": "/api/integrations/servicenow/accounts",
21269     "title": "Creates a new Servicenow Account",
21270     "examples": [
21271       {
21272         "title": "Example usage:",
21273         "content": "curl https://{domain}/api/integrations/servicenow/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
21274         "type": "json"
21275       }
21276     ],
21277     "name": "CreateServicenow_Accounts",
21278     "group": "Servicenow_Accounts",
21279     "parameter": {
21280       "fields": {
21281         "Body": [
21282           {
21283             "group": "Body",
21284             "type": "String",
21285             "optional": true,
21286             "field": "name",
21287             "description": ""
21288           },
21289           {
21290             "group": "Body",
21291             "type": "String",
21292             "optional": true,
21293             "field": "description",
21294             "description": ""
21295           },
21296           {
21297             "group": "Body",
21298             "type": "String",
21299             "optional": true,
21300             "field": "username",
21301             "description": ""
21302           },
21303           {
21304             "group": "Body",
21305             "type": "String",
21306             "optional": true,
21307             "field": "password",
21308             "description": ""
21309           },
21310           {
21311             "group": "Body",
21312             "type": "String",
21313             "optional": true,
21314             "field": "email",
21315             "description": ""
21316           },
21317           {
21318             "group": "Body",
21319             "type": "String",
21320             "optional": true,
21321             "field": "remoteUri",
21322             "description": ""
21323           },
21324           {
21325             "group": "Body",
21326             "type": "String",
21327             "optional": false,
21328             "field": "serverUrl",
21329             "description": ""
21330           }
21331         ]
21332       }
21333     },
21334     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21335     "version": "0.0.0",
21336     "filename": "server/api/intServicenowAccount/index.js",
21337     "groupTitle": "Servicenow_Accounts"
21338   },
21339   {
21340     "type": "delete",
21341     "url": "/api/integrations/servicenow/accounts/{id}",
21342     "title": "Deletes a Servicenow Account",
21343     "examples": [
21344       {
21345         "title": "Example usage:",
21346         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password} -X DELETE",
21347         "type": "json"
21348       }
21349     ],
21350     "name": "DeleteServicenow_Accounts",
21351     "group": "Servicenow_Accounts",
21352     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21353     "version": "0.0.0",
21354     "filename": "server/api/intServicenowAccount/index.js",
21355     "groupTitle": "Servicenow_Accounts"
21356   },
21357   {
21358     "type": "get",
21359     "url": "/api/integrations/servicenow/accounts",
21360     "title": "Gets a list of Servicenow Accounts",
21361     "examples": [
21362       {
21363         "title": "Example usage:",
21364         "content": "curl https://{domain}/api/integrations/servicenow/accounts -v -u {name}:{password}",
21365         "type": "json"
21366       }
21367     ],
21368     "name": "GetServicenow_Accounts",
21369     "group": "Servicenow_Accounts",
21370     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/servicenow/accounts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/servicenow/accounts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/servicenow/accounts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/servicenow/accounts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/servicenow/accounts?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
21371     "version": "0.0.0",
21372     "filename": "server/api/intServicenowAccount/index.js",
21373     "groupTitle": "Servicenow_Accounts"
21374   },
21375   {
21376     "type": "get",
21377     "url": "/api/integrations/servicenow/accounts/{id}",
21378     "title": "Gets a single Servicenow Account",
21379     "examples": [
21380       {
21381         "title": "Example usage:",
21382         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password}",
21383         "type": "json"
21384       }
21385     ],
21386     "name": "ShowServicenow_Accounts",
21387     "group": "Servicenow_Accounts",
21388     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21389     "version": "0.0.0",
21390     "filename": "server/api/intServicenowAccount/index.js",
21391     "groupTitle": "Servicenow_Accounts"
21392   },
21393   {
21394     "type": "post",
21395     "url": "/api/integrations/servicenow/accounts/{id}/configurations",
21396     "title": "Creates new configuration",
21397     "examples": [
21398       {
21399         "title": "Example usage:",
21400         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/configurations -d '{\"name\": \"conf1\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
21401         "type": "json"
21402       }
21403     ],
21404     "name": "addConfiguration",
21405     "group": "Servicenow_Accounts",
21406     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21407     "version": "0.0.0",
21408     "filename": "server/api/intServicenowAccount/index.js",
21409     "groupTitle": "Servicenow_Accounts"
21410   },
21411   {
21412     "type": "get",
21413     "url": "/api/integrations/servicenow/accounts/{id}/configurations",
21414     "title": "Gets account configurations",
21415     "examples": [
21416       {
21417         "title": "Example usage:",
21418         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/configurations -v -u {name}:{password} -X GET",
21419         "type": "json"
21420       }
21421     ],
21422     "name": "getConfigurations",
21423     "group": "Servicenow_Accounts",
21424     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21425     "version": "0.0.0",
21426     "filename": "server/api/intServicenowAccount/index.js",
21427     "groupTitle": "Servicenow_Accounts"
21428   },
21429   {
21430     "type": "get",
21431     "url": "/api/integrations/servicenow/accounts/{id}/fields",
21432     "title": "Gets account fields",
21433     "examples": [
21434       {
21435         "title": "Example usage:",
21436         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/fields -v -u {name}:{password} -X GET",
21437         "type": "json"
21438       }
21439     ],
21440     "name": "getFields",
21441     "group": "Servicenow_Accounts",
21442     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21443     "version": "0.0.0",
21444     "filename": "server/api/intServicenowAccount/index.js",
21445     "groupTitle": "Servicenow_Accounts"
21446   },
21447   {
21448     "type": "put",
21449     "url": "/api/integrations/servicenow/accounts/{id}",
21450     "title": "Update an existing Servicenow Account",
21451     "examples": [
21452       {
21453         "title": "Example usage:",
21454         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
21455         "type": "json"
21456       }
21457     ],
21458     "name": "updateServicenow_Accounts",
21459     "group": "Servicenow_Accounts",
21460     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21461     "version": "0.0.0",
21462     "filename": "server/api/intServicenowAccount/index.js",
21463     "groupTitle": "Servicenow_Accounts"
21464   },
21465   {
21466     "type": "post",
21467     "url": "/api/integrations/servicenow/configurations",
21468     "title": "Creates a new Servicenow Configuration",
21469     "examples": [
21470       {
21471         "title": "Example usage:",
21472         "content": "curl https://{domain}/api/integrations/servicenow/configurations -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
21473         "type": "json"
21474       }
21475     ],
21476     "name": "CreateServicenow_Configurations",
21477     "group": "Servicenow_Configurations",
21478     "parameter": {
21479       "fields": {
21480         "Body": [
21481           {
21482             "group": "Body",
21483             "type": "String",
21484             "optional": true,
21485             "field": "name",
21486             "description": ""
21487           },
21488           {
21489             "group": "Body",
21490             "type": "String",
21491             "optional": true,
21492             "field": "description",
21493             "description": ""
21494           }
21495         ]
21496       }
21497     },
21498     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21499     "version": "0.0.0",
21500     "filename": "server/api/intServicenowConfiguration/index.js",
21501     "groupTitle": "Servicenow_Configurations"
21502   },
21503   {
21504     "type": "delete",
21505     "url": "/api/integrations/servicenow/configurations/{id}",
21506     "title": "Deletes a Servicenow Configuration",
21507     "examples": [
21508       {
21509         "title": "Example usage:",
21510         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password} -X DELETE",
21511         "type": "json"
21512       }
21513     ],
21514     "name": "DeleteServicenow_Configurations",
21515     "group": "Servicenow_Configurations",
21516     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21517     "version": "0.0.0",
21518     "filename": "server/api/intServicenowConfiguration/index.js",
21519     "groupTitle": "Servicenow_Configurations"
21520   },
21521   {
21522     "type": "get",
21523     "url": "/api/integrations/servicenow/configurations",
21524     "title": "Gets a list of Servicenow Configurations",
21525     "examples": [
21526       {
21527         "title": "Example usage:",
21528         "content": "curl https://{domain}/api/integrations/servicenow/configurations -v -u {name}:{password}",
21529         "type": "json"
21530       }
21531     ],
21532     "name": "GetServicenow_Configurations",
21533     "group": "Servicenow_Configurations",
21534     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/servicenow/configurations?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/servicenow/configurations?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/servicenow/configurations?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/servicenow/configurations?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/servicenow/configurations?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
21535     "version": "0.0.0",
21536     "filename": "server/api/intServicenowConfiguration/index.js",
21537     "groupTitle": "Servicenow_Configurations"
21538   },
21539   {
21540     "type": "get",
21541     "url": "/api/integrations/servicenow/configurations/{id}",
21542     "title": "Gets a single Servicenow Configuration",
21543     "examples": [
21544       {
21545         "title": "Example usage:",
21546         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password}",
21547         "type": "json"
21548       }
21549     ],
21550     "name": "ShowServicenow_Configurations",
21551     "group": "Servicenow_Configurations",
21552     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21553     "version": "0.0.0",
21554     "filename": "server/api/intServicenowConfiguration/index.js",
21555     "groupTitle": "Servicenow_Configurations"
21556   },
21557   {
21558     "type": "get",
21559     "url": "/api/integrations/servicenow/configurations/{id}/descriptions",
21560     "title": "Gets configurations descriptions",
21561     "examples": [
21562       {
21563         "title": "Example usage:",
21564         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
21565         "type": "json"
21566       }
21567     ],
21568     "name": "getDescriptions",
21569     "group": "Servicenow_Configurations",
21570     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21571     "version": "0.0.0",
21572     "filename": "server/api/intServicenowConfiguration/index.js",
21573     "groupTitle": "Servicenow_Configurations"
21574   },
21575   {
21576     "type": "get",
21577     "url": "/api/integrations/servicenow/configurations/{id}/fields",
21578     "title": "Gets configurations fields",
21579     "examples": [
21580       {
21581         "title": "Example usage:",
21582         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/fields -v -u {name}:{password} -X GET",
21583         "type": "json"
21584       }
21585     ],
21586     "name": "getFields",
21587     "group": "Servicenow_Configurations",
21588     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21589     "version": "0.0.0",
21590     "filename": "server/api/intServicenowConfiguration/index.js",
21591     "groupTitle": "Servicenow_Configurations"
21592   },
21593   {
21594     "type": "get",
21595     "url": "/api/integrations/servicenow/configurations/{id}/subjects",
21596     "title": "Gets configurations subjects",
21597     "examples": [
21598       {
21599         "title": "Example usage:",
21600         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/subjects -v -u {name}:{password} -X GET",
21601         "type": "json"
21602       }
21603     ],
21604     "name": "getSubjects",
21605     "group": "Servicenow_Configurations",
21606     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21607     "version": "0.0.0",
21608     "filename": "server/api/intServicenowConfiguration/index.js",
21609     "groupTitle": "Servicenow_Configurations"
21610   },
21611   {
21612     "type": "put",
21613     "url": "/api/integrations/servicenow/configurations/{id}",
21614     "title": "Update an existing Servicenow Configuration",
21615     "examples": [
21616       {
21617         "title": "Example usage:",
21618         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
21619         "type": "json"
21620       }
21621     ],
21622     "name": "updateServicenow_Configurations",
21623     "group": "Servicenow_Configurations",
21624     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21625     "version": "0.0.0",
21626     "filename": "server/api/intServicenowConfiguration/index.js",
21627     "groupTitle": "Servicenow_Configurations"
21628   },
21629   {
21630     "type": "post",
21631     "url": "/api/integrations/servicenow/fields",
21632     "title": "Creates a new Servicenow Field",
21633     "examples": [
21634       {
21635         "title": "Example usage:",
21636         "content": "curl https://{domain}/api/integrations/servicenow/fields -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
21637         "type": "json"
21638       }
21639     ],
21640     "name": "CreateServicenow_Fields",
21641     "group": "Servicenow_Fields",
21642     "parameter": {
21643       "fields": {
21644         "Body": [
21645           {
21646             "group": "Body",
21647             "type": "String",
21648             "allowedValues": [
21649               "\"string\"",
21650               "\"variable\"",
21651               "\"customVariable\"",
21652               "\"keyValue\""
21653             ],
21654             "optional": true,
21655             "field": "type",
21656             "description": ""
21657           },
21658           {
21659             "group": "Body",
21660             "type": "String",
21661             "optional": true,
21662             "field": "content",
21663             "description": ""
21664           },
21665           {
21666             "group": "Body",
21667             "type": "String",
21668             "optional": true,
21669             "field": "key",
21670             "description": ""
21671           },
21672           {
21673             "group": "Body",
21674             "type": "String",
21675             "allowedValues": [
21676               "\"string\"",
21677               "\"variable\"",
21678               "\"customVariable\""
21679             ],
21680             "optional": true,
21681             "field": "keyType",
21682             "description": ""
21683           },
21684           {
21685             "group": "Body",
21686             "type": "String",
21687             "optional": true,
21688             "field": "keyContent",
21689             "description": ""
21690           },
21691           {
21692             "group": "Body",
21693             "type": "String",
21694             "optional": true,
21695             "field": "idField",
21696             "description": ""
21697           },
21698           {
21699             "group": "Body",
21700             "type": "String",
21701             "optional": true,
21702             "field": "nameField",
21703             "description": ""
21704           },
21705           {
21706             "group": "Body",
21707             "type": "Boolean",
21708             "optional": true,
21709             "field": "customField",
21710             "description": ""
21711           },
21712           {
21713             "group": "Body",
21714             "type": "String",
21715             "optional": true,
21716             "field": "variableName",
21717             "description": ""
21718           }
21719         ]
21720       }
21721     },
21722     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21723     "version": "0.0.0",
21724     "filename": "server/api/intServicenowField/index.js",
21725     "groupTitle": "Servicenow_Fields"
21726   },
21727   {
21728     "type": "delete",
21729     "url": "/api/integrations/servicenow/fields/{id}",
21730     "title": "Deletes a Servicenow Field",
21731     "examples": [
21732       {
21733         "title": "Example usage:",
21734         "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password} -X DELETE",
21735         "type": "json"
21736       }
21737     ],
21738     "name": "DeleteServicenow_Fields",
21739     "group": "Servicenow_Fields",
21740     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21741     "version": "0.0.0",
21742     "filename": "server/api/intServicenowField/index.js",
21743     "groupTitle": "Servicenow_Fields"
21744   },
21745   {
21746     "type": "get",
21747     "url": "/api/integrations/servicenow/fields",
21748     "title": "Gets a list of Servicenow Fields",
21749     "examples": [
21750       {
21751         "title": "Example usage:",
21752         "content": "curl https://{domain}/api/integrations/servicenow/fields -v -u {name}:{password}",
21753         "type": "json"
21754       }
21755     ],
21756     "name": "GetServicenow_Fields",
21757     "group": "Servicenow_Fields",
21758     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/servicenow/fields?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/integrations/servicenow/fields?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/integrations/servicenow/fields?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/integrations/servicenow/fields?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/integrations/servicenow/fields?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
21759     "version": "0.0.0",
21760     "filename": "server/api/intServicenowField/index.js",
21761     "groupTitle": "Servicenow_Fields"
21762   },
21763   {
21764     "type": "get",
21765     "url": "/api/integrations/servicenow/fields/{id}",
21766     "title": "Gets a single Servicenow Field",
21767     "examples": [
21768       {
21769         "title": "Example usage:",
21770         "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password}",
21771         "type": "json"
21772       }
21773     ],
21774     "name": "ShowServicenow_Fields",
21775     "group": "Servicenow_Fields",
21776     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21777     "version": "0.0.0",
21778     "filename": "server/api/intServicenowField/index.js",
21779     "groupTitle": "Servicenow_Fields"
21780   },
21781   {
21782     "type": "put",
21783     "url": "/api/integrations/servicenow/fields/{id}",
21784     "title": "Update an existing Servicenow Field",
21785     "examples": [
21786       {
21787         "title": "Example usage:",
21788         "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
21789         "type": "json"
21790       }
21791     ],
21792     "name": "updateServicenow_Fields",
21793     "group": "Servicenow_Fields",
21794     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21795     "version": "0.0.0",
21796     "filename": "server/api/intServicenowField/index.js",
21797     "groupTitle": "Servicenow_Fields"
21798   },
21799   {
21800     "type": "get",
21801     "url": "/api/settings",
21802     "title": "Gets a list of Settings",
21803     "examples": [
21804       {
21805         "title": "Example usage:",
21806         "content": "curl https://{domain}/api/settings -v -u {name}:{password}",
21807         "type": "json"
21808       }
21809     ],
21810     "name": "GetSettings",
21811     "group": "Settings",
21812     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/settings?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/settings?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/settings?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/settings?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/settings?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
21813     "version": "0.0.0",
21814     "filename": "server/api/setting/index.js",
21815     "groupTitle": "Settings"
21816   },
21817   {
21818     "type": "get",
21819     "url": "/api/settings/{id}",
21820     "title": "Gets a single Setting",
21821     "examples": [
21822       {
21823         "title": "Example usage:",
21824         "content": "curl https://{domain}/api/settings/{id} -v -u {name}:{password}",
21825         "type": "json"
21826       }
21827     ],
21828     "name": "ShowSettings",
21829     "group": "Settings",
21830     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21831     "version": "0.0.0",
21832     "filename": "server/api/setting/index.js",
21833     "groupTitle": "Settings"
21834   },
21835   {
21836     "type": "post",
21837     "url": "/api/settings/{id}/favicon",
21838     "title": "Add Favicon",
21839     "examples": [
21840       {
21841         "title": "Example usage:",
21842         "content": "curl https://{domain}/api/settings/{id}/favicon -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21843         "type": "json"
21844       }
21845     ],
21846     "name": "addFavicon",
21847     "group": "Settings",
21848     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21849     "version": "0.0.0",
21850     "filename": "server/api/setting/index.js",
21851     "groupTitle": "Settings"
21852   },
21853   {
21854     "type": "post",
21855     "url": "/api/settings/{id}/logo",
21856     "title": "Add logo",
21857     "examples": [
21858       {
21859         "title": "Example usage:",
21860         "content": "curl https://{domain}/api/settings/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21861         "type": "json"
21862       }
21863     ],
21864     "name": "addLogo",
21865     "group": "Settings",
21866     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21867     "version": "0.0.0",
21868     "filename": "server/api/setting/index.js",
21869     "groupTitle": "Settings"
21870   },
21871   {
21872     "type": "post",
21873     "url": "/api/settings/{id}/logo_login",
21874     "title": "Add logo login",
21875     "examples": [
21876       {
21877         "title": "Example usage:",
21878         "content": "curl https://{domain}/api/settings/{id}/logo_login -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21879         "type": "json"
21880       }
21881     ],
21882     "name": "addLogoLogin",
21883     "group": "Settings",
21884     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21885     "version": "0.0.0",
21886     "filename": "server/api/setting/index.js",
21887     "groupTitle": "Settings"
21888   },
21889   {
21890     "type": "post",
21891     "url": "/api/settings/{id}/preferred",
21892     "title": "Add Preferred",
21893     "examples": [
21894       {
21895         "title": "Example usage:",
21896         "content": "curl https://{domain}/api/settings/{id}/preferred -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21897         "type": "json"
21898       }
21899     ],
21900     "name": "addPreferred",
21901     "group": "Settings",
21902     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21903     "version": "0.0.0",
21904     "filename": "server/api/setting/index.js",
21905     "groupTitle": "Settings"
21906   },
21907   {
21908     "type": "get",
21909     "url": "/api/settings/now",
21910     "title": "Get Server Current Date",
21911     "examples": [
21912       {
21913         "title": "Example usage:",
21914         "content": "curl https://{domain}/api/settings/now -v -X GET",
21915         "type": "json"
21916       }
21917     ],
21918     "name": "getDate",
21919     "group": "Settings",
21920     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21921     "version": "0.0.0",
21922     "filename": "server/api/setting/index.js",
21923     "groupTitle": "Settings"
21924   },
21925   {
21926     "type": "get",
21927     "url": "/api/settings/{id}/favicon",
21928     "title": "Get Favicon",
21929     "examples": [
21930       {
21931         "title": "Example usage:",
21932         "content": "curl https://{domain}/api/settings/{id}/favicon -v -X GET",
21933         "type": "json"
21934       }
21935     ],
21936     "name": "getFavicon",
21937     "group": "Settings",
21938     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21939     "version": "0.0.0",
21940     "filename": "server/api/setting/index.js",
21941     "groupTitle": "Settings"
21942   },
21943   {
21944     "type": "get",
21945     "url": "/api/settings/{id}/gdpr",
21946     "title": "Get gdpr settings",
21947     "examples": [
21948       {
21949         "title": "Example usage:",
21950         "content": "curl https://{domain}/api/settings/{id}/gdpr -v -u {name}:{password} -X GET",
21951         "type": "json"
21952       }
21953     ],
21954     "name": "getGdpr",
21955     "group": "Settings",
21956     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21957     "version": "0.0.0",
21958     "filename": "server/api/setting/index.js",
21959     "groupTitle": "Settings"
21960   },
21961   {
21962     "type": "get",
21963     "url": "/api/settings/{id}/logo",
21964     "title": "Get logo",
21965     "examples": [
21966       {
21967         "title": "Example usage:",
21968         "content": "curl https://{domain}/api/settings/{id}/logo -v -X GET",
21969         "type": "json"
21970       }
21971     ],
21972     "name": "getLogo",
21973     "group": "Settings",
21974     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21975     "version": "0.0.0",
21976     "filename": "server/api/setting/index.js",
21977     "groupTitle": "Settings"
21978   },
21979   {
21980     "type": "get",
21981     "url": "/api/settings/{id}/logo_login",
21982     "title": "Get logo login",
21983     "examples": [
21984       {
21985         "title": "Example usage:",
21986         "content": "curl https://{domain}/api/settings/{id}/logo_login -v -X GET",
21987         "type": "json"
21988       }
21989     ],
21990     "name": "getLogoLogin",
21991     "group": "Settings",
21992     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21993     "version": "0.0.0",
21994     "filename": "server/api/setting/index.js",
21995     "groupTitle": "Settings"
21996   },
21997   {
21998     "type": "get",
21999     "url": "/api/settings/{id}/preferred",
22000     "title": "Get Preferred",
22001     "examples": [
22002       {
22003         "title": "Example usage:",
22004         "content": "curl https://{domain}/api/settings/{id}/preferred -v -X GET",
22005         "type": "json"
22006       }
22007     ],
22008     "name": "getPreferred",
22009     "group": "Settings",
22010     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22011     "version": "0.0.0",
22012     "filename": "server/api/setting/index.js",
22013     "groupTitle": "Settings"
22014   },
22015   {
22016     "type": "put",
22017     "url": "/api/settings/{id}",
22018     "title": "Update an existing Setting",
22019     "examples": [
22020       {
22021         "title": "Example usage:",
22022         "content": "curl https://{domain}/api/settings/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
22023         "type": "json"
22024       }
22025     ],
22026     "name": "updateSettings",
22027     "group": "Settings",
22028     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22029     "version": "0.0.0",
22030     "filename": "server/api/setting/index.js",
22031     "groupTitle": "Settings"
22032   },
22033   {
22034     "type": "post",
22035     "url": "/api/sms/accounts/{id}/users",
22036     "title": "Add agents to a sms account",
22037     "examples": [
22038       {
22039         "title": "Example usage:",
22040         "content": "curl https://{domain}/api/sms/accounts/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
22041         "type": "json"
22042       }
22043     ],
22044     "name": "AddAgents",
22045     "group": "Sms_Accounts",
22046     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22047     "version": "0.0.0",
22048     "filename": "server/api/smsAccount/index.js",
22049     "groupTitle": "Sms_Accounts"
22050   },
22051   {
22052     "type": "post",
22053     "url": "/api/sms/accounts",
22054     "title": "Creates a new Account",
22055     "examples": [
22056       {
22057         "title": "Example usage:",
22058         "content": "curl https://{domain}/api/sms/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22059         "type": "json"
22060       }
22061     ],
22062     "name": "CreateAccounts",
22063     "group": "Sms_Accounts",
22064     "parameter": {
22065       "fields": {
22066         "Body": [
22067           {
22068             "group": "Body",
22069             "type": "String",
22070             "optional": false,
22071             "field": "name",
22072             "description": ""
22073           },
22074           {
22075             "group": "Body",
22076             "type": "String",
22077             "optional": false,
22078             "field": "key",
22079             "description": ""
22080           },
22081           {
22082             "group": "Body",
22083             "type": "String",
22084             "optional": false,
22085             "field": "remote",
22086             "description": ""
22087           },
22088           {
22089             "group": "Body",
22090             "type": "String",
22091             "optional": true,
22092             "field": "token",
22093             "description": ""
22094           },
22095           {
22096             "group": "Body",
22097             "type": "String",
22098             "optional": true,
22099             "field": "phone",
22100             "description": ""
22101           },
22102           {
22103             "group": "Body",
22104             "type": "String",
22105             "allowedValues": [
22106               "\"twilio\"",
22107               "\"skebby\"",
22108               "\"connectel\"",
22109               "\"clicksend\"",
22110               "\"plivo\"",
22111               "\"clickatell\"",
22112               "\"bandwidth\"",
22113               "\"csc\"",
22114               "\"infobip\"",
22115               "\"intelepeer\""
22116             ],
22117             "optional": true,
22118             "field": "type",
22119             "description": ""
22120           },
22121           {
22122             "group": "Body",
22123             "type": "String",
22124             "optional": true,
22125             "field": "accountSid",
22126             "description": ""
22127           },
22128           {
22129             "group": "Body",
22130             "type": "String",
22131             "optional": true,
22132             "field": "authId",
22133             "description": ""
22134           },
22135           {
22136             "group": "Body",
22137             "type": "String",
22138             "optional": true,
22139             "field": "authToken",
22140             "description": ""
22141           },
22142           {
22143             "group": "Body",
22144             "type": "String",
22145             "allowedValues": [
22146               "\"SI\"",
22147               "\"TI\"",
22148               "\"GP\""
22149             ],
22150             "optional": true,
22151             "field": "smsMethod",
22152             "description": ""
22153           },
22154           {
22155             "group": "Body",
22156             "type": "String",
22157             "optional": true,
22158             "field": "username",
22159             "description": ""
22160           },
22161           {
22162             "group": "Body",
22163             "type": "String",
22164             "optional": true,
22165             "field": "password",
22166             "description": ""
22167           },
22168           {
22169             "group": "Body",
22170             "type": "String",
22171             "optional": true,
22172             "field": "apiKey",
22173             "description": ""
22174           },
22175           {
22176             "group": "Body",
22177             "type": "String",
22178             "optional": true,
22179             "field": "applicationId",
22180             "description": ""
22181           },
22182           {
22183             "group": "Body",
22184             "type": "String",
22185             "optional": true,
22186             "field": "accountId",
22187             "description": ""
22188           },
22189           {
22190             "group": "Body",
22191             "type": "String",
22192             "optional": true,
22193             "field": "senderString",
22194             "description": ""
22195           },
22196           {
22197             "group": "Body",
22198             "type": "Boolean",
22199             "optional": true,
22200             "field": "deliveryReport",
22201             "description": ""
22202           },
22203           {
22204             "group": "Body",
22205             "type": "String",
22206             "optional": true,
22207             "field": "description",
22208             "description": ""
22209           },
22210           {
22211             "group": "Body",
22212             "type": "Text",
22213             "optional": true,
22214             "field": "notificationTemplate",
22215             "description": ""
22216           },
22217           {
22218             "group": "Body",
22219             "type": "Boolean",
22220             "optional": true,
22221             "field": "notificationSound",
22222             "description": ""
22223           },
22224           {
22225             "group": "Body",
22226             "type": "Boolean",
22227             "optional": true,
22228             "field": "notificationShake",
22229             "description": ""
22230           },
22231           {
22232             "group": "Body",
22233             "type": "Integer",
22234             "optional": true,
22235             "field": "waitForTheAssignedAgent",
22236             "description": ""
22237           },
22238           {
22239             "group": "Body",
22240             "type": "Boolean",
22241             "optional": true,
22242             "field": "queueTransfer",
22243             "description": ""
22244           },
22245           {
22246             "group": "Body",
22247             "type": "Integer",
22248             "optional": true,
22249             "field": "queueTransferTimeout",
22250             "description": ""
22251           },
22252           {
22253             "group": "Body",
22254             "type": "Boolean",
22255             "optional": true,
22256             "field": "agentTransfer",
22257             "description": ""
22258           },
22259           {
22260             "group": "Body",
22261             "type": "Integer",
22262             "optional": true,
22263             "field": "agentTransferTimeout",
22264             "description": ""
22265           },
22266           {
22267             "group": "Body",
22268             "type": "String",
22269             "optional": true,
22270             "field": "baseUrl",
22271             "description": ""
22272           },
22273           {
22274             "group": "Body",
22275             "type": "Integer",
22276             "optional": true,
22277             "field": "mandatoryDispositionPauseId",
22278             "description": "<p>Status to put when mandatory disposition is enabled</p>"
22279           },
22280           {
22281             "group": "Body",
22282             "type": "Boolean",
22283             "optional": true,
22284             "field": "mandatoryDisposition",
22285             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
22286           }
22287         ]
22288       }
22289     },
22290     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22291     "version": "0.0.0",
22292     "filename": "server/api/smsAccount/index.js",
22293     "groupTitle": "Sms_Accounts"
22294   },
22295   {
22296     "type": "delete",
22297     "url": "/api/sms/accounts/{id}",
22298     "title": "Deletes a Account",
22299     "examples": [
22300       {
22301         "title": "Example usage:",
22302         "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password} -X DELETE",
22303         "type": "json"
22304       }
22305     ],
22306     "name": "DeleteAccounts",
22307     "group": "Sms_Accounts",
22308     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22309     "version": "0.0.0",
22310     "filename": "server/api/smsAccount/index.js",
22311     "groupTitle": "Sms_Accounts"
22312   },
22313   {
22314     "type": "get",
22315     "url": "/api/sms/accounts/describe",
22316     "title": "Gets table info about Accounts",
22317     "examples": [
22318       {
22319         "title": "Example usage:",
22320         "content": "curl https://{domain}/api/sms/accounts/describe -v -u {name}:{password}",
22321         "type": "json"
22322       }
22323     ],
22324     "name": "DescribeAccounts",
22325     "group": "Sms_Accounts",
22326     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22327     "version": "0.0.0",
22328     "filename": "server/api/smsAccount/index.js",
22329     "groupTitle": "Sms_Accounts"
22330   },
22331   {
22332     "type": "get",
22333     "url": "/api/sms/accounts",
22334     "title": "Gets a list of Accounts",
22335     "examples": [
22336       {
22337         "title": "Example usage:",
22338         "content": "curl https://{domain}/api/sms/accounts -v -u {name}:{password}",
22339         "type": "json"
22340       }
22341     ],
22342     "name": "GetAccounts",
22343     "group": "Sms_Accounts",
22344     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22345     "version": "0.0.0",
22346     "filename": "server/api/smsAccount/index.js",
22347     "groupTitle": "Sms_Accounts"
22348   },
22349   {
22350     "type": "get",
22351     "url": "/api/sms/accounts/{id}/users",
22352     "title": "Gets agents from sms account",
22353     "examples": [
22354       {
22355         "title": "Example usage:",
22356         "content": "curl https://{domain}/api/sms/accounts/{id}/users -v -u {name}:{password} -X GET",
22357         "type": "json"
22358       }
22359     ],
22360     "name": "GetAgents",
22361     "group": "Sms_Accounts",
22362     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22363     "version": "0.0.0",
22364     "filename": "server/api/smsAccount/index.js",
22365     "groupTitle": "Sms_Accounts"
22366   },
22367   {
22368     "type": "delete",
22369     "url": "/api/sms/accounts/{id}/users",
22370     "title": "Removes agents from a sms account",
22371     "examples": [
22372       {
22373         "title": "Example usage:",
22374         "content": "curl https://{domain}/api/sms/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22375         "type": "json"
22376       }
22377     ],
22378     "name": "RemoveAgents",
22379     "group": "Sms_Accounts",
22380     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22381     "version": "0.0.0",
22382     "filename": "server/api/smsAccount/index.js",
22383     "groupTitle": "Sms_Accounts"
22384   },
22385   {
22386     "type": "delete",
22387     "url": "/api/sms/accounts/{id}/canned_answers",
22388     "title": "Removes canned answers from account",
22389     "examples": [
22390       {
22391         "title": "Example usage:",
22392         "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22393         "type": "json"
22394       }
22395     ],
22396     "name": "RemoveAnswers",
22397     "group": "Sms_Accounts",
22398     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22399     "version": "0.0.0",
22400     "filename": "server/api/smsAccount/index.js",
22401     "groupTitle": "Sms_Accounts"
22402   },
22403   {
22404     "type": "delete",
22405     "url": "/api/sms/accounts/{id}/dispositions",
22406     "title": "Removes dispositions from account",
22407     "examples": [
22408       {
22409         "title": "Example usage:",
22410         "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22411         "type": "json"
22412       }
22413     ],
22414     "name": "RemoveDispositions",
22415     "group": "Sms_Accounts",
22416     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22417     "version": "0.0.0",
22418     "filename": "server/api/smsAccount/index.js",
22419     "groupTitle": "Sms_Accounts"
22420   },
22421   {
22422     "type": "get",
22423     "url": "/api/sms/accounts/{id}",
22424     "title": "Gets a single Account",
22425     "examples": [
22426       {
22427         "title": "Example usage:",
22428         "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password}",
22429         "type": "json"
22430       }
22431     ],
22432     "name": "ShowAccounts",
22433     "group": "Sms_Accounts",
22434     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22435     "version": "0.0.0",
22436     "filename": "server/api/smsAccount/index.js",
22437     "groupTitle": "Sms_Accounts"
22438   },
22439   {
22440     "type": "put",
22441     "url": "/api/sms/messages/{id}/accept",
22442     "title": "Accepts message",
22443     "examples": [
22444       {
22445         "title": "Example usage:",
22446         "content": "curl https://{domain}/api/sms/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
22447         "type": "json"
22448       }
22449     ],
22450     "name": "acceptMessage",
22451     "group": "Sms_Accounts",
22452     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22453     "version": "0.0.0",
22454     "filename": "server/api/smsMessage/index.js",
22455     "groupTitle": "Sms_Accounts"
22456   },
22457   {
22458     "type": "post",
22459     "url": "/api/sms/accounts/{id}/canned_answers",
22460     "title": "Creates new canned answer",
22461     "examples": [
22462       {
22463         "title": "Example usage:",
22464         "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",
22465         "type": "json"
22466       }
22467     ],
22468     "name": "addAnswer",
22469     "group": "Sms_Accounts",
22470     "parameter": {
22471       "fields": {
22472         "Body": [
22473           {
22474             "group": "Body",
22475             "type": "String",
22476             "optional": false,
22477             "field": "key",
22478             "description": ""
22479           },
22480           {
22481             "group": "Body",
22482             "type": "Text",
22483             "optional": false,
22484             "field": "value",
22485             "description": ""
22486           },
22487           {
22488             "group": "Body",
22489             "type": "String",
22490             "optional": true,
22491             "field": "description",
22492             "description": ""
22493           },
22494           {
22495             "group": "Body",
22496             "type": "Virtual",
22497             "optional": true,
22498             "field": "name",
22499             "description": ""
22500           }
22501         ]
22502       }
22503     },
22504     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22505     "version": "0.0.0",
22506     "filename": "server/api/smsAccount/index.js",
22507     "groupTitle": "Sms_Accounts"
22508   },
22509   {
22510     "type": "post",
22511     "url": "/api/sms/accounts/{id}/applications",
22512     "title": "Creates new applications",
22513     "examples": [
22514       {
22515         "title": "Example usage:",
22516         "content": "curl https://{domain}/api/sms/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
22517         "type": "json"
22518       }
22519     ],
22520     "name": "addApplications",
22521     "group": "Sms_Accounts",
22522     "parameter": {
22523       "fields": {
22524         "Body": [
22525           {
22526             "group": "Body",
22527             "type": "Integer",
22528             "optional": false,
22529             "field": "priority",
22530             "description": ""
22531           },
22532           {
22533             "group": "Body",
22534             "type": "String",
22535             "optional": false,
22536             "field": "app",
22537             "description": ""
22538           },
22539           {
22540             "group": "Body",
22541             "type": "Text",
22542             "optional": true,
22543             "field": "appdata",
22544             "description": ""
22545           },
22546           {
22547             "group": "Body",
22548             "type": "String",
22549             "optional": true,
22550             "field": "description",
22551             "description": ""
22552           },
22553           {
22554             "group": "Body",
22555             "type": "String",
22556             "optional": true,
22557             "field": "interval",
22558             "description": ""
22559           }
22560         ]
22561       }
22562     },
22563     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22564     "version": "0.0.0",
22565     "filename": "server/api/smsAccount/index.js",
22566     "groupTitle": "Sms_Accounts"
22567   },
22568   {
22569     "type": "post",
22570     "url": "/api/sms/accounts/{id}/dispositions",
22571     "title": "Creates new disposition",
22572     "examples": [
22573       {
22574         "title": "Example usage:",
22575         "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
22576         "type": "json"
22577       }
22578     ],
22579     "name": "addDisposition",
22580     "group": "Sms_Accounts",
22581     "parameter": {
22582       "fields": {
22583         "Body": [
22584           {
22585             "group": "Body",
22586             "type": "String",
22587             "optional": false,
22588             "field": "name",
22589             "description": ""
22590           },
22591           {
22592             "group": "Body",
22593             "type": "String",
22594             "allowedValues": [
22595               "\"first\"",
22596               "\"second\"",
22597               "\"third\""
22598             ],
22599             "optional": false,
22600             "field": "level",
22601             "description": ""
22602           },
22603           {
22604             "group": "Body",
22605             "type": "String",
22606             "optional": true,
22607             "field": "description",
22608             "description": ""
22609           }
22610         ]
22611       }
22612     },
22613     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22614     "version": "0.0.0",
22615     "filename": "server/api/smsAccount/index.js",
22616     "groupTitle": "Sms_Accounts"
22617   },
22618   {
22619     "type": "get",
22620     "url": "/api/sms/accounts/{id}/canned_answers",
22621     "title": "Gets account canned answers",
22622     "examples": [
22623       {
22624         "title": "Example usage:",
22625         "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
22626         "type": "json"
22627       }
22628     ],
22629     "name": "getAnswers",
22630     "group": "Sms_Accounts",
22631     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22632     "version": "0.0.0",
22633     "filename": "server/api/smsAccount/index.js",
22634     "groupTitle": "Sms_Accounts"
22635   },
22636   {
22637     "type": "get",
22638     "url": "/api/sms/accounts/{id}/applications",
22639     "title": "Gets account applications",
22640     "examples": [
22641       {
22642         "title": "Example usage:",
22643         "content": "curl https://{domain}/api/sms/accounts/{id}/applications -v -u {name}:{password} -X GET",
22644         "type": "json"
22645       }
22646     ],
22647     "name": "getApplications",
22648     "group": "Sms_Accounts",
22649     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22650     "version": "0.0.0",
22651     "filename": "server/api/smsAccount/index.js",
22652     "groupTitle": "Sms_Accounts"
22653   },
22654   {
22655     "type": "get",
22656     "url": "/api/sms/accounts/{id}/dispositions",
22657     "title": "Gets account dispositions",
22658     "examples": [
22659       {
22660         "title": "Example usage:",
22661         "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
22662         "type": "json"
22663       }
22664     ],
22665     "name": "getDispositions",
22666     "group": "Sms_Accounts",
22667     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22668     "version": "0.0.0",
22669     "filename": "server/api/smsAccount/index.js",
22670     "groupTitle": "Sms_Accounts"
22671   },
22672   {
22673     "type": "get",
22674     "url": "/api/sms/accounts/{id}/interactions",
22675     "title": "Gets Sms Account interactions",
22676     "examples": [
22677       {
22678         "title": "Example usage:",
22679         "content": "curl https://{domain}/api/sms/accounts/{id}/interactions -v -u {name}:{password} -X GET",
22680         "type": "json"
22681       }
22682     ],
22683     "name": "getInteractions",
22684     "group": "Sms_Accounts",
22685     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22686     "version": "0.0.0",
22687     "filename": "server/api/smsAccount/index.js",
22688     "groupTitle": "Sms_Accounts"
22689   },
22690   {
22691     "type": "post",
22692     "url": "/api/sms/accounts/{id}/notify",
22693     "title": "Notify new message",
22694     "examples": [
22695       {
22696         "title": "Example usage:",
22697         "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",
22698         "type": "json"
22699       }
22700     ],
22701     "name": "notify",
22702     "group": "Sms_Accounts",
22703     "description": "<p>Motion 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>",
22704     "version": "0.0.0",
22705     "filename": "server/api/smsAccount/index.js",
22706     "groupTitle": "Sms_Accounts"
22707   },
22708   {
22709     "type": "put",
22710     "url": "/api/sms/messages/{id}/reject",
22711     "title": "Rejects message",
22712     "examples": [
22713       {
22714         "title": "Example usage:",
22715         "content": "curl https://{domain}/api/sms/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
22716         "type": "json"
22717       }
22718     ],
22719     "name": "rejectMessage",
22720     "group": "Sms_Accounts",
22721     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22722     "version": "0.0.0",
22723     "filename": "server/api/smsMessage/index.js",
22724     "groupTitle": "Sms_Accounts"
22725   },
22726   {
22727     "type": "post",
22728     "url": "/api/sms/accounts/{id}/send",
22729     "title": "Send new sms message",
22730     "examples": [
22731       {
22732         "title": "Example usage:",
22733         "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",
22734         "type": "json"
22735       }
22736     ],
22737     "name": "sendSms",
22738     "group": "Sms_Accounts",
22739     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22740     "version": "0.0.0",
22741     "filename": "server/api/smsAccount/index.js",
22742     "groupTitle": "Sms_Accounts"
22743   },
22744   {
22745     "type": "get",
22746     "url": "/api/sms/accounts/{id}/status",
22747     "title": "Receive message status as get request",
22748     "examples": [
22749       {
22750         "title": "Example usage:",
22751         "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X GET",
22752         "type": "json"
22753       }
22754     ],
22755     "name": "statusMessage",
22756     "group": "Sms_Accounts",
22757     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22758     "version": "0.0.0",
22759     "filename": "server/api/smsAccount/index.js",
22760     "groupTitle": "Sms_Accounts"
22761   },
22762   {
22763     "type": "post",
22764     "url": "/api/sms/messages/{id}/status",
22765     "title": "Receive message status",
22766     "examples": [
22767       {
22768         "title": "Example usage:",
22769         "content": "curl https://{domain}/api/sms/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
22770         "type": "json"
22771       }
22772     ],
22773     "name": "statusMessage",
22774     "group": "Sms_Accounts",
22775     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22776     "version": "0.0.0",
22777     "filename": "server/api/smsMessage/index.js",
22778     "groupTitle": "Sms_Accounts"
22779   },
22780   {
22781     "type": "post",
22782     "url": "/api/sms/accounts/{id}/status",
22783     "title": "Receive message status",
22784     "examples": [
22785       {
22786         "title": "Example usage:",
22787         "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X POST",
22788         "type": "json"
22789       }
22790     ],
22791     "name": "statusMessage",
22792     "group": "Sms_Accounts",
22793     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22794     "version": "0.0.0",
22795     "filename": "server/api/smsAccount/index.js",
22796     "groupTitle": "Sms_Accounts"
22797   },
22798   {
22799     "type": "put",
22800     "url": "/api/sms/accounts/{id}",
22801     "title": "Update an existing Account",
22802     "examples": [
22803       {
22804         "title": "Example usage:",
22805         "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",
22806         "type": "json"
22807       }
22808     ],
22809     "name": "updateAccounts",
22810     "group": "Sms_Accounts",
22811     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22812     "version": "0.0.0",
22813     "filename": "server/api/smsAccount/index.js",
22814     "groupTitle": "Sms_Accounts"
22815   },
22816   {
22817     "type": "post",
22818     "url": "/api/sms/applications",
22819     "title": "Creates a new Application",
22820     "examples": [
22821       {
22822         "title": "Example usage:",
22823         "content": "curl https://{domain}/api/sms/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22824         "type": "json"
22825       }
22826     ],
22827     "name": "CreateApplications",
22828     "group": "Sms_Applications",
22829     "parameter": {
22830       "fields": {
22831         "Body": [
22832           {
22833             "group": "Body",
22834             "type": "Integer",
22835             "optional": false,
22836             "field": "priority",
22837             "description": ""
22838           },
22839           {
22840             "group": "Body",
22841             "type": "String",
22842             "optional": false,
22843             "field": "app",
22844             "description": ""
22845           },
22846           {
22847             "group": "Body",
22848             "type": "Text",
22849             "optional": true,
22850             "field": "appdata",
22851             "description": ""
22852           },
22853           {
22854             "group": "Body",
22855             "type": "String",
22856             "optional": true,
22857             "field": "description",
22858             "description": ""
22859           },
22860           {
22861             "group": "Body",
22862             "type": "String",
22863             "optional": true,
22864             "field": "interval",
22865             "description": ""
22866           }
22867         ]
22868       }
22869     },
22870     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22871     "version": "0.0.0",
22872     "filename": "server/api/smsApplication/index.js",
22873     "groupTitle": "Sms_Applications"
22874   },
22875   {
22876     "type": "delete",
22877     "url": "/api/sms/applications/{id}",
22878     "title": "Deletes a Application",
22879     "examples": [
22880       {
22881         "title": "Example usage:",
22882         "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password} -X DELETE",
22883         "type": "json"
22884       }
22885     ],
22886     "name": "DeleteApplications",
22887     "group": "Sms_Applications",
22888     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22889     "version": "0.0.0",
22890     "filename": "server/api/smsApplication/index.js",
22891     "groupTitle": "Sms_Applications"
22892   },
22893   {
22894     "type": "get",
22895     "url": "/api/sms/applications",
22896     "title": "Gets a list of Applications",
22897     "examples": [
22898       {
22899         "title": "Example usage:",
22900         "content": "curl https://{domain}/api/sms/applications -v -u {name}:{password}",
22901         "type": "json"
22902       }
22903     ],
22904     "name": "GetApplications",
22905     "group": "Sms_Applications",
22906     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22907     "version": "0.0.0",
22908     "filename": "server/api/smsApplication/index.js",
22909     "groupTitle": "Sms_Applications"
22910   },
22911   {
22912     "type": "get",
22913     "url": "/api/sms/applications/{id}",
22914     "title": "Gets a single Application",
22915     "examples": [
22916       {
22917         "title": "Example usage:",
22918         "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password}",
22919         "type": "json"
22920       }
22921     ],
22922     "name": "ShowApplications",
22923     "group": "Sms_Applications",
22924     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22925     "version": "0.0.0",
22926     "filename": "server/api/smsApplication/index.js",
22927     "groupTitle": "Sms_Applications"
22928   },
22929   {
22930     "type": "put",
22931     "url": "/api/sms/applications/{id}",
22932     "title": "Update an existing Application",
22933     "examples": [
22934       {
22935         "title": "Example usage:",
22936         "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",
22937         "type": "json"
22938       }
22939     ],
22940     "name": "updateApplications",
22941     "group": "Sms_Applications",
22942     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22943     "version": "0.0.0",
22944     "filename": "server/api/smsApplication/index.js",
22945     "groupTitle": "Sms_Applications"
22946   },
22947   {
22948     "type": "post",
22949     "url": "/api/sms/interactions/{id}/tags",
22950     "title": "Add tags to the interaction",
22951     "examples": [
22952       {
22953         "title": "Example usage:",
22954         "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",
22955         "type": "json"
22956       }
22957     ],
22958     "name": "AddTags",
22959     "group": "Sms_Interactions",
22960     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22961     "version": "0.0.0",
22962     "filename": "server/api/smsInteraction/index.js",
22963     "groupTitle": "Sms_Interactions"
22964   },
22965   {
22966     "type": "post",
22967     "url": "/api/sms/interactions",
22968     "title": "Creates a new Interaction",
22969     "examples": [
22970       {
22971         "title": "Example usage:",
22972         "content": "curl https://{domain}/api/sms/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22973         "type": "json"
22974       }
22975     ],
22976     "name": "CreateInteractions",
22977     "group": "Sms_Interactions",
22978     "parameter": {
22979       "fields": {
22980         "Body": [
22981           {
22982             "group": "Body",
22983             "type": "Boolean",
22984             "optional": true,
22985             "field": "closed",
22986             "description": ""
22987           },
22988           {
22989             "group": "Body",
22990             "type": "String",
22991             "optional": true,
22992             "field": "closedAt",
22993             "description": ""
22994           },
22995           {
22996             "group": "Body",
22997             "type": "String",
22998             "optional": true,
22999             "field": "disposition",
23000             "description": ""
23001           },
23002           {
23003             "group": "Body",
23004             "type": "String",
23005             "optional": true,
23006             "field": "secondDisposition",
23007             "description": ""
23008           },
23009           {
23010             "group": "Body",
23011             "type": "String",
23012             "optional": true,
23013             "field": "thirdDisposition",
23014             "description": ""
23015           },
23016           {
23017             "group": "Body",
23018             "type": "String",
23019             "optional": true,
23020             "field": "note",
23021             "description": ""
23022           },
23023           {
23024             "group": "Body",
23025             "type": "String",
23026             "optional": true,
23027             "field": "phone",
23028             "description": ""
23029           },
23030           {
23031             "group": "Body",
23032             "type": "String",
23033             "optional": true,
23034             "field": "read1stAt",
23035             "description": ""
23036           },
23037           {
23038             "group": "Body",
23039             "type": "String",
23040             "allowedValues": [
23041               "\"in\"",
23042               "\"out\""
23043             ],
23044             "optional": false,
23045             "field": "firstMsgDirection",
23046             "description": ""
23047           },
23048           {
23049             "group": "Body",
23050             "type": "String",
23051             "optional": true,
23052             "field": "lastMsgAt",
23053             "description": ""
23054           },
23055           {
23056             "group": "Body",
23057             "type": "String",
23058             "allowedValues": [
23059               "\"in\"",
23060               "\"out\""
23061             ],
23062             "optional": false,
23063             "field": "lastMsgDirection",
23064             "description": ""
23065           }
23066         ]
23067       }
23068     },
23069     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23070     "version": "0.0.0",
23071     "filename": "server/api/smsInteraction/index.js",
23072     "groupTitle": "Sms_Interactions"
23073   },
23074   {
23075     "type": "delete",
23076     "url": "/api/sms/interactions/{id}",
23077     "title": "Deletes a Interaction",
23078     "examples": [
23079       {
23080         "title": "Example usage:",
23081         "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password} -X DELETE",
23082         "type": "json"
23083       }
23084     ],
23085     "name": "DeleteInteractions",
23086     "group": "Sms_Interactions",
23087     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23088     "version": "0.0.0",
23089     "filename": "server/api/smsInteraction/index.js",
23090     "groupTitle": "Sms_Interactions"
23091   },
23092   {
23093     "type": "get",
23094     "url": "/api/sms/interactions/describe",
23095     "title": "Gets table info about Interactions",
23096     "examples": [
23097       {
23098         "title": "Example usage:",
23099         "content": "curl https://{domain}/api/sms/interactions/describe -v -u {name}:{password}",
23100         "type": "json"
23101       }
23102     ],
23103     "name": "DescribeInteractions",
23104     "group": "Sms_Interactions",
23105     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23106     "version": "0.0.0",
23107     "filename": "server/api/smsInteraction/index.js",
23108     "groupTitle": "Sms_Interactions"
23109   },
23110   {
23111     "type": "get",
23112     "url": "/api/sms/interactions",
23113     "title": "Gets a list of Interactions",
23114     "examples": [
23115       {
23116         "title": "Example usage:",
23117         "content": "curl https://{domain}/api/sms/interactions -v -u {name}:{password}",
23118         "type": "json"
23119       }
23120     ],
23121     "name": "GetInteractions",
23122     "group": "Sms_Interactions",
23123     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23124     "version": "0.0.0",
23125     "filename": "server/api/smsInteraction/index.js",
23126     "groupTitle": "Sms_Interactions"
23127   },
23128   {
23129     "type": "delete",
23130     "url": "/api/sms/interactions/{id}/tags",
23131     "title": "Removes tags from interaction",
23132     "examples": [
23133       {
23134         "title": "Example usage:",
23135         "content": "curl https://{domain}/api/sms/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
23136         "type": "json"
23137       }
23138     ],
23139     "name": "RemoveTags",
23140     "group": "Sms_Interactions",
23141     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23142     "version": "0.0.0",
23143     "filename": "server/api/smsInteraction/index.js",
23144     "groupTitle": "Sms_Interactions"
23145   },
23146   {
23147     "type": "get",
23148     "url": "/api/sms/interactions/{id}",
23149     "title": "Gets a single Interaction",
23150     "examples": [
23151       {
23152         "title": "Example usage:",
23153         "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password}",
23154         "type": "json"
23155       }
23156     ],
23157     "name": "ShowInteractions",
23158     "group": "Sms_Interactions",
23159     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23160     "version": "0.0.0",
23161     "filename": "server/api/smsInteraction/index.js",
23162     "groupTitle": "Sms_Interactions"
23163   },
23164   {
23165     "type": "post",
23166     "url": "/api/sms/interactions/{id}/messages",
23167     "title": "Creates new messages",
23168     "examples": [
23169       {
23170         "title": "Example usage:",
23171         "content": "curl https://{domain}/api/sms/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
23172         "type": "json"
23173       }
23174     ],
23175     "name": "addMessage",
23176     "group": "Sms_Interactions",
23177     "parameter": {
23178       "fields": {
23179         "Body": [
23180           {
23181             "group": "Body",
23182             "type": "Text",
23183             "optional": false,
23184             "field": "body",
23185             "description": ""
23186           },
23187           {
23188             "group": "Body",
23189             "type": "Boolean",
23190             "optional": true,
23191             "field": "read",
23192             "description": ""
23193           },
23194           {
23195             "group": "Body",
23196             "type": "String",
23197             "allowedValues": [
23198               "\"in\"",
23199               "\"out\""
23200             ],
23201             "optional": false,
23202             "field": "direction",
23203             "description": ""
23204           },
23205           {
23206             "group": "Body",
23207             "type": "String",
23208             "optional": true,
23209             "field": "messageId",
23210             "description": ""
23211           },
23212           {
23213             "group": "Body",
23214             "type": "String",
23215             "optional": true,
23216             "field": "phone",
23217             "description": ""
23218           },
23219           {
23220             "group": "Body",
23221             "type": "String",
23222             "optional": true,
23223             "field": "readAt",
23224             "description": ""
23225           },
23226           {
23227             "group": "Body",
23228             "type": "Boolean",
23229             "optional": true,
23230             "field": "secret",
23231             "description": ""
23232           },
23233           {
23234             "group": "Body",
23235             "type": "String",
23236             "optional": true,
23237             "field": "providerName",
23238             "description": ""
23239           },
23240           {
23241             "group": "Body",
23242             "type": "Text",
23243             "optional": true,
23244             "field": "providerResponse",
23245             "description": ""
23246           }
23247         ]
23248       }
23249     },
23250     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23251     "version": "0.0.0",
23252     "filename": "server/api/smsInteraction/index.js",
23253     "groupTitle": "Sms_Interactions"
23254   },
23255   {
23256     "type": "get",
23257     "url": "/api/sms/interactions/{id}/download",
23258     "title": "Gets interaction",
23259     "examples": [
23260       {
23261         "title": "Example usage:",
23262         "content": "curl https://{domain}/api/sms/interactions/{id}/download -v -u {name}:{password} -X GET",
23263         "type": "json"
23264       }
23265     ],
23266     "name": "download",
23267     "group": "Sms_Interactions",
23268     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23269     "version": "0.0.0",
23270     "filename": "server/api/smsInteraction/index.js",
23271     "groupTitle": "Sms_Interactions"
23272   },
23273   {
23274     "type": "get",
23275     "url": "/api/sms/interactions/{id}/messages",
23276     "title": "Gets interaction messages",
23277     "examples": [
23278       {
23279         "title": "Example usage:",
23280         "content": "curl https://{domain}/api/sms/interactions/{id}/messages -v -u {name}:{password} -X GET",
23281         "type": "json"
23282       }
23283     ],
23284     "name": "getMessages",
23285     "group": "Sms_Interactions",
23286     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23287     "version": "0.0.0",
23288     "filename": "server/api/smsInteraction/index.js",
23289     "groupTitle": "Sms_Interactions"
23290   },
23291   {
23292     "type": "put",
23293     "url": "/api/sms/interactions/{id}",
23294     "title": "Update an existing Interaction",
23295     "examples": [
23296       {
23297         "title": "Example usage:",
23298         "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",
23299         "type": "json"
23300       }
23301     ],
23302     "name": "updateInteractions",
23303     "group": "Sms_Interactions",
23304     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23305     "version": "0.0.0",
23306     "filename": "server/api/smsInteraction/index.js",
23307     "groupTitle": "Sms_Interactions"
23308   },
23309   {
23310     "type": "post",
23311     "url": "/api/sms/messages",
23312     "title": "Creates a new Message",
23313     "examples": [
23314       {
23315         "title": "Example usage:",
23316         "content": "curl https://{domain}/api/sms/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23317         "type": "json"
23318       }
23319     ],
23320     "name": "CreateMessages",
23321     "group": "Sms_Messages",
23322     "parameter": {
23323       "fields": {
23324         "Body": [
23325           {
23326             "group": "Body",
23327             "type": "Text",
23328             "optional": false,
23329             "field": "body",
23330             "description": ""
23331           },
23332           {
23333             "group": "Body",
23334             "type": "Boolean",
23335             "optional": true,
23336             "field": "read",
23337             "description": ""
23338           },
23339           {
23340             "group": "Body",
23341             "type": "String",
23342             "allowedValues": [
23343               "\"in\"",
23344               "\"out\""
23345             ],
23346             "optional": false,
23347             "field": "direction",
23348             "description": ""
23349           },
23350           {
23351             "group": "Body",
23352             "type": "String",
23353             "optional": true,
23354             "field": "messageId",
23355             "description": ""
23356           },
23357           {
23358             "group": "Body",
23359             "type": "String",
23360             "optional": true,
23361             "field": "phone",
23362             "description": ""
23363           },
23364           {
23365             "group": "Body",
23366             "type": "String",
23367             "optional": true,
23368             "field": "readAt",
23369             "description": ""
23370           },
23371           {
23372             "group": "Body",
23373             "type": "Boolean",
23374             "optional": true,
23375             "field": "secret",
23376             "description": ""
23377           },
23378           {
23379             "group": "Body",
23380             "type": "String",
23381             "optional": true,
23382             "field": "providerName",
23383             "description": ""
23384           },
23385           {
23386             "group": "Body",
23387             "type": "Text",
23388             "optional": true,
23389             "field": "providerResponse",
23390             "description": ""
23391           }
23392         ]
23393       }
23394     },
23395     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23396     "version": "0.0.0",
23397     "filename": "server/api/smsMessage/index.js",
23398     "groupTitle": "Sms_Messages"
23399   },
23400   {
23401     "type": "delete",
23402     "url": "/api/sms/messages/{id}",
23403     "title": "Deletes a Message",
23404     "examples": [
23405       {
23406         "title": "Example usage:",
23407         "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password} -X DELETE",
23408         "type": "json"
23409       }
23410     ],
23411     "name": "DeleteMessages",
23412     "group": "Sms_Messages",
23413     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23414     "version": "0.0.0",
23415     "filename": "server/api/smsMessage/index.js",
23416     "groupTitle": "Sms_Messages"
23417   },
23418   {
23419     "type": "get",
23420     "url": "/api/sms/messages/describe",
23421     "title": "Gets table info about Messages",
23422     "examples": [
23423       {
23424         "title": "Example usage:",
23425         "content": "curl https://{domain}/api/sms/messages/describe -v -u {name}:{password}",
23426         "type": "json"
23427       }
23428     ],
23429     "name": "DescribeMessages",
23430     "group": "Sms_Messages",
23431     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23432     "version": "0.0.0",
23433     "filename": "server/api/smsMessage/index.js",
23434     "groupTitle": "Sms_Messages"
23435   },
23436   {
23437     "type": "get",
23438     "url": "/api/sms/messages",
23439     "title": "Gets a list of Messages",
23440     "examples": [
23441       {
23442         "title": "Example usage:",
23443         "content": "curl https://{domain}/api/sms/messages -v -u {name}:{password}",
23444         "type": "json"
23445       }
23446     ],
23447     "name": "GetMessages",
23448     "group": "Sms_Messages",
23449     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23450     "version": "0.0.0",
23451     "filename": "server/api/smsMessage/index.js",
23452     "groupTitle": "Sms_Messages"
23453   },
23454   {
23455     "type": "get",
23456     "url": "/api/sms/messages/{id}",
23457     "title": "Gets a single Message",
23458     "examples": [
23459       {
23460         "title": "Example usage:",
23461         "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password}",
23462         "type": "json"
23463       }
23464     ],
23465     "name": "ShowMessages",
23466     "group": "Sms_Messages",
23467     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23468     "version": "0.0.0",
23469     "filename": "server/api/smsMessage/index.js",
23470     "groupTitle": "Sms_Messages"
23471   },
23472   {
23473     "type": "put",
23474     "url": "/api/sms/messages/{id}",
23475     "title": "Update an existing Message",
23476     "examples": [
23477       {
23478         "title": "Example usage:",
23479         "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",
23480         "type": "json"
23481       }
23482     ],
23483     "name": "updateMessages",
23484     "group": "Sms_Messages",
23485     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23486     "version": "0.0.0",
23487     "filename": "server/api/smsMessage/index.js",
23488     "groupTitle": "Sms_Messages"
23489   },
23490   {
23491     "type": "post",
23492     "url": "/api/sms/reports/queue",
23493     "title": "Creates a new Sms Queue Report",
23494     "examples": [
23495       {
23496         "title": "Example usage:",
23497         "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",
23498         "type": "json"
23499       }
23500     ],
23501     "name": "CreateSms_Queue_Reports",
23502     "group": "Sms_Queue_Reports",
23503     "parameter": {
23504       "fields": {
23505         "Body": [
23506           {
23507             "group": "Body",
23508             "type": "String",
23509             "optional": false,
23510             "field": "uniqueid",
23511             "description": ""
23512           },
23513           {
23514             "group": "Body",
23515             "type": "String",
23516             "optional": true,
23517             "field": "from",
23518             "description": ""
23519           },
23520           {
23521             "group": "Body",
23522             "type": "String",
23523             "optional": true,
23524             "field": "joinAt",
23525             "description": ""
23526           },
23527           {
23528             "group": "Body",
23529             "type": "String",
23530             "optional": true,
23531             "field": "leaveAt",
23532             "description": ""
23533           },
23534           {
23535             "group": "Body",
23536             "type": "String",
23537             "optional": true,
23538             "field": "acceptAt",
23539             "description": ""
23540           },
23541           {
23542             "group": "Body",
23543             "type": "String",
23544             "optional": true,
23545             "field": "exitAt",
23546             "description": ""
23547           },
23548           {
23549             "group": "Body",
23550             "type": "String",
23551             "optional": true,
23552             "field": "reason",
23553             "description": ""
23554           }
23555         ]
23556       }
23557     },
23558     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23559     "version": "0.0.0",
23560     "filename": "server/api/smsQueueReport/index.js",
23561     "groupTitle": "Sms_Queue_Reports"
23562   },
23563   {
23564     "type": "delete",
23565     "url": "/api/sms/reports/queue/{id}",
23566     "title": "Deletes a Sms Queue Report",
23567     "examples": [
23568       {
23569         "title": "Example usage:",
23570         "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password} -X DELETE",
23571         "type": "json"
23572       }
23573     ],
23574     "name": "DeleteSms_Queue_Reports",
23575     "group": "Sms_Queue_Reports",
23576     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23577     "version": "0.0.0",
23578     "filename": "server/api/smsQueueReport/index.js",
23579     "groupTitle": "Sms_Queue_Reports"
23580   },
23581   {
23582     "type": "get",
23583     "url": "/api/sms/reports/queue/describe",
23584     "title": "Gets table info about Sms Queue Reports",
23585     "examples": [
23586       {
23587         "title": "Example usage:",
23588         "content": "curl https://{domain}/api/sms/reports/queue/describe -v -u {name}:{password}",
23589         "type": "json"
23590       }
23591     ],
23592     "name": "DescribeSms_Queue_Reports",
23593     "group": "Sms_Queue_Reports",
23594     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23595     "version": "0.0.0",
23596     "filename": "server/api/smsQueueReport/index.js",
23597     "groupTitle": "Sms_Queue_Reports"
23598   },
23599   {
23600     "type": "get",
23601     "url": "/api/sms/reports/queue",
23602     "title": "Gets a list of Sms Queue Reports",
23603     "examples": [
23604       {
23605         "title": "Example usage:",
23606         "content": "curl https://{domain}/api/sms/reports/queue -v -u {name}:{password}",
23607         "type": "json"
23608       }
23609     ],
23610     "name": "GetSms_Queue_Reports",
23611     "group": "Sms_Queue_Reports",
23612     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23613     "version": "0.0.0",
23614     "filename": "server/api/smsQueueReport/index.js",
23615     "groupTitle": "Sms_Queue_Reports"
23616   },
23617   {
23618     "type": "get",
23619     "url": "/api/sms/reports/queue/{id}",
23620     "title": "Gets a single Sms Queue Report",
23621     "examples": [
23622       {
23623         "title": "Example usage:",
23624         "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password}",
23625         "type": "json"
23626       }
23627     ],
23628     "name": "ShowSms_Queue_Reports",
23629     "group": "Sms_Queue_Reports",
23630     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23631     "version": "0.0.0",
23632     "filename": "server/api/smsQueueReport/index.js",
23633     "groupTitle": "Sms_Queue_Reports"
23634   },
23635   {
23636     "type": "put",
23637     "url": "/api/sms/reports/queue/{id}",
23638     "title": "Update an existing Sms Queue Report",
23639     "examples": [
23640       {
23641         "title": "Example usage:",
23642         "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",
23643         "type": "json"
23644       }
23645     ],
23646     "name": "updateSms_Queue_Reports",
23647     "group": "Sms_Queue_Reports",
23648     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23649     "version": "0.0.0",
23650     "filename": "server/api/smsQueueReport/index.js",
23651     "groupTitle": "Sms_Queue_Reports"
23652   },
23653   {
23654     "type": "post",
23655     "url": "/api/sms/queues/{id}/users",
23656     "title": "Add agents to a queue",
23657     "examples": [
23658       {
23659         "title": "Example usage:",
23660         "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",
23661         "type": "json"
23662       }
23663     ],
23664     "name": "AddAgents",
23665     "group": "Sms_Queues",
23666     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23667     "version": "0.0.0",
23668     "filename": "server/api/smsQueue/index.js",
23669     "groupTitle": "Sms_Queues"
23670   },
23671   {
23672     "type": "post",
23673     "url": "/api/sms/queues/{id}/teams",
23674     "title": "Add teams to a queue",
23675     "examples": [
23676       {
23677         "title": "Example usage:",
23678         "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",
23679         "type": "json"
23680       }
23681     ],
23682     "name": "AddTeams",
23683     "group": "Sms_Queues",
23684     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23685     "version": "0.0.0",
23686     "filename": "server/api/smsQueue/index.js",
23687     "groupTitle": "Sms_Queues"
23688   },
23689   {
23690     "type": "post",
23691     "url": "/api/sms/queues",
23692     "title": "Creates a new Queue",
23693     "examples": [
23694       {
23695         "title": "Example usage:",
23696         "content": "curl https://{domain}/api/sms/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23697         "type": "json"
23698       }
23699     ],
23700     "name": "CreateQueues",
23701     "group": "Sms_Queues",
23702     "parameter": {
23703       "fields": {
23704         "Body": [
23705           {
23706             "group": "Body",
23707             "type": "String",
23708             "optional": true,
23709             "field": "name",
23710             "description": ""
23711           },
23712           {
23713             "group": "Body",
23714             "type": "String",
23715             "optional": true,
23716             "field": "description",
23717             "description": ""
23718           },
23719           {
23720             "group": "Body",
23721             "type": "Integer",
23722             "optional": true,
23723             "field": "timeout",
23724             "description": ""
23725           },
23726           {
23727             "group": "Body",
23728             "type": "String",
23729             "allowedValues": [
23730               "\"rrmemory\"",
23731               "\"beepall\"",
23732               "\"roundrobin\""
23733             ],
23734             "optional": true,
23735             "field": "strategy",
23736             "description": ""
23737           }
23738         ]
23739       }
23740     },
23741     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23742     "version": "0.0.0",
23743     "filename": "server/api/smsQueue/index.js",
23744     "groupTitle": "Sms_Queues"
23745   },
23746   {
23747     "type": "delete",
23748     "url": "/api/sms/queues/{id}",
23749     "title": "Deletes a Queue",
23750     "examples": [
23751       {
23752         "title": "Example usage:",
23753         "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password} -X DELETE",
23754         "type": "json"
23755       }
23756     ],
23757     "name": "DeleteQueues",
23758     "group": "Sms_Queues",
23759     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23760     "version": "0.0.0",
23761     "filename": "server/api/smsQueue/index.js",
23762     "groupTitle": "Sms_Queues"
23763   },
23764   {
23765     "type": "get",
23766     "url": "/api/sms/queues/describe",
23767     "title": "Gets table info about Queues",
23768     "examples": [
23769       {
23770         "title": "Example usage:",
23771         "content": "curl https://{domain}/api/sms/queues/describe -v -u {name}:{password}",
23772         "type": "json"
23773       }
23774     ],
23775     "name": "DescribeQueues",
23776     "group": "Sms_Queues",
23777     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23778     "version": "0.0.0",
23779     "filename": "server/api/smsQueue/index.js",
23780     "groupTitle": "Sms_Queues"
23781   },
23782   {
23783     "type": "get",
23784     "url": "/api/sms/queues/{id}/users",
23785     "title": "Gets queue agents",
23786     "examples": [
23787       {
23788         "title": "Example usage:",
23789         "content": "curl https://{domain}/api/sms/queues/{id}/users -v -u {name}:{password} -X POST",
23790         "type": "json"
23791       }
23792     ],
23793     "name": "GetAgents",
23794     "group": "Sms_Queues",
23795     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23796     "version": "0.0.0",
23797     "filename": "server/api/smsQueue/index.js",
23798     "groupTitle": "Sms_Queues"
23799   },
23800   {
23801     "type": "get",
23802     "url": "/api/sms/queues/{id}/members",
23803     "title": "GetMembers",
23804     "examples": [
23805       {
23806         "title": "Example usage:",
23807         "content": "curl https://{domain}/api/sms/queues/{id}/members  -v -u {name}:{password}",
23808         "type": "json"
23809       }
23810     ],
23811     "name": "GetMembers",
23812     "group": "Sms_Queues",
23813     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23814     "version": "0.0.0",
23815     "filename": "server/api/smsQueue/index.js",
23816     "groupTitle": "Sms_Queues"
23817   },
23818   {
23819     "type": "get",
23820     "url": "/api/sms/queues",
23821     "title": "Gets a list of Queues",
23822     "examples": [
23823       {
23824         "title": "Example usage:",
23825         "content": "curl https://{domain}/api/sms/queues -v -u {name}:{password}",
23826         "type": "json"
23827       }
23828     ],
23829     "name": "GetQueues",
23830     "group": "Sms_Queues",
23831     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23832     "version": "0.0.0",
23833     "filename": "server/api/smsQueue/index.js",
23834     "groupTitle": "Sms_Queues"
23835   },
23836   {
23837     "type": "get",
23838     "url": "/api/sms/queues/{id}/teams",
23839     "title": "Gets queues list",
23840     "examples": [
23841       {
23842         "title": "Example usage:",
23843         "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password}",
23844         "type": "json"
23845       }
23846     ],
23847     "name": "GetTeams",
23848     "group": "Sms_Queues",
23849     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23850     "version": "0.0.0",
23851     "filename": "server/api/smsQueue/index.js",
23852     "groupTitle": "Sms_Queues"
23853   },
23854   {
23855     "type": "delete",
23856     "url": "/api/sms/queues/{id}/users",
23857     "title": "Removes agents from a queue",
23858     "examples": [
23859       {
23860         "title": "Example usage:",
23861         "content": "curl https://{domain}/api/sms/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
23862         "type": "json"
23863       }
23864     ],
23865     "name": "RemoveAgents",
23866     "group": "Sms_Queues",
23867     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23868     "version": "0.0.0",
23869     "filename": "server/api/smsQueue/index.js",
23870     "groupTitle": "Sms_Queues"
23871   },
23872   {
23873     "type": "get",
23874     "url": "/api/sms/queues/{id}",
23875     "title": "Gets a single Queue",
23876     "examples": [
23877       {
23878         "title": "Example usage:",
23879         "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password}",
23880         "type": "json"
23881       }
23882     ],
23883     "name": "ShowQueues",
23884     "group": "Sms_Queues",
23885     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23886     "version": "0.0.0",
23887     "filename": "server/api/smsQueue/index.js",
23888     "groupTitle": "Sms_Queues"
23889   },
23890   {
23891     "type": "put",
23892     "url": "/api/sms/queues/{id}",
23893     "title": "Update an existing Queue",
23894     "examples": [
23895       {
23896         "title": "Example usage:",
23897         "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",
23898         "type": "json"
23899       }
23900     ],
23901     "name": "updateQueues",
23902     "group": "Sms_Queues",
23903     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23904     "version": "0.0.0",
23905     "filename": "server/api/smsQueue/index.js",
23906     "groupTitle": "Sms_Queues"
23907   },
23908   {
23909     "type": "post",
23910     "url": "/api/sms/reports/transfer",
23911     "title": "Creates a new Sms Transfer Report",
23912     "examples": [
23913       {
23914         "title": "Example usage:",
23915         "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",
23916         "type": "json"
23917       }
23918     ],
23919     "name": "CreateSms_Transfer_Reports",
23920     "group": "Sms_Transfer_Reports",
23921     "parameter": {
23922       "fields": {
23923         "Body": [
23924           {
23925             "group": "Body",
23926             "type": "String",
23927             "optional": false,
23928             "field": "uniqueid",
23929             "description": ""
23930           },
23931           {
23932             "group": "Body",
23933             "type": "String",
23934             "allowedValues": [
23935               "\"account\"",
23936               "\"agent\"",
23937               "\"queue\""
23938             ],
23939             "optional": false,
23940             "field": "type",
23941             "description": ""
23942           },
23943           {
23944             "group": "Body",
23945             "type": "String",
23946             "optional": false,
23947             "field": "transferredAt",
23948             "description": ""
23949           }
23950         ]
23951       }
23952     },
23953     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23954     "version": "0.0.0",
23955     "filename": "server/api/smsTransferReport/index.js",
23956     "groupTitle": "Sms_Transfer_Reports"
23957   },
23958   {
23959     "type": "delete",
23960     "url": "/api/sms/reports/transfer/{id}",
23961     "title": "Deletes a Sms Transfer Report",
23962     "examples": [
23963       {
23964         "title": "Example usage:",
23965         "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
23966         "type": "json"
23967       }
23968     ],
23969     "name": "DeleteSms_Transfer_Reports",
23970     "group": "Sms_Transfer_Reports",
23971     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23972     "version": "0.0.0",
23973     "filename": "server/api/smsTransferReport/index.js",
23974     "groupTitle": "Sms_Transfer_Reports"
23975   },
23976   {
23977     "type": "get",
23978     "url": "/api/sms/reports/transfer/describe",
23979     "title": "Gets table info about Sms Transfer Reports",
23980     "examples": [
23981       {
23982         "title": "Example usage:",
23983         "content": "curl https://{domain}/api/sms/reports/transfer/describe -v -u {name}:{password}",
23984         "type": "json"
23985       }
23986     ],
23987     "name": "DescribeSms_Transfer_Reports",
23988     "group": "Sms_Transfer_Reports",
23989     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23990     "version": "0.0.0",
23991     "filename": "server/api/smsTransferReport/index.js",
23992     "groupTitle": "Sms_Transfer_Reports"
23993   },
23994   {
23995     "type": "get",
23996     "url": "/api/sms/reports/transfer",
23997     "title": "Gets a list of Sms Transfer Reports",
23998     "examples": [
23999       {
24000         "title": "Example usage:",
24001         "content": "curl https://{domain}/api/sms/reports/transfer -v -u {name}:{password}",
24002         "type": "json"
24003       }
24004     ],
24005     "name": "GetSms_Transfer_Reports",
24006     "group": "Sms_Transfer_Reports",
24007     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24008     "version": "0.0.0",
24009     "filename": "server/api/smsTransferReport/index.js",
24010     "groupTitle": "Sms_Transfer_Reports"
24011   },
24012   {
24013     "type": "get",
24014     "url": "/api/sms/reports/transfer/{id}",
24015     "title": "Gets a single Sms Transfer Report",
24016     "examples": [
24017       {
24018         "title": "Example usage:",
24019         "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password}",
24020         "type": "json"
24021       }
24022     ],
24023     "name": "ShowSms_Transfer_Reports",
24024     "group": "Sms_Transfer_Reports",
24025     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24026     "version": "0.0.0",
24027     "filename": "server/api/smsTransferReport/index.js",
24028     "groupTitle": "Sms_Transfer_Reports"
24029   },
24030   {
24031     "type": "put",
24032     "url": "/api/sms/reports/transfer/{id}",
24033     "title": "Update an existing Sms Transfer Report",
24034     "examples": [
24035       {
24036         "title": "Example usage:",
24037         "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",
24038         "type": "json"
24039       }
24040     ],
24041     "name": "updateSms_Transfer_Reports",
24042     "group": "Sms_Transfer_Reports",
24043     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24044     "version": "0.0.0",
24045     "filename": "server/api/smsTransferReport/index.js",
24046     "groupTitle": "Sms_Transfer_Reports"
24047   },
24048   {
24049     "type": "get",
24050     "url": "/api/sounds",
24051     "title": "Gets a list of Sounds",
24052     "examples": [
24053       {
24054         "title": "Example usage:",
24055         "content": "curl https://{domain}/api/sounds -v -u {name}:{password}",
24056         "type": "json"
24057       }
24058     ],
24059     "name": "GetSounds",
24060     "group": "Sounds",
24061     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24062     "version": "0.0.0",
24063     "filename": "server/api/sound/index.js",
24064     "groupTitle": "Sounds"
24065   },
24066   {
24067     "type": "get",
24068     "url": "/api/sounds/{id}",
24069     "title": "Gets a single Sound",
24070     "examples": [
24071       {
24072         "title": "Example usage:",
24073         "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password}",
24074         "type": "json"
24075       }
24076     ],
24077     "name": "ShowSounds",
24078     "group": "Sounds",
24079     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24080     "version": "0.0.0",
24081     "filename": "server/api/sound/index.js",
24082     "groupTitle": "Sounds"
24083   },
24084   {
24085     "type": "post",
24086     "url": "/api/sounds",
24087     "title": "Create a new sound",
24088     "examples": [
24089       {
24090         "title": "Example usage:",
24091         "content": "curl https://{domain}/api/sounds -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
24092         "type": "json"
24093       }
24094     ],
24095     "name": "addSound",
24096     "group": "Sounds",
24097     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24098     "version": "0.0.0",
24099     "filename": "server/api/sound/index.js",
24100     "groupTitle": "Sounds"
24101   },
24102   {
24103     "type": "delete",
24104     "url": "/api/sounds/{id}",
24105     "title": "Deletes a sound",
24106     "examples": [
24107       {
24108         "title": "Example usage:",
24109         "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password} -X DELETE",
24110         "type": "json"
24111       }
24112     ],
24113     "name": "destroySound",
24114     "group": "Sounds",
24115     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24116     "version": "0.0.0",
24117     "filename": "server/api/sound/index.js",
24118     "groupTitle": "Sounds"
24119   },
24120   {
24121     "type": "get",
24122     "url": "/api/sounds/{id}/download",
24123     "title": "Download Sound",
24124     "examples": [
24125       {
24126         "title": "Example usage:",
24127         "content": "curl https://{domain}/api/sounds/{id}/download -v -u {name}:{password} -X GET",
24128         "type": "json"
24129       }
24130     ],
24131     "name": "download",
24132     "group": "Sounds",
24133     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24134     "version": "0.0.0",
24135     "filename": "server/api/sound/index.js",
24136     "groupTitle": "Sounds"
24137   },
24138   {
24139     "type": "put",
24140     "url": "/api/sounds",
24141     "title": "Update an existing new sound",
24142     "examples": [
24143       {
24144         "title": "Example usage:",
24145         "content": "curl https://{domain}/api/sounds -d '[\"name\": \"sound_name\", \"description\": \"sound_desc\"]' -v -u {name}:{password} -X PUT",
24146         "type": "json"
24147       }
24148     ],
24149     "name": "updateSound",
24150     "group": "Sounds",
24151     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24152     "version": "0.0.0",
24153     "filename": "server/api/sound/index.js",
24154     "groupTitle": "Sounds"
24155   },
24156   {
24157     "type": "post",
24158     "url": "/api/square/details/reports",
24159     "title": "Creates a new Square Detail Report",
24160     "examples": [
24161       {
24162         "title": "Example usage:",
24163         "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",
24164         "type": "json"
24165       }
24166     ],
24167     "name": "CreateSquare_Detail_Reports",
24168     "group": "Square_Details_Reports",
24169     "parameter": {
24170       "fields": {
24171         "Body": [
24172           {
24173             "group": "Body",
24174             "type": "String",
24175             "optional": true,
24176             "field": "uniqueid",
24177             "description": ""
24178           },
24179           {
24180             "group": "Body",
24181             "type": "String",
24182             "optional": true,
24183             "field": "node",
24184             "description": ""
24185           },
24186           {
24187             "group": "Body",
24188             "type": "String",
24189             "optional": true,
24190             "field": "application",
24191             "description": ""
24192           },
24193           {
24194             "group": "Body",
24195             "type": "Text",
24196             "optional": true,
24197             "field": "data",
24198             "description": ""
24199           },
24200           {
24201             "group": "Body",
24202             "type": "String",
24203             "optional": true,
24204             "field": "project_name",
24205             "description": ""
24206           },
24207           {
24208             "group": "Body",
24209             "type": "String",
24210             "optional": true,
24211             "field": "callerid",
24212             "description": ""
24213           }
24214         ]
24215       }
24216     },
24217     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24218     "version": "0.0.0",
24219     "filename": "server/api/squareReportDetail/index.js",
24220     "groupTitle": "Square_Details_Reports"
24221   },
24222   {
24223     "type": "delete",
24224     "url": "/api/square/details/reports/{id}",
24225     "title": "Deletes a Square Detail Report",
24226     "examples": [
24227       {
24228         "title": "Example usage:",
24229         "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password} -X DELETE",
24230         "type": "json"
24231       }
24232     ],
24233     "name": "DeleteSquare_Detail_Reports",
24234     "group": "Square_Details_Reports",
24235     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24236     "version": "0.0.0",
24237     "filename": "server/api/squareReportDetail/index.js",
24238     "groupTitle": "Square_Details_Reports"
24239   },
24240   {
24241     "type": "get",
24242     "url": "/api/square/details/reports/describe",
24243     "title": "Gets table info about Square Detail Reports",
24244     "examples": [
24245       {
24246         "title": "Example usage:",
24247         "content": "curl https://{domain}/api/square/details/reports/describe -v -u {name}:{password}",
24248         "type": "json"
24249       }
24250     ],
24251     "name": "DescribeSquare_Detail_Reports",
24252     "group": "Square_Details_Reports",
24253     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24254     "version": "0.0.0",
24255     "filename": "server/api/squareReportDetail/index.js",
24256     "groupTitle": "Square_Details_Reports"
24257   },
24258   {
24259     "type": "get",
24260     "url": "/api/square/details/reports",
24261     "title": "Gets a list of Square Detail Reports",
24262     "examples": [
24263       {
24264         "title": "Example usage:",
24265         "content": "curl https://{domain}/api/square/details/reports -v -u {name}:{password}",
24266         "type": "json"
24267       }
24268     ],
24269     "name": "GetSquare_Detail_Reports",
24270     "group": "Square_Details_Reports",
24271     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24272     "version": "0.0.0",
24273     "filename": "server/api/squareReportDetail/index.js",
24274     "groupTitle": "Square_Details_Reports"
24275   },
24276   {
24277     "type": "get",
24278     "url": "/api/square/details/reports/{id}",
24279     "title": "Gets a single Square Detail Report",
24280     "examples": [
24281       {
24282         "title": "Example usage:",
24283         "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password}",
24284         "type": "json"
24285       }
24286     ],
24287     "name": "ShowSquare_Detail_Reports",
24288     "group": "Square_Details_Reports",
24289     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24290     "version": "0.0.0",
24291     "filename": "server/api/squareReportDetail/index.js",
24292     "groupTitle": "Square_Details_Reports"
24293   },
24294   {
24295     "type": "put",
24296     "url": "/api/square/details/reports/{id}",
24297     "title": "Update an existing Square Detail Report",
24298     "examples": [
24299       {
24300         "title": "Example usage:",
24301         "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",
24302         "type": "json"
24303       }
24304     ],
24305     "name": "updateSquare_Detail_Reports",
24306     "group": "Square_Details_Reports",
24307     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24308     "version": "0.0.0",
24309     "filename": "server/api/squareReportDetail/index.js",
24310     "groupTitle": "Square_Details_Reports"
24311   },
24312   {
24313     "type": "post",
24314     "url": "/api/square/messages",
24315     "title": "Creates a new Message",
24316     "examples": [
24317       {
24318         "title": "Example usage:",
24319         "content": "curl https://{domain}/api/square/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24320         "type": "json"
24321       }
24322     ],
24323     "name": "CreateMessages",
24324     "group": "Square_Messages",
24325     "parameter": {
24326       "fields": {
24327         "Body": [
24328           {
24329             "group": "Body",
24330             "type": "String",
24331             "optional": true,
24332             "field": "uniqueid",
24333             "description": ""
24334           },
24335           {
24336             "group": "Body",
24337             "type": "Text",
24338             "optional": false,
24339             "field": "body",
24340             "description": ""
24341           },
24342           {
24343             "group": "Body",
24344             "type": "String",
24345             "allowedValues": [
24346               "\"in\"",
24347               "\"out\""
24348             ],
24349             "optional": false,
24350             "field": "direction",
24351             "description": ""
24352           },
24353           {
24354             "group": "Body",
24355             "type": "String",
24356             "optional": true,
24357             "field": "providerName",
24358             "description": ""
24359           },
24360           {
24361             "group": "Body",
24362             "type": "Text",
24363             "optional": true,
24364             "field": "providerResponse",
24365             "description": ""
24366           }
24367         ]
24368       }
24369     },
24370     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24371     "version": "0.0.0",
24372     "filename": "server/api/squareMessage/index.js",
24373     "groupTitle": "Square_Messages"
24374   },
24375   {
24376     "type": "delete",
24377     "url": "/api/square/messages/{id}",
24378     "title": "Deletes a Message",
24379     "examples": [
24380       {
24381         "title": "Example usage:",
24382         "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password} -X DELETE",
24383         "type": "json"
24384       }
24385     ],
24386     "name": "DeleteMessages",
24387     "group": "Square_Messages",
24388     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24389     "version": "0.0.0",
24390     "filename": "server/api/squareMessage/index.js",
24391     "groupTitle": "Square_Messages"
24392   },
24393   {
24394     "type": "get",
24395     "url": "/api/square/messages",
24396     "title": "Gets a list of Messages",
24397     "examples": [
24398       {
24399         "title": "Example usage:",
24400         "content": "curl https://{domain}/api/square/messages -v -u {name}:{password}",
24401         "type": "json"
24402       }
24403     ],
24404     "name": "GetMessages",
24405     "group": "Square_Messages",
24406     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24407     "version": "0.0.0",
24408     "filename": "server/api/squareMessage/index.js",
24409     "groupTitle": "Square_Messages"
24410   },
24411   {
24412     "type": "get",
24413     "url": "/api/square/messages/{id}",
24414     "title": "Gets a single Message",
24415     "examples": [
24416       {
24417         "title": "Example usage:",
24418         "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password}",
24419         "type": "json"
24420       }
24421     ],
24422     "name": "ShowMessages",
24423     "group": "Square_Messages",
24424     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24425     "version": "0.0.0",
24426     "filename": "server/api/squareMessage/index.js",
24427     "groupTitle": "Square_Messages"
24428   },
24429   {
24430     "type": "put",
24431     "url": "/api/square/messages/{id}",
24432     "title": "Update an existing Message",
24433     "examples": [
24434       {
24435         "title": "Example usage:",
24436         "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",
24437         "type": "json"
24438       }
24439     ],
24440     "name": "updateMessages",
24441     "group": "Square_Messages",
24442     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24443     "version": "0.0.0",
24444     "filename": "server/api/squareMessage/index.js",
24445     "groupTitle": "Square_Messages"
24446   },
24447   {
24448     "type": "post",
24449     "url": "/api/square/odbc",
24450     "title": "Creates a new ODBC",
24451     "examples": [
24452       {
24453         "title": "Example usage:",
24454         "content": "curl https://{domain}/api/square/odbc -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24455         "type": "json"
24456       }
24457     ],
24458     "name": "CreateODBCs",
24459     "group": "Square_ODBC",
24460     "parameter": {
24461       "fields": {
24462         "Body": [
24463           {
24464             "group": "Body",
24465             "type": "String",
24466             "optional": false,
24467             "field": "name",
24468             "description": ""
24469           },
24470           {
24471             "group": "Body",
24472             "type": "String",
24473             "optional": true,
24474             "field": "dsn",
24475             "description": ""
24476           },
24477           {
24478             "group": "Body",
24479             "type": "String",
24480             "optional": true,
24481             "field": "description",
24482             "description": ""
24483           }
24484         ]
24485       }
24486     },
24487     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24488     "version": "0.0.0",
24489     "filename": "server/api/squareOdbc/index.js",
24490     "groupTitle": "Square_ODBC"
24491   },
24492   {
24493     "type": "delete",
24494     "url": "/api/square/odbc/{id}",
24495     "title": "Deletes a ODBC",
24496     "examples": [
24497       {
24498         "title": "Example usage:",
24499         "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password} -X DELETE",
24500         "type": "json"
24501       }
24502     ],
24503     "name": "DeleteODBCs",
24504     "group": "Square_ODBC",
24505     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24506     "version": "0.0.0",
24507     "filename": "server/api/squareOdbc/index.js",
24508     "groupTitle": "Square_ODBC"
24509   },
24510   {
24511     "type": "get",
24512     "url": "/api/square/odbc",
24513     "title": "Gets a list of ODBCs",
24514     "examples": [
24515       {
24516         "title": "Example usage:",
24517         "content": "curl https://{domain}/api/square/odbc -v -u {name}:{password}",
24518         "type": "json"
24519       }
24520     ],
24521     "name": "GetODBCs",
24522     "group": "Square_ODBC",
24523     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24524     "version": "0.0.0",
24525     "filename": "server/api/squareOdbc/index.js",
24526     "groupTitle": "Square_ODBC"
24527   },
24528   {
24529     "type": "get",
24530     "url": "/api/square/odbc/{id}",
24531     "title": "Gets a single ODBC",
24532     "examples": [
24533       {
24534         "title": "Example usage:",
24535         "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password}",
24536         "type": "json"
24537       }
24538     ],
24539     "name": "ShowODBCs",
24540     "group": "Square_ODBC",
24541     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24542     "version": "0.0.0",
24543     "filename": "server/api/squareOdbc/index.js",
24544     "groupTitle": "Square_ODBC"
24545   },
24546   {
24547     "type": "get",
24548     "url": "/api/square/odbc/{id}/test",
24549     "title": "Test Odbc",
24550     "examples": [
24551       {
24552         "title": "Example usage:",
24553         "content": "curl https://{domain}/api/square/odbc/{id}/test -v -u {name}:{password} -X GET",
24554         "type": "json"
24555       }
24556     ],
24557     "name": "test",
24558     "group": "Square_ODBC",
24559     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24560     "version": "0.0.0",
24561     "filename": "server/api/squareOdbc/index.js",
24562     "groupTitle": "Square_ODBC"
24563   },
24564   {
24565     "type": "put",
24566     "url": "/api/square/odbc/{id}",
24567     "title": "Update an existing ODBC",
24568     "examples": [
24569       {
24570         "title": "Example usage:",
24571         "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",
24572         "type": "json"
24573       }
24574     ],
24575     "name": "updateODBCs",
24576     "group": "Square_ODBC",
24577     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24578     "version": "0.0.0",
24579     "filename": "server/api/squareOdbc/index.js",
24580     "groupTitle": "Square_ODBC"
24581   },
24582   {
24583     "type": "post",
24584     "url": "/api/square/projects",
24585     "title": "Creates a new Project",
24586     "examples": [
24587       {
24588         "title": "Example usage:",
24589         "content": "curl https://{domain}/api/square/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24590         "type": "json"
24591       }
24592     ],
24593     "name": "CreateProjects",
24594     "group": "Square_Projects",
24595     "parameter": {
24596       "fields": {
24597         "Body": [
24598           {
24599             "group": "Body",
24600             "type": "String",
24601             "optional": false,
24602             "field": "name",
24603             "description": ""
24604           },
24605           {
24606             "group": "Body",
24607             "type": "String",
24608             "optional": true,
24609             "field": "description",
24610             "description": ""
24611           },
24612           {
24613             "group": "Body",
24614             "type": "Text",
24615             "optional": true,
24616             "field": "notes",
24617             "description": ""
24618           },
24619           {
24620             "group": "Body",
24621             "type": "Blob",
24622             "optional": true,
24623             "field": "preproduction",
24624             "description": ""
24625           },
24626           {
24627             "group": "Body",
24628             "type": "Blob",
24629             "optional": true,
24630             "field": "production",
24631             "description": ""
24632           },
24633           {
24634             "group": "Body",
24635             "type": "String",
24636             "optional": true,
24637             "field": "savedAt",
24638             "description": ""
24639           },
24640           {
24641             "group": "Body",
24642             "type": "String",
24643             "optional": true,
24644             "field": "publishedAt",
24645             "description": ""
24646           }
24647         ]
24648       }
24649     },
24650     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24651     "version": "0.0.0",
24652     "filename": "server/api/squareProject/index.js",
24653     "groupTitle": "Square_Projects"
24654   },
24655   {
24656     "type": "delete",
24657     "url": "/api/square/projects/{id}",
24658     "title": "Deletes a Project",
24659     "examples": [
24660       {
24661         "title": "Example usage:",
24662         "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password} -X DELETE",
24663         "type": "json"
24664       }
24665     ],
24666     "name": "DeleteProjects",
24667     "group": "Square_Projects",
24668     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24669     "version": "0.0.0",
24670     "filename": "server/api/squareProject/index.js",
24671     "groupTitle": "Square_Projects"
24672   },
24673   {
24674     "type": "get",
24675     "url": "/api/square/projects",
24676     "title": "Gets a list of Projects",
24677     "examples": [
24678       {
24679         "title": "Example usage:",
24680         "content": "curl https://{domain}/api/square/projects -v -u {name}:{password}",
24681         "type": "json"
24682       }
24683     ],
24684     "name": "GetProjects",
24685     "group": "Square_Projects",
24686     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24687     "version": "0.0.0",
24688     "filename": "server/api/squareProject/index.js",
24689     "groupTitle": "Square_Projects"
24690   },
24691   {
24692     "type": "get",
24693     "url": "/api/square/projects/{id}",
24694     "title": "Gets a single Project",
24695     "examples": [
24696       {
24697         "title": "Example usage:",
24698         "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password}",
24699         "type": "json"
24700       }
24701     ],
24702     "name": "ShowProjects",
24703     "group": "Square_Projects",
24704     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24705     "version": "0.0.0",
24706     "filename": "server/api/squareProject/index.js",
24707     "groupTitle": "Square_Projects"
24708   },
24709   {
24710     "type": "post",
24711     "url": "/api/square/projects/{id}/users",
24712     "title": "Adds user permissions to a Project",
24713     "examples": [
24714       {
24715         "title": "Example usage:",
24716         "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",
24717         "type": "json"
24718       }
24719     ],
24720     "name": "addUsers",
24721     "group": "Square_Projects",
24722     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24723     "version": "0.0.0",
24724     "filename": "server/api/squareProject/index.js",
24725     "groupTitle": "Square_Projects"
24726   },
24727   {
24728     "type": "get",
24729     "url": "/api/square/projects/{id}/users",
24730     "title": "Gets users permissions from Project",
24731     "examples": [
24732       {
24733         "title": "Example usage:",
24734         "content": "curl https://{domain}/api/square/projects/{id}/users -v -u {name}:{password} -X GET",
24735         "type": "json"
24736       }
24737     ],
24738     "name": "getUsers",
24739     "group": "Square_Projects",
24740     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24741     "version": "0.0.0",
24742     "filename": "server/api/squareProject/index.js",
24743     "groupTitle": "Square_Projects"
24744   },
24745   {
24746     "type": "delete",
24747     "url": "/api/square/projects/{id}/users",
24748     "title": "Removes user permissions from a Project",
24749     "examples": [
24750       {
24751         "title": "Example usage:",
24752         "content": "curl https://{domain}/api/square/projects/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
24753         "type": "json"
24754       }
24755     ],
24756     "name": "removeUsers",
24757     "group": "Square_Projects",
24758     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24759     "version": "0.0.0",
24760     "filename": "server/api/squareProject/index.js",
24761     "groupTitle": "Square_Projects"
24762   },
24763   {
24764     "type": "put",
24765     "url": "/api/square/projects/{id}",
24766     "title": "Update an existing Project",
24767     "examples": [
24768       {
24769         "title": "Example usage:",
24770         "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",
24771         "type": "json"
24772       }
24773     ],
24774     "name": "updateProjects",
24775     "group": "Square_Projects",
24776     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24777     "version": "0.0.0",
24778     "filename": "server/api/squareProject/index.js",
24779     "groupTitle": "Square_Projects"
24780   },
24781   {
24782     "type": "post",
24783     "url": "/api/square/recordings",
24784     "title": "Creates a new Recording",
24785     "examples": [
24786       {
24787         "title": "Example usage:",
24788         "content": "curl https://{domain}/api/square/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24789         "type": "json"
24790       }
24791     ],
24792     "name": "CreateRecordings",
24793     "group": "Square_Recordings",
24794     "parameter": {
24795       "fields": {
24796         "Body": [
24797           {
24798             "group": "Body",
24799             "type": "String",
24800             "optional": true,
24801             "field": "uniqueid",
24802             "description": ""
24803           },
24804           {
24805             "group": "Body",
24806             "type": "String",
24807             "optional": true,
24808             "field": "callerid",
24809             "description": ""
24810           },
24811           {
24812             "group": "Body",
24813             "type": "String",
24814             "optional": true,
24815             "field": "calleridname",
24816             "description": ""
24817           },
24818           {
24819             "group": "Body",
24820             "type": "String",
24821             "optional": true,
24822             "field": "context",
24823             "description": ""
24824           },
24825           {
24826             "group": "Body",
24827             "type": "String",
24828             "optional": true,
24829             "field": "extension",
24830             "description": ""
24831           },
24832           {
24833             "group": "Body",
24834             "type": "String",
24835             "optional": true,
24836             "field": "priority",
24837             "description": ""
24838           },
24839           {
24840             "group": "Body",
24841             "type": "String",
24842             "optional": true,
24843             "field": "accountcode",
24844             "description": ""
24845           },
24846           {
24847             "group": "Body",
24848             "type": "String",
24849             "optional": true,
24850             "field": "dnid",
24851             "description": ""
24852           },
24853           {
24854             "group": "Body",
24855             "type": "String",
24856             "optional": true,
24857             "field": "projectName",
24858             "description": ""
24859           },
24860           {
24861             "group": "Body",
24862             "type": "String",
24863             "optional": true,
24864             "field": "saveName",
24865             "description": ""
24866           },
24867           {
24868             "group": "Body",
24869             "type": "String",
24870             "optional": true,
24871             "field": "filename",
24872             "description": ""
24873           },
24874           {
24875             "group": "Body",
24876             "type": "String",
24877             "optional": true,
24878             "field": "savePath",
24879             "description": ""
24880           },
24881           {
24882             "group": "Body",
24883             "type": "Virtual",
24884             "optional": true,
24885             "field": "format",
24886             "description": ""
24887           }
24888         ]
24889       }
24890     },
24891     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24892     "version": "0.0.0",
24893     "filename": "server/api/squareRecording/index.js",
24894     "groupTitle": "Square_Recordings"
24895   },
24896   {
24897     "type": "get",
24898     "url": "/api/square/recordings",
24899     "title": "Gets a list of Recordings",
24900     "examples": [
24901       {
24902         "title": "Example usage:",
24903         "content": "curl https://{domain}/api/square/recordings -v -u {name}:{password}",
24904         "type": "json"
24905       }
24906     ],
24907     "name": "GetRecordings",
24908     "group": "Square_Recordings",
24909     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24910     "version": "0.0.0",
24911     "filename": "server/api/squareRecording/index.js",
24912     "groupTitle": "Square_Recordings"
24913   },
24914   {
24915     "type": "get",
24916     "url": "/api/square/recordings/{id}",
24917     "title": "Gets a single Recording",
24918     "examples": [
24919       {
24920         "title": "Example usage:",
24921         "content": "curl https://{domain}/api/square/recordings/{id} -v -u {name}:{password}",
24922         "type": "json"
24923       }
24924     ],
24925     "name": "ShowRecordings",
24926     "group": "Square_Recordings",
24927     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24928     "version": "0.0.0",
24929     "filename": "server/api/squareRecording/index.js",
24930     "groupTitle": "Square_Recordings"
24931   },
24932   {
24933     "type": "delete",
24934     "url": "/api/square/recordings/{id}/delete",
24935     "title": "Delete recording",
24936     "examples": [
24937       {
24938         "title": "Example usage:",
24939         "content": "curl https://{domain}/api/square/recordings/{id}/delete -v -u {name}:{password} -X DELETE",
24940         "type": "json"
24941       }
24942     ],
24943     "name": "destroy",
24944     "group": "Square_Recordings",
24945     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24946     "version": "0.0.0",
24947     "filename": "server/api/squareRecording/index.js",
24948     "groupTitle": "Square_Recordings"
24949   },
24950   {
24951     "type": "get",
24952     "url": "/api/square/recordings/{id}/download",
24953     "title": "Download Recording",
24954     "examples": [
24955       {
24956         "title": "Example usage:",
24957         "content": "curl https://{domain}/api/square/recordings/{id}/download -v -u {name}:{password} -X GET",
24958         "type": "json"
24959       }
24960     ],
24961     "name": "download",
24962     "group": "Square_Recordings",
24963     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24964     "version": "0.0.0",
24965     "filename": "server/api/squareRecording/index.js",
24966     "groupTitle": "Square_Recordings"
24967   },
24968   {
24969     "type": "put",
24970     "url": "/api/square/recordings/{id}",
24971     "title": "Update an existing Recording",
24972     "examples": [
24973       {
24974         "title": "Example usage:",
24975         "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",
24976         "type": "json"
24977       }
24978     ],
24979     "name": "updateRecordings",
24980     "group": "Square_Recordings",
24981     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24982     "version": "0.0.0",
24983     "filename": "server/api/squareRecording/index.js",
24984     "groupTitle": "Square_Recordings"
24985   },
24986   {
24987     "type": "post",
24988     "url": "/api/square/reports",
24989     "title": "Creates a new Square Report",
24990     "examples": [
24991       {
24992         "title": "Example usage:",
24993         "content": "curl https://{domain}/api/square/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24994         "type": "json"
24995       }
24996     ],
24997     "name": "CreateSquare_Reports",
24998     "group": "Square_Reports",
24999     "parameter": {
25000       "fields": {
25001         "Body": [
25002           {
25003             "group": "Body",
25004             "type": "String",
25005             "optional": true,
25006             "field": "network",
25007             "description": ""
25008           },
25009           {
25010             "group": "Body",
25011             "type": "String",
25012             "optional": true,
25013             "field": "network_script",
25014             "description": ""
25015           },
25016           {
25017             "group": "Body",
25018             "type": "String",
25019             "optional": true,
25020             "field": "request",
25021             "description": ""
25022           },
25023           {
25024             "group": "Body",
25025             "type": "String",
25026             "optional": true,
25027             "field": "channel",
25028             "description": ""
25029           },
25030           {
25031             "group": "Body",
25032             "type": "String",
25033             "optional": true,
25034             "field": "language",
25035             "description": ""
25036           },
25037           {
25038             "group": "Body",
25039             "type": "String",
25040             "optional": true,
25041             "field": "type",
25042             "description": ""
25043           },
25044           {
25045             "group": "Body",
25046             "type": "String",
25047             "optional": true,
25048             "field": "uniqueid",
25049             "description": ""
25050           },
25051           {
25052             "group": "Body",
25053             "type": "String",
25054             "optional": true,
25055             "field": "version",
25056             "description": ""
25057           },
25058           {
25059             "group": "Body",
25060             "type": "String",
25061             "optional": true,
25062             "field": "callerid",
25063             "description": ""
25064           },
25065           {
25066             "group": "Body",
25067             "type": "String",
25068             "optional": true,
25069             "field": "calleridname",
25070             "description": ""
25071           },
25072           {
25073             "group": "Body",
25074             "type": "String",
25075             "optional": true,
25076             "field": "callingpres",
25077             "description": ""
25078           },
25079           {
25080             "group": "Body",
25081             "type": "String",
25082             "optional": true,
25083             "field": "callingani2",
25084             "description": ""
25085           },
25086           {
25087             "group": "Body",
25088             "type": "String",
25089             "optional": true,
25090             "field": "callington",
25091             "description": ""
25092           },
25093           {
25094             "group": "Body",
25095             "type": "String",
25096             "optional": true,
25097             "field": "callingtns",
25098             "description": ""
25099           },
25100           {
25101             "group": "Body",
25102             "type": "String",
25103             "optional": true,
25104             "field": "dnid",
25105             "description": ""
25106           },
25107           {
25108             "group": "Body",
25109             "type": "String",
25110             "optional": true,
25111             "field": "rdnis",
25112             "description": ""
25113           },
25114           {
25115             "group": "Body",
25116             "type": "String",
25117             "optional": true,
25118             "field": "context",
25119             "description": ""
25120           },
25121           {
25122             "group": "Body",
25123             "type": "String",
25124             "optional": true,
25125             "field": "extension",
25126             "description": ""
25127           },
25128           {
25129             "group": "Body",
25130             "type": "String",
25131             "optional": true,
25132             "field": "priority",
25133             "description": ""
25134           },
25135           {
25136             "group": "Body",
25137             "type": "String",
25138             "optional": true,
25139             "field": "enhanced",
25140             "description": ""
25141           },
25142           {
25143             "group": "Body",
25144             "type": "String",
25145             "optional": true,
25146             "field": "accountcode",
25147             "description": ""
25148           },
25149           {
25150             "group": "Body",
25151             "type": "String",
25152             "optional": true,
25153             "field": "threadid",
25154             "description": ""
25155           },
25156           {
25157             "group": "Body",
25158             "type": "String",
25159             "optional": true,
25160             "field": "project_name",
25161             "description": ""
25162           },
25163           {
25164             "group": "Body",
25165             "type": "String",
25166             "optional": true,
25167             "field": "joinAt",
25168             "description": ""
25169           },
25170           {
25171             "group": "Body",
25172             "type": "String",
25173             "optional": true,
25174             "field": "leaveAt",
25175             "description": ""
25176           },
25177           {
25178             "group": "Body",
25179             "type": "Boolean",
25180             "optional": true,
25181             "field": "bot",
25182             "description": ""
25183           }
25184         ]
25185       }
25186     },
25187     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25188     "version": "0.0.0",
25189     "filename": "server/api/squareReport/index.js",
25190     "groupTitle": "Square_Reports"
25191   },
25192   {
25193     "type": "delete",
25194     "url": "/api/square/reports/{id}",
25195     "title": "Deletes a Square Report",
25196     "examples": [
25197       {
25198         "title": "Example usage:",
25199         "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password} -X DELETE",
25200         "type": "json"
25201       }
25202     ],
25203     "name": "DeleteSquare_Reports",
25204     "group": "Square_Reports",
25205     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25206     "version": "0.0.0",
25207     "filename": "server/api/squareReport/index.js",
25208     "groupTitle": "Square_Reports"
25209   },
25210   {
25211     "type": "get",
25212     "url": "/api/square/reports/describe",
25213     "title": "Gets table info about Square Reports",
25214     "examples": [
25215       {
25216         "title": "Example usage:",
25217         "content": "curl https://{domain}/api/square/reports/describe -v -u {name}:{password}",
25218         "type": "json"
25219       }
25220     ],
25221     "name": "DescribeSquare_Reports",
25222     "group": "Square_Reports",
25223     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25224     "version": "0.0.0",
25225     "filename": "server/api/squareReport/index.js",
25226     "groupTitle": "Square_Reports"
25227   },
25228   {
25229     "type": "get",
25230     "url": "/api/square/reports",
25231     "title": "Gets a list of Square Reports",
25232     "examples": [
25233       {
25234         "title": "Example usage:",
25235         "content": "curl https://{domain}/api/square/reports -v -u {name}:{password}",
25236         "type": "json"
25237       }
25238     ],
25239     "name": "GetSquare_Reports",
25240     "group": "Square_Reports",
25241     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25242     "version": "0.0.0",
25243     "filename": "server/api/squareReport/index.js",
25244     "groupTitle": "Square_Reports"
25245   },
25246   {
25247     "type": "get",
25248     "url": "/api/square/reports/{id}",
25249     "title": "Gets a single Square Report",
25250     "examples": [
25251       {
25252         "title": "Example usage:",
25253         "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password}",
25254         "type": "json"
25255       }
25256     ],
25257     "name": "ShowSquare_Reports",
25258     "group": "Square_Reports",
25259     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25260     "version": "0.0.0",
25261     "filename": "server/api/squareReport/index.js",
25262     "groupTitle": "Square_Reports"
25263   },
25264   {
25265     "type": "put",
25266     "url": "/api/square/reports/{id}",
25267     "title": "Update an existing Square Report",
25268     "examples": [
25269       {
25270         "title": "Example usage:",
25271         "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",
25272         "type": "json"
25273       }
25274     ],
25275     "name": "updateSquare_Reports",
25276     "group": "Square_Reports",
25277     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25278     "version": "0.0.0",
25279     "filename": "server/api/squareReport/index.js",
25280     "groupTitle": "Square_Reports"
25281   },
25282   {
25283     "type": "post",
25284     "url": "/api/integrations/sugarcrm/configurations",
25285     "title": "Creates a new SugarCRM Configuration",
25286     "examples": [
25287       {
25288         "title": "Example usage:",
25289         "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",
25290         "type": "json"
25291       }
25292     ],
25293     "name": "CreateSugarCRM_Configurations",
25294     "group": "SugarCRM_Configurations",
25295     "parameter": {
25296       "fields": {
25297         "Body": [
25298           {
25299             "group": "Body",
25300             "type": "String",
25301             "optional": true,
25302             "field": "name",
25303             "description": ""
25304           },
25305           {
25306             "group": "Body",
25307             "type": "String",
25308             "optional": true,
25309             "field": "description",
25310             "description": ""
25311           }
25312         ]
25313       }
25314     },
25315     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25316     "version": "0.0.0",
25317     "filename": "server/api/intSugarcrmConfiguration/index.js",
25318     "groupTitle": "SugarCRM_Configurations"
25319   },
25320   {
25321     "type": "delete",
25322     "url": "/api/integrations/sugarcrm/configurations/{id}",
25323     "title": "Deletes a SugarCRM Configuration",
25324     "examples": [
25325       {
25326         "title": "Example usage:",
25327         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password} -X DELETE",
25328         "type": "json"
25329       }
25330     ],
25331     "name": "DeleteSugarCRM_Configurations",
25332     "group": "SugarCRM_Configurations",
25333     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25334     "version": "0.0.0",
25335     "filename": "server/api/intSugarcrmConfiguration/index.js",
25336     "groupTitle": "SugarCRM_Configurations"
25337   },
25338   {
25339     "type": "get",
25340     "url": "/api/integrations/sugarcrm/configurations",
25341     "title": "Gets a list of SugarCRM Configurations",
25342     "examples": [
25343       {
25344         "title": "Example usage:",
25345         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations -v -u {name}:{password}",
25346         "type": "json"
25347       }
25348     ],
25349     "name": "GetSugarCRM_Configurations",
25350     "group": "SugarCRM_Configurations",
25351     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25352     "version": "0.0.0",
25353     "filename": "server/api/intSugarcrmConfiguration/index.js",
25354     "groupTitle": "SugarCRM_Configurations"
25355   },
25356   {
25357     "type": "get",
25358     "url": "/api/integrations/sugarcrm/configurations/{id}",
25359     "title": "Gets a single SugarCRM Configuration",
25360     "examples": [
25361       {
25362         "title": "Example usage:",
25363         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password}",
25364         "type": "json"
25365       }
25366     ],
25367     "name": "ShowSugarCRM_Configurations",
25368     "group": "SugarCRM_Configurations",
25369     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25370     "version": "0.0.0",
25371     "filename": "server/api/intSugarcrmConfiguration/index.js",
25372     "groupTitle": "SugarCRM_Configurations"
25373   },
25374   {
25375     "type": "put",
25376     "url": "/api/integrations/sugarcrm/configurations/{id}",
25377     "title": "Update an existing SugarCRM Configuration",
25378     "examples": [
25379       {
25380         "title": "Example usage:",
25381         "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",
25382         "type": "json"
25383       }
25384     ],
25385     "name": "updateSugarCRM_Configurations",
25386     "group": "SugarCRM_Configurations",
25387     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25388     "version": "0.0.0",
25389     "filename": "server/api/intSugarcrmConfiguration/index.js",
25390     "groupTitle": "SugarCRM_Configurations"
25391   },
25392   {
25393     "type": "post",
25394     "url": "/api/integrations/sugarcrm/accounts",
25395     "title": "Creates a new Sugarcrm Account",
25396     "examples": [
25397       {
25398         "title": "Example usage:",
25399         "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",
25400         "type": "json"
25401       }
25402     ],
25403     "name": "CreateSugarcrm_Accounts",
25404     "group": "Sugarcrm_Accounts",
25405     "parameter": {
25406       "fields": {
25407         "Body": [
25408           {
25409             "group": "Body",
25410             "type": "String",
25411             "optional": true,
25412             "field": "name",
25413             "description": ""
25414           },
25415           {
25416             "group": "Body",
25417             "type": "String",
25418             "optional": true,
25419             "field": "description",
25420             "description": ""
25421           },
25422           {
25423             "group": "Body",
25424             "type": "String",
25425             "optional": true,
25426             "field": "username",
25427             "description": ""
25428           },
25429           {
25430             "group": "Body",
25431             "type": "String",
25432             "optional": true,
25433             "field": "password",
25434             "description": ""
25435           },
25436           {
25437             "group": "Body",
25438             "type": "String",
25439             "optional": true,
25440             "field": "remoteUri",
25441             "description": ""
25442           },
25443           {
25444             "group": "Body",
25445             "type": "String",
25446             "optional": false,
25447             "field": "serverUrl",
25448             "description": ""
25449           }
25450         ]
25451       }
25452     },
25453     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25454     "version": "0.0.0",
25455     "filename": "server/api/intSugarcrmAccount/index.js",
25456     "groupTitle": "Sugarcrm_Accounts"
25457   },
25458   {
25459     "type": "delete",
25460     "url": "/api/integrations/sugarcrm/accounts/{id}",
25461     "title": "Deletes a Sugarcrm Account",
25462     "examples": [
25463       {
25464         "title": "Example usage:",
25465         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password} -X DELETE",
25466         "type": "json"
25467       }
25468     ],
25469     "name": "DeleteSugarcrm_Accounts",
25470     "group": "Sugarcrm_Accounts",
25471     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25472     "version": "0.0.0",
25473     "filename": "server/api/intSugarcrmAccount/index.js",
25474     "groupTitle": "Sugarcrm_Accounts"
25475   },
25476   {
25477     "type": "get",
25478     "url": "/api/integrations/sugarcrm/accounts",
25479     "title": "Gets a list of Sugarcrm Accounts",
25480     "examples": [
25481       {
25482         "title": "Example usage:",
25483         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts -v -u {name}:{password}",
25484         "type": "json"
25485       }
25486     ],
25487     "name": "GetSugarcrm_Accounts",
25488     "group": "Sugarcrm_Accounts",
25489     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25490     "version": "0.0.0",
25491     "filename": "server/api/intSugarcrmAccount/index.js",
25492     "groupTitle": "Sugarcrm_Accounts"
25493   },
25494   {
25495     "type": "get",
25496     "url": "/api/integrations/sugarcrm/accounts/{id}",
25497     "title": "Gets a single Sugarcrm Account",
25498     "examples": [
25499       {
25500         "title": "Example usage:",
25501         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password}",
25502         "type": "json"
25503       }
25504     ],
25505     "name": "ShowSugarcrm_Accounts",
25506     "group": "Sugarcrm_Accounts",
25507     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25508     "version": "0.0.0",
25509     "filename": "server/api/intSugarcrmAccount/index.js",
25510     "groupTitle": "Sugarcrm_Accounts"
25511   },
25512   {
25513     "type": "post",
25514     "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
25515     "title": "Creates new configuration",
25516     "examples": [
25517       {
25518         "title": "Example usage:",
25519         "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",
25520         "type": "json"
25521       }
25522     ],
25523     "name": "addConfiguration",
25524     "group": "Sugarcrm_Accounts",
25525     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25526     "version": "0.0.0",
25527     "filename": "server/api/intSugarcrmAccount/index.js",
25528     "groupTitle": "Sugarcrm_Accounts"
25529   },
25530   {
25531     "type": "get",
25532     "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
25533     "title": "Gets account configurations",
25534     "examples": [
25535       {
25536         "title": "Example usage:",
25537         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/configurations -v -u {name}:{password} -X GET",
25538         "type": "json"
25539       }
25540     ],
25541     "name": "getConfigurations",
25542     "group": "Sugarcrm_Accounts",
25543     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25544     "version": "0.0.0",
25545     "filename": "server/api/intSugarcrmAccount/index.js",
25546     "groupTitle": "Sugarcrm_Accounts"
25547   },
25548   {
25549     "type": "get",
25550     "url": "/api/integrations/sugarcrm/accounts/{id}/fields",
25551     "title": "Gets account fields",
25552     "examples": [
25553       {
25554         "title": "Example usage:",
25555         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/fields -v -u {name}:{password} -X GET",
25556         "type": "json"
25557       }
25558     ],
25559     "name": "getFields",
25560     "group": "Sugarcrm_Accounts",
25561     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25562     "version": "0.0.0",
25563     "filename": "server/api/intSugarcrmAccount/index.js",
25564     "groupTitle": "Sugarcrm_Accounts"
25565   },
25566   {
25567     "type": "put",
25568     "url": "/api/integrations/sugarcrm/accounts/{id}",
25569     "title": "Update an existing Sugarcrm Account",
25570     "examples": [
25571       {
25572         "title": "Example usage:",
25573         "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",
25574         "type": "json"
25575       }
25576     ],
25577     "name": "updateSugarcrm_Accounts",
25578     "group": "Sugarcrm_Accounts",
25579     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25580     "version": "0.0.0",
25581     "filename": "server/api/intSugarcrmAccount/index.js",
25582     "groupTitle": "Sugarcrm_Accounts"
25583   },
25584   {
25585     "type": "get",
25586     "url": "/api/integrations/sugarcrm/configurations/{id}/descriptions",
25587     "title": "Gets configurations descriptions",
25588     "examples": [
25589       {
25590         "title": "Example usage:",
25591         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
25592         "type": "json"
25593       }
25594     ],
25595     "name": "getDescriptions",
25596     "group": "Sugarcrm_Configurations",
25597     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25598     "version": "0.0.0",
25599     "filename": "server/api/intSugarcrmConfiguration/index.js",
25600     "groupTitle": "Sugarcrm_Configurations"
25601   },
25602   {
25603     "type": "get",
25604     "url": "/api/integrations/sugarcrm/configurations/{id}/fields",
25605     "title": "Gets configurations fields",
25606     "examples": [
25607       {
25608         "title": "Example usage:",
25609         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/fields -v -u {name}:{password} -X GET",
25610         "type": "json"
25611       }
25612     ],
25613     "name": "getFields",
25614     "group": "Sugarcrm_Configurations",
25615     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25616     "version": "0.0.0",
25617     "filename": "server/api/intSugarcrmConfiguration/index.js",
25618     "groupTitle": "Sugarcrm_Configurations"
25619   },
25620   {
25621     "type": "get",
25622     "url": "/api/integrations/sugarcrm/configurations/{id}/subjects",
25623     "title": "Gets configurations subjects",
25624     "examples": [
25625       {
25626         "title": "Example usage:",
25627         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/subjects -v -u {name}:{password} -X GET",
25628         "type": "json"
25629       }
25630     ],
25631     "name": "getSubjects",
25632     "group": "Sugarcrm_Configurations",
25633     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25634     "version": "0.0.0",
25635     "filename": "server/api/intSugarcrmConfiguration/index.js",
25636     "groupTitle": "Sugarcrm_Configurations"
25637   },
25638   {
25639     "type": "post",
25640     "url": "/api/integrations/sugarcrm/fields",
25641     "title": "Creates a new Sugarcrm Field",
25642     "examples": [
25643       {
25644         "title": "Example usage:",
25645         "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",
25646         "type": "json"
25647       }
25648     ],
25649     "name": "CreateSugarcrm_Fields",
25650     "group": "Sugarcrm_Fields",
25651     "parameter": {
25652       "fields": {
25653         "Body": [
25654           {
25655             "group": "Body",
25656             "type": "String",
25657             "allowedValues": [
25658               "\"string\"",
25659               "\"variable\"",
25660               "\"customVariable\"",
25661               "\"keyValue\""
25662             ],
25663             "optional": true,
25664             "field": "type",
25665             "description": ""
25666           },
25667           {
25668             "group": "Body",
25669             "type": "String",
25670             "optional": true,
25671             "field": "content",
25672             "description": ""
25673           },
25674           {
25675             "group": "Body",
25676             "type": "String",
25677             "optional": true,
25678             "field": "key",
25679             "description": ""
25680           },
25681           {
25682             "group": "Body",
25683             "type": "String",
25684             "allowedValues": [
25685               "\"string\"",
25686               "\"variable\"",
25687               "\"customVariable\""
25688             ],
25689             "optional": true,
25690             "field": "keyType",
25691             "description": ""
25692           },
25693           {
25694             "group": "Body",
25695             "type": "String",
25696             "optional": true,
25697             "field": "keyContent",
25698             "description": ""
25699           },
25700           {
25701             "group": "Body",
25702             "type": "String",
25703             "optional": true,
25704             "field": "idField",
25705             "description": ""
25706           },
25707           {
25708             "group": "Body",
25709             "type": "String",
25710             "optional": true,
25711             "field": "nameField",
25712             "description": ""
25713           },
25714           {
25715             "group": "Body",
25716             "type": "Boolean",
25717             "optional": true,
25718             "field": "customField",
25719             "description": ""
25720           },
25721           {
25722             "group": "Body",
25723             "type": "String",
25724             "optional": true,
25725             "field": "variableName",
25726             "description": ""
25727           }
25728         ]
25729       }
25730     },
25731     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25732     "version": "0.0.0",
25733     "filename": "server/api/intSugarcrmField/index.js",
25734     "groupTitle": "Sugarcrm_Fields"
25735   },
25736   {
25737     "type": "delete",
25738     "url": "/api/integrations/sugarcrm/fields/{id}",
25739     "title": "Deletes a Sugarcrm Field",
25740     "examples": [
25741       {
25742         "title": "Example usage:",
25743         "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password} -X DELETE",
25744         "type": "json"
25745       }
25746     ],
25747     "name": "DeleteSugarcrm_Fields",
25748     "group": "Sugarcrm_Fields",
25749     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25750     "version": "0.0.0",
25751     "filename": "server/api/intSugarcrmField/index.js",
25752     "groupTitle": "Sugarcrm_Fields"
25753   },
25754   {
25755     "type": "get",
25756     "url": "/api/integrations/sugarcrm/fields",
25757     "title": "Gets a list of Sugarcrm Fields",
25758     "examples": [
25759       {
25760         "title": "Example usage:",
25761         "content": "curl https://{domain}/api/integrations/sugarcrm/fields -v -u {name}:{password}",
25762         "type": "json"
25763       }
25764     ],
25765     "name": "GetSugarcrm_Fields",
25766     "group": "Sugarcrm_Fields",
25767     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25768     "version": "0.0.0",
25769     "filename": "server/api/intSugarcrmField/index.js",
25770     "groupTitle": "Sugarcrm_Fields"
25771   },
25772   {
25773     "type": "get",
25774     "url": "/api/integrations/sugarcrm/fields/{id}",
25775     "title": "Gets a single Sugarcrm Field",
25776     "examples": [
25777       {
25778         "title": "Example usage:",
25779         "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password}",
25780         "type": "json"
25781       }
25782     ],
25783     "name": "ShowSugarcrm_Fields",
25784     "group": "Sugarcrm_Fields",
25785     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25786     "version": "0.0.0",
25787     "filename": "server/api/intSugarcrmField/index.js",
25788     "groupTitle": "Sugarcrm_Fields"
25789   },
25790   {
25791     "type": "put",
25792     "url": "/api/integrations/sugarcrm/fields/{id}",
25793     "title": "Update an existing Sugarcrm Field",
25794     "examples": [
25795       {
25796         "title": "Example usage:",
25797         "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",
25798         "type": "json"
25799       }
25800     ],
25801     "name": "updateSugarcrm_Fields",
25802     "group": "Sugarcrm_Fields",
25803     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25804     "version": "0.0.0",
25805     "filename": "server/api/intSugarcrmField/index.js",
25806     "groupTitle": "Sugarcrm_Fields"
25807   },
25808   {
25809     "type": "get",
25810     "url": "/api/system",
25811     "title": "Gets system information",
25812     "examples": [
25813       {
25814         "title": "Example usage:",
25815         "content": "curl https://{domain}/api/system -v -u {name}:{password}",
25816         "type": "json"
25817       }
25818     ],
25819     "name": "GetSystemInformation",
25820     "group": "System_Information",
25821     "description": "<p>Motion returns the system information.</p>",
25822     "version": "0.0.0",
25823     "filename": "server/api/system/index.js",
25824     "groupTitle": "System_Information"
25825   },
25826   {
25827     "type": "get",
25828     "url": "/api/system/process",
25829     "title": "Gets system information",
25830     "examples": [
25831       {
25832         "title": "Example usage:",
25833         "content": "curl https://{domain}/api/system -v -u {name}:{password}",
25834         "type": "json"
25835       }
25836     ],
25837     "name": "GetSystemInformation",
25838     "group": "System_Information",
25839     "description": "<p>Motion returns the system information.</p>",
25840     "version": "0.0.0",
25841     "filename": "server/api/system/index.js",
25842     "groupTitle": "System_Information"
25843   },
25844   {
25845     "type": "post",
25846     "url": "/api/tags",
25847     "title": "Creates a new Tag",
25848     "examples": [
25849       {
25850         "title": "Example usage:",
25851         "content": "curl https://{domain}/api/tags -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25852         "type": "json"
25853       }
25854     ],
25855     "name": "CreateTags",
25856     "group": "Tags",
25857     "parameter": {
25858       "fields": {
25859         "Body": [
25860           {
25861             "group": "Body",
25862             "type": "String",
25863             "optional": false,
25864             "field": "name",
25865             "description": ""
25866           },
25867           {
25868             "group": "Body",
25869             "type": "String",
25870             "optional": true,
25871             "field": "color",
25872             "description": ""
25873           },
25874           {
25875             "group": "Body",
25876             "type": "String",
25877             "optional": true,
25878             "field": "description",
25879             "description": ""
25880           }
25881         ]
25882       }
25883     },
25884     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25885     "version": "0.0.0",
25886     "filename": "server/api/tag/index.js",
25887     "groupTitle": "Tags"
25888   },
25889   {
25890     "type": "delete",
25891     "url": "/api/tags/{id}",
25892     "title": "Deletes a Tag",
25893     "examples": [
25894       {
25895         "title": "Example usage:",
25896         "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password} -X DELETE",
25897         "type": "json"
25898       }
25899     ],
25900     "name": "DeleteTags",
25901     "group": "Tags",
25902     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25903     "version": "0.0.0",
25904     "filename": "server/api/tag/index.js",
25905     "groupTitle": "Tags"
25906   },
25907   {
25908     "type": "get",
25909     "url": "/api/tags",
25910     "title": "Gets a list of Tags",
25911     "examples": [
25912       {
25913         "title": "Example usage:",
25914         "content": "curl https://{domain}/api/tags -v -u {name}:{password}",
25915         "type": "json"
25916       }
25917     ],
25918     "name": "GetTags",
25919     "group": "Tags",
25920     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25921     "version": "0.0.0",
25922     "filename": "server/api/tag/index.js",
25923     "groupTitle": "Tags"
25924   },
25925   {
25926     "type": "get",
25927     "url": "/api/tags/{id}",
25928     "title": "Gets a single Tag",
25929     "examples": [
25930       {
25931         "title": "Example usage:",
25932         "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password}",
25933         "type": "json"
25934       }
25935     ],
25936     "name": "ShowTags",
25937     "group": "Tags",
25938     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25939     "version": "0.0.0",
25940     "filename": "server/api/tag/index.js",
25941     "groupTitle": "Tags"
25942   },
25943   {
25944     "type": "put",
25945     "url": "/api/tags/{id}",
25946     "title": "Update an existing Tag",
25947     "examples": [
25948       {
25949         "title": "Example usage:",
25950         "content": "curl https://{domain}/api/tags/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
25951         "type": "json"
25952       }
25953     ],
25954     "name": "updateTags",
25955     "group": "Tags",
25956     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25957     "version": "0.0.0",
25958     "filename": "server/api/tag/index.js",
25959     "groupTitle": "Tags"
25960   },
25961   {
25962     "type": "post",
25963     "url": "/api/teams/{id}/queues",
25964     "title": "Add queues to a team",
25965     "examples": [
25966       {
25967         "title": "Example usage:",
25968         "content": "curl https://{domain}/api/teams/{id}/queues -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
25969         "type": "json"
25970       }
25971     ],
25972     "name": "AddQueues",
25973     "group": "Teams",
25974     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25975     "version": "0.0.0",
25976     "filename": "server/api/team/index.js",
25977     "groupTitle": "Teams"
25978   },
25979   {
25980     "type": "post",
25981     "url": "/api/teams",
25982     "title": "Creates a new Team",
25983     "examples": [
25984       {
25985         "title": "Example usage:",
25986         "content": "curl https://{domain}/api/teams -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25987         "type": "json"
25988       }
25989     ],
25990     "name": "CreateTeams",
25991     "group": "Teams",
25992     "parameter": {
25993       "fields": {
25994         "Body": [
25995           {
25996             "group": "Body",
25997             "type": "String",
25998             "optional": false,
25999             "field": "name",
26000             "description": ""
26001           },
26002           {
26003             "group": "Body",
26004             "type": "String",
26005             "optional": true,
26006             "field": "description",
26007             "description": ""
26008           }
26009         ]
26010       }
26011     },
26012     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26013     "version": "0.0.0",
26014     "filename": "server/api/team/index.js",
26015     "groupTitle": "Teams"
26016   },
26017   {
26018     "type": "delete",
26019     "url": "/api/teams/{id}",
26020     "title": "Deletes a Team",
26021     "examples": [
26022       {
26023         "title": "Example usage:",
26024         "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password} -X DELETE",
26025         "type": "json"
26026       }
26027     ],
26028     "name": "DeleteTeams",
26029     "group": "Teams",
26030     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26031     "version": "0.0.0",
26032     "filename": "server/api/team/index.js",
26033     "groupTitle": "Teams"
26034   },
26035   {
26036     "type": "get",
26037     "url": "/api/teams/{id}/users",
26038     "title": "Gets agents from team",
26039     "examples": [
26040       {
26041         "title": "Example usage:",
26042         "content": "curl https://{domain}/api/teams/{id}/users -v -u {name}:{password} -X GET",
26043         "type": "json"
26044       }
26045     ],
26046     "name": "GetAgents",
26047     "group": "Teams",
26048     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26049     "version": "0.0.0",
26050     "filename": "server/api/team/index.js",
26051     "groupTitle": "Teams"
26052   },
26053   {
26054     "type": "get",
26055     "url": "/api/teams/{id}/queues?channel={channel}",
26056     "title": "Gets Queues list",
26057     "examples": [
26058       {
26059         "title": "Example usage:",
26060         "content": "curl https://{domain}/api/teams/{id}/queues?channel={channel} -v -u {name}:{password}",
26061         "type": "json"
26062       }
26063     ],
26064     "name": "GetQueues",
26065     "group": "Teams",
26066     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26067     "version": "0.0.0",
26068     "filename": "server/api/team/index.js",
26069     "groupTitle": "Teams"
26070   },
26071   {
26072     "type": "get",
26073     "url": "/api/teams",
26074     "title": "Gets a list of Teams",
26075     "examples": [
26076       {
26077         "title": "Example usage:",
26078         "content": "curl https://{domain}/api/teams -v -u {name}:{password}",
26079         "type": "json"
26080       }
26081     ],
26082     "name": "GetTeams",
26083     "group": "Teams",
26084     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26085     "version": "0.0.0",
26086     "filename": "server/api/team/index.js",
26087     "groupTitle": "Teams"
26088   },
26089   {
26090     "type": "delete",
26091     "url": "/api/teams/{id}/users",
26092     "title": "Removes agents from a team",
26093     "examples": [
26094       {
26095         "title": "Example usage:",
26096         "content": "curl https://{domain}/api/teams/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
26097         "type": "json"
26098       }
26099     ],
26100     "name": "RemoveAgents",
26101     "group": "Teams",
26102     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26103     "version": "0.0.0",
26104     "filename": "server/api/team/index.js",
26105     "groupTitle": "Teams"
26106   },
26107   {
26108     "type": "delete",
26109     "url": "/api/teams/{id}/queues",
26110     "title": "Remove queues to a team",
26111     "examples": [
26112       {
26113         "title": "Example usage:",
26114         "content": "curl https://{domain}/api/teams/{id}/queues?channel=voice&ids=1&ids=2 -v -u {name}:{password} -X DELETE",
26115         "type": "json"
26116       }
26117     ],
26118     "name": "RemoveQueues",
26119     "group": "Teams",
26120     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26121     "version": "0.0.0",
26122     "filename": "server/api/team/index.js",
26123     "groupTitle": "Teams"
26124   },
26125   {
26126     "type": "delete",
26127     "url": "/api/whatsapp/queues/{id}/teams",
26128     "title": "Remove teams from a queue",
26129     "examples": [
26130       {
26131         "title": "Example usage:",
26132         "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26133         "type": "json"
26134       }
26135     ],
26136     "name": "RemoveTeams",
26137     "group": "Teams",
26138     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26139     "version": "0.0.0",
26140     "filename": "server/api/whatsappQueue/index.js",
26141     "groupTitle": "Teams"
26142   },
26143   {
26144     "type": "delete",
26145     "url": "/api/openchannel/queues/{id}/teams",
26146     "title": "Remove teams from a queue",
26147     "examples": [
26148       {
26149         "title": "Example usage:",
26150         "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26151         "type": "json"
26152       }
26153     ],
26154     "name": "RemoveTeams",
26155     "group": "Teams",
26156     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26157     "version": "0.0.0",
26158     "filename": "server/api/openchannelQueue/index.js",
26159     "groupTitle": "Teams"
26160   },
26161   {
26162     "type": "delete",
26163     "url": "/api/voice/queues/{id}/teams",
26164     "title": "Remove teams from a queue",
26165     "examples": [
26166       {
26167         "title": "Example usage:",
26168         "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26169         "type": "json"
26170       }
26171     ],
26172     "name": "RemoveTeams",
26173     "group": "Teams",
26174     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26175     "version": "0.0.0",
26176     "filename": "server/api/voiceQueue/index.js",
26177     "groupTitle": "Teams"
26178   },
26179   {
26180     "type": "delete",
26181     "url": "/api/sms/queues/{id}/teams",
26182     "title": "Remove teams from a queue",
26183     "examples": [
26184       {
26185         "title": "Example usage:",
26186         "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26187         "type": "json"
26188       }
26189     ],
26190     "name": "RemoveTeams",
26191     "group": "Teams",
26192     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26193     "version": "0.0.0",
26194     "filename": "server/api/smsQueue/index.js",
26195     "groupTitle": "Teams"
26196   },
26197   {
26198     "type": "delete",
26199     "url": "/api/chat/queues/{id}/teams",
26200     "title": "Remove teams from a queue",
26201     "examples": [
26202       {
26203         "title": "Example usage:",
26204         "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26205         "type": "json"
26206       }
26207     ],
26208     "name": "RemoveTeams",
26209     "group": "Teams",
26210     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26211     "version": "0.0.0",
26212     "filename": "server/api/chatQueue/index.js",
26213     "groupTitle": "Teams"
26214   },
26215   {
26216     "type": "delete",
26217     "url": "/api/mail/queues/{id}/teams",
26218     "title": "Remove teams from a queue",
26219     "examples": [
26220       {
26221         "title": "Example usage:",
26222         "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26223         "type": "json"
26224       }
26225     ],
26226     "name": "RemoveTeams",
26227     "group": "Teams",
26228     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26229     "version": "0.0.0",
26230     "filename": "server/api/mailQueue/index.js",
26231     "groupTitle": "Teams"
26232   },
26233   {
26234     "type": "delete",
26235     "url": "/api/fax/queues/{id}/teams",
26236     "title": "Remove teams from a queue",
26237     "examples": [
26238       {
26239         "title": "Example usage:",
26240         "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26241         "type": "json"
26242       }
26243     ],
26244     "name": "RemoveTeams",
26245     "group": "Teams",
26246     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26247     "version": "0.0.0",
26248     "filename": "server/api/faxQueue/index.js",
26249     "groupTitle": "Teams"
26250   },
26251   {
26252     "type": "get",
26253     "url": "/api/teams/{id}",
26254     "title": "Gets a single Team",
26255     "examples": [
26256       {
26257         "title": "Example usage:",
26258         "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password}",
26259         "type": "json"
26260       }
26261     ],
26262     "name": "ShowTeams",
26263     "group": "Teams",
26264     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26265     "version": "0.0.0",
26266     "filename": "server/api/team/index.js",
26267     "groupTitle": "Teams"
26268   },
26269   {
26270     "type": "post",
26271     "url": "/api/teams/{id}/users",
26272     "title": "Adds agents to a team",
26273     "examples": [
26274       {
26275         "title": "Example usage:",
26276         "content": "curl https://{domain}/api/teams/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26277         "type": "json"
26278       }
26279     ],
26280     "name": "addAgents",
26281     "group": "Teams",
26282     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26283     "version": "0.0.0",
26284     "filename": "server/api/team/index.js",
26285     "groupTitle": "Teams"
26286   },
26287   {
26288     "type": "put",
26289     "url": "/api/teams/{id}",
26290     "title": "Update an existing Team",
26291     "examples": [
26292       {
26293         "title": "Example usage:",
26294         "content": "curl https://{domain}/api/teams/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26295         "type": "json"
26296       }
26297     ],
26298     "name": "updateTeams",
26299     "group": "Teams",
26300     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26301     "version": "0.0.0",
26302     "filename": "server/api/team/index.js",
26303     "groupTitle": "Teams"
26304   },
26305   {
26306     "type": "post",
26307     "url": "/api/templates",
26308     "title": "Creates a new Template",
26309     "examples": [
26310       {
26311         "title": "Example usage:",
26312         "content": "curl https://{domain}/api/templates -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26313         "type": "json"
26314       }
26315     ],
26316     "name": "CreateTemplates",
26317     "group": "Templates",
26318     "parameter": {
26319       "fields": {
26320         "Body": [
26321           {
26322             "group": "Body",
26323             "type": "String",
26324             "optional": true,
26325             "field": "name",
26326             "description": ""
26327           },
26328           {
26329             "group": "Body",
26330             "type": "String",
26331             "optional": true,
26332             "field": "description",
26333             "description": ""
26334           },
26335           {
26336             "group": "Body",
26337             "type": "Text",
26338             "optional": true,
26339             "field": "html",
26340             "description": ""
26341           }
26342         ]
26343       }
26344     },
26345     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26346     "version": "0.0.0",
26347     "filename": "server/api/template/index.js",
26348     "groupTitle": "Templates"
26349   },
26350   {
26351     "type": "delete",
26352     "url": "/api/templates/{id}",
26353     "title": "Deletes a Template",
26354     "examples": [
26355       {
26356         "title": "Example usage:",
26357         "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password} -X DELETE",
26358         "type": "json"
26359       }
26360     ],
26361     "name": "DeleteTemplates",
26362     "group": "Templates",
26363     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26364     "version": "0.0.0",
26365     "filename": "server/api/template/index.js",
26366     "groupTitle": "Templates"
26367   },
26368   {
26369     "type": "get",
26370     "url": "/api/templates",
26371     "title": "Gets a list of Templates",
26372     "examples": [
26373       {
26374         "title": "Example usage:",
26375         "content": "curl https://{domain}/api/templates -v -u {name}:{password}",
26376         "type": "json"
26377       }
26378     ],
26379     "name": "GetTemplates",
26380     "group": "Templates",
26381     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26382     "version": "0.0.0",
26383     "filename": "server/api/template/index.js",
26384     "groupTitle": "Templates"
26385   },
26386   {
26387     "type": "get",
26388     "url": "/api/templates/{id}",
26389     "title": "Gets a single Template",
26390     "examples": [
26391       {
26392         "title": "Example usage:",
26393         "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password}",
26394         "type": "json"
26395       }
26396     ],
26397     "name": "ShowTemplates",
26398     "group": "Templates",
26399     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26400     "version": "0.0.0",
26401     "filename": "server/api/template/index.js",
26402     "groupTitle": "Templates"
26403   },
26404   {
26405     "type": "put",
26406     "url": "/api/templates/{id}",
26407     "title": "Update an existing Template",
26408     "examples": [
26409       {
26410         "title": "Example usage:",
26411         "content": "curl https://{domain}/api/templates/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26412         "type": "json"
26413       }
26414     ],
26415     "name": "updateTemplates",
26416     "group": "Templates",
26417     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26418     "version": "0.0.0",
26419     "filename": "server/api/template/index.js",
26420     "groupTitle": "Templates"
26421   },
26422   {
26423     "type": "post",
26424     "url": "/api/triggers",
26425     "title": "Creates a new Trigger",
26426     "examples": [
26427       {
26428         "title": "Example usage:",
26429         "content": "curl https://{domain}/api/triggers -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26430         "type": "json"
26431       }
26432     ],
26433     "name": "CreateTriggers",
26434     "group": "Triggers",
26435     "parameter": {
26436       "fields": {
26437         "Body": [
26438           {
26439             "group": "Body",
26440             "type": "String",
26441             "optional": true,
26442             "field": "name",
26443             "description": ""
26444           },
26445           {
26446             "group": "Body",
26447             "type": "String",
26448             "optional": true,
26449             "field": "channel",
26450             "description": ""
26451           },
26452           {
26453             "group": "Body",
26454             "type": "String",
26455             "optional": true,
26456             "field": "description",
26457             "description": ""
26458           },
26459           {
26460             "group": "Body",
26461             "type": "Boolean",
26462             "optional": true,
26463             "field": "status",
26464             "description": ""
26465           }
26466         ]
26467       }
26468     },
26469     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26470     "version": "0.0.0",
26471     "filename": "server/api/trigger/index.js",
26472     "groupTitle": "Triggers"
26473   },
26474   {
26475     "type": "delete",
26476     "url": "/api/triggers/{id}",
26477     "title": "Deletes a Trigger",
26478     "examples": [
26479       {
26480         "title": "Example usage:",
26481         "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password} -X DELETE",
26482         "type": "json"
26483       }
26484     ],
26485     "name": "DeleteTriggers",
26486     "group": "Triggers",
26487     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26488     "version": "0.0.0",
26489     "filename": "server/api/trigger/index.js",
26490     "groupTitle": "Triggers"
26491   },
26492   {
26493     "type": "get",
26494     "url": "/api/triggers",
26495     "title": "Gets a list of Triggers",
26496     "examples": [
26497       {
26498         "title": "Example usage:",
26499         "content": "curl https://{domain}/api/triggers -v -u {name}:{password}",
26500         "type": "json"
26501       }
26502     ],
26503     "name": "GetTriggers",
26504     "group": "Triggers",
26505     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26506     "version": "0.0.0",
26507     "filename": "server/api/trigger/index.js",
26508     "groupTitle": "Triggers"
26509   },
26510   {
26511     "type": "get",
26512     "url": "/api/triggers/{id}",
26513     "title": "Gets a single Trigger",
26514     "examples": [
26515       {
26516         "title": "Example usage:",
26517         "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password}",
26518         "type": "json"
26519       }
26520     ],
26521     "name": "ShowTriggers",
26522     "group": "Triggers",
26523     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26524     "version": "0.0.0",
26525     "filename": "server/api/trigger/index.js",
26526     "groupTitle": "Triggers"
26527   },
26528   {
26529     "type": "post",
26530     "url": "/api/triggers/{id}/actions",
26531     "title": "Creates new actions",
26532     "examples": [
26533       {
26534         "title": "Example usage:",
26535         "content": "curl https://{domain}/api/triggers/{id}/actions -d '{\"action\": \"contactManager\",\"data1\": \"1\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26536         "type": "json"
26537       }
26538     ],
26539     "name": "addAction",
26540     "group": "Triggers",
26541     "parameter": {
26542       "fields": {
26543         "Body": [
26544           {
26545             "group": "Body",
26546             "type": "Virtual",
26547             "optional": true,
26548             "field": "name",
26549             "description": ""
26550           },
26551           {
26552             "group": "Body",
26553             "type": "String",
26554             "optional": false,
26555             "field": "action",
26556             "description": "<p>Allowed values: contactManager, integration, motionbar, jscripty, urlForward, browser, bot, script</p>"
26557           },
26558           {
26559             "group": "Body",
26560             "type": "String",
26561             "optional": true,
26562             "field": "data1",
26563             "description": "<p>contactManager[ListId], integration[intName(zendesk)], motionbar[Popup(0),URL(1),WinApp(2)], urlForward[GET,POST], browser[TemplateId(0),URL(1)]</p>"
26564           },
26565           {
26566             "group": "Body",
26567             "type": "String",
26568             "optional": true,
26569             "field": "data2",
26570             "description": "<p>integration[AccountId], motionbar[TemplateId,URL,WinAppPath], urlForward[URL]</p>"
26571           },
26572           {
26573             "group": "Body",
26574             "type": "String",
26575             "optional": true,
26576             "field": "data3",
26577             "description": "<p>motionbar[NULL,NULL,WinAppArguments]</p>"
26578           },
26579           {
26580             "group": "Body",
26581             "type": "String",
26582             "optional": true,
26583             "field": "data4",
26584             "description": ""
26585           },
26586           {
26587             "group": "Body",
26588             "type": "String",
26589             "optional": true,
26590             "field": "data5",
26591             "description": ""
26592           },
26593           {
26594             "group": "Body",
26595             "type": "String",
26596             "optional": true,
26597             "field": "data6",
26598             "description": ""
26599           },
26600           {
26601             "group": "Body",
26602             "type": "Text",
26603             "optional": true,
26604             "field": "data7",
26605             "description": ""
26606           }
26607         ]
26608       }
26609     },
26610     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26611     "version": "0.0.0",
26612     "filename": "server/api/trigger/index.js",
26613     "groupTitle": "Triggers"
26614   },
26615   {
26616     "type": "post",
26617     "url": "/api/triggers/{id}/all_conditions",
26618     "title": "Creates a new \"AND\"condition",
26619     "examples": [
26620       {
26621         "title": "Example usage:",
26622         "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",
26623         "type": "json"
26624       }
26625     ],
26626     "name": "addAllCondition",
26627     "group": "Triggers",
26628     "parameter": {
26629       "fields": {
26630         "Body": [
26631           {
26632             "group": "Body",
26633             "type": "Virtual",
26634             "optional": true,
26635             "field": "name",
26636             "description": ""
26637           },
26638           {
26639             "group": "Body",
26640             "type": "String",
26641             "optional": false,
26642             "field": "field",
26643             "description": ""
26644           },
26645           {
26646             "group": "Body",
26647             "type": "String",
26648             "optional": false,
26649             "field": "operator",
26650             "description": ""
26651           },
26652           {
26653             "group": "Body",
26654             "type": "String",
26655             "optional": false,
26656             "field": "value",
26657             "description": ""
26658           }
26659         ]
26660       }
26661     },
26662     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26663     "version": "0.0.0",
26664     "filename": "server/api/trigger/index.js",
26665     "groupTitle": "Triggers"
26666   },
26667   {
26668     "type": "post",
26669     "url": "/api/triggers/{id}/any_conditions",
26670     "title": "Creates a new \"OR\"condition",
26671     "examples": [
26672       {
26673         "title": "Example usage:",
26674         "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",
26675         "type": "json"
26676       }
26677     ],
26678     "name": "addAnyCondition",
26679     "group": "Triggers",
26680     "parameter": {
26681       "fields": {
26682         "Body": [
26683           {
26684             "group": "Body",
26685             "type": "Virtual",
26686             "optional": true,
26687             "field": "name",
26688             "description": ""
26689           },
26690           {
26691             "group": "Body",
26692             "type": "String",
26693             "optional": false,
26694             "field": "field",
26695             "description": ""
26696           },
26697           {
26698             "group": "Body",
26699             "type": "String",
26700             "optional": false,
26701             "field": "operator",
26702             "description": ""
26703           },
26704           {
26705             "group": "Body",
26706             "type": "String",
26707             "optional": false,
26708             "field": "value",
26709             "description": ""
26710           }
26711         ]
26712       }
26713     },
26714     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26715     "version": "0.0.0",
26716     "filename": "server/api/trigger/index.js",
26717     "groupTitle": "Triggers"
26718   },
26719   {
26720     "type": "get",
26721     "url": "/api/triggers/{id}/actions",
26722     "title": "Gets Trigger Actions",
26723     "examples": [
26724       {
26725         "title": "Example usage:",
26726         "content": "curl https://{domain}/api/triggers/{id}/actions -v -u {name}:{password} -X GET",
26727         "type": "json"
26728       }
26729     ],
26730     "name": "getActions",
26731     "group": "Triggers",
26732     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26733     "version": "0.0.0",
26734     "filename": "server/api/trigger/index.js",
26735     "groupTitle": "Triggers"
26736   },
26737   {
26738     "type": "get",
26739     "url": "/api/triggers/{id}/all_conditions",
26740     "title": "Gets \"AND\" Trigger Conditions",
26741     "examples": [
26742       {
26743         "title": "Example usage:",
26744         "content": "curl https://{domain}/api/triggers/{id}/all_conditions -v -u {name}:{password} -X GET",
26745         "type": "json"
26746       }
26747     ],
26748     "name": "getAllConditions",
26749     "group": "Triggers",
26750     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26751     "version": "0.0.0",
26752     "filename": "server/api/trigger/index.js",
26753     "groupTitle": "Triggers"
26754   },
26755   {
26756     "type": "get",
26757     "url": "/api/triggers/{id}/any_conditions",
26758     "title": "Gets \"OR\" Trigger Conditions",
26759     "examples": [
26760       {
26761         "title": "Example usage:",
26762         "content": "curl https://{domain}/api/triggers/{id}/any_conditions -v -u {name}:{password} -X GET",
26763         "type": "json"
26764       }
26765     ],
26766     "name": "getAnyConditions",
26767     "group": "Triggers",
26768     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26769     "version": "0.0.0",
26770     "filename": "server/api/trigger/index.js",
26771     "groupTitle": "Triggers"
26772   },
26773   {
26774     "type": "put",
26775     "url": "/api/triggers/{id}",
26776     "title": "Update an existing Trigger",
26777     "examples": [
26778       {
26779         "title": "Example usage:",
26780         "content": "curl https://{domain}/api/triggers/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26781         "type": "json"
26782       }
26783     ],
26784     "name": "updateTriggers",
26785     "group": "Triggers",
26786     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26787     "version": "0.0.0",
26788     "filename": "server/api/trigger/index.js",
26789     "groupTitle": "Triggers"
26790   },
26791   {
26792     "type": "post",
26793     "url": "/api/trunks/clone",
26794     "title": "Clone an existing Trunk",
26795     "examples": [
26796       {
26797         "title": "Example usage:",
26798         "content": "curl https://{domain}/api/trunks/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26799         "type": "json"
26800       }
26801     ],
26802     "name": "CloneTrunks",
26803     "group": "Trunks",
26804     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26805     "version": "0.0.0",
26806     "filename": "server/api/trunk/index.js",
26807     "groupTitle": "Trunks"
26808   },
26809   {
26810     "type": "post",
26811     "url": "/api/trunks",
26812     "title": "Create a new trunk",
26813     "examples": [
26814       {
26815         "title": "Example usage:",
26816         "content": "curl https://{domain}/api/trunks -v -u {name}:{password} -X POST",
26817         "type": "json"
26818       }
26819     ],
26820     "name": "Create",
26821     "group": "Trunks",
26822     "parameter": {
26823       "fields": {
26824         "Body": [
26825           {
26826             "group": "Body",
26827             "type": "String",
26828             "optional": false,
26829             "field": "name",
26830             "description": ""
26831           },
26832           {
26833             "group": "Body",
26834             "type": "String",
26835             "allowedValues": [
26836               "\"friend\"",
26837               "\"user\"",
26838               "\"peer\""
26839             ],
26840             "optional": false,
26841             "field": "type",
26842             "description": ""
26843           },
26844           {
26845             "group": "Body",
26846             "type": "String",
26847             "optional": false,
26848             "field": "context",
26849             "description": ""
26850           },
26851           {
26852             "group": "Body",
26853             "type": "String",
26854             "allowedValues": [
26855               "\"ALLOWED_NOT_SCREENED\"",
26856               "\"ALLOWED_PASSED_SCREEN\"",
26857               "\"ALLOWED_FAILED_SCREEN\"",
26858               "\"ALLOWED\"",
26859               "\"PROHIB_NOT_SCREENED\"",
26860               "\"PROHIB_PASSED_SCREEN\"",
26861               "\"PROHIB_FAILED_SCREEN\"",
26862               "\"PROHIB\""
26863             ],
26864             "optional": true,
26865             "field": "callingpres",
26866             "description": ""
26867           },
26868           {
26869             "group": "Body",
26870             "type": "String",
26871             "optional": true,
26872             "field": "deny",
26873             "description": ""
26874           },
26875           {
26876             "group": "Body",
26877             "type": "String",
26878             "optional": true,
26879             "field": "permit",
26880             "description": ""
26881           },
26882           {
26883             "group": "Body",
26884             "type": "String",
26885             "optional": true,
26886             "field": "secret",
26887             "description": ""
26888           },
26889           {
26890             "group": "Body",
26891             "type": "String",
26892             "optional": true,
26893             "field": "md5secret",
26894             "description": ""
26895           },
26896           {
26897             "group": "Body",
26898             "type": "String",
26899             "optional": true,
26900             "field": "remotesecret",
26901             "description": ""
26902           },
26903           {
26904             "group": "Body",
26905             "type": "String",
26906             "optional": true,
26907             "field": "transport",
26908             "description": "<p>String is deprecated. Please use an Array as [&quot;udp&quot;, &quot;tcp&quot;]</p>"
26909           },
26910           {
26911             "group": "Body",
26912             "type": "String",
26913             "allowedValues": [
26914               "\"rfc2833\"",
26915               "\"info\"",
26916               "\"shortinfo\"",
26917               "\"inband\"",
26918               "\"auto\""
26919             ],
26920             "optional": true,
26921             "field": "dtmfmode",
26922             "description": ""
26923           },
26924           {
26925             "group": "Body",
26926             "type": "String",
26927             "allowedValues": [
26928               "\"yes\"",
26929               "\"no\"",
26930               "\"nonat\"",
26931               "\"update\"",
26932               "\"outgoing\""
26933             ],
26934             "optional": true,
26935             "field": "directmedia",
26936             "description": ""
26937           },
26938           {
26939             "group": "Body",
26940             "type": "String",
26941             "allowedValues": [
26942               "\"yes\"",
26943               "\"no\""
26944             ],
26945             "optional": true,
26946             "field": "directrtpsetup",
26947             "description": ""
26948           },
26949           {
26950             "group": "Body",
26951             "type": "String",
26952             "optional": true,
26953             "field": "directmediapermit",
26954             "description": ""
26955           },
26956           {
26957             "group": "Body",
26958             "type": "String",
26959             "optional": true,
26960             "field": "directmediadeny",
26961             "description": ""
26962           },
26963           {
26964             "group": "Body",
26965             "type": "String",
26966             "optional": true,
26967             "field": "nat",
26968             "description": "<p>String is deprecated. Please use an Array as [&quot;force_rport&quot;, &quot;comedia&quot;]</p>"
26969           },
26970           {
26971             "group": "Body",
26972             "type": "String",
26973             "optional": true,
26974             "field": "callgroup",
26975             "description": ""
26976           },
26977           {
26978             "group": "Body",
26979             "type": "String",
26980             "optional": true,
26981             "field": "namedcallgroup",
26982             "description": ""
26983           },
26984           {
26985             "group": "Body",
26986             "type": "String",
26987             "optional": true,
26988             "field": "pickupgroup",
26989             "description": ""
26990           },
26991           {
26992             "group": "Body",
26993             "type": "String",
26994             "optional": true,
26995             "field": "namedpickupgroup",
26996             "description": ""
26997           },
26998           {
26999             "group": "Body",
27000             "type": "String",
27001             "optional": true,
27002             "field": "language",
27003             "description": ""
27004           },
27005           {
27006             "group": "Body",
27007             "type": "String",
27008             "optional": true,
27009             "field": "tonezone",
27010             "description": ""
27011           },
27012           {
27013             "group": "Body",
27014             "type": "String",
27015             "optional": true,
27016             "field": "disallow",
27017             "description": ""
27018           },
27019           {
27020             "group": "Body",
27021             "type": "String",
27022             "optional": false,
27023             "field": "allow",
27024             "description": "<p>String is deprecated. Please use an Array as [&quot;ulaw&quot;, &quot;alaw&quot;, &quot;alaw&quot;]</p>"
27025           },
27026           {
27027             "group": "Body",
27028             "type": "String",
27029             "allowedValues": [
27030               "\"yes\"",
27031               "\"no\""
27032             ],
27033             "optional": true,
27034             "field": "autoframing",
27035             "description": ""
27036           },
27037           {
27038             "group": "Body",
27039             "type": "String",
27040             "optional": true,
27041             "field": "insecure",
27042             "description": "<p>String is deprecated. Please use an Array as [&quot;port&quot;, &quot;invite&quot;]</p>"
27043           },
27044           {
27045             "group": "Body",
27046             "type": "String",
27047             "allowedValues": [
27048               "\"yes\"",
27049               "\"no\""
27050             ],
27051             "optional": true,
27052             "field": "trustrpid",
27053             "description": ""
27054           },
27055           {
27056             "group": "Body",
27057             "type": "String",
27058             "allowedValues": [
27059               "\"yes\"",
27060               "\"no\""
27061             ],
27062             "optional": true,
27063             "field": "trust_id_outbound",
27064             "description": ""
27065           },
27066           {
27067             "group": "Body",
27068             "type": "String",
27069             "allowedValues": [
27070               "\"yes\"",
27071               "\"no\"",
27072               "\"never\""
27073             ],
27074             "optional": true,
27075             "field": "progressinband",
27076             "description": ""
27077           },
27078           {
27079             "group": "Body",
27080             "type": "String",
27081             "allowedValues": [
27082               "\"yes\"",
27083               "\"no\""
27084             ],
27085             "optional": true,
27086             "field": "promiscredir",
27087             "description": ""
27088           },
27089           {
27090             "group": "Body",
27091             "type": "String",
27092             "allowedValues": [
27093               "\"yes\"",
27094               "\"no\""
27095             ],
27096             "optional": true,
27097             "field": "useclientcode",
27098             "description": ""
27099           },
27100           {
27101             "group": "Body",
27102             "type": "Integer",
27103             "optional": true,
27104             "field": "accountcode",
27105             "description": ""
27106           },
27107           {
27108             "group": "Body",
27109             "type": "String",
27110             "optional": true,
27111             "field": "setvar",
27112             "description": ""
27113           },
27114           {
27115             "group": "Body",
27116             "type": "String",
27117             "optional": true,
27118             "field": "callerid",
27119             "description": ""
27120           },
27121           {
27122             "group": "Body",
27123             "type": "String",
27124             "optional": true,
27125             "field": "amaflags",
27126             "description": ""
27127           },
27128           {
27129             "group": "Body",
27130             "type": "String",
27131             "allowedValues": [
27132               "\"yes\"",
27133               "\"no\""
27134             ],
27135             "optional": true,
27136             "field": "callcounter",
27137             "description": ""
27138           },
27139           {
27140             "group": "Body",
27141             "type": "Integer",
27142             "optional": true,
27143             "field": "busylevel",
27144             "description": ""
27145           },
27146           {
27147             "group": "Body",
27148             "type": "String",
27149             "allowedValues": [
27150               "\"yes\"",
27151               "\"no\""
27152             ],
27153             "optional": true,
27154             "field": "allowoverlap",
27155             "description": ""
27156           },
27157           {
27158             "group": "Body",
27159             "type": "String",
27160             "allowedValues": [
27161               "\"yes\"",
27162               "\"no\""
27163             ],
27164             "optional": true,
27165             "field": "allowsubscribe",
27166             "description": ""
27167           },
27168           {
27169             "group": "Body",
27170             "type": "String",
27171             "allowedValues": [
27172               "\"yes\"",
27173               "\"no\""
27174             ],
27175             "optional": true,
27176             "field": "allowtransfer",
27177             "description": ""
27178           },
27179           {
27180             "group": "Body",
27181             "type": "String",
27182             "allowedValues": [
27183               "\"yes\"",
27184               "\"no\""
27185             ],
27186             "optional": true,
27187             "field": "ignoresdpversion",
27188             "description": ""
27189           },
27190           {
27191             "group": "Body",
27192             "type": "String",
27193             "optional": true,
27194             "field": "subscribecontext",
27195             "description": ""
27196           },
27197           {
27198             "group": "Body",
27199             "type": "String",
27200             "optional": true,
27201             "field": "template",
27202             "description": ""
27203           },
27204           {
27205             "group": "Body",
27206             "type": "String",
27207             "allowedValues": [
27208               "\"yes\"",
27209               "\"no\"",
27210               "\"always\""
27211             ],
27212             "optional": true,
27213             "field": "videosupport",
27214             "description": ""
27215           },
27216           {
27217             "group": "Body",
27218             "type": "Integer",
27219             "optional": true,
27220             "field": "maxcallbitrate",
27221             "description": ""
27222           },
27223           {
27224             "group": "Body",
27225             "type": "String",
27226             "allowedValues": [
27227               "\"yes\"",
27228               "\"no\""
27229             ],
27230             "optional": true,
27231             "field": "rfc2833compensate",
27232             "description": ""
27233           },
27234           {
27235             "group": "Body",
27236             "type": "String",
27237             "optional": true,
27238             "field": "mailbox",
27239             "description": ""
27240           },
27241           {
27242             "group": "Body",
27243             "type": "String",
27244             "allowedValues": [
27245               "\"accept\"",
27246               "\"refuse\"",
27247               "\"originate\""
27248             ],
27249             "optional": true,
27250             "field": "session_timers",
27251             "description": ""
27252           },
27253           {
27254             "group": "Body",
27255             "type": "Integer",
27256             "optional": true,
27257             "field": "session_expires",
27258             "description": ""
27259           },
27260           {
27261             "group": "Body",
27262             "type": "Integer",
27263             "optional": true,
27264             "field": "session_minse",
27265             "description": ""
27266           },
27267           {
27268             "group": "Body",
27269             "type": "String",
27270             "allowedValues": [
27271               "\"uac\"",
27272               "\"uas\""
27273             ],
27274             "optional": true,
27275             "field": "session_refresher",
27276             "description": ""
27277           },
27278           {
27279             "group": "Body",
27280             "type": "String",
27281             "optional": true,
27282             "field": "t38pt_usertpsource",
27283             "description": ""
27284           },
27285           {
27286             "group": "Body",
27287             "type": "String",
27288             "optional": true,
27289             "field": "regexten",
27290             "description": ""
27291           },
27292           {
27293             "group": "Body",
27294             "type": "String",
27295             "optional": true,
27296             "field": "fromdomain",
27297             "description": ""
27298           },
27299           {
27300             "group": "Body",
27301             "type": "String",
27302             "optional": true,
27303             "field": "fromuser",
27304             "description": ""
27305           },
27306           {
27307             "group": "Body",
27308             "type": "Integer",
27309             "optional": true,
27310             "field": "port",
27311             "description": ""
27312           },
27313           {
27314             "group": "Body",
27315             "type": "String",
27316             "allowedValues": [
27317               "\"yes\"",
27318               "\"no\""
27319             ],
27320             "optional": true,
27321             "field": "qualify",
27322             "description": ""
27323           },
27324           {
27325             "group": "Body",
27326             "type": "Integer",
27327             "optional": true,
27328             "field": "keepalive",
27329             "description": ""
27330           },
27331           {
27332             "group": "Body",
27333             "type": "String",
27334             "optional": true,
27335             "field": "defaultip",
27336             "description": ""
27337           },
27338           {
27339             "group": "Body",
27340             "type": "String",
27341             "optional": true,
27342             "field": "defaultuser",
27343             "description": ""
27344           },
27345           {
27346             "group": "Body",
27347             "type": "Integer",
27348             "optional": true,
27349             "field": "rtptimeout",
27350             "description": ""
27351           },
27352           {
27353             "group": "Body",
27354             "type": "Integer",
27355             "optional": true,
27356             "field": "rtpholdtimeout",
27357             "description": ""
27358           },
27359           {
27360             "group": "Body",
27361             "type": "Integer",
27362             "optional": true,
27363             "field": "rtpkeepalive",
27364             "description": ""
27365           },
27366           {
27367             "group": "Body",
27368             "type": "String",
27369             "allowedValues": [
27370               "\"yes\"",
27371               "\"no\"",
27372               "\"pai\""
27373             ],
27374             "optional": true,
27375             "field": "sendrpid",
27376             "description": ""
27377           },
27378           {
27379             "group": "Body",
27380             "type": "String",
27381             "optional": true,
27382             "field": "outboundproxy",
27383             "description": ""
27384           },
27385           {
27386             "group": "Body",
27387             "type": "String",
27388             "optional": true,
27389             "field": "callbackextension",
27390             "description": ""
27391           },
27392           {
27393             "group": "Body",
27394             "type": "Integer",
27395             "optional": true,
27396             "field": "timert1",
27397             "description": ""
27398           },
27399           {
27400             "group": "Body",
27401             "type": "Integer",
27402             "optional": true,
27403             "field": "timerb",
27404             "description": ""
27405           },
27406           {
27407             "group": "Body",
27408             "type": "Integer",
27409             "optional": true,
27410             "field": "qualifyfreq",
27411             "description": ""
27412           },
27413           {
27414             "group": "Body",
27415             "type": "String",
27416             "optional": true,
27417             "field": "contactpermit",
27418             "description": ""
27419           },
27420           {
27421             "group": "Body",
27422             "type": "String",
27423             "optional": true,
27424             "field": "contactdeny",
27425             "description": ""
27426           },
27427           {
27428             "group": "Body",
27429             "type": "String",
27430             "optional": true,
27431             "field": "contactacl",
27432             "description": ""
27433           },
27434           {
27435             "group": "Body",
27436             "type": "String",
27437             "optional": true,
27438             "field": "unsolicited_mailbox",
27439             "description": ""
27440           },
27441           {
27442             "group": "Body",
27443             "type": "String",
27444             "optional": true,
27445             "field": "use_q850_reason",
27446             "description": ""
27447           },
27448           {
27449             "group": "Body",
27450             "type": "Integer",
27451             "optional": true,
27452             "field": "maxforwards",
27453             "description": ""
27454           },
27455           {
27456             "group": "Body",
27457             "type": "String",
27458             "allowedValues": [
27459               "\"yes\"",
27460               "\"no\""
27461             ],
27462             "optional": true,
27463             "field": "encryption",
27464             "description": ""
27465           },
27466           {
27467             "group": "Body",
27468             "type": "String",
27469             "allowedValues": [
27470               "\"yes\"",
27471               "\"no\""
27472             ],
27473             "optional": true,
27474             "field": "avpf",
27475             "description": ""
27476           },
27477           {
27478             "group": "Body",
27479             "type": "String",
27480             "allowedValues": [
27481               "\"yes\"",
27482               "\"no\""
27483             ],
27484             "optional": true,
27485             "field": "force_avp",
27486             "description": ""
27487           },
27488           {
27489             "group": "Body",
27490             "type": "String",
27491             "allowedValues": [
27492               "\"yes\"",
27493               "\"no\""
27494             ],
27495             "optional": true,
27496             "field": "icesupport",
27497             "description": ""
27498           },
27499           {
27500             "group": "Body",
27501             "type": "String",
27502             "allowedValues": [
27503               "\"yes\"",
27504               "\"no\""
27505             ],
27506             "optional": true,
27507             "field": "dtlsenable",
27508             "description": ""
27509           },
27510           {
27511             "group": "Body",
27512             "type": "String",
27513             "allowedValues": [
27514               "\"yes\"",
27515               "\"no\"",
27516               "\"fingerprint\"",
27517               "\"certificate\""
27518             ],
27519             "optional": true,
27520             "field": "dtlsverify",
27521             "description": ""
27522           },
27523           {
27524             "group": "Body",
27525             "type": "Integer",
27526             "optional": true,
27527             "field": "dtlsrekey",
27528             "description": ""
27529           },
27530           {
27531             "group": "Body",
27532             "type": "String",
27533             "optional": true,
27534             "field": "dtlscertfile",
27535             "description": ""
27536           },
27537           {
27538             "group": "Body",
27539             "type": "String",
27540             "optional": true,
27541             "field": "dtlsprivatekey",
27542             "description": ""
27543           },
27544           {
27545             "group": "Body",
27546             "type": "String",
27547             "optional": true,
27548             "field": "dtlscipher",
27549             "description": ""
27550           },
27551           {
27552             "group": "Body",
27553             "type": "String",
27554             "optional": true,
27555             "field": "dtlscafile",
27556             "description": ""
27557           },
27558           {
27559             "group": "Body",
27560             "type": "String",
27561             "optional": true,
27562             "field": "dtlscapath",
27563             "description": ""
27564           },
27565           {
27566             "group": "Body",
27567             "type": "String",
27568             "allowedValues": [
27569               "\"active\"",
27570               "\"passive\"",
27571               "\"actpass\""
27572             ],
27573             "optional": true,
27574             "field": "dtlssetup",
27575             "description": ""
27576           },
27577           {
27578             "group": "Body",
27579             "type": "String",
27580             "optional": true,
27581             "field": "dtlsfingerprint",
27582             "description": ""
27583           },
27584           {
27585             "group": "Body",
27586             "type": "String",
27587             "allowedValues": [
27588               "\"yes\"",
27589               "\"no\""
27590             ],
27591             "optional": true,
27592             "field": "usereqphone",
27593             "description": ""
27594           },
27595           {
27596             "group": "Body",
27597             "type": "String",
27598             "optional": true,
27599             "field": "recordonfeature",
27600             "description": ""
27601           },
27602           {
27603             "group": "Body",
27604             "type": "String",
27605             "optional": true,
27606             "field": "recordofffeature",
27607             "description": ""
27608           },
27609           {
27610             "group": "Body",
27611             "type": "Integer",
27612             "optional": true,
27613             "field": "call_limit",
27614             "description": ""
27615           },
27616           {
27617             "group": "Body",
27618             "type": "String",
27619             "allowedValues": [
27620               "\"yes\"",
27621               "\"no\""
27622             ],
27623             "optional": true,
27624             "field": "registertrying",
27625             "description": ""
27626           },
27627           {
27628             "group": "Body",
27629             "type": "String",
27630             "allowedValues": [
27631               "\"yes\"",
27632               "\"no\""
27633             ],
27634             "optional": true,
27635             "field": "subscribemwi",
27636             "description": ""
27637           },
27638           {
27639             "group": "Body",
27640             "type": "String",
27641             "optional": true,
27642             "field": "vmexten",
27643             "description": ""
27644           },
27645           {
27646             "group": "Body",
27647             "type": "String",
27648             "optional": true,
27649             "field": "mohinterpret",
27650             "description": ""
27651           },
27652           {
27653             "group": "Body",
27654             "type": "String",
27655             "optional": true,
27656             "field": "mohsuggest",
27657             "description": ""
27658           },
27659           {
27660             "group": "Body",
27661             "type": "String",
27662             "optional": true,
27663             "field": "parkinglot",
27664             "description": ""
27665           },
27666           {
27667             "group": "Body",
27668             "type": "String",
27669             "optional": true,
27670             "field": "description",
27671             "description": ""
27672           },
27673           {
27674             "group": "Body",
27675             "type": "String",
27676             "optional": true,
27677             "field": "host",
27678             "description": ""
27679           },
27680           {
27681             "group": "Body",
27682             "type": "String",
27683             "allowedValues": [
27684               "\"yes\"",
27685               "\"no\"",
27686               "\"nonat\"",
27687               "\"update\"",
27688               "\"update,nonat\""
27689             ],
27690             "optional": true,
27691             "field": "canreinvite",
27692             "description": ""
27693           },
27694           {
27695             "group": "Body",
27696             "type": "String",
27697             "optional": true,
27698             "field": "registry",
27699             "description": ""
27700           },
27701           {
27702             "group": "Body",
27703             "type": "String",
27704             "optional": true,
27705             "field": "otherFields",
27706             "description": ""
27707           },
27708           {
27709             "group": "Body",
27710             "type": "Boolean",
27711             "optional": false,
27712             "field": "active",
27713             "description": ""
27714           },
27715           {
27716             "group": "Body",
27717             "type": "String",
27718             "optional": true,
27719             "field": "t38pt_udptl",
27720             "description": ""
27721           }
27722         ]
27723       }
27724     },
27725     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27726     "version": "0.0.0",
27727     "filename": "server/api/trunk/index.js",
27728     "groupTitle": "Trunks"
27729   },
27730   {
27731     "type": "delete",
27732     "url": "/api/trunks/{id}",
27733     "title": "Deletes a trunk",
27734     "examples": [
27735       {
27736         "title": "Example usage:",
27737         "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X DELETE",
27738         "type": "json"
27739       }
27740     ],
27741     "name": "Delete",
27742     "group": "Trunks",
27743     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27744     "version": "0.0.0",
27745     "filename": "server/api/trunk/index.js",
27746     "groupTitle": "Trunks"
27747   },
27748   {
27749     "type": "get",
27750     "url": "/api/trunks",
27751     "title": "Gets a list of Trunks",
27752     "examples": [
27753       {
27754         "title": "Example usage:",
27755         "content": "curl https://{domain}/api/trunks -v -u {name}:{password}",
27756         "type": "json"
27757       }
27758     ],
27759     "name": "GetTrunks",
27760     "group": "Trunks",
27761     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
27762     "version": "0.0.0",
27763     "filename": "server/api/trunk/index.js",
27764     "groupTitle": "Trunks"
27765   },
27766   {
27767     "type": "get",
27768     "url": "/api/trunks/{id}",
27769     "title": "Gets a single Trunk",
27770     "examples": [
27771       {
27772         "title": "Example usage:",
27773         "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password}",
27774         "type": "json"
27775       }
27776     ],
27777     "name": "ShowTrunks",
27778     "group": "Trunks",
27779     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27780     "version": "0.0.0",
27781     "filename": "server/api/trunk/index.js",
27782     "groupTitle": "Trunks"
27783   },
27784   {
27785     "type": "put",
27786     "url": "/api/trunks/{id}",
27787     "title": "Update an existing trunk",
27788     "examples": [
27789       {
27790         "title": "Example usage:",
27791         "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X PUT",
27792         "type": "json"
27793       }
27794     ],
27795     "name": "Update",
27796     "group": "Trunks",
27797     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27798     "version": "0.0.0",
27799     "filename": "server/api/trunk/index.js",
27800     "groupTitle": "Trunks"
27801   },
27802   {
27803     "type": "post",
27804     "url": "/api/userNotifications",
27805     "title": "Send notification to user",
27806     "examples": [
27807       {
27808         "title": "Example usage:",
27809         "content": "curl https://{domain}/api/userNotifications -d '{\"text\": \"Hello!\", \"TemplateId\": 1}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
27810         "type": "json"
27811       }
27812     ],
27813     "name": "Send",
27814     "group": "UserNotifications",
27815     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27816     "version": "0.0.0",
27817     "filename": "server/api/userNotification/index.js",
27818     "groupTitle": "UserNotifications"
27819   },
27820   {
27821     "type": "post",
27822     "url": "/api/userProfile/resources",
27823     "title": "Creates a new User Profile Resource",
27824     "examples": [
27825       {
27826         "title": "Example usage:",
27827         "content": "curl https://{domain}/api/userProfile/resources -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27828         "type": "json"
27829       }
27830     ],
27831     "name": "CreateUser_Profile_Resources",
27832     "group": "User_Profile_Resources",
27833     "parameter": {
27834       "fields": {
27835         "Body": [
27836           {
27837             "group": "Body",
27838             "type": "String",
27839             "optional": false,
27840             "field": "name",
27841             "description": ""
27842           },
27843           {
27844             "group": "Body",
27845             "type": "Integer",
27846             "optional": false,
27847             "field": "resourceId",
27848             "description": ""
27849           },
27850           {
27851             "group": "Body",
27852             "type": "String",
27853             "optional": false,
27854             "field": "type",
27855             "description": ""
27856           }
27857         ]
27858       }
27859     },
27860     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27861     "version": "0.0.0",
27862     "filename": "server/api/userProfileResource/index.js",
27863     "groupTitle": "User_Profile_Resources"
27864   },
27865   {
27866     "type": "delete",
27867     "url": "/api/userProfile/resources/{id}",
27868     "title": "Deletes a User Profile Resource",
27869     "examples": [
27870       {
27871         "title": "Example usage:",
27872         "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password} -X DELETE",
27873         "type": "json"
27874       }
27875     ],
27876     "name": "DeleteUser_Profile_Resources",
27877     "group": "User_Profile_Resources",
27878     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27879     "version": "0.0.0",
27880     "filename": "server/api/userProfileResource/index.js",
27881     "groupTitle": "User_Profile_Resources"
27882   },
27883   {
27884     "type": "get",
27885     "url": "/api/userProfile/resources/describe",
27886     "title": "Gets table info about User Profile Resources",
27887     "examples": [
27888       {
27889         "title": "Example usage:",
27890         "content": "curl https://{domain}/api/userProfile/resources/describe -v -u {name}:{password}",
27891         "type": "json"
27892       }
27893     ],
27894     "name": "DescribeUser_Profile_Resources",
27895     "group": "User_Profile_Resources",
27896     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27897     "version": "0.0.0",
27898     "filename": "server/api/userProfileResource/index.js",
27899     "groupTitle": "User_Profile_Resources"
27900   },
27901   {
27902     "type": "get",
27903     "url": "/api/userProfile/resources",
27904     "title": "Gets a list of User Profile Resources",
27905     "examples": [
27906       {
27907         "title": "Example usage:",
27908         "content": "curl https://{domain}/api/userProfile/resources -v -u {name}:{password}",
27909         "type": "json"
27910       }
27911     ],
27912     "name": "GetUser_Profile_Resources",
27913     "group": "User_Profile_Resources",
27914     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
27915     "version": "0.0.0",
27916     "filename": "server/api/userProfileResource/index.js",
27917     "groupTitle": "User_Profile_Resources"
27918   },
27919   {
27920     "type": "get",
27921     "url": "/api/userProfile/resources/{id}",
27922     "title": "Gets a single User Profile Resource",
27923     "examples": [
27924       {
27925         "title": "Example usage:",
27926         "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password}",
27927         "type": "json"
27928       }
27929     ],
27930     "name": "ShowUser_Profile_Resources",
27931     "group": "User_Profile_Resources",
27932     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27933     "version": "0.0.0",
27934     "filename": "server/api/userProfileResource/index.js",
27935     "groupTitle": "User_Profile_Resources"
27936   },
27937   {
27938     "type": "put",
27939     "url": "/api/userProfile/resources/{id}",
27940     "title": "Update an existing User Profile Resource",
27941     "examples": [
27942       {
27943         "title": "Example usage:",
27944         "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",
27945         "type": "json"
27946       }
27947     ],
27948     "name": "updateUser_Profile_Resources",
27949     "group": "User_Profile_Resources",
27950     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27951     "version": "0.0.0",
27952     "filename": "server/api/userProfileResource/index.js",
27953     "groupTitle": "User_Profile_Resources"
27954   },
27955   {
27956     "type": "post",
27957     "url": "/api/userProfile/sections",
27958     "title": "Creates a new User Profile Section",
27959     "examples": [
27960       {
27961         "title": "Example usage:",
27962         "content": "curl https://{domain}/api/userProfile/sections -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27963         "type": "json"
27964       }
27965     ],
27966     "name": "CreateUser_Profile_Sections",
27967     "group": "User_Profile_Sections",
27968     "parameter": {
27969       "fields": {
27970         "Body": [
27971           {
27972             "group": "Body",
27973             "type": "String",
27974             "optional": false,
27975             "field": "name",
27976             "description": ""
27977           },
27978           {
27979             "group": "Body",
27980             "type": "String",
27981             "optional": false,
27982             "field": "category",
27983             "description": ""
27984           },
27985           {
27986             "group": "Body",
27987             "type": "Integer",
27988             "optional": false,
27989             "field": "sectionId",
27990             "description": ""
27991           },
27992           {
27993             "group": "Body",
27994             "type": "Boolean",
27995             "optional": true,
27996             "field": "enabled",
27997             "description": ""
27998           },
27999           {
28000             "group": "Body",
28001             "type": "Boolean",
28002             "optional": true,
28003             "field": "autoAssociation",
28004             "description": ""
28005           },
28006           {
28007             "group": "Body",
28008             "type": "String",
28009             "optional": true,
28010             "field": "crudPermissions",
28011             "description": ""
28012           }
28013         ]
28014       }
28015     },
28016     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28017     "version": "0.0.0",
28018     "filename": "server/api/userProfileSection/index.js",
28019     "groupTitle": "User_Profile_Sections"
28020   },
28021   {
28022     "type": "delete",
28023     "url": "/api/userProfile/sections/{id}",
28024     "title": "Deletes a User Profile Section",
28025     "examples": [
28026       {
28027         "title": "Example usage:",
28028         "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password} -X DELETE",
28029         "type": "json"
28030       }
28031     ],
28032     "name": "DeleteUser_Profile_Sections",
28033     "group": "User_Profile_Sections",
28034     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28035     "version": "0.0.0",
28036     "filename": "server/api/userProfileSection/index.js",
28037     "groupTitle": "User_Profile_Sections"
28038   },
28039   {
28040     "type": "get",
28041     "url": "/api/userProfile/sections/describe",
28042     "title": "Gets table info about User Profile Sections",
28043     "examples": [
28044       {
28045         "title": "Example usage:",
28046         "content": "curl https://{domain}/api/userProfile/sections/describe -v -u {name}:{password}",
28047         "type": "json"
28048       }
28049     ],
28050     "name": "DescribeUser_Profile_Sections",
28051     "group": "User_Profile_Sections",
28052     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28053     "version": "0.0.0",
28054     "filename": "server/api/userProfileSection/index.js",
28055     "groupTitle": "User_Profile_Sections"
28056   },
28057   {
28058     "type": "get",
28059     "url": "/api/userProfile/sections",
28060     "title": "Gets a list of User Profile Sections",
28061     "examples": [
28062       {
28063         "title": "Example usage:",
28064         "content": "curl https://{domain}/api/userProfile/sections -v -u {name}:{password}",
28065         "type": "json"
28066       }
28067     ],
28068     "name": "GetUser_Profile_Sections",
28069     "group": "User_Profile_Sections",
28070     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
28071     "version": "0.0.0",
28072     "filename": "server/api/userProfileSection/index.js",
28073     "groupTitle": "User_Profile_Sections"
28074   },
28075   {
28076     "type": "get",
28077     "url": "/api/userProfile/sections/{id}",
28078     "title": "Gets a single User Profile Section",
28079     "examples": [
28080       {
28081         "title": "Example usage:",
28082         "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password}",
28083         "type": "json"
28084       }
28085     ],
28086     "name": "ShowUser_Profile_Sections",
28087     "group": "User_Profile_Sections",
28088     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28089     "version": "0.0.0",
28090     "filename": "server/api/userProfileSection/index.js",
28091     "groupTitle": "User_Profile_Sections"
28092   },
28093   {
28094     "type": "put",
28095     "url": "/api/userProfile/sections/{id}",
28096     "title": "Update an existing User Profile Section",
28097     "examples": [
28098       {
28099         "title": "Example usage:",
28100         "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",
28101         "type": "json"
28102       }
28103     ],
28104     "name": "updateUser_Profile_Sections",
28105     "group": "User_Profile_Sections",
28106     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28107     "version": "0.0.0",
28108     "filename": "server/api/userProfileSection/index.js",
28109     "groupTitle": "User_Profile_Sections"
28110   },
28111   {
28112     "type": "post",
28113     "url": "/api/userProfiles/{id}/resources",
28114     "title": "Add resources' permissions to User Profile",
28115     "examples": [
28116       {
28117         "title": "Example usage:",
28118         "content": "curl https://{domain}/api/userProfiles/{id}/resources -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28119         "type": "json"
28120       }
28121     ],
28122     "name": "AddResources",
28123     "group": "User_Profiles",
28124     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28125     "version": "0.0.0",
28126     "filename": "server/api/userProfile/index.js",
28127     "groupTitle": "User_Profiles"
28128   },
28129   {
28130     "type": "post",
28131     "url": "/api/userProfiles/{id}/sections",
28132     "title": "Add sections' permissions to User Profile",
28133     "examples": [
28134       {
28135         "title": "Example usage:",
28136         "content": "curl https://{domain}/api/userProfiles/{id}/sections -d '[{\"sectionId\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28137         "type": "json"
28138       }
28139     ],
28140     "name": "AddSections",
28141     "group": "User_Profiles",
28142     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28143     "version": "0.0.0",
28144     "filename": "server/api/userProfile/index.js",
28145     "groupTitle": "User_Profiles"
28146   },
28147   {
28148     "type": "post",
28149     "url": "/api/userProfiles/clone",
28150     "title": "Clone an existing User Profile",
28151     "examples": [
28152       {
28153         "title": "Example usage:",
28154         "content": "curl https://{domain}/api/userProfiles/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28155         "type": "json"
28156       }
28157     ],
28158     "name": "CloneUser_Profiles",
28159     "group": "User_Profiles",
28160     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28161     "version": "0.0.0",
28162     "filename": "server/api/userProfile/index.js",
28163     "groupTitle": "User_Profiles"
28164   },
28165   {
28166     "type": "post",
28167     "url": "/api/userProfiles",
28168     "title": "Creates a new User Profile",
28169     "examples": [
28170       {
28171         "title": "Example usage:",
28172         "content": "curl https://{domain}/api/userProfiles -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28173         "type": "json"
28174       }
28175     ],
28176     "name": "CreateUser_Profiles",
28177     "group": "User_Profiles",
28178     "parameter": {
28179       "fields": {
28180         "Body": [
28181           {
28182             "group": "Body",
28183             "type": "String",
28184             "optional": false,
28185             "field": "name",
28186             "description": ""
28187           },
28188           {
28189             "group": "Body",
28190             "type": "String",
28191             "optional": false,
28192             "field": "crudPermissions",
28193             "description": ""
28194           },
28195           {
28196             "group": "Body",
28197             "type": "String",
28198             "optional": true,
28199             "field": "description",
28200             "description": ""
28201           }
28202         ]
28203       }
28204     },
28205     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28206     "version": "0.0.0",
28207     "filename": "server/api/userProfile/index.js",
28208     "groupTitle": "User_Profiles"
28209   },
28210   {
28211     "type": "delete",
28212     "url": "/api/userProfiles/{id}",
28213     "title": "Deletes a User Profile",
28214     "examples": [
28215       {
28216         "title": "Example usage:",
28217         "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password} -X DELETE",
28218         "type": "json"
28219       }
28220     ],
28221     "name": "DeleteUser_Profiles",
28222     "group": "User_Profiles",
28223     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28224     "version": "0.0.0",
28225     "filename": "server/api/userProfile/index.js",
28226     "groupTitle": "User_Profiles"
28227   },
28228   {
28229     "type": "get",
28230     "url": "/api/userProfiles/describe",
28231     "title": "Gets table info about User Profiles",
28232     "examples": [
28233       {
28234         "title": "Example usage:",
28235         "content": "curl https://{domain}/api/userProfiles/describe -v -u {name}:{password}",
28236         "type": "json"
28237       }
28238     ],
28239     "name": "DescribeUser_Profiles",
28240     "group": "User_Profiles",
28241     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28242     "version": "0.0.0",
28243     "filename": "server/api/userProfile/index.js",
28244     "groupTitle": "User_Profiles"
28245   },
28246   {
28247     "type": "get",
28248     "url": "/api/userProfiles/{id}/resources?section={section}",
28249     "title": "Get Resources assigned to a Section",
28250     "examples": [
28251       {
28252         "title": "Example usage:",
28253         "content": "curl https://{domain}/api/userProfiles/{id}/resources?section={section} -v -u {name}:{password} -X GET",
28254         "type": "json"
28255       }
28256     ],
28257     "name": "GetResources",
28258     "group": "User_Profiles",
28259     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28260     "version": "0.0.0",
28261     "filename": "server/api/userProfile/index.js",
28262     "groupTitle": "User_Profiles"
28263   },
28264   {
28265     "type": "get",
28266     "url": "/api/userProfiles/{id}/sections",
28267     "title": "Get sections associated to a User Profile",
28268     "examples": [
28269       {
28270         "title": "Example usage:",
28271         "content": "curl https://{domain}/api/userProfiles/{id}/sections -v -u {name}:{password} -X GET",
28272         "type": "json"
28273       }
28274     ],
28275     "name": "GetSections",
28276     "group": "User_Profiles",
28277     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28278     "version": "0.0.0",
28279     "filename": "server/api/userProfile/index.js",
28280     "groupTitle": "User_Profiles"
28281   },
28282   {
28283     "type": "get",
28284     "url": "/api/userProfiles",
28285     "title": "Gets a list of User Profiles",
28286     "examples": [
28287       {
28288         "title": "Example usage:",
28289         "content": "curl https://{domain}/api/userProfiles -v -u {name}:{password}",
28290         "type": "json"
28291       }
28292     ],
28293     "name": "GetUser_Profiles",
28294     "group": "User_Profiles",
28295     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
28296     "version": "0.0.0",
28297     "filename": "server/api/userProfile/index.js",
28298     "groupTitle": "User_Profiles"
28299   },
28300   {
28301     "type": "delete",
28302     "url": "/api/userProfiles/{id}/resources",
28303     "title": "Removes resources' permissions from User Profile",
28304     "examples": [
28305       {
28306         "title": "Example usage:",
28307         "content": "curl https://{domain}/api/userProfiles/{id}/resources?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
28308         "type": "json"
28309       }
28310     ],
28311     "name": "RemoveResources",
28312     "group": "User_Profiles",
28313     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28314     "version": "0.0.0",
28315     "filename": "server/api/userProfile/index.js",
28316     "groupTitle": "User_Profiles"
28317   },
28318   {
28319     "type": "delete",
28320     "url": "/api/userProfiles/{id}/sections",
28321     "title": "Removes sections' permissions from User Profile",
28322     "examples": [
28323       {
28324         "title": "Example usage:",
28325         "content": "curl https://{domain}/api/userProfiles/{id}/sections?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
28326         "type": "json"
28327       }
28328     ],
28329     "name": "RemoveSections",
28330     "group": "User_Profiles",
28331     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28332     "version": "0.0.0",
28333     "filename": "server/api/userProfile/index.js",
28334     "groupTitle": "User_Profiles"
28335   },
28336   {
28337     "type": "get",
28338     "url": "/api/userProfiles/{id}",
28339     "title": "Gets a single User Profile",
28340     "examples": [
28341       {
28342         "title": "Example usage:",
28343         "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password}",
28344         "type": "json"
28345       }
28346     ],
28347     "name": "ShowUser_Profiles",
28348     "group": "User_Profiles",
28349     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28350     "version": "0.0.0",
28351     "filename": "server/api/userProfile/index.js",
28352     "groupTitle": "User_Profiles"
28353   },
28354   {
28355     "type": "put",
28356     "url": "/api/userProfiles/{id}",
28357     "title": "Update an existing User Profile",
28358     "examples": [
28359       {
28360         "title": "Example usage:",
28361         "content": "curl https://{domain}/api/userProfiles/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
28362         "type": "json"
28363       }
28364     ],
28365     "name": "updateUser_Profiles",
28366     "group": "User_Profiles",
28367     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28368     "version": "0.0.0",
28369     "filename": "server/api/userProfile/index.js",
28370     "groupTitle": "User_Profiles"
28371   },
28372   {
28373     "type": "post",
28374     "url": "/api/users/{id}/chat_interactions",
28375     "title": "Add chat interaction tabs to an agent",
28376     "examples": [
28377       {
28378         "title": "Example usage:",
28379         "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",
28380         "type": "json"
28381       }
28382     ],
28383     "name": "AddChatInteractions",
28384     "group": "Users",
28385     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28386     "version": "0.0.0",
28387     "filename": "server/api/user/index.js",
28388     "groupTitle": "Users"
28389   },
28390   {
28391     "type": "post",
28392     "url": "/api/users/{id}/chat_websites",
28393     "title": "Add a Chat Website to a user",
28394     "examples": [
28395       {
28396         "title": "Example usage:",
28397         "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",
28398         "type": "json"
28399       }
28400     ],
28401     "name": "AddChatWebsites",
28402     "group": "Users",
28403     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28404     "version": "0.0.0",
28405     "filename": "server/api/user/index.js",
28406     "groupTitle": "Users"
28407   },
28408   {
28409     "type": "post",
28410     "url": "/api/users/{id}/contacts",
28411     "title": "Add contacts to a user",
28412     "examples": [
28413       {
28414         "title": "Example usage:",
28415         "content": "curl https://{domain}/api/users/{id}/contacts -d '{\"ids\": [1,2]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28416         "type": "json"
28417       }
28418     ],
28419     "name": "AddContacts",
28420     "group": "Users",
28421     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28422     "version": "0.0.0",
28423     "filename": "server/api/user/index.js",
28424     "groupTitle": "Users"
28425   },
28426   {
28427     "type": "post",
28428     "url": "/api/users/{id}/fax_accounts",
28429     "title": "Add a Fax Account to a user",
28430     "examples": [
28431       {
28432         "title": "Example usage:",
28433         "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",
28434         "type": "json"
28435       }
28436     ],
28437     "name": "AddFaxAccounts",
28438     "group": "Users",
28439     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28440     "version": "0.0.0",
28441     "filename": "server/api/user/index.js",
28442     "groupTitle": "Users"
28443   },
28444   {
28445     "type": "post",
28446     "url": "/api/users/{id}/fax_interactions",
28447     "title": "Add fax interaction tabs to an agent",
28448     "examples": [
28449       {
28450         "title": "Example usage:",
28451         "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",
28452         "type": "json"
28453       }
28454     ],
28455     "name": "AddFaxInteractions",
28456     "group": "Users",
28457     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28458     "version": "0.0.0",
28459     "filename": "server/api/user/index.js",
28460     "groupTitle": "Users"
28461   },
28462   {
28463     "type": "post",
28464     "url": "/api/users/{id}/mail_accounts",
28465     "title": "Add a Mail Account to a user",
28466     "examples": [
28467       {
28468         "title": "Example usage:",
28469         "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",
28470         "type": "json"
28471       }
28472     ],
28473     "name": "AddMailAccounts",
28474     "group": "Users",
28475     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28476     "version": "0.0.0",
28477     "filename": "server/api/user/index.js",
28478     "groupTitle": "Users"
28479   },
28480   {
28481     "type": "post",
28482     "url": "/api/users/{id}/mail_interactions",
28483     "title": "Add mail interaction tabs to an agent",
28484     "examples": [
28485       {
28486         "title": "Example usage:",
28487         "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",
28488         "type": "json"
28489       }
28490     ],
28491     "name": "AddMailInteractions",
28492     "group": "Users",
28493     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28494     "version": "0.0.0",
28495     "filename": "server/api/user/index.js",
28496     "groupTitle": "Users"
28497   },
28498   {
28499     "type": "post",
28500     "url": "/api/users/{id}/openchannel_accounts",
28501     "title": "Add a Open Channel Account to a user",
28502     "examples": [
28503       {
28504         "title": "Example usage:",
28505         "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",
28506         "type": "json"
28507       }
28508     ],
28509     "name": "AddOpenchannelAccounts",
28510     "group": "Users",
28511     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28512     "version": "0.0.0",
28513     "filename": "server/api/user/index.js",
28514     "groupTitle": "Users"
28515   },
28516   {
28517     "type": "post",
28518     "url": "/api/users/{id}/openchannel_interactions",
28519     "title": "Add openchannel interaction tabs to an agent",
28520     "examples": [
28521       {
28522         "title": "Example usage:",
28523         "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",
28524         "type": "json"
28525       }
28526     ],
28527     "name": "AddOpenchannelInteractions",
28528     "group": "Users",
28529     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28530     "version": "0.0.0",
28531     "filename": "server/api/user/index.js",
28532     "groupTitle": "Users"
28533   },
28534   {
28535     "type": "post",
28536     "url": "/api/users/{id}/queues",
28537     "title": "Add queues to an agent",
28538     "examples": [
28539       {
28540         "title": "Example usage:",
28541         "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",
28542         "type": "json"
28543       }
28544     ],
28545     "name": "AddQueues",
28546     "group": "Users",
28547     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28548     "version": "0.0.0",
28549     "filename": "server/api/user/index.js",
28550     "groupTitle": "Users"
28551   },
28552   {
28553     "type": "post",
28554     "url": "/api/users/{id}/sms_accounts",
28555     "title": "Add a Sms Account to a user",
28556     "examples": [
28557       {
28558         "title": "Example usage:",
28559         "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",
28560         "type": "json"
28561       }
28562     ],
28563     "name": "AddSmsAccounts",
28564     "group": "Users",
28565     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28566     "version": "0.0.0",
28567     "filename": "server/api/user/index.js",
28568     "groupTitle": "Users"
28569   },
28570   {
28571     "type": "post",
28572     "url": "/api/users/{id}/sms_interactions",
28573     "title": "Add sms interaction tabs to an agent",
28574     "examples": [
28575       {
28576         "title": "Example usage:",
28577         "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",
28578         "type": "json"
28579       }
28580     ],
28581     "name": "AddSmsInteractions",
28582     "group": "Users",
28583     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28584     "version": "0.0.0",
28585     "filename": "server/api/user/index.js",
28586     "groupTitle": "Users"
28587   },
28588   {
28589     "type": "post",
28590     "url": "/api/users/{id}/square_projects",
28591     "title": "Add a Square Project to a user",
28592     "examples": [
28593       {
28594         "title": "Example usage:",
28595         "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",
28596         "type": "json"
28597       }
28598     ],
28599     "name": "AddSquareProjects",
28600     "group": "Users",
28601     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28602     "version": "0.0.0",
28603     "filename": "server/api/user/index.js",
28604     "groupTitle": "Users"
28605   },
28606   {
28607     "type": "post",
28608     "url": "/api/users/{id}/teams",
28609     "title": "Add teams to an agent",
28610     "examples": [
28611       {
28612         "title": "Example usage:",
28613         "content": "curl https://{domain}/api/users/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28614         "type": "json"
28615       }
28616     ],
28617     "name": "AddTeams",
28618     "group": "Users",
28619     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28620     "version": "0.0.0",
28621     "filename": "server/api/user/index.js",
28622     "groupTitle": "Users"
28623   },
28624   {
28625     "type": "post",
28626     "url": "/api/users/{id}/whatsapp_accounts",
28627     "title": "Add a Whatsapp Account to a user",
28628     "examples": [
28629       {
28630         "title": "Example usage:",
28631         "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",
28632         "type": "json"
28633       }
28634     ],
28635     "name": "AddWhatsappAccounts",
28636     "group": "Users",
28637     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28638     "version": "0.0.0",
28639     "filename": "server/api/user/index.js",
28640     "groupTitle": "Users"
28641   },
28642   {
28643     "type": "post",
28644     "url": "/api/users/{id}/whatsapp_interactions",
28645     "title": "Add Whatsapp interaction tabs to an agent",
28646     "examples": [
28647       {
28648         "title": "Example usage:",
28649         "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",
28650         "type": "json"
28651       }
28652     ],
28653     "name": "AddWhatsappInteractions",
28654     "group": "Users",
28655     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28656     "version": "0.0.0",
28657     "filename": "server/api/user/index.js",
28658     "groupTitle": "Users"
28659   },
28660   {
28661     "type": "put",
28662     "url": "/api/users/{id}/password",
28663     "title": "Change user password",
28664     "examples": [
28665       {
28666         "title": "Example usage:",
28667         "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",
28668         "type": "json"
28669       }
28670     ],
28671     "name": "ChangePwd",
28672     "group": "Users",
28673     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28674     "version": "0.0.0",
28675     "filename": "server/api/user/index.js",
28676     "groupTitle": "Users"
28677   },
28678   {
28679     "type": "post",
28680     "url": "/api/users",
28681     "title": "Create a new user",
28682     "examples": [
28683       {
28684         "title": "Example usage:",
28685         "content": "curl https://{domain}/api/users -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28686         "type": "json"
28687       }
28688     ],
28689     "name": "Create",
28690     "group": "Users",
28691     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28692     "version": "0.0.0",
28693     "filename": "server/api/user/index.js",
28694     "groupTitle": "Users"
28695   },
28696   {
28697     "type": "post",
28698     "url": "/api/users/{id}/api_key",
28699     "title": "Create a new API access key for the user",
28700     "examples": [
28701       {
28702         "title": "Example usage:",
28703         "content": "curl https://{domain}/api/users/:id/api_key -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28704         "type": "json"
28705       }
28706     ],
28707     "name": "CreateApiKey",
28708     "group": "Users",
28709     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28710     "version": "0.0.0",
28711     "filename": "server/api/user/index.js",
28712     "groupTitle": "Users"
28713   },
28714   {
28715     "type": "delete",
28716     "url": "/api/users/{id}",
28717     "title": "Deletes a user",
28718     "examples": [
28719       {
28720         "title": "Example usage:",
28721         "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password} -X DELETE",
28722         "type": "json"
28723       }
28724     ],
28725     "name": "Delete",
28726     "group": "Users",
28727     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28728     "version": "0.0.0",
28729     "filename": "server/api/user/index.js",
28730     "groupTitle": "Users"
28731   },
28732   {
28733     "type": "get",
28734     "url": "/api/users/describe",
28735     "title": "Gets table info about Users",
28736     "examples": [
28737       {
28738         "title": "Example usage:",
28739         "content": "curl https://{domain}/api/users/describe -v -u {name}:{password}",
28740         "type": "json"
28741       }
28742     ],
28743     "name": "DescribeUsers",
28744     "group": "Users",
28745     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28746     "version": "0.0.0",
28747     "filename": "server/api/user/index.js",
28748     "groupTitle": "Users"
28749   },
28750   {
28751     "type": "get",
28752     "url": "/api/users/{id}/agents",
28753     "title": "GetAgents",
28754     "examples": [
28755       {
28756         "title": "Example usage:",
28757         "content": "curl https://{domain}/api/users/{id}/agents -v -u {name}:{password} -X GET",
28758         "type": "json"
28759       }
28760     ],
28761     "name": "GetAgents",
28762     "group": "Users",
28763     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28764     "version": "0.0.0",
28765     "filename": "server/api/user/index.js",
28766     "groupTitle": "Users"
28767   },
28768   {
28769     "type": "get",
28770     "url": "/api/users/{id}/api_key",
28771     "title": "Get the API access key for the user",
28772     "examples": [
28773       {
28774         "title": "Example usage:",
28775         "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X GET",
28776         "type": "json"
28777       }
28778     ],
28779     "name": "GetApiKey",
28780     "group": "Users",
28781     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28782     "version": "0.0.0",
28783     "filename": "server/api/user/index.js",
28784     "groupTitle": "Users"
28785   },
28786   {
28787     "type": "get",
28788     "url": "/api/users/{id}/groups",
28789     "title": "GetChatGroups",
28790     "examples": [
28791       {
28792         "title": "Example usage:",
28793         "content": "curl https://{domain}/api/users/{id}/groups -v -u {name}:{password} -X GET",
28794         "type": "json"
28795       }
28796     ],
28797     "name": "GetChatGroups",
28798     "group": "Users",
28799     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28800     "version": "0.0.0",
28801     "filename": "server/api/user/index.js",
28802     "groupTitle": "Users"
28803   },
28804   {
28805     "type": "get",
28806     "url": "/api/users/{id}/chat/interactions",
28807     "title": "GetChatInteractions",
28808     "examples": [
28809       {
28810         "title": "Example usage:",
28811         "content": "curl https://{domain}/api/users/{id}/chat/interactions -v -u {name}:{password} -X GET",
28812         "type": "json"
28813       }
28814     ],
28815     "name": "GetChatInteractions",
28816     "group": "Users",
28817     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28818     "version": "0.0.0",
28819     "filename": "server/api/user/index.js",
28820     "groupTitle": "Users"
28821   },
28822   {
28823     "type": "get",
28824     "url": "/api/users/{id}/chat_websites",
28825     "title": "GetChatWebsites",
28826     "examples": [
28827       {
28828         "title": "Example usage:",
28829         "content": "curl https://{domain}/api/users/{id}/chat_websites -v -u {name}:{password} -X GET",
28830         "type": "json"
28831       }
28832     ],
28833     "name": "GetChatWebsites",
28834     "group": "Users",
28835     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28836     "version": "0.0.0",
28837     "filename": "server/api/user/index.js",
28838     "groupTitle": "Users"
28839   },
28840   {
28841     "type": "get",
28842     "url": "/api/users/{id}/contacts",
28843     "title": "GetContacts",
28844     "examples": [
28845       {
28846         "title": "Example usage:",
28847         "content": "curl https://{domain}/api/users/{id}/contacts -v -u {name}:{password} -X GET",
28848         "type": "json"
28849       }
28850     ],
28851     "name": "GetContacts",
28852     "group": "Users",
28853     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28854     "version": "0.0.0",
28855     "filename": "server/api/user/index.js",
28856     "groupTitle": "Users"
28857   },
28858   {
28859     "type": "get",
28860     "url": "/api/users/{id}/fax_accounts",
28861     "title": "GetFaxAccounts",
28862     "examples": [
28863       {
28864         "title": "Example usage:",
28865         "content": "curl https://{domain}/api/users/{id}/fax_accounts -v -u {name}:{password} -X GET",
28866         "type": "json"
28867       }
28868     ],
28869     "name": "GetFaxAccounts",
28870     "group": "Users",
28871     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28872     "version": "0.0.0",
28873     "filename": "server/api/user/index.js",
28874     "groupTitle": "Users"
28875   },
28876   {
28877     "type": "get",
28878     "url": "/api/users/{id}/fax/interactions",
28879     "title": "GetFaxInteractions",
28880     "examples": [
28881       {
28882         "title": "Example usage:",
28883         "content": "curl https://{domain}/api/users/{id}/fax/interactions -v -u {name}:{password} -X GET",
28884         "type": "json"
28885       }
28886     ],
28887     "name": "GetFaxInteractions",
28888     "group": "Users",
28889     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28890     "version": "0.0.0",
28891     "filename": "server/api/user/index.js",
28892     "groupTitle": "Users"
28893   },
28894   {
28895     "type": "get",
28896     "url": "/api/users/{id}/lists",
28897     "title": "GetLists",
28898     "examples": [
28899       {
28900         "title": "Example usage:",
28901         "content": "curl https://{domain}/api/users/{id}/lists -v -u {name}:{password} -X GET",
28902         "type": "json"
28903       }
28904     ],
28905     "name": "GetLists",
28906     "group": "Users",
28907     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28908     "version": "0.0.0",
28909     "filename": "server/api/user/index.js",
28910     "groupTitle": "Users"
28911   },
28912   {
28913     "type": "get",
28914     "url": "/api/users/{id}/mail_accounts",
28915     "title": "GetMailAccounts",
28916     "examples": [
28917       {
28918         "title": "Example usage:",
28919         "content": "curl https://{domain}/api/users/{id}/mail_accounts -v -u {name}:{password} -X GET",
28920         "type": "json"
28921       }
28922     ],
28923     "name": "GetMailAccounts",
28924     "group": "Users",
28925     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28926     "version": "0.0.0",
28927     "filename": "server/api/user/index.js",
28928     "groupTitle": "Users"
28929   },
28930   {
28931     "type": "get",
28932     "url": "/api/users/{id}/mail/interactions",
28933     "title": "GetMailInteractions",
28934     "examples": [
28935       {
28936         "title": "Example usage:",
28937         "content": "curl https://{domain}/api/users/{id}/mail/interactions -v -u {name}:{password} -X GET",
28938         "type": "json"
28939       }
28940     ],
28941     "name": "GetMailInteractions",
28942     "group": "Users",
28943     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28944     "version": "0.0.0",
28945     "filename": "server/api/user/index.js",
28946     "groupTitle": "Users"
28947   },
28948   {
28949     "type": "get",
28950     "url": "/api/users/{id}/openchannel_accounts",
28951     "title": "GetOpenchannelAccounts",
28952     "examples": [
28953       {
28954         "title": "Example usage:",
28955         "content": "curl https://{domain}/api/users/{id}/openchannel_accounts -v -u {name}:{password} -X GET",
28956         "type": "json"
28957       }
28958     ],
28959     "name": "GetOpenchannelAccounts",
28960     "group": "Users",
28961     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28962     "version": "0.0.0",
28963     "filename": "server/api/user/index.js",
28964     "groupTitle": "Users"
28965   },
28966   {
28967     "type": "get",
28968     "url": "/api/users/{id}/openchannel/interactions",
28969     "title": "GetOpenchannelInteractions",
28970     "examples": [
28971       {
28972         "title": "Example usage:",
28973         "content": "curl https://{domain}/api/users/{id}/openchannel/interactions -v -u {name}:{password}",
28974         "type": "json"
28975       }
28976     ],
28977     "name": "GetOpenchannelInteractions",
28978     "group": "Users",
28979     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28980     "version": "0.0.0",
28981     "filename": "server/api/user/index.js",
28982     "groupTitle": "Users"
28983   },
28984   {
28985     "type": "get",
28986     "url": "/api/users/{id}/prefixes",
28987     "title": "GetPrefixes",
28988     "examples": [
28989       {
28990         "title": "Example usage:",
28991         "content": "curl https://{domain}/api/users/{id}/prefixes -v -u {name}:{password} -X GET",
28992         "type": "json"
28993       }
28994     ],
28995     "name": "GetPrefixes",
28996     "group": "Users",
28997     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28998     "version": "0.0.0",
28999     "filename": "server/api/user/index.js",
29000     "groupTitle": "Users"
29001   },
29002   {
29003     "type": "get",
29004     "url": "/api/users/{id}/queues?channel={channel}",
29005     "title": "Gets Queues list",
29006     "examples": [
29007       {
29008         "title": "Example usage:",
29009         "content": "curl https://{domain}/api/users/{id}/queues/?channel={channel} -v -u {name}:{password} -X GET",
29010         "type": "json"
29011       }
29012     ],
29013     "name": "GetQueues",
29014     "group": "Users",
29015     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29016     "version": "0.0.0",
29017     "filename": "server/api/user/index.js",
29018     "groupTitle": "Users"
29019   },
29020   {
29021     "type": "get",
29022     "url": "/api/users/{id}/recordings",
29023     "title": "GetRecordings",
29024     "examples": [
29025       {
29026         "title": "Example usage:",
29027         "content": "curl https://{domain}/api/users/{id}/recordings -v -u {name}:{password} -X GET",
29028         "type": "json"
29029       }
29030     ],
29031     "name": "GetRecordings",
29032     "group": "Users",
29033     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29034     "version": "0.0.0",
29035     "filename": "server/api/user/index.js",
29036     "groupTitle": "Users"
29037   },
29038   {
29039     "type": "get",
29040     "url": "/api/users/{id}/scheduled_calls",
29041     "title": "GetScheduledCalls",
29042     "examples": [
29043       {
29044         "title": "Example usage:",
29045         "content": "curl https://{domain}/api/users/{id}/scheduled_calls -v -u {name}:{password} -X GET",
29046         "type": "json"
29047       }
29048     ],
29049     "name": "GetScheduledCalls",
29050     "group": "Users",
29051     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29052     "version": "0.0.0",
29053     "filename": "server/api/user/index.js",
29054     "groupTitle": "Users"
29055   },
29056   {
29057     "type": "get",
29058     "url": "/api/users/{id}/screen_recordings",
29059     "title": "GetScreenRecordings",
29060     "examples": [
29061       {
29062         "title": "Example usage:",
29063         "content": "curl https://{domain}/api/users/{id}/screen_recordings -v -u {name}:{password} -X GET",
29064         "type": "json"
29065       }
29066     ],
29067     "name": "GetScreenRecordings",
29068     "group": "Users",
29069     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29070     "version": "0.0.0",
29071     "filename": "server/api/user/index.js",
29072     "groupTitle": "Users"
29073   },
29074   {
29075     "type": "get",
29076     "url": "/api/users/{id}/sms_accounts",
29077     "title": "GetSmsAccounts",
29078     "examples": [
29079       {
29080         "title": "Example usage:",
29081         "content": "curl https://{domain}/api/users/{id}/sms_accounts -v -u {name}:{password} -X GET",
29082         "type": "json"
29083       }
29084     ],
29085     "name": "GetSmsAccounts",
29086     "group": "Users",
29087     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29088     "version": "0.0.0",
29089     "filename": "server/api/user/index.js",
29090     "groupTitle": "Users"
29091   },
29092   {
29093     "type": "get",
29094     "url": "/api/users/{id}/sms/interactions",
29095     "title": "GetSmsInteractions",
29096     "examples": [
29097       {
29098         "title": "Example usage:",
29099         "content": "curl https://{domain}/api/users/{id}/sms/interactions -v -u {name}:{password} -X GET",
29100         "type": "json"
29101       }
29102     ],
29103     "name": "GetSmsInteractions",
29104     "group": "Users",
29105     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29106     "version": "0.0.0",
29107     "filename": "server/api/user/index.js",
29108     "groupTitle": "Users"
29109   },
29110   {
29111     "type": "get",
29112     "url": "/api/users/{id}/square_projects",
29113     "title": "GetSquareProjects",
29114     "examples": [
29115       {
29116         "title": "Example usage:",
29117         "content": "curl https://{domain}/api/users/{id}/square_projects -v -u {name}:{password} -X GET",
29118         "type": "json"
29119       }
29120     ],
29121     "name": "GetSquareProjects",
29122     "group": "Users",
29123     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29124     "version": "0.0.0",
29125     "filename": "server/api/user/index.js",
29126     "groupTitle": "Users"
29127   },
29128   {
29129     "type": "get",
29130     "url": "/api/users/{id}/teams",
29131     "title": "GetTeams",
29132     "examples": [
29133       {
29134         "title": "Example usage:",
29135         "content": "curl https://{domain}/api/users/{id}/teams -v -u {name}:{password} -X GET",
29136         "type": "json"
29137       }
29138     ],
29139     "name": "GetTeams",
29140     "group": "Users",
29141     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29142     "version": "0.0.0",
29143     "filename": "server/api/user/index.js",
29144     "groupTitle": "Users"
29145   },
29146   {
29147     "type": "get",
29148     "url": "/api/users",
29149     "title": "Gets a list of Users",
29150     "examples": [
29151       {
29152         "title": "Example usage:",
29153         "content": "curl https://{domain}/api/users -v -u {name}:{password}",
29154         "type": "json"
29155       }
29156     ],
29157     "name": "GetUsers",
29158     "group": "Users",
29159     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
29160     "version": "0.0.0",
29161     "filename": "server/api/user/index.js",
29162     "groupTitle": "Users"
29163   },
29164   {
29165     "type": "get",
29166     "url": "/api/users/{id}/queues_rt",
29167     "title": "GetVoiceQueuesRt",
29168     "examples": [
29169       {
29170         "title": "Example usage:",
29171         "content": "curl https://{domain}/api/users/{id}/queues_rt -v -u {name}:{password} -X GET",
29172         "type": "json"
29173       }
29174     ],
29175     "name": "GetVoiceQueuesRt",
29176     "group": "Users",
29177     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29178     "version": "0.0.0",
29179     "filename": "server/api/user/index.js",
29180     "groupTitle": "Users"
29181   },
29182   {
29183     "type": "get",
29184     "url": "/api/users/{id}/whatsapp_accounts",
29185     "title": "GetWhatsappAccounts",
29186     "examples": [
29187       {
29188         "title": "Example usage:",
29189         "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts -v -u {name}:{password} -X GET",
29190         "type": "json"
29191       }
29192     ],
29193     "name": "GetWhatsappAccounts",
29194     "group": "Users",
29195     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29196     "version": "0.0.0",
29197     "filename": "server/api/user/index.js",
29198     "groupTitle": "Users"
29199   },
29200   {
29201     "type": "get",
29202     "url": "/api/users/{id}/whatsapp/interactions",
29203     "title": "GetWhatsappInteractions",
29204     "examples": [
29205       {
29206         "title": "Example usage:",
29207         "content": "curl https://{domain}/api/users/{id}/whatsapp/interactions -v -u {name}:{password} -X GET",
29208         "type": "json"
29209       }
29210     ],
29211     "name": "GetWhatsappInteractions",
29212     "group": "Users",
29213     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29214     "version": "0.0.0",
29215     "filename": "server/api/user/index.js",
29216     "groupTitle": "Users"
29217   },
29218   {
29219     "type": "post",
29220     "url": "/api/users/{id}/login",
29221     "title": "Login",
29222     "examples": [
29223       {
29224         "title": "Example usage:",
29225         "content": "curl https://{domain}/api/users/{id}/login  -v -u {name}:{password} -X POST",
29226         "type": "json"
29227       }
29228     ],
29229     "name": "Login",
29230     "group": "Users",
29231     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29232     "version": "0.0.0",
29233     "filename": "server/api/user/index.js",
29234     "groupTitle": "Users"
29235   },
29236   {
29237     "type": "post",
29238     "url": "/api/users/{id}/logout",
29239     "title": "Logout",
29240     "examples": [
29241       {
29242         "title": "Example usage:",
29243         "content": "curl https://{domain}/api/users/{id}/logout -v -u {name}:{password} -X POST",
29244         "type": "json"
29245       }
29246     ],
29247     "name": "Logout",
29248     "group": "Users",
29249     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29250     "version": "0.0.0",
29251     "filename": "server/api/user/index.js",
29252     "groupTitle": "Users"
29253   },
29254   {
29255     "type": "post",
29256     "url": "/api/users/{id}/pause",
29257     "title": "Pause",
29258     "examples": [
29259       {
29260         "title": "Example usage:",
29261         "content": "curl https://{domain}/api/users/{id}/pause -v -u {name}:{password} -X POST",
29262         "type": "json"
29263       }
29264     ],
29265     "name": "Pause",
29266     "group": "Users",
29267     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29268     "version": "0.0.0",
29269     "filename": "server/api/user/index.js",
29270     "groupTitle": "Users"
29271   },
29272   {
29273     "type": "delete",
29274     "url": "/api/users/{id}/api_key",
29275     "title": "Remove API access key for the user",
29276     "examples": [
29277       {
29278         "title": "Example usage:",
29279         "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X DELETE",
29280         "type": "json"
29281       }
29282     ],
29283     "name": "RemoveApiKey",
29284     "group": "Users",
29285     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29286     "version": "0.0.0",
29287     "filename": "server/api/user/index.js",
29288     "groupTitle": "Users"
29289   },
29290   {
29291     "type": "delete",
29292     "url": "/api/users/{id}/chat_interactions",
29293     "title": "Removes interactions from an agent",
29294     "examples": [
29295       {
29296         "title": "Example usage:",
29297         "content": "curl https://{domain}/api/users/{id}/chat_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29298         "type": "json"
29299       }
29300     ],
29301     "name": "RemoveChatInteractions",
29302     "group": "Users",
29303     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29304     "version": "0.0.0",
29305     "filename": "server/api/user/index.js",
29306     "groupTitle": "Users"
29307   },
29308   {
29309     "type": "delete",
29310     "url": "/api/users/{id}/chat_websites",
29311     "title": "Removes a Chat Website from a user",
29312     "examples": [
29313       {
29314         "title": "Example usage:",
29315         "content": "curl https://{domain}/api/users/{id}/chat_websites?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29316         "type": "json"
29317       }
29318     ],
29319     "name": "RemoveChatWebsites",
29320     "group": "Users",
29321     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29322     "version": "0.0.0",
29323     "filename": "server/api/user/index.js",
29324     "groupTitle": "Users"
29325   },
29326   {
29327     "type": "delete",
29328     "url": "/api/users/{id}/fax_accounts",
29329     "title": "Removes a Fax Account from a user",
29330     "examples": [
29331       {
29332         "title": "Example usage:",
29333         "content": "curl https://{domain}/api/users/{id}/fax_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29334         "type": "json"
29335       }
29336     ],
29337     "name": "RemoveFaxAccounts",
29338     "group": "Users",
29339     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29340     "version": "0.0.0",
29341     "filename": "server/api/user/index.js",
29342     "groupTitle": "Users"
29343   },
29344   {
29345     "type": "delete",
29346     "url": "/api/users/{id}/fax_interactions",
29347     "title": "Removes interactions from an agent",
29348     "examples": [
29349       {
29350         "title": "Example usage:",
29351         "content": "curl https://{domain}/api/users/{id}/fax_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29352         "type": "json"
29353       }
29354     ],
29355     "name": "RemoveFaxInteractions",
29356     "group": "Users",
29357     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29358     "version": "0.0.0",
29359     "filename": "server/api/user/index.js",
29360     "groupTitle": "Users"
29361   },
29362   {
29363     "type": "delete",
29364     "url": "/api/users/{id}/mail_accounts",
29365     "title": "Removes a Mail Account from a user",
29366     "examples": [
29367       {
29368         "title": "Example usage:",
29369         "content": "curl https://{domain}/api/users/{id}/mail_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29370         "type": "json"
29371       }
29372     ],
29373     "name": "RemoveMailAccounts",
29374     "group": "Users",
29375     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29376     "version": "0.0.0",
29377     "filename": "server/api/user/index.js",
29378     "groupTitle": "Users"
29379   },
29380   {
29381     "type": "delete",
29382     "url": "/api/users/{id}/mail_interactions",
29383     "title": "Removes interactions from an agent",
29384     "examples": [
29385       {
29386         "title": "Example usage:",
29387         "content": "curl https://{domain}/api/users/{id}/mail_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29388         "type": "json"
29389       }
29390     ],
29391     "name": "RemoveMailInteractions",
29392     "group": "Users",
29393     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29394     "version": "0.0.0",
29395     "filename": "server/api/user/index.js",
29396     "groupTitle": "Users"
29397   },
29398   {
29399     "type": "delete",
29400     "url": "/api/users/{id}/openchannel_accounts",
29401     "title": "Removes a Open Channel Account from a user",
29402     "examples": [
29403       {
29404         "title": "Example usage:",
29405         "content": "curl https://{domain}/api/users/{id}/openchannel_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29406         "type": "json"
29407       }
29408     ],
29409     "name": "RemoveOpenchannelAccounts",
29410     "group": "Users",
29411     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29412     "version": "0.0.0",
29413     "filename": "server/api/user/index.js",
29414     "groupTitle": "Users"
29415   },
29416   {
29417     "type": "delete",
29418     "url": "/api/users/{id}/openchannel_interactions",
29419     "title": "Removes openchannel interactions from an agent",
29420     "examples": [
29421       {
29422         "title": "Example usage:",
29423         "content": "curl https://{domain}/api/users/{id}/openchannel_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29424         "type": "json"
29425       }
29426     ],
29427     "name": "RemoveOpenchannelInteractions",
29428     "group": "Users",
29429     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29430     "version": "0.0.0",
29431     "filename": "server/api/user/index.js",
29432     "groupTitle": "Users"
29433   },
29434   {
29435     "type": "delete",
29436     "url": "/api/users/{id}/queues",
29437     "title": "Remove queues to an agent",
29438     "examples": [
29439       {
29440         "title": "Example usage:",
29441         "content": "curl https://{domain}/api/users/{id}/queues?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29442         "type": "json"
29443       }
29444     ],
29445     "name": "RemoveQueues",
29446     "group": "Users",
29447     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29448     "version": "0.0.0",
29449     "filename": "server/api/user/index.js",
29450     "groupTitle": "Users"
29451   },
29452   {
29453     "type": "delete",
29454     "url": "/api/users/{id}/sms_accounts",
29455     "title": "Removes a Sms Account from a user",
29456     "examples": [
29457       {
29458         "title": "Example usage:",
29459         "content": "curl https://{domain}/api/users/{id}/sms_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29460         "type": "json"
29461       }
29462     ],
29463     "name": "RemoveSmsAccounts",
29464     "group": "Users",
29465     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29466     "version": "0.0.0",
29467     "filename": "server/api/user/index.js",
29468     "groupTitle": "Users"
29469   },
29470   {
29471     "type": "delete",
29472     "url": "/api/users/{id}/sms_interactions",
29473     "title": "Removes interactions from an agent",
29474     "examples": [
29475       {
29476         "title": "Example usage:",
29477         "content": "curl https://{domain}/api/users/{id}/sms_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29478         "type": "json"
29479       }
29480     ],
29481     "name": "RemoveSmsInteractions",
29482     "group": "Users",
29483     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29484     "version": "0.0.0",
29485     "filename": "server/api/user/index.js",
29486     "groupTitle": "Users"
29487   },
29488   {
29489     "type": "delete",
29490     "url": "/api/users/{id}/square_projects",
29491     "title": "Removes a Square Project from a user",
29492     "examples": [
29493       {
29494         "title": "Example usage:",
29495         "content": "curl https://{domain}/api/users/{id}/square_projects?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29496         "type": "json"
29497       }
29498     ],
29499     "name": "RemoveSquareProjects",
29500     "group": "Users",
29501     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29502     "version": "0.0.0",
29503     "filename": "server/api/user/index.js",
29504     "groupTitle": "Users"
29505   },
29506   {
29507     "type": "delete",
29508     "url": "/api/users/{id}/teams",
29509     "title": "Removes teams from an agent",
29510     "examples": [
29511       {
29512         "title": "Example usage:",
29513         "content": "curl https://{domain}/api/users/{id}/teams?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29514         "type": "json"
29515       }
29516     ],
29517     "name": "RemoveTeams",
29518     "group": "Users",
29519     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29520     "version": "0.0.0",
29521     "filename": "server/api/user/index.js",
29522     "groupTitle": "Users"
29523   },
29524   {
29525     "type": "delete",
29526     "url": "/api/users/{id}/whatsapp_accounts",
29527     "title": "Removes a Whatsapp Account from a user",
29528     "examples": [
29529       {
29530         "title": "Example usage:",
29531         "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29532         "type": "json"
29533       }
29534     ],
29535     "name": "RemoveWhatsappAccounts",
29536     "group": "Users",
29537     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29538     "version": "0.0.0",
29539     "filename": "server/api/user/index.js",
29540     "groupTitle": "Users"
29541   },
29542   {
29543     "type": "delete",
29544     "url": "/api/users/{id}/whatsapp_interactions",
29545     "title": "Removes Whatsapp interactions from an agent",
29546     "examples": [
29547       {
29548         "title": "Example usage:",
29549         "content": "curl https://{domain}/api/users/{id}/whatsapp_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29550         "type": "json"
29551       }
29552     ],
29553     "name": "RemoveWhatsappInteractions",
29554     "group": "Users",
29555     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29556     "version": "0.0.0",
29557     "filename": "server/api/user/index.js",
29558     "groupTitle": "Users"
29559   },
29560   {
29561     "type": "get",
29562     "url": "/api/users/{id}",
29563     "title": "Gets a single User",
29564     "examples": [
29565       {
29566         "title": "Example usage:",
29567         "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password}",
29568         "type": "json"
29569       }
29570     ],
29571     "name": "ShowUsers",
29572     "group": "Users",
29573     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29574     "version": "0.0.0",
29575     "filename": "server/api/user/index.js",
29576     "groupTitle": "Users"
29577   },
29578   {
29579     "type": "post",
29580     "url": "/api/users/{id}/unpause",
29581     "title": "Unpause",
29582     "examples": [
29583       {
29584         "title": "Example usage:",
29585         "content": "curl https://{domain}/api/users/{id}/unpause -v -u {name}:{password} -X POST",
29586         "type": "json"
29587       }
29588     ],
29589     "name": "Unpause",
29590     "group": "Users",
29591     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29592     "version": "0.0.0",
29593     "filename": "server/api/user/index.js",
29594     "groupTitle": "Users"
29595   },
29596   {
29597     "type": "get",
29598     "url": "/api/users/whoami",
29599     "title": "WhoAmI",
29600     "examples": [
29601       {
29602         "title": "Example usage:",
29603         "content": "curl https://{domain}/api/users/whoami -v -u {name}:{password} -X GET",
29604         "type": "json"
29605       }
29606     ],
29607     "name": "WhoAmI",
29608     "group": "Users",
29609     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29610     "version": "0.0.0",
29611     "filename": "server/api/user/index.js",
29612     "groupTitle": "Users"
29613   },
29614   {
29615     "type": "post",
29616     "url": "/api/users/{id}/avatar",
29617     "title": "Add avatar",
29618     "examples": [
29619       {
29620         "title": "Example usage:",
29621         "content": "curl https://{domain}/api/users/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
29622         "type": "json"
29623       }
29624     ],
29625     "name": "addAvatar",
29626     "group": "Users",
29627     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29628     "version": "0.0.0",
29629     "filename": "server/api/user/index.js",
29630     "groupTitle": "Users"
29631   },
29632   {
29633     "type": "post",
29634     "url": "/api/users/create_many",
29635     "title": "Create Users",
29636     "examples": [
29637       {
29638         "title": "Example usage:",
29639         "content": "curl https://{domain}/api/users/create_many -d '[{\"name\": \"john.doe\", \"role\": \"user\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",
29640         "type": "json"
29641       }
29642     ],
29643     "name": "bulkCreate",
29644     "group": "Users",
29645     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29646     "version": "0.0.0",
29647     "filename": "server/api/user/index.js",
29648     "groupTitle": "Users"
29649   },
29650   {
29651     "type": "get",
29652     "url": "/api/users/{id}/avatar",
29653     "title": "Get avatar",
29654     "examples": [
29655       {
29656         "title": "Example usage:",
29657         "content": "curl https://{domain}/api/users/{id}/avatar -v -u {name}:{password} -X GET",
29658         "type": "json"
29659       }
29660     ],
29661     "name": "getAvatar",
29662     "group": "Users",
29663     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29664     "version": "0.0.0",
29665     "filename": "server/api/user/index.js",
29666     "groupTitle": "Users"
29667   },
29668   {
29669     "type": "get",
29670     "url": "/api/users/presence",
29671     "title": "Gets agent presence",
29672     "examples": [
29673       {
29674         "title": "Example usage:",
29675         "content": "curl https://{domain}/api/users/presence -v -u {name}:{password}  -X GET",
29676         "type": "json"
29677       }
29678     ],
29679     "name": "getPresence",
29680     "group": "Users",
29681     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29682     "version": "0.0.0",
29683     "filename": "server/api/user/index.js",
29684     "groupTitle": "Users"
29685   },
29686   {
29687     "type": "put",
29688     "url": "/api/users/{id}",
29689     "title": "Update an existing User",
29690     "examples": [
29691       {
29692         "title": "Example usage:",
29693         "content": "curl https://{domain}/api/users/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
29694         "type": "json"
29695       }
29696     ],
29697     "name": "updateUsers",
29698     "group": "Users",
29699     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29700     "version": "0.0.0",
29701     "filename": "server/api/user/index.js",
29702     "groupTitle": "Users"
29703   },
29704   {
29705     "type": "post",
29706     "url": "/api/variables",
29707     "title": "Creates a new Variable",
29708     "examples": [
29709       {
29710         "title": "Example usage:",
29711         "content": "curl https://{domain}/api/variables -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
29712         "type": "json"
29713       }
29714     ],
29715     "name": "CreateVariables",
29716     "group": "Variables",
29717     "parameter": {
29718       "fields": {
29719         "Body": [
29720           {
29721             "group": "Body",
29722             "type": "String",
29723             "optional": false,
29724             "field": "name",
29725             "description": ""
29726           },
29727           {
29728             "group": "Body",
29729             "type": "String",
29730             "optional": true,
29731             "field": "description",
29732             "description": ""
29733           }
29734         ]
29735       }
29736     },
29737     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29738     "version": "0.0.0",
29739     "filename": "server/api/variable/index.js",
29740     "groupTitle": "Variables"
29741   },
29742   {
29743     "type": "delete",
29744     "url": "/api/variables/{id}",
29745     "title": "Deletes a Variable",
29746     "examples": [
29747       {
29748         "title": "Example usage:",
29749         "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password} -X DELETE",
29750         "type": "json"
29751       }
29752     ],
29753     "name": "DeleteVariables",
29754     "group": "Variables",
29755     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29756     "version": "0.0.0",
29757     "filename": "server/api/variable/index.js",
29758     "groupTitle": "Variables"
29759   },
29760   {
29761     "type": "get",
29762     "url": "/api/variables",
29763     "title": "Gets a list of Variables",
29764     "examples": [
29765       {
29766         "title": "Example usage:",
29767         "content": "curl https://{domain}/api/variables -v -u {name}:{password}",
29768         "type": "json"
29769       }
29770     ],
29771     "name": "GetVariables",
29772     "group": "Variables",
29773     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
29774     "version": "0.0.0",
29775     "filename": "server/api/variable/index.js",
29776     "groupTitle": "Variables"
29777   },
29778   {
29779     "type": "get",
29780     "url": "/api/variables/{id}",
29781     "title": "Gets a single Variable",
29782     "examples": [
29783       {
29784         "title": "Example usage:",
29785         "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password}",
29786         "type": "json"
29787       }
29788     ],
29789     "name": "ShowVariables",
29790     "group": "Variables",
29791     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29792     "version": "0.0.0",
29793     "filename": "server/api/variable/index.js",
29794     "groupTitle": "Variables"
29795   },
29796   {
29797     "type": "put",
29798     "url": "/api/variables/{id}",
29799     "title": "Update an existing Variable",
29800     "examples": [
29801       {
29802         "title": "Example usage:",
29803         "content": "curl https://{domain}/api/variables/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
29804         "type": "json"
29805       }
29806     ],
29807     "name": "updateVariables",
29808     "group": "Variables",
29809     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29810     "version": "0.0.0",
29811     "filename": "server/api/variable/index.js",
29812     "groupTitle": "Variables"
29813   },
29814   {
29815     "type": "get",
29816     "url": "/api/version/fetch",
29817     "title": "Fetch git version",
29818     "examples": [
29819       {
29820         "title": "Example usage:",
29821         "content": "curl https://{domain}/api/version/fetch -v -u {name}:{password}",
29822         "type": "json"
29823       }
29824     ],
29825     "name": "FetchVersion",
29826     "group": "Version",
29827     "description": "<p>Motion run the following command: git fetch origin master</p>",
29828     "version": "0.0.0",
29829     "filename": "server/api/version/index.js",
29830     "groupTitle": "Version"
29831   },
29832   {
29833     "type": "get",
29834     "url": "/api/version",
29835     "title": "Gets version",
29836     "examples": [
29837       {
29838         "title": "Example usage:",
29839         "content": "curl https://{domain}/api/version -v -u {name}:{password}",
29840         "type": "json"
29841       }
29842     ],
29843     "name": "GetVersion",
29844     "group": "Version",
29845     "description": "<p>Motion returns the current and latest motion version.</p>",
29846     "version": "0.0.0",
29847     "filename": "server/api/version/index.js",
29848     "groupTitle": "Version"
29849   },
29850   {
29851     "type": "get",
29852     "url": "/api/version/migrations",
29853     "title": "Launch database migrations",
29854     "examples": [
29855       {
29856         "title": "Example usage:",
29857         "content": "curl https://{domain}/api/version/migrations -v -u {name}:{password}",
29858         "type": "json"
29859       }
29860     ],
29861     "name": "MigrateVersion",
29862     "group": "Version",
29863     "description": "<p>Motion launch the database migrations, according to the application version</p>",
29864     "version": "0.0.0",
29865     "filename": "server/api/version/index.js",
29866     "groupTitle": "Version"
29867   },
29868   {
29869     "type": "get",
29870     "url": "/api/version/pull",
29871     "title": "Pull git version",
29872     "examples": [
29873       {
29874         "title": "Example usage:",
29875         "content": "curl https://{domain}/api/version/pull -v -u {name}:{password}",
29876         "type": "json"
29877       }
29878     ],
29879     "name": "PullVersion",
29880     "group": "Version",
29881     "description": "<p>Motion run the following command: git pull</p>",
29882     "version": "0.0.0",
29883     "filename": "server/api/version/index.js",
29884     "groupTitle": "Version"
29885   },
29886   {
29887     "type": "get",
29888     "url": "/api/version/reset",
29889     "title": "Reset git version",
29890     "examples": [
29891       {
29892         "title": "Example usage:",
29893         "content": "curl https://{domain}/api/version/reset -v -u {name}:{password}",
29894         "type": "json"
29895       }
29896     ],
29897     "name": "ResetVersion",
29898     "group": "Version",
29899     "description": "<p>Motion run the following command: git reset --hard FETCH_HEAD</p>",
29900     "version": "0.0.0",
29901     "filename": "server/api/version/index.js",
29902     "groupTitle": "Version"
29903   },
29904   {
29905     "type": "get",
29906     "url": "/api/version/restart",
29907     "title": "Restart motion2 after update",
29908     "examples": [
29909       {
29910         "title": "Example usage:",
29911         "content": "curl https://{domain}/api/version/restart -v -u {name}:{password}",
29912         "type": "json"
29913       }
29914     ],
29915     "name": "RestartVersion",
29916     "group": "Version",
29917     "description": "<p>Motion run the following command: pm2 restart motion</p>",
29918     "version": "0.0.0",
29919     "filename": "server/api/version/index.js",
29920     "groupTitle": "Version"
29921   },
29922   {
29923     "type": "get",
29924     "url": "/api/voice/agents/reports/describe",
29925     "title": "Gets table info about Agent Reports",
29926     "examples": [
29927       {
29928         "title": "Example usage:",
29929         "content": "curl https://{domain}/api/voice/agents/reports/describe -v -u {name}:{password}",
29930         "type": "json"
29931       }
29932     ],
29933     "name": "DescribeAgent_Reports",
29934     "group": "Voice_Agent_Reports",
29935     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29936     "version": "0.0.0",
29937     "filename": "server/api/voiceAgentReport/index.js",
29938     "groupTitle": "Voice_Agent_Reports"
29939   },
29940   {
29941     "type": "get",
29942     "url": "/api/voice/agents/reports",
29943     "title": "Gets a list of Agent Reports",
29944     "examples": [
29945       {
29946         "title": "Example usage:",
29947         "content": "curl https://{domain}/api/voice/agents/reports -v -u {name}:{password}",
29948         "type": "json"
29949       }
29950     ],
29951     "name": "GetAgent_Reports",
29952     "group": "Voice_Agent_Reports",
29953     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
29954     "version": "0.0.0",
29955     "filename": "server/api/voiceAgentReport/index.js",
29956     "groupTitle": "Voice_Agent_Reports"
29957   },
29958   {
29959     "type": "get",
29960     "url": "/api/voice/agents/reports/{id}",
29961     "title": "Gets a single Agent Report",
29962     "examples": [
29963       {
29964         "title": "Example usage:",
29965         "content": "curl https://{domain}/api/voice/agents/reports/{id} -v -u {name}:{password}",
29966         "type": "json"
29967       }
29968     ],
29969     "name": "ShowAgent_Reports",
29970     "group": "Voice_Agent_Reports",
29971     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29972     "version": "0.0.0",
29973     "filename": "server/api/voiceAgentReport/index.js",
29974     "groupTitle": "Voice_Agent_Reports"
29975   },
29976   {
29977     "type": "get",
29978     "url": "/api/voice/calls/reports/describe",
29979     "title": "Gets table info about Call Reports",
29980     "examples": [
29981       {
29982         "title": "Example usage:",
29983         "content": "curl https://{domain}/api/voice/calls/reports/describe -v -u {name}:{password}",
29984         "type": "json"
29985       }
29986     ],
29987     "name": "DescribeCall_Reports",
29988     "group": "Voice_Call_Reports",
29989     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29990     "version": "0.0.0",
29991     "filename": "server/api/voiceCallReport/index.js",
29992     "groupTitle": "Voice_Call_Reports"
29993   },
29994   {
29995     "type": "get",
29996     "url": "/api/voice/calls/reports",
29997     "title": "Gets a list of Call Reports",
29998     "examples": [
29999       {
30000         "title": "Example usage:",
30001         "content": "curl https://{domain}/api/voice/calls/reports -v -u {name}:{password}",
30002         "type": "json"
30003       }
30004     ],
30005     "name": "GetCall_Reports",
30006     "group": "Voice_Call_Reports",
30007     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30008     "version": "0.0.0",
30009     "filename": "server/api/voiceCallReport/index.js",
30010     "groupTitle": "Voice_Call_Reports"
30011   },
30012   {
30013     "type": "get",
30014     "url": "/api/voice/calls/reports/{id}",
30015     "title": "Gets a single Call Report",
30016     "examples": [
30017       {
30018         "title": "Example usage:",
30019         "content": "curl https://{domain}/api/voice/calls/reports/{id} -v -u {name}:{password}",
30020         "type": "json"
30021       }
30022     ],
30023     "name": "ShowCall_Reports",
30024     "group": "Voice_Call_Reports",
30025     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30026     "version": "0.0.0",
30027     "filename": "server/api/voiceCallReport/index.js",
30028     "groupTitle": "Voice_Call_Reports"
30029   },
30030   {
30031     "type": "put",
30032     "url": "/api/voice/calls/reports/{id}",
30033     "title": "Update a single cdr",
30034     "examples": [
30035       {
30036         "title": "Example usage:",
30037         "content": "curl https://{domain}/api/voice/calls/reports/{id} -d '{\"userDispositio\": \"OK\"}' -v -u {name}:{password} -X PUT",
30038         "type": "json"
30039       }
30040     ],
30041     "name": "update",
30042     "group": "Voice_Call_Reports",
30043     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30044     "version": "0.0.0",
30045     "filename": "server/api/voiceCallReport/index.js",
30046     "groupTitle": "Voice_Call_Reports"
30047   },
30048   {
30049     "type": "post",
30050     "url": "/api/voice/chanspy",
30051     "title": "Creates a new ChanSpy",
30052     "examples": [
30053       {
30054         "title": "Example usage:",
30055         "content": "curl https://{domain}/api/voice/chanspy -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
30056         "type": "json"
30057       }
30058     ],
30059     "name": "CreateChanSpy",
30060     "group": "Voice_ChanSpy",
30061     "parameter": {
30062       "fields": {
30063         "Body": [
30064           {
30065             "group": "Body",
30066             "type": "String",
30067             "optional": true,
30068             "field": "name",
30069             "description": ""
30070           },
30071           {
30072             "group": "Body",
30073             "type": "String",
30074             "optional": false,
30075             "field": "prefix",
30076             "description": ""
30077           },
30078           {
30079             "group": "Body",
30080             "type": "String",
30081             "optional": true,
30082             "field": "options",
30083             "description": ""
30084           },
30085           {
30086             "group": "Body",
30087             "type": "Boolean",
30088             "optional": true,
30089             "field": "auth",
30090             "description": ""
30091           },
30092           {
30093             "group": "Body",
30094             "type": "String",
30095             "optional": true,
30096             "field": "password",
30097             "description": ""
30098           },
30099           {
30100             "group": "Body",
30101             "type": "Boolean",
30102             "optional": true,
30103             "field": "record",
30104             "description": ""
30105           },
30106           {
30107             "group": "Body",
30108             "type": "String",
30109             "optional": true,
30110             "field": "recordingFormat",
30111             "description": ""
30112           },
30113           {
30114             "group": "Body",
30115             "type": "String",
30116             "optional": true,
30117             "field": "description",
30118             "description": ""
30119           }
30120         ]
30121       }
30122     },
30123     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30124     "version": "0.0.0",
30125     "filename": "server/api/voiceChanSpy/index.js",
30126     "groupTitle": "Voice_ChanSpy"
30127   },
30128   {
30129     "type": "delete",
30130     "url": "/api/voice/chanspy/{id}",
30131     "title": "Deletes a ChanSpy",
30132     "examples": [
30133       {
30134         "title": "Example usage:",
30135         "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password} -X DELETE",
30136         "type": "json"
30137       }
30138     ],
30139     "name": "DeleteChanSpy",
30140     "group": "Voice_ChanSpy",
30141     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30142     "version": "0.0.0",
30143     "filename": "server/api/voiceChanSpy/index.js",
30144     "groupTitle": "Voice_ChanSpy"
30145   },
30146   {
30147     "type": "get",
30148     "url": "/api/voice/chanspy",
30149     "title": "Gets a list of ChanSpy",
30150     "examples": [
30151       {
30152         "title": "Example usage:",
30153         "content": "curl https://{domain}/api/voice/chanspy -v -u {name}:{password}",
30154         "type": "json"
30155       }
30156     ],
30157     "name": "GetChanSpy",
30158     "group": "Voice_ChanSpy",
30159     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30160     "version": "0.0.0",
30161     "filename": "server/api/voiceChanSpy/index.js",
30162     "groupTitle": "Voice_ChanSpy"
30163   },
30164   {
30165     "type": "get",
30166     "url": "/api/voice/chanspy/{id}",
30167     "title": "Gets a single ChanSpy",
30168     "examples": [
30169       {
30170         "title": "Example usage:",
30171         "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password}",
30172         "type": "json"
30173       }
30174     ],
30175     "name": "ShowChanSpy",
30176     "group": "Voice_ChanSpy",
30177     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30178     "version": "0.0.0",
30179     "filename": "server/api/voiceChanSpy/index.js",
30180     "groupTitle": "Voice_ChanSpy"
30181   },
30182   {
30183     "type": "put",
30184     "url": "/api/voice/chanspy/{id}",
30185     "title": "Update an existing ChanSpy",
30186     "examples": [
30187       {
30188         "title": "Example usage:",
30189         "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",
30190         "type": "json"
30191       }
30192     ],
30193     "name": "updateChanSpy",
30194     "group": "Voice_ChanSpy",
30195     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30196     "version": "0.0.0",
30197     "filename": "server/api/voiceChanSpy/index.js",
30198     "groupTitle": "Voice_ChanSpy"
30199   },
30200   {
30201     "type": "post",
30202     "url": "/api/voice/contexts",
30203     "title": "Create a new context",
30204     "examples": [
30205       {
30206         "title": "Example usage:",
30207         "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password} -X POST",
30208         "type": "json"
30209       }
30210     ],
30211     "name": "Create",
30212     "group": "Voice_Contexts",
30213     "parameter": {
30214       "fields": {
30215         "Body": [
30216           {
30217             "group": "Body",
30218             "type": "String",
30219             "optional": true,
30220             "field": "name",
30221             "description": ""
30222           },
30223           {
30224             "group": "Body",
30225             "type": "String",
30226             "optional": true,
30227             "field": "description",
30228             "description": ""
30229           },
30230           {
30231             "group": "Body",
30232             "type": "Boolean",
30233             "optional": true,
30234             "field": "defaultEntry",
30235             "description": ""
30236           }
30237         ]
30238       }
30239     },
30240     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30241     "version": "0.0.0",
30242     "filename": "server/api/voiceContext/index.js",
30243     "groupTitle": "Voice_Contexts"
30244   },
30245   {
30246     "type": "delete",
30247     "url": "/api/voice/contexts/{id}",
30248     "title": "Deletes a context",
30249     "examples": [
30250       {
30251         "title": "Example usage:",
30252         "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X DELETE",
30253         "type": "json"
30254       }
30255     ],
30256     "name": "Delete",
30257     "group": "Voice_Contexts",
30258     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30259     "version": "0.0.0",
30260     "filename": "server/api/voiceContext/index.js",
30261     "groupTitle": "Voice_Contexts"
30262   },
30263   {
30264     "type": "get",
30265     "url": "/api/voice/contexts",
30266     "title": "Gets a list of Contexts",
30267     "examples": [
30268       {
30269         "title": "Example usage:",
30270         "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password}",
30271         "type": "json"
30272       }
30273     ],
30274     "name": "GetContexts",
30275     "group": "Voice_Contexts",
30276     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30277     "version": "0.0.0",
30278     "filename": "server/api/voiceContext/index.js",
30279     "groupTitle": "Voice_Contexts"
30280   },
30281   {
30282     "type": "get",
30283     "url": "/api/voice/contexts/{id}",
30284     "title": "Gets a single Context",
30285     "examples": [
30286       {
30287         "title": "Example usage:",
30288         "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password}",
30289         "type": "json"
30290       }
30291     ],
30292     "name": "ShowContexts",
30293     "group": "Voice_Contexts",
30294     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30295     "version": "0.0.0",
30296     "filename": "server/api/voiceContext/index.js",
30297     "groupTitle": "Voice_Contexts"
30298   },
30299   {
30300     "type": "put",
30301     "url": "/api/voice/contexts/{id}",
30302     "title": "Update an existing context",
30303     "examples": [
30304       {
30305         "title": "Example usage:",
30306         "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X PUT",
30307         "type": "json"
30308       }
30309     ],
30310     "name": "Update",
30311     "group": "Voice_Contexts",
30312     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30313     "version": "0.0.0",
30314     "filename": "server/api/voiceContext/index.js",
30315     "groupTitle": "Voice_Contexts"
30316   },
30317   {
30318     "type": "get",
30319     "url": "/api/voice/dials/reports/describe",
30320     "title": "Gets table info about Dial Reports",
30321     "examples": [
30322       {
30323         "title": "Example usage:",
30324         "content": "curl https://{domain}/api/voice/dials/reports/describe -v -u {name}:{password}",
30325         "type": "json"
30326       }
30327     ],
30328     "name": "DescribeDial_Reports",
30329     "group": "Voice_Dial_Reports",
30330     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30331     "version": "0.0.0",
30332     "filename": "server/api/voiceDialReport/index.js",
30333     "groupTitle": "Voice_Dial_Reports"
30334   },
30335   {
30336     "type": "get",
30337     "url": "/api/voice/dials/reports",
30338     "title": "Gets a list of Dial Reports",
30339     "examples": [
30340       {
30341         "title": "Example usage:",
30342         "content": "curl https://{domain}/api/voice/dials/reports -v -u {name}:{password}",
30343         "type": "json"
30344       }
30345     ],
30346     "name": "GetDial_Reports",
30347     "group": "Voice_Dial_Reports",
30348     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30349     "version": "0.0.0",
30350     "filename": "server/api/voiceDialReport/index.js",
30351     "groupTitle": "Voice_Dial_Reports"
30352   },
30353   {
30354     "type": "get",
30355     "url": "/api/voice/dials/reports/{id}",
30356     "title": "Gets a single Dial Report",
30357     "examples": [
30358       {
30359         "title": "Example usage:",
30360         "content": "curl https://{domain}/api/voice/dials/reports/{id} -v -u {name}:{password}",
30361         "type": "json"
30362       }
30363     ],
30364     "name": "ShowDial_Reports",
30365     "group": "Voice_Dial_Reports",
30366     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30367     "version": "0.0.0",
30368     "filename": "server/api/voiceDialReport/index.js",
30369     "groupTitle": "Voice_Dial_Reports"
30370   },
30371   {
30372     "type": "delete",
30373     "url": "/api/voice/extensions/{id}",
30374     "title": "Deletes a Extension",
30375     "examples": [
30376       {
30377         "title": "Example usage:",
30378         "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password} -X DELETE",
30379         "type": "json"
30380       }
30381     ],
30382     "name": "DeleteExtensions",
30383     "group": "Voice_Extensions",
30384     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30385     "version": "0.0.0",
30386     "filename": "server/api/voiceExtension/index.js",
30387     "groupTitle": "Voice_Extensions"
30388   },
30389   {
30390     "type": "get",
30391     "url": "/api/voice/extensions",
30392     "title": "Gets a list of Extensions",
30393     "examples": [
30394       {
30395         "title": "Example usage:",
30396         "content": "curl https://{domain}/api/voice/extensions -v -u {name}:{password}",
30397         "type": "json"
30398       }
30399     ],
30400     "name": "GetExtensions",
30401     "group": "Voice_Extensions",
30402     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30403     "version": "0.0.0",
30404     "filename": "server/api/voiceExtension/index.js",
30405     "groupTitle": "Voice_Extensions"
30406   },
30407   {
30408     "type": "get",
30409     "url": "/api/voice/extensions/{id}",
30410     "title": "Gets a single Extension",
30411     "examples": [
30412       {
30413         "title": "Example usage:",
30414         "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password}",
30415         "type": "json"
30416       }
30417     ],
30418     "name": "ShowExtensions",
30419     "group": "Voice_Extensions",
30420     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30421     "version": "0.0.0",
30422     "filename": "server/api/voiceExtension/index.js",
30423     "groupTitle": "Voice_Extensions"
30424   },
30425   {
30426     "type": "post",
30427     "url": "/api/voice/extensions",
30428     "title": "Create new applications",
30429     "examples": [
30430       {
30431         "title": "Example usage:",
30432         "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",
30433         "type": "json"
30434       }
30435     ],
30436     "name": "addApplications",
30437     "group": "Voice_Extensions",
30438     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30439     "version": "0.0.0",
30440     "filename": "server/api/voiceExtension/index.js",
30441     "groupTitle": "Voice_Extensions"
30442   },
30443   {
30444     "type": "post",
30445     "url": "/api/voice/extensions",
30446     "title": "Create an extension",
30447     "examples": [
30448       {
30449         "title": "Example usage:",
30450         "content": "curl https://{domain}/api/voice/extensions -d '{\"exten\": \"12345\", \"context\": \"from-custom\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30451         "type": "json"
30452       }
30453     ],
30454     "name": "create",
30455     "group": "Voice_Extensions",
30456     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30457     "version": "0.0.0",
30458     "filename": "server/api/voiceExtension/index.js",
30459     "groupTitle": "Voice_Extensions"
30460   },
30461   {
30462     "type": "put",
30463     "url": "/api/voice/extensions/{id}",
30464     "title": "Update an extension",
30465     "examples": [
30466       {
30467         "title": "Example usage:",
30468         "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",
30469         "type": "json"
30470       }
30471     ],
30472     "name": "update",
30473     "group": "Voice_Extensions",
30474     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30475     "version": "0.0.0",
30476     "filename": "server/api/voiceExtension/index.js",
30477     "groupTitle": "Voice_Extensions"
30478   },
30479   {
30480     "type": "post",
30481     "url": "/api/voice/mohs",
30482     "title": "Create a new a new MOH",
30483     "examples": [
30484       {
30485         "title": "Example usage:",
30486         "content": "curl https://{domain}/api/voice/mohs -d '{\"name\": \"xmas_musics\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30487         "type": "json"
30488       }
30489     ],
30490     "name": "AddMoh",
30491     "group": "Voice_MOHs",
30492     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30493     "version": "0.0.0",
30494     "filename": "server/api/voiceMusicOnHold/index.js",
30495     "groupTitle": "Voice_MOHs"
30496   },
30497   {
30498     "type": "post",
30499     "url": "/api/voice/mohs/{id}/sounds",
30500     "title": "Add sound to MOH",
30501     "examples": [
30502       {
30503         "title": "Example usage:",
30504         "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -d '{\"id\": 1}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30505         "type": "json"
30506       }
30507     ],
30508     "name": "AddSound",
30509     "group": "Voice_MOHs",
30510     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30511     "version": "0.0.0",
30512     "filename": "server/api/voiceMusicOnHold/index.js",
30513     "groupTitle": "Voice_MOHs"
30514   },
30515   {
30516     "type": "delete",
30517     "url": "/api/voice/mohs/{id}",
30518     "title": "Deletes an MOH",
30519     "examples": [
30520       {
30521         "title": "Example usage:",
30522         "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password} -X DELETE",
30523         "type": "json"
30524       }
30525     ],
30526     "name": "DestroyMoh",
30527     "group": "Voice_MOHs",
30528     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30529     "version": "0.0.0",
30530     "filename": "server/api/voiceMusicOnHold/index.js",
30531     "groupTitle": "Voice_MOHs"
30532   },
30533   {
30534     "type": "get",
30535     "url": "/api/voice/mohs",
30536     "title": "Gets a list of Music On Holds",
30537     "examples": [
30538       {
30539         "title": "Example usage:",
30540         "content": "curl https://{domain}/api/voice/mohs -v -u {name}:{password}",
30541         "type": "json"
30542       }
30543     ],
30544     "name": "GetMusic_On_Holds",
30545     "group": "Voice_MOHs",
30546     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30547     "version": "0.0.0",
30548     "filename": "server/api/voiceMusicOnHold/index.js",
30549     "groupTitle": "Voice_MOHs"
30550   },
30551   {
30552     "type": "get",
30553     "url": "/api/voice/mohs/{id}/sounds",
30554     "title": "Gets sounds from MOH",
30555     "examples": [
30556       {
30557         "title": "Example usage:",
30558         "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -v -u {name}:{password} -X DELETE",
30559         "type": "json"
30560       }
30561     ],
30562     "name": "GetSounds",
30563     "group": "Voice_MOHs",
30564     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30565     "version": "0.0.0",
30566     "filename": "server/api/voiceMusicOnHold/index.js",
30567     "groupTitle": "Voice_MOHs"
30568   },
30569   {
30570     "type": "delete",
30571     "url": "/api/voice/mohs/{id}/sounds/{id2}",
30572     "title": "Remove sound from MOH",
30573     "examples": [
30574       {
30575         "title": "Example usage:",
30576         "content": "curl https://{domain}/api/voice/mohs/{id}/sounds/{id2} -v -u {name}:{password} -X DELETE",
30577         "type": "json"
30578       }
30579     ],
30580     "name": "RemoveSound",
30581     "group": "Voice_MOHs",
30582     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30583     "version": "0.0.0",
30584     "filename": "server/api/voiceMusicOnHold/index.js",
30585     "groupTitle": "Voice_MOHs"
30586   },
30587   {
30588     "type": "get",
30589     "url": "/api/voice/mohs/{id}",
30590     "title": "Gets a single Music On Hold",
30591     "examples": [
30592       {
30593         "title": "Example usage:",
30594         "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password}",
30595         "type": "json"
30596       }
30597     ],
30598     "name": "ShowMusic_On_Holds",
30599     "group": "Voice_MOHs",
30600     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30601     "version": "0.0.0",
30602     "filename": "server/api/voiceMusicOnHold/index.js",
30603     "groupTitle": "Voice_MOHs"
30604   },
30605   {
30606     "type": "put",
30607     "url": "/api/voice/mohs/{id}",
30608     "title": "Update an existing Music On Hold",
30609     "examples": [
30610       {
30611         "title": "Example usage:",
30612         "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",
30613         "type": "json"
30614       }
30615     ],
30616     "name": "updateMusic_On_Holds",
30617     "group": "Voice_MOHs",
30618     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30619     "version": "0.0.0",
30620     "filename": "server/api/voiceMusicOnHold/index.js",
30621     "groupTitle": "Voice_MOHs"
30622   },
30623   {
30624     "type": "post",
30625     "url": "/api/voice/mails",
30626     "title": "Creates a new Mail",
30627     "examples": [
30628       {
30629         "title": "Example usage:",
30630         "content": "curl https://{domain}/api/voice/mails -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
30631         "type": "json"
30632       }
30633     ],
30634     "name": "CreateMails",
30635     "group": "Voice_Mails",
30636     "parameter": {
30637       "fields": {
30638         "Body": [
30639           {
30640             "group": "Body",
30641             "type": "String",
30642             "optional": true,
30643             "field": "customer_id",
30644             "description": ""
30645           },
30646           {
30647             "group": "Body",
30648             "type": "String",
30649             "optional": true,
30650             "field": "context",
30651             "description": ""
30652           },
30653           {
30654             "group": "Body",
30655             "type": "String",
30656             "optional": false,
30657             "field": "mailbox",
30658             "description": ""
30659           },
30660           {
30661             "group": "Body",
30662             "type": "String",
30663             "optional": true,
30664             "field": "password",
30665             "description": ""
30666           },
30667           {
30668             "group": "Body",
30669             "type": "String",
30670             "optional": true,
30671             "field": "fullname",
30672             "description": ""
30673           },
30674           {
30675             "group": "Body",
30676             "type": "String",
30677             "optional": true,
30678             "field": "email",
30679             "description": ""
30680           },
30681           {
30682             "group": "Body",
30683             "type": "String",
30684             "optional": true,
30685             "field": "pager",
30686             "description": ""
30687           },
30688           {
30689             "group": "Body",
30690             "type": "String",
30691             "optional": true,
30692             "field": "tz",
30693             "description": ""
30694           },
30695           {
30696             "group": "Body",
30697             "type": "String",
30698             "allowedValues": [
30699               "\"yes\"",
30700               "\"no\""
30701             ],
30702             "optional": false,
30703             "field": "attach",
30704             "description": ""
30705           },
30706           {
30707             "group": "Body",
30708             "type": "String",
30709             "allowedValues": [
30710               "\"yes\"",
30711               "\"no\""
30712             ],
30713             "optional": false,
30714             "field": "saycid",
30715             "description": ""
30716           },
30717           {
30718             "group": "Body",
30719             "type": "String",
30720             "optional": true,
30721             "field": "dialout",
30722             "description": ""
30723           },
30724           {
30725             "group": "Body",
30726             "type": "String",
30727             "optional": true,
30728             "field": "callback",
30729             "description": ""
30730           },
30731           {
30732             "group": "Body",
30733             "type": "String",
30734             "allowedValues": [
30735               "\"yes\"",
30736               "\"no\""
30737             ],
30738             "optional": false,
30739             "field": "review",
30740             "description": ""
30741           },
30742           {
30743             "group": "Body",
30744             "type": "String",
30745             "allowedValues": [
30746               "\"yes\"",
30747               "\"no\""
30748             ],
30749             "optional": false,
30750             "field": "operator",
30751             "description": ""
30752           },
30753           {
30754             "group": "Body",
30755             "type": "String",
30756             "allowedValues": [
30757               "\"yes\"",
30758               "\"no\""
30759             ],
30760             "optional": false,
30761             "field": "envelope",
30762             "description": ""
30763           },
30764           {
30765             "group": "Body",
30766             "type": "String",
30767             "allowedValues": [
30768               "\"yes\"",
30769               "\"no\""
30770             ],
30771             "optional": false,
30772             "field": "sayduration",
30773             "description": ""
30774           },
30775           {
30776             "group": "Body",
30777             "type": "String",
30778             "optional": false,
30779             "field": "saydurationm",
30780             "description": ""
30781           },
30782           {
30783             "group": "Body",
30784             "type": "String",
30785             "allowedValues": [
30786               "\"yes\"",
30787               "\"no\""
30788             ],
30789             "optional": false,
30790             "field": "sendvoicemail",
30791             "description": ""
30792           },
30793           {
30794             "group": "Body",
30795             "type": "String",
30796             "allowedValues": [
30797               "\"yes\"",
30798               "\"no\""
30799             ],
30800             "optional": false,
30801             "field": "delete",
30802             "description": ""
30803           },
30804           {
30805             "group": "Body",
30806             "type": "String",
30807             "allowedValues": [
30808               "\"yes\"",
30809               "\"no\""
30810             ],
30811             "optional": false,
30812             "field": "nextaftercmd",
30813             "description": ""
30814           },
30815           {
30816             "group": "Body",
30817             "type": "String",
30818             "allowedValues": [
30819               "\"yes\"",
30820               "\"no\""
30821             ],
30822             "optional": false,
30823             "field": "forcename",
30824             "description": ""
30825           },
30826           {
30827             "group": "Body",
30828             "type": "String",
30829             "allowedValues": [
30830               "\"yes\"",
30831               "\"no\""
30832             ],
30833             "optional": false,
30834             "field": "forcegreetings",
30835             "description": ""
30836           },
30837           {
30838             "group": "Body",
30839             "type": "String",
30840             "allowedValues": [
30841               "\"yes\"",
30842               "\"no\""
30843             ],
30844             "optional": false,
30845             "field": "hidefromdir",
30846             "description": ""
30847           },
30848           {
30849             "group": "Body",
30850             "type": "String",
30851             "optional": true,
30852             "field": "stamp",
30853             "description": ""
30854           },
30855           {
30856             "group": "Body",
30857             "type": "String",
30858             "optional": true,
30859             "field": "emailsubject",
30860             "description": ""
30861           },
30862           {
30863             "group": "Body",
30864             "type": "String",
30865             "optional": true,
30866             "field": "emailbody",
30867             "description": ""
30868           },
30869           {
30870             "group": "Body",
30871             "type": "Integer",
30872             "optional": false,
30873             "field": "maxsecs",
30874             "description": ""
30875           },
30876           {
30877             "group": "Body",
30878             "type": "Integer",
30879             "optional": false,
30880             "field": "maxmsg",
30881             "description": ""
30882           },
30883           {
30884             "group": "Body",
30885             "type": "Virtual",
30886             "optional": true,
30887             "field": "name",
30888             "description": ""
30889           }
30890         ]
30891       }
30892     },
30893     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30894     "version": "0.0.0",
30895     "filename": "server/api/voiceMail/index.js",
30896     "groupTitle": "Voice_Mails"
30897   },
30898   {
30899     "type": "delete",
30900     "url": "/api/voice/mails/{id}",
30901     "title": "Deletes a Mail",
30902     "examples": [
30903       {
30904         "title": "Example usage:",
30905         "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password} -X DELETE",
30906         "type": "json"
30907       }
30908     ],
30909     "name": "DeleteMails",
30910     "group": "Voice_Mails",
30911     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30912     "version": "0.0.0",
30913     "filename": "server/api/voiceMail/index.js",
30914     "groupTitle": "Voice_Mails"
30915   },
30916   {
30917     "type": "get",
30918     "url": "/api/voice/mails",
30919     "title": "Gets a list of Mails",
30920     "examples": [
30921       {
30922         "title": "Example usage:",
30923         "content": "curl https://{domain}/api/voice/mails -v -u {name}:{password}",
30924         "type": "json"
30925       }
30926     ],
30927     "name": "GetMails",
30928     "group": "Voice_Mails",
30929     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30930     "version": "0.0.0",
30931     "filename": "server/api/voiceMail/index.js",
30932     "groupTitle": "Voice_Mails"
30933   },
30934   {
30935     "type": "get",
30936     "url": "/api/voice/mails/{id}",
30937     "title": "Gets a single Mail",
30938     "examples": [
30939       {
30940         "title": "Example usage:",
30941         "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password}",
30942         "type": "json"
30943       }
30944     ],
30945     "name": "ShowMails",
30946     "group": "Voice_Mails",
30947     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30948     "version": "0.0.0",
30949     "filename": "server/api/voiceMail/index.js",
30950     "groupTitle": "Voice_Mails"
30951   },
30952   {
30953     "type": "get",
30954     "url": "/api/voice/mails/{id}/messages",
30955     "title": "Gets voice mail messages",
30956     "examples": [
30957       {
30958         "title": "Example usage:",
30959         "content": "curl https://{domain}/api/voice/mails/{id}/messages -v -u {name}:{password} -X GET",
30960         "type": "json"
30961       }
30962     ],
30963     "name": "getMessages",
30964     "group": "Voice_Mails",
30965     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30966     "version": "0.0.0",
30967     "filename": "server/api/voiceMail/index.js",
30968     "groupTitle": "Voice_Mails"
30969   },
30970   {
30971     "type": "put",
30972     "url": "/api/voice/mails/{id}",
30973     "title": "Update an existing Mail",
30974     "examples": [
30975       {
30976         "title": "Example usage:",
30977         "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",
30978         "type": "json"
30979       }
30980     ],
30981     "name": "updateMails",
30982     "group": "Voice_Mails",
30983     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30984     "version": "0.0.0",
30985     "filename": "server/api/voiceMail/index.js",
30986     "groupTitle": "Voice_Mails"
30987   },
30988   {
30989     "type": "post",
30990     "url": "/api/voice/mails/messages",
30991     "title": "Creates a new Message",
30992     "examples": [
30993       {
30994         "title": "Example usage:",
30995         "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",
30996         "type": "json"
30997       }
30998     ],
30999     "name": "CreateMessages",
31000     "group": "Voice_Messages",
31001     "parameter": {
31002       "fields": {
31003         "Body": [
31004           {
31005             "group": "Body",
31006             "type": "Virtual",
31007             "optional": true,
31008             "field": "name",
31009             "description": ""
31010           },
31011           {
31012             "group": "Body",
31013             "type": "Integer",
31014             "optional": false,
31015             "field": "msgnum",
31016             "description": ""
31017           },
31018           {
31019             "group": "Body",
31020             "type": "String",
31021             "optional": true,
31022             "field": "dir",
31023             "description": ""
31024           },
31025           {
31026             "group": "Body",
31027             "type": "String",
31028             "optional": true,
31029             "field": "context",
31030             "description": ""
31031           },
31032           {
31033             "group": "Body",
31034             "type": "String",
31035             "optional": true,
31036             "field": "macrocontext",
31037             "description": ""
31038           },
31039           {
31040             "group": "Body",
31041             "type": "String",
31042             "optional": true,
31043             "field": "callerid",
31044             "description": ""
31045           },
31046           {
31047             "group": "Body",
31048             "type": "String",
31049             "optional": true,
31050             "field": "origtime",
31051             "description": ""
31052           },
31053           {
31054             "group": "Body",
31055             "type": "String",
31056             "optional": true,
31057             "field": "duration",
31058             "description": ""
31059           },
31060           {
31061             "group": "Body",
31062             "type": "String",
31063             "optional": true,
31064             "field": "mailboxuser",
31065             "description": ""
31066           },
31067           {
31068             "group": "Body",
31069             "type": "String",
31070             "optional": true,
31071             "field": "mailboxcontext",
31072             "description": ""
31073           },
31074           {
31075             "group": "Body",
31076             "type": "Blob",
31077             "optional": true,
31078             "field": "recording",
31079             "description": ""
31080           },
31081           {
31082             "group": "Body",
31083             "type": "String",
31084             "optional": true,
31085             "field": "flag",
31086             "description": ""
31087           },
31088           {
31089             "group": "Body",
31090             "type": "String",
31091             "optional": true,
31092             "field": "msg_id",
31093             "description": ""
31094           },
31095           {
31096             "group": "Body",
31097             "type": "String",
31098             "optional": false,
31099             "field": "stamp",
31100             "description": ""
31101           }
31102         ]
31103       }
31104     },
31105     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31106     "version": "0.0.0",
31107     "filename": "server/api/voiceMailMessage/index.js",
31108     "groupTitle": "Voice_Messages"
31109   },
31110   {
31111     "type": "delete",
31112     "url": "/api/voice/mails/messages/{id}",
31113     "title": "Deletes a Message",
31114     "examples": [
31115       {
31116         "title": "Example usage:",
31117         "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password} -X DELETE",
31118         "type": "json"
31119       }
31120     ],
31121     "name": "DeleteMessages",
31122     "group": "Voice_Messages",
31123     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31124     "version": "0.0.0",
31125     "filename": "server/api/voiceMailMessage/index.js",
31126     "groupTitle": "Voice_Messages"
31127   },
31128   {
31129     "type": "get",
31130     "url": "/api/voice/mails/messages",
31131     "title": "Gets a list of Messages",
31132     "examples": [
31133       {
31134         "title": "Example usage:",
31135         "content": "curl https://{domain}/api/voice/mails/messages -v -u {name}:{password}",
31136         "type": "json"
31137       }
31138     ],
31139     "name": "GetMessages",
31140     "group": "Voice_Messages",
31141     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31142     "version": "0.0.0",
31143     "filename": "server/api/voiceMailMessage/index.js",
31144     "groupTitle": "Voice_Messages"
31145   },
31146   {
31147     "type": "get",
31148     "url": "/api/voice/mails/messages/{id}",
31149     "title": "Gets a single Message",
31150     "examples": [
31151       {
31152         "title": "Example usage:",
31153         "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password}",
31154         "type": "json"
31155       }
31156     ],
31157     "name": "ShowMessages",
31158     "group": "Voice_Messages",
31159     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31160     "version": "0.0.0",
31161     "filename": "server/api/voiceMailMessage/index.js",
31162     "groupTitle": "Voice_Messages"
31163   },
31164   {
31165     "type": "get",
31166     "url": "voice/mails/messages/{id}/download",
31167     "title": "Download Voice Message",
31168     "examples": [
31169       {
31170         "title": "Example usage:",
31171         "content": "curl https://{domain}voice/mails/messages/{id}/download -v -u {name}:{password} -X GET",
31172         "type": "json"
31173       }
31174     ],
31175     "name": "download",
31176     "group": "Voice_Messages",
31177     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31178     "version": "0.0.0",
31179     "filename": "server/api/voiceMailMessage/index.js",
31180     "groupTitle": "Voice_Messages"
31181   },
31182   {
31183     "type": "put",
31184     "url": "/api/voice/mails/messages/{id}",
31185     "title": "Update an existing Message",
31186     "examples": [
31187       {
31188         "title": "Example usage:",
31189         "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",
31190         "type": "json"
31191       }
31192     ],
31193     "name": "updateMessages",
31194     "group": "Voice_Messages",
31195     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31196     "version": "0.0.0",
31197     "filename": "server/api/voiceMailMessage/index.js",
31198     "groupTitle": "Voice_Messages"
31199   },
31200   {
31201     "type": "post",
31202     "url": "/api/voice/prefixes/{id}/users",
31203     "title": "Add agents to a prefix",
31204     "examples": [
31205       {
31206         "title": "Example usage:",
31207         "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",
31208         "type": "json"
31209       }
31210     ],
31211     "name": "AddAgents",
31212     "group": "Voice_Prefixes",
31213     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31214     "version": "0.0.0",
31215     "filename": "server/api/voicePrefix/index.js",
31216     "groupTitle": "Voice_Prefixes"
31217   },
31218   {
31219     "type": "delete",
31220     "url": "/api/voice/prefixes/{id}",
31221     "title": "Deletes a Prefix",
31222     "examples": [
31223       {
31224         "title": "Example usage:",
31225         "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X DELETE",
31226         "type": "json"
31227       }
31228     ],
31229     "name": "DeletePrefixes",
31230     "group": "Voice_Prefixes",
31231     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31232     "version": "0.0.0",
31233     "filename": "server/api/voicePrefix/index.js",
31234     "groupTitle": "Voice_Prefixes"
31235   },
31236   {
31237     "type": "get",
31238     "url": "/api/voice/prefixes/describe",
31239     "title": "Gets table info about Prefixes",
31240     "examples": [
31241       {
31242         "title": "Example usage:",
31243         "content": "curl https://{domain}/api/voice/prefixes/describe -v -u {name}:{password}",
31244         "type": "json"
31245       }
31246     ],
31247     "name": "DescribePrefixes",
31248     "group": "Voice_Prefixes",
31249     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31250     "version": "0.0.0",
31251     "filename": "server/api/voicePrefix/index.js",
31252     "groupTitle": "Voice_Prefixes"
31253   },
31254   {
31255     "type": "get",
31256     "url": "/api/voice/prefixes/{id}/users",
31257     "title": "Gets agents from prefix",
31258     "examples": [
31259       {
31260         "title": "Example usage:",
31261         "content": "curl https://{domain}/api/voice/prefixes/{id}/users -v -u {name}:{password} -X GET",
31262         "type": "json"
31263       }
31264     ],
31265     "name": "GetAgents",
31266     "group": "Voice_Prefixes",
31267     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31268     "version": "0.0.0",
31269     "filename": "server/api/voicePrefix/index.js",
31270     "groupTitle": "Voice_Prefixes"
31271   },
31272   {
31273     "type": "get",
31274     "url": "/api/voice/prefixes",
31275     "title": "Gets a list of Prefixes",
31276     "examples": [
31277       {
31278         "title": "Example usage:",
31279         "content": "curl https://{domain}/api/voice/prefixes -v -u {name}:{password}",
31280         "type": "json"
31281       }
31282     ],
31283     "name": "GetPrefixes",
31284     "group": "Voice_Prefixes",
31285     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31286     "version": "0.0.0",
31287     "filename": "server/api/voicePrefix/index.js",
31288     "groupTitle": "Voice_Prefixes"
31289   },
31290   {
31291     "type": "delete",
31292     "url": "/api/voice/prefixes/{id}/users",
31293     "title": "Removes agents from a prefix",
31294     "examples": [
31295       {
31296         "title": "Example usage:",
31297         "content": "curl https://{domain}/api/voice/prefixes/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
31298         "type": "json"
31299       }
31300     ],
31301     "name": "RemoveAgents",
31302     "group": "Voice_Prefixes",
31303     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31304     "version": "0.0.0",
31305     "filename": "server/api/voicePrefix/index.js",
31306     "groupTitle": "Voice_Prefixes"
31307   },
31308   {
31309     "type": "get",
31310     "url": "/api/voice/prefixes/{id}",
31311     "title": "Gets a single Prefix",
31312     "examples": [
31313       {
31314         "title": "Example usage:",
31315         "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password}",
31316         "type": "json"
31317       }
31318     ],
31319     "name": "ShowPrefixes",
31320     "group": "Voice_Prefixes",
31321     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31322     "version": "0.0.0",
31323     "filename": "server/api/voicePrefix/index.js",
31324     "groupTitle": "Voice_Prefixes"
31325   },
31326   {
31327     "type": "put",
31328     "url": "/api/voice/prefixes/{id}",
31329     "title": "Update an existing prefix",
31330     "examples": [
31331       {
31332         "title": "Example usage:",
31333         "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X PUT",
31334         "type": "json"
31335       }
31336     ],
31337     "name": "Update",
31338     "group": "Voice_Prefixes",
31339     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31340     "version": "0.0.0",
31341     "filename": "server/api/voicePrefix/index.js",
31342     "groupTitle": "Voice_Prefixes"
31343   },
31344   {
31345     "type": "post",
31346     "url": "/api/voice/prefixes",
31347     "title": "Create a prefix",
31348     "examples": [
31349       {
31350         "title": "Example usage:",
31351         "content": "curl https://{domain}/api/voice/prefixes -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31352         "type": "json"
31353       }
31354     ],
31355     "name": "create",
31356     "group": "Voice_Prefixes",
31357     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31358     "version": "0.0.0",
31359     "filename": "server/api/voicePrefix/index.js",
31360     "groupTitle": "Voice_Prefixes"
31361   },
31362   {
31363     "type": "get",
31364     "url": "/api/voice/queues/reports/describe",
31365     "title": "Gets table info about Queue Reports",
31366     "examples": [
31367       {
31368         "title": "Example usage:",
31369         "content": "curl https://{domain}/api/voice/queues/reports/describe -v -u {name}:{password}",
31370         "type": "json"
31371       }
31372     ],
31373     "name": "DescribeQueue_Reports",
31374     "group": "Voice_Queue_Reports",
31375     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31376     "version": "0.0.0",
31377     "filename": "server/api/voiceQueueReport/index.js",
31378     "groupTitle": "Voice_Queue_Reports"
31379   },
31380   {
31381     "type": "get",
31382     "url": "/api/voice/queues/reports",
31383     "title": "Gets a list of Queue Reports",
31384     "examples": [
31385       {
31386         "title": "Example usage:",
31387         "content": "curl https://{domain}/api/voice/queues/reports -v -u {name}:{password}",
31388         "type": "json"
31389       }
31390     ],
31391     "name": "GetQueue_Reports",
31392     "group": "Voice_Queue_Reports",
31393     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31394     "version": "0.0.0",
31395     "filename": "server/api/voiceQueueReport/index.js",
31396     "groupTitle": "Voice_Queue_Reports"
31397   },
31398   {
31399     "type": "get",
31400     "url": "/api/voice/queues/reports/{id}",
31401     "title": "Gets a single Queue Report",
31402     "examples": [
31403       {
31404         "title": "Example usage:",
31405         "content": "curl https://{domain}/api/voice/queues/reports/{id} -v -u {name}:{password}",
31406         "type": "json"
31407       }
31408     ],
31409     "name": "ShowQueue_Reports",
31410     "group": "Voice_Queue_Reports",
31411     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31412     "version": "0.0.0",
31413     "filename": "server/api/voiceQueueReport/index.js",
31414     "groupTitle": "Voice_Queue_Reports"
31415   },
31416   {
31417     "type": "get",
31418     "url": "/api/voice/queues/reports/index",
31419     "title": "Get Voice Queues Report",
31420     "examples": [
31421       {
31422         "title": "Example usage:",
31423         "content": "curl https://{domain}/api/voice/queues/reports/index -v -u {name}:{password} -X GET",
31424         "type": "json"
31425       }
31426     ],
31427     "name": "getVoiceQueuesReport",
31428     "group": "Voice_Queue_Reports",
31429     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31430     "version": "0.0.0",
31431     "filename": "server/api/voiceQueueReport/index.js",
31432     "groupTitle": "Voice_Queue_Reports"
31433   },
31434   {
31435     "type": "post",
31436     "url": "/api/voice/queues/{id}/users",
31437     "title": "Add agents to queue",
31438     "examples": [
31439       {
31440         "title": "Example usage:",
31441         "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",
31442         "type": "json"
31443       }
31444     ],
31445     "name": "AddAgents",
31446     "group": "Voice_Queues",
31447     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31448     "version": "0.0.0",
31449     "filename": "server/api/voiceQueue/index.js",
31450     "groupTitle": "Voice_Queues"
31451   },
31452   {
31453     "type": "post",
31454     "url": "/api/voice/queues/{id}/blacklists",
31455     "title": "Add blacklists to a queue",
31456     "examples": [
31457       {
31458         "title": "Example usage:",
31459         "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",
31460         "type": "json"
31461       }
31462     ],
31463     "name": "AddBlackLists",
31464     "group": "Voice_Queues",
31465     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31466     "version": "0.0.0",
31467     "filename": "server/api/voiceQueue/index.js",
31468     "groupTitle": "Voice_Queues"
31469   },
31470   {
31471     "type": "post",
31472     "url": "/api/voice/queues/{id}/lists",
31473     "title": "Add lists to a queue",
31474     "examples": [
31475       {
31476         "title": "Example usage:",
31477         "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",
31478         "type": "json"
31479       }
31480     ],
31481     "name": "AddLists",
31482     "group": "Voice_Queues",
31483     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31484     "version": "0.0.0",
31485     "filename": "server/api/voiceQueue/index.js",
31486     "groupTitle": "Voice_Queues"
31487   },
31488   {
31489     "type": "post",
31490     "url": "/api/voice/queues/{id}/teams",
31491     "title": "Add teams to queue",
31492     "examples": [
31493       {
31494         "title": "Example usage:",
31495         "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",
31496         "type": "json"
31497       }
31498     ],
31499     "name": "AddTeams",
31500     "group": "Voice_Queues",
31501     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31502     "version": "0.0.0",
31503     "filename": "server/api/voiceQueue/index.js",
31504     "groupTitle": "Voice_Queues"
31505   },
31506   {
31507     "type": "post",
31508     "url": "/api/voice/queues/clone",
31509     "title": "Clone an existing Queue",
31510     "examples": [
31511       {
31512         "title": "Example usage:",
31513         "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",
31514         "type": "json"
31515       }
31516     ],
31517     "name": "CloneQueues",
31518     "group": "Voice_Queues",
31519     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31520     "version": "0.0.0",
31521     "filename": "server/api/voiceQueue/index.js",
31522     "groupTitle": "Voice_Queues"
31523   },
31524   {
31525     "type": "post",
31526     "url": "/api/voice/queues",
31527     "title": "Creates a new Queue",
31528     "examples": [
31529       {
31530         "title": "Example usage:",
31531         "content": "curl https://{domain}/api/voice/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
31532         "type": "json"
31533       }
31534     ],
31535     "name": "CreateQueues",
31536     "group": "Voice_Queues",
31537     "parameter": {
31538       "fields": {
31539         "Body": [
31540           {
31541             "group": "Body",
31542             "type": "String",
31543             "optional": false,
31544             "field": "name",
31545             "description": ""
31546           },
31547           {
31548             "group": "Body",
31549             "type": "String",
31550             "allowedValues": [
31551               "\"inbound\"",
31552               "\"outbound\""
31553             ],
31554             "optional": false,
31555             "field": "type",
31556             "description": ""
31557           },
31558           {
31559             "group": "Body",
31560             "type": "String",
31561             "optional": true,
31562             "field": "musiconhold",
31563             "description": ""
31564           },
31565           {
31566             "group": "Body",
31567             "type": "String",
31568             "optional": true,
31569             "field": "announce",
31570             "description": ""
31571           },
31572           {
31573             "group": "Body",
31574             "type": "String",
31575             "allowedValues": [
31576               "\"rr\"",
31577               "\"ringall\"",
31578               "\"leastrecent\"",
31579               "\"fewestcalls\"",
31580               "\"random\"",
31581               "\"rrmemory\"",
31582               "\"linear\"",
31583               "\"wrandom\"",
31584               "\"rrordered\""
31585             ],
31586             "optional": false,
31587             "field": "strategy",
31588             "description": ""
31589           },
31590           {
31591             "group": "Body",
31592             "type": "Integer",
31593             "optional": true,
31594             "field": "servicelevel",
31595             "description": ""
31596           },
31597           {
31598             "group": "Body",
31599             "type": "String",
31600             "optional": true,
31601             "field": "context",
31602             "description": ""
31603           },
31604           {
31605             "group": "Body",
31606             "type": "Integer",
31607             "optional": true,
31608             "field": "penaltymemberslimit",
31609             "description": ""
31610           },
31611           {
31612             "group": "Body",
31613             "type": "Integer",
31614             "optional": true,
31615             "field": "timeout",
31616             "description": ""
31617           },
31618           {
31619             "group": "Body",
31620             "type": "Integer",
31621             "optional": true,
31622             "field": "retry",
31623             "description": ""
31624           },
31625           {
31626             "group": "Body",
31627             "type": "String",
31628             "optional": true,
31629             "field": "timeoutpriority",
31630             "description": ""
31631           },
31632           {
31633             "group": "Body",
31634             "type": "Integer",
31635             "optional": true,
31636             "field": "weight",
31637             "description": ""
31638           },
31639           {
31640             "group": "Body",
31641             "type": "Integer",
31642             "optional": true,
31643             "field": "wrapuptime",
31644             "description": ""
31645           },
31646           {
31647             "group": "Body",
31648             "type": "String",
31649             "allowedValues": [
31650               "\"yes\"",
31651               "\"no\""
31652             ],
31653             "optional": true,
31654             "field": "autofill",
31655             "description": ""
31656           },
31657           {
31658             "group": "Body",
31659             "type": "String",
31660             "allowedValues": [
31661               "\"yes\"",
31662               "\"no\"",
31663               "\"all\""
31664             ],
31665             "optional": true,
31666             "field": "autopause",
31667             "description": ""
31668           },
31669           {
31670             "group": "Body",
31671             "type": "Integer",
31672             "optional": true,
31673             "field": "autopausedelay",
31674             "description": ""
31675           },
31676           {
31677             "group": "Body",
31678             "type": "String",
31679             "allowedValues": [
31680               "\"yes\"",
31681               "\"no\""
31682             ],
31683             "optional": true,
31684             "field": "autopausebusy",
31685             "description": ""
31686           },
31687           {
31688             "group": "Body",
31689             "type": "String",
31690             "allowedValues": [
31691               "\"yes\"",
31692               "\"no\""
31693             ],
31694             "optional": true,
31695             "field": "autopauseunavail",
31696             "description": ""
31697           },
31698           {
31699             "group": "Body",
31700             "type": "Integer",
31701             "optional": true,
31702             "field": "maxlen",
31703             "description": ""
31704           },
31705           {
31706             "group": "Body",
31707             "type": "String",
31708             "allowedValues": [
31709               "\"yes\"",
31710               "\"no\""
31711             ],
31712             "optional": true,
31713             "field": "setinterfacevar",
31714             "description": ""
31715           },
31716           {
31717             "group": "Body",
31718             "type": "String",
31719             "allowedValues": [
31720               "\"yes\"",
31721               "\"no\""
31722             ],
31723             "optional": true,
31724             "field": "setqueueentryvar",
31725             "description": ""
31726           },
31727           {
31728             "group": "Body",
31729             "type": "String",
31730             "allowedValues": [
31731               "\"yes\"",
31732               "\"no\""
31733             ],
31734             "optional": true,
31735             "field": "setqueuevar",
31736             "description": ""
31737           },
31738           {
31739             "group": "Body",
31740             "type": "String",
31741             "allowedValues": [
31742               "\"yes\"",
31743               "\"no\""
31744             ],
31745             "optional": true,
31746             "field": "eventmemberstatus",
31747             "description": ""
31748           },
31749           {
31750             "group": "Body",
31751             "type": "String",
31752             "optional": true,
31753             "field": "membermacro",
31754             "description": ""
31755           },
31756           {
31757             "group": "Body",
31758             "type": "String",
31759             "optional": true,
31760             "field": "membergosub",
31761             "description": ""
31762           },
31763           {
31764             "group": "Body",
31765             "type": "Integer",
31766             "optional": true,
31767             "field": "announce_frequency",
31768             "description": ""
31769           },
31770           {
31771             "group": "Body",
31772             "type": "Integer",
31773             "optional": true,
31774             "field": "min_announce_frequency",
31775             "description": ""
31776           },
31777           {
31778             "group": "Body",
31779             "type": "Integer",
31780             "optional": true,
31781             "field": "periodic_announce_frequency",
31782             "description": ""
31783           },
31784           {
31785             "group": "Body",
31786             "type": "String",
31787             "allowedValues": [
31788               "\"yes\"",
31789               "\"no\""
31790             ],
31791             "optional": true,
31792             "field": "random_periodic_announce",
31793             "description": ""
31794           },
31795           {
31796             "group": "Body",
31797             "type": "String",
31798             "allowedValues": [
31799               "\"yes\"",
31800               "\"no\""
31801             ],
31802             "optional": true,
31803             "field": "relative_periodic_announce",
31804             "description": ""
31805           },
31806           {
31807             "group": "Body",
31808             "type": "String",
31809             "allowedValues": [
31810               "\"yes\"",
31811               "\"no\"",
31812               "\"once\""
31813             ],
31814             "optional": true,
31815             "field": "announce_holdtime",
31816             "description": ""
31817           },
31818           {
31819             "group": "Body",
31820             "type": "String",
31821             "optional": true,
31822             "field": "announce_position",
31823             "description": ""
31824           },
31825           {
31826             "group": "Body",
31827             "type": "String",
31828             "allowedValues": [
31829               "\"yes\"",
31830               "\"no\""
31831             ],
31832             "optional": true,
31833             "field": "announce_to_first_user",
31834             "description": ""
31835           },
31836           {
31837             "group": "Body",
31838             "type": "Integer",
31839             "optional": true,
31840             "field": "announce_position_limit",
31841             "description": ""
31842           },
31843           {
31844             "group": "Body",
31845             "type": "String",
31846             "allowedValues": [
31847               "\"0\"",
31848               "\"5\"",
31849               "\"10\"",
31850               "\"15\"",
31851               "\"20\"",
31852               "\"30\""
31853             ],
31854             "optional": true,
31855             "field": "announce_round_seconds",
31856             "description": ""
31857           },
31858           {
31859             "group": "Body",
31860             "type": "String",
31861             "optional": true,
31862             "field": "monitor_format",
31863             "description": ""
31864           },
31865           {
31866             "group": "Body",
31867             "type": "String",
31868             "optional": true,
31869             "field": "monitor_type",
31870             "description": ""
31871           },
31872           {
31873             "group": "Body",
31874             "type": "String",
31875             "optional": true,
31876             "field": "queue_youarenext",
31877             "description": ""
31878           },
31879           {
31880             "group": "Body",
31881             "type": "String",
31882             "optional": true,
31883             "field": "queue_thereare",
31884             "description": ""
31885           },
31886           {
31887             "group": "Body",
31888             "type": "String",
31889             "optional": true,
31890             "field": "queue_callswaiting",
31891             "description": ""
31892           },
31893           {
31894             "group": "Body",
31895             "type": "String",
31896             "optional": true,
31897             "field": "queue_holdtime",
31898             "description": ""
31899           },
31900           {
31901             "group": "Body",
31902             "type": "String",
31903             "optional": true,
31904             "field": "queue_minute",
31905             "description": ""
31906           },
31907           {
31908             "group": "Body",
31909             "type": "String",
31910             "optional": true,
31911             "field": "queue_minutes",
31912             "description": ""
31913           },
31914           {
31915             "group": "Body",
31916             "type": "String",
31917             "optional": true,
31918             "field": "queue_seconds",
31919             "description": ""
31920           },
31921           {
31922             "group": "Body",
31923             "type": "String",
31924             "optional": true,
31925             "field": "queue_thankyou",
31926             "description": ""
31927           },
31928           {
31929             "group": "Body",
31930             "type": "String",
31931             "optional": true,
31932             "field": "queue_reporthold",
31933             "description": ""
31934           },
31935           {
31936             "group": "Body",
31937             "type": "String",
31938             "optional": true,
31939             "field": "queue_quantity1",
31940             "description": ""
31941           },
31942           {
31943             "group": "Body",
31944             "type": "String",
31945             "optional": true,
31946             "field": "queue_quantity2",
31947             "description": ""
31948           },
31949           {
31950             "group": "Body",
31951             "type": "String",
31952             "optional": true,
31953             "field": "queue_periodic_announce",
31954             "description": ""
31955           },
31956           {
31957             "group": "Body",
31958             "type": "String",
31959             "optional": true,
31960             "field": "queue_less_than",
31961             "description": ""
31962           },
31963           {
31964             "group": "Body",
31965             "type": "Text",
31966             "optional": true,
31967             "field": "periodic_announce",
31968             "description": ""
31969           },
31970           {
31971             "group": "Body",
31972             "type": "String",
31973             "optional": true,
31974             "field": "joinempty",
31975             "description": ""
31976           },
31977           {
31978             "group": "Body",
31979             "type": "String",
31980             "optional": true,
31981             "field": "leavewhenempty",
31982             "description": ""
31983           },
31984           {
31985             "group": "Body",
31986             "type": "String",
31987             "allowedValues": [
31988               "\"yes\"",
31989               "\"no\""
31990             ],
31991             "optional": true,
31992             "field": "reportholdtime",
31993             "description": ""
31994           },
31995           {
31996             "group": "Body",
31997             "type": "String",
31998             "allowedValues": [
31999               "\"yes\"",
32000               "\"no\""
32001             ],
32002             "optional": true,
32003             "field": "ringinuse",
32004             "description": ""
32005           },
32006           {
32007             "group": "Body",
32008             "type": "Integer",
32009             "optional": true,
32010             "field": "memberdelay",
32011             "description": ""
32012           },
32013           {
32014             "group": "Body",
32015             "type": "String",
32016             "allowedValues": [
32017               "\"yes\"",
32018               "\"no\""
32019             ],
32020             "optional": true,
32021             "field": "timeoutrestart",
32022             "description": ""
32023           },
32024           {
32025             "group": "Body",
32026             "type": "String",
32027             "optional": true,
32028             "field": "defaultrule",
32029             "description": ""
32030           },
32031           {
32032             "group": "Body",
32033             "type": "String",
32034             "optional": true,
32035             "field": "description",
32036             "description": ""
32037           },
32038           {
32039             "group": "Body",
32040             "type": "Boolean",
32041             "optional": true,
32042             "field": "acw",
32043             "description": ""
32044           },
32045           {
32046             "group": "Body",
32047             "type": "Integer",
32048             "optional": true,
32049             "field": "acwTimeout",
32050             "description": ""
32051           },
32052           {
32053             "group": "Body",
32054             "type": "Boolean",
32055             "optional": true,
32056             "field": "dialActive",
32057             "description": "<p>Active/Disactive Campaign</p>"
32058           },
32059           {
32060             "group": "Body",
32061             "type": "String",
32062             "allowedValues": [
32063               "\"preview\"",
32064               "\"progressive\"",
32065               "\"power\"",
32066               "\"predictive\"",
32067               "\"booked\""
32068             ],
32069             "optional": true,
32070             "field": "dialMethod",
32071             "description": "<p>Dial Method.</p>"
32072           },
32073           {
32074             "group": "Body",
32075             "type": "Integer",
32076             "optional": true,
32077             "field": "dialLimitChannel",
32078             "description": "<p>Max 9999 channels, 0 means unlimited.</p>"
32079           },
32080           {
32081             "group": "Body",
32082             "type": "Integer",
32083             "optional": true,
32084             "field": "dialLimitQueue",
32085             "description": "<p>Max 9999 member in queue(min:1, max:9999), 0 means unlimited.</p>"
32086           },
32087           {
32088             "group": "Body",
32089             "type": "Float",
32090             "optional": true,
32091             "field": "dialPowerLevel",
32092             "description": "<p>Power Level: Calls for agents (min:1, max:10).</p>"
32093           },
32094           {
32095             "group": "Body",
32096             "type": "String",
32097             "allowedValues": [
32098               "\"agentBusyFactor\"",
32099               "\"dropRate\""
32100             ],
32101             "optional": true,
32102             "field": "dialPredictiveOptimization",
32103             "description": "<p>Only for predictive method.</p>"
32104           },
32105           {
32106             "group": "Body",
32107             "type": "Float",
32108             "optional": true,
32109             "field": "dialPredictiveOptimizationPercentage",
32110             "description": "<p>Predictive Optimization Percentage (min: 1, max: 95)</p>"
32111           },
32112           {
32113             "group": "Body",
32114             "type": "Integer",
32115             "optional": true,
32116             "field": "dialPredictiveInterval",
32117             "description": "<p>Interval Predictive Minutes (min:5 max:30)</p>"
32118           },
32119           {
32120             "group": "Body",
32121             "type": "String",
32122             "optional": true,
32123             "field": "dialOriginateCallerIdName",
32124             "description": ""
32125           },
32126           {
32127             "group": "Body",
32128             "type": "String",
32129             "optional": true,
32130             "field": "dialOriginateCallerIdNumber",
32131             "description": ""
32132           },
32133           {
32134             "group": "Body",
32135             "type": "Integer",
32136             "optional": true,
32137             "field": "dialOriginateTimeout",
32138             "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
32139           },
32140           {
32141             "group": "Body",
32142             "type": "String",
32143             "optional": true,
32144             "field": "dialQueueOptions",
32145             "description": "<p>https://wiki.asterisk.org/wiki/display/AST/Asterisk+13+Application_Queue</p>"
32146           },
32147           {
32148             "group": "Body",
32149             "type": "Integer",
32150             "optional": true,
32151             "field": "dialQueueTimeout",
32152             "description": "<p>Queue Timeout Seconds (min:1, max:999)</p>"
32153           },
32154           {
32155             "group": "Body",
32156             "type": "String",
32157             "optional": true,
32158             "field": "dialQueueProject",
32159             "description": "<p>AGI queue option (use: agi://127.0.0.1/square,&lt;project_name&gt;)</p>"
32160           },
32161           {
32162             "group": "Body",
32163             "type": "Integer",
32164             "optional": true,
32165             "field": "dialCongestionMaxRetry",
32166             "description": "<p>#Congestion Retry (min:1, max:999)</p>"
32167           },
32168           {
32169             "group": "Body",
32170             "type": "Integer",
32171             "optional": true,
32172             "field": "dialCongestionRetryFrequency",
32173             "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
32174           },
32175           {
32176             "group": "Body",
32177             "type": "Integer",
32178             "optional": true,
32179             "field": "dialBusyMaxRetry",
32180             "description": "<p>#Busy Retry (min:1, max:999)</p>"
32181           },
32182           {
32183             "group": "Body",
32184             "type": "Integer",
32185             "optional": true,
32186             "field": "dialBusyRetryFrequency",
32187             "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
32188           },
32189           {
32190             "group": "Body",
32191             "type": "Integer",
32192             "optional": true,
32193             "field": "dialNoAnswerMaxRetry",
32194             "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
32195           },
32196           {
32197             "group": "Body",
32198             "type": "Integer",
32199             "optional": true,
32200             "field": "dialNoAnswerRetryFrequency",
32201             "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
32202           },
32203           {
32204             "group": "Body",
32205             "type": "Integer",
32206             "optional": true,
32207             "field": "dialGlobalMaxRetry",
32208             "description": "<p>#Global Max Retry (min:1, max:999)</p>"
32209           },
32210           {
32211             "group": "Body",
32212             "type": "String",
32213             "optional": true,
32214             "field": "dialTimezone",
32215             "description": ""
32216           },
32217           {
32218             "group": "Body",
32219             "type": "String",
32220             "optional": true,
32221             "field": "dialGlobalInterval",
32222             "description": ""
32223           },
32224           {
32225             "group": "Body",
32226             "type": "String",
32227             "optional": true,
32228             "field": "dialPrefix",
32229             "description": ""
32230           },
32231           {
32232             "group": "Body",
32233             "type": "String",
32234             "allowedValues": [
32235               "\"always\"",
32236               "\"never\"",
32237               "\"onlyIfOpen\""
32238             ],
32239             "optional": true,
32240             "field": "dialCheckDuplicateType",
32241             "description": ""
32242           },
32243           {
32244             "group": "Body",
32245             "type": "Boolean",
32246             "optional": true,
32247             "field": "dialAMDActive",
32248             "description": "<p>Active/Disactive AMD</p>"
32249           },
32250           {
32251             "group": "Body",
32252             "type": "Integer",
32253             "optional": true,
32254             "field": "dialAMDInitialSilence",
32255             "description": "<p>#AMD Initial Silence</p>"
32256           },
32257           {
32258             "group": "Body",
32259             "type": "Integer",
32260             "optional": true,
32261             "field": "dialAMDGreeting",
32262             "description": "<p>#AMD Greeting</p>"
32263           },
32264           {
32265             "group": "Body",
32266             "type": "Integer",
32267             "optional": true,
32268             "field": "dialAMDAfterGreetingSilence",
32269             "description": "<p>#AMD After Greeting Silence</p>"
32270           },
32271           {
32272             "group": "Body",
32273             "type": "Integer",
32274             "optional": true,
32275             "field": "dialAMDTotalAnalysisTime",
32276             "description": "<p>#AMD Total Analysis Time</p>"
32277           },
32278           {
32279             "group": "Body",
32280             "type": "Integer",
32281             "optional": true,
32282             "field": "dialAMDMinWordLength",
32283             "description": "<p>#AMD Min Word Length</p>"
32284           },
32285           {
32286             "group": "Body",
32287             "type": "Integer",
32288             "optional": true,
32289             "field": "dialAMDBetweenWordsSilence",
32290             "description": "<p>#AMD Between Words Silence</p>"
32291           },
32292           {
32293             "group": "Body",
32294             "type": "Integer",
32295             "optional": true,
32296             "field": "dialAMDMaximumNumberOfWords",
32297             "description": "<p>#AMD Maximum Number Of Words</p>"
32298           },
32299           {
32300             "group": "Body",
32301             "type": "Integer",
32302             "optional": true,
32303             "field": "dialAMDSilenceThreshold",
32304             "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
32305           },
32306           {
32307             "group": "Body",
32308             "type": "Integer",
32309             "optional": true,
32310             "field": "dialAMDMaximumWordLength",
32311             "description": "<p>#AMD Maximum Word Length</p>"
32312           },
32313           {
32314             "group": "Body",
32315             "type": "Integer",
32316             "optional": true,
32317             "field": "dialRecallMeTimeout",
32318             "description": "<p>#RecallMe Timeout (min:1)</p>"
32319           },
32320           {
32321             "group": "Body",
32322             "type": "Boolean",
32323             "optional": true,
32324             "field": "dialRecallInQueue",
32325             "description": "<p>Active/Disactive Recall In Queue</p>"
32326           },
32327           {
32328             "group": "Body",
32329             "type": "String",
32330             "allowedValues": [
32331               "\"DESC\"",
32332               "\"ASC\""
32333             ],
32334             "optional": true,
32335             "field": "dialOrderByScheduledAt",
32336             "description": ""
32337           },
32338           {
32339             "group": "Body",
32340             "type": "String",
32341             "optional": true,
32342             "field": "dialQueueProject2",
32343             "description": "<p>AGI queue option (use: agi://127.0.0.1/square,&lt;project_name&gt;)</p>"
32344           },
32345           {
32346             "group": "Body",
32347             "type": "Boolean",
32348             "optional": true,
32349             "field": "dialAgiAfterHangupClient",
32350             "description": ""
32351           },
32352           {
32353             "group": "Body",
32354             "type": "Boolean",
32355             "optional": true,
32356             "field": "dialAgiAfterHangupAgent",
32357             "description": ""
32358           },
32359           {
32360             "group": "Body",
32361             "type": "Integer",
32362             "optional": true,
32363             "field": "dialRandomLastDigitCallerIdNumber",
32364             "description": "<p>Random Last Digit (min:1, max:15)</p>"
32365           },
32366           {
32367             "group": "Body",
32368             "type": "Integer",
32369             "optional": true,
32370             "field": "dialCutDigit",
32371             "description": "<p>Cut Digit (min:1, max:15)</p>"
32372           },
32373           {
32374             "group": "Body",
32375             "type": "Integer",
32376             "optional": true,
32377             "field": "dialNoSuchNumberMaxRetry",
32378             "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
32379           },
32380           {
32381             "group": "Body",
32382             "type": "Integer",
32383             "optional": true,
32384             "field": "dialNoSuchNumberRetryFrequency",
32385             "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
32386           },
32387           {
32388             "group": "Body",
32389             "type": "Integer",
32390             "optional": true,
32391             "field": "dialDropMaxRetry",
32392             "description": "<p>#Drop Retry (min:1, max:999)</p>"
32393           },
32394           {
32395             "group": "Body",
32396             "type": "Integer",
32397             "optional": true,
32398             "field": "dialDropRetryFrequency",
32399             "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
32400           },
32401           {
32402             "group": "Body",
32403             "type": "Integer",
32404             "optional": true,
32405             "field": "dialAbandonedMaxRetry",
32406             "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
32407           },
32408           {
32409             "group": "Body",
32410             "type": "Integer",
32411             "optional": true,
32412             "field": "dialAbandonedRetryFrequency",
32413             "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
32414           },
32415           {
32416             "group": "Body",
32417             "type": "Integer",
32418             "optional": true,
32419             "field": "dialMachineMaxRetry",
32420             "description": "<p>#Machine Retry (min:1, max:999)</p>"
32421           },
32422           {
32423             "group": "Body",
32424             "type": "Integer",
32425             "optional": true,
32426             "field": "dialMachineRetryFrequency",
32427             "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
32428           },
32429           {
32430             "group": "Body",
32431             "type": "Integer",
32432             "optional": true,
32433             "field": "dialAgentRejectMaxRetry",
32434             "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
32435           },
32436           {
32437             "group": "Body",
32438             "type": "Integer",
32439             "optional": true,
32440             "field": "dialAgentRejectRetryFrequency",
32441             "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
32442           },
32443           {
32444             "group": "Body",
32445             "type": "Integer",
32446             "optional": true,
32447             "field": "mandatoryDispositionPauseId",
32448             "description": "<p>Status to put when mandatory disposition is enabled</p>"
32449           },
32450           {
32451             "group": "Body",
32452             "type": "Boolean",
32453             "optional": true,
32454             "field": "mandatoryDisposition",
32455             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
32456           },
32457           {
32458             "group": "Body",
32459             "type": "Integer",
32460             "optional": true,
32461             "field": "dialPredictiveIntervalMaxThreshold",
32462             "description": ""
32463           },
32464           {
32465             "group": "Body",
32466             "type": "Integer",
32467             "optional": true,
32468             "field": "dialPredictiveIntervalMinThreshold",
32469             "description": ""
32470           }
32471         ]
32472       }
32473     },
32474     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32475     "version": "0.0.0",
32476     "filename": "server/api/voiceQueue/index.js",
32477     "groupTitle": "Voice_Queues"
32478   },
32479   {
32480     "type": "delete",
32481     "url": "/api/voice/queues/{id}",
32482     "title": "Deletes a Queue",
32483     "examples": [
32484       {
32485         "title": "Example usage:",
32486         "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password} -X DELETE",
32487         "type": "json"
32488       }
32489     ],
32490     "name": "DeleteQueues",
32491     "group": "Voice_Queues",
32492     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32493     "version": "0.0.0",
32494     "filename": "server/api/voiceQueue/index.js",
32495     "groupTitle": "Voice_Queues"
32496   },
32497   {
32498     "type": "get",
32499     "url": "/api/voice/queues/{id}/users",
32500     "title": "Gets queue agents",
32501     "examples": [
32502       {
32503         "title": "Example usage:",
32504         "content": "curl https://{domain}/api/voice/queues/{id}/users -v -u {name}:{password} -X GET",
32505         "type": "json"
32506       }
32507     ],
32508     "name": "GetAgents",
32509     "group": "Voice_Queues",
32510     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32511     "version": "0.0.0",
32512     "filename": "server/api/voiceQueue/index.js",
32513     "groupTitle": "Voice_Queues"
32514   },
32515   {
32516     "type": "get",
32517     "url": "/api/voice/queues/{id}/blacklists",
32518     "title": "Get queue blacklists",
32519     "examples": [
32520       {
32521         "title": "Example usage:",
32522         "content": "curl https://{domain}/api/voice/queues/{id}/blacklists -v -u {name}:{password} -X GET",
32523         "type": "json"
32524       }
32525     ],
32526     "name": "GetBlackLists",
32527     "group": "Voice_Queues",
32528     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32529     "version": "0.0.0",
32530     "filename": "server/api/voiceQueue/index.js",
32531     "groupTitle": "Voice_Queues"
32532   },
32533   {
32534     "type": "get",
32535     "url": "/api/voice/queues/{id}/finals",
32536     "title": "Gets queue hopper finals",
32537     "examples": [
32538       {
32539         "title": "Example usage:",
32540         "content": "curl https://{domain}/api/voice/queues/{id}/hopper_finals -v -u {name}:{password}  -X GET",
32541         "type": "json"
32542       }
32543     ],
32544     "name": "GetHopperFinals",
32545     "group": "Voice_Queues",
32546     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32547     "version": "0.0.0",
32548     "filename": "server/api/voiceQueue/index.js",
32549     "groupTitle": "Voice_Queues"
32550   },
32551   {
32552     "type": "get",
32553     "url": "/api/voice/queues/{id}/hopper_histories",
32554     "title": "Gets queue hopper histories",
32555     "examples": [
32556       {
32557         "title": "Example usage:",
32558         "content": "curl https://{domain}/api/voice/queues/{id}/hopper_histories -v -u {name}:{password} -X GET",
32559         "type": "json"
32560       }
32561     ],
32562     "name": "GetHopperHistories",
32563     "group": "Voice_Queues",
32564     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32565     "version": "0.0.0",
32566     "filename": "server/api/voiceQueue/index.js",
32567     "groupTitle": "Voice_Queues"
32568   },
32569   {
32570     "type": "get",
32571     "url": "/api/voice/queues/{id}/hoppers",
32572     "title": "Gets queue hoppers",
32573     "examples": [
32574       {
32575         "title": "Example usage:",
32576         "content": "curl https://{domain}/api/voice/queues/{id}/hoppers -v -u {name}:{password} -X GET",
32577         "type": "json"
32578       }
32579     ],
32580     "name": "GetHoppers",
32581     "group": "Voice_Queues",
32582     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32583     "version": "0.0.0",
32584     "filename": "server/api/voiceQueue/index.js",
32585     "groupTitle": "Voice_Queues"
32586   },
32587   {
32588     "type": "get",
32589     "url": "/api/voice/queues/{id}/lists",
32590     "title": "Get queue lists",
32591     "examples": [
32592       {
32593         "title": "Example usage:",
32594         "content": "curl https://{domain}/api/voice/queues/{id}/lists -v -u {name}:{password} -X GET",
32595         "type": "json"
32596       }
32597     ],
32598     "name": "GetLists",
32599     "group": "Voice_Queues",
32600     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32601     "version": "0.0.0",
32602     "filename": "server/api/voiceQueue/index.js",
32603     "groupTitle": "Voice_Queues"
32604   },
32605   {
32606     "type": "get",
32607     "url": "/api/voice/queues/{id}/members",
32608     "title": "Gets queue members",
32609     "examples": [
32610       {
32611         "title": "Example usage:",
32612         "content": "curl https://{domain}/api/voice/queues/{id}/members -v -u {name}:{password} -X GET",
32613         "type": "json"
32614       }
32615     ],
32616     "name": "GetMembers",
32617     "group": "Voice_Queues",
32618     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32619     "version": "0.0.0",
32620     "filename": "server/api/voiceQueue/index.js",
32621     "groupTitle": "Voice_Queues"
32622   },
32623   {
32624     "type": "get",
32625     "url": "/api/voice/queues",
32626     "title": "Gets a list of Queues",
32627     "examples": [
32628       {
32629         "title": "Example usage:",
32630         "content": "curl https://{domain}/api/voice/queues -v -u {name}:{password}",
32631         "type": "json"
32632       }
32633     ],
32634     "name": "GetQueues",
32635     "group": "Voice_Queues",
32636     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
32637     "version": "0.0.0",
32638     "filename": "server/api/voiceQueue/index.js",
32639     "groupTitle": "Voice_Queues"
32640   },
32641   {
32642     "type": "get",
32643     "url": "/api/voice/queues/{id}/teams",
32644     "title": "Gets queue team",
32645     "examples": [
32646       {
32647         "title": "Example usage:",
32648         "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password}  -X GET",
32649         "type": "json"
32650       }
32651     ],
32652     "name": "GetTeams",
32653     "group": "Voice_Queues",
32654     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32655     "version": "0.0.0",
32656     "filename": "server/api/voiceQueue/index.js",
32657     "groupTitle": "Voice_Queues"
32658   },
32659   {
32660     "type": "delete",
32661     "url": "/api/voice/queues/{id}/users",
32662     "title": "Removes agents from a queue",
32663     "examples": [
32664       {
32665         "title": "Example usage:",
32666         "content": "curl https://{domain}/api/voice/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32667         "type": "json"
32668       }
32669     ],
32670     "name": "RemoveAgents",
32671     "group": "Voice_Queues",
32672     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32673     "version": "0.0.0",
32674     "filename": "server/api/voiceQueue/index.js",
32675     "groupTitle": "Voice_Queues"
32676   },
32677   {
32678     "type": "delete",
32679     "url": "/api/voice/queues/{id}/blacklists",
32680     "title": "Remove blacklists from a queue",
32681     "examples": [
32682       {
32683         "title": "Example usage:",
32684         "content": "curl https://{domain}/api/voice/queues/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32685         "type": "json"
32686       }
32687     ],
32688     "name": "RemoveBlackLists",
32689     "group": "Voice_Queues",
32690     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32691     "version": "0.0.0",
32692     "filename": "server/api/voiceQueue/index.js",
32693     "groupTitle": "Voice_Queues"
32694   },
32695   {
32696     "type": "delete",
32697     "url": "/api/voice/queues/{id}/lists",
32698     "title": "Remove lists from a queue",
32699     "examples": [
32700       {
32701         "title": "Example usage:",
32702         "content": "curl https://{domain}/api/voice/queues/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32703         "type": "json"
32704       }
32705     ],
32706     "name": "RemoveLists",
32707     "group": "Voice_Queues",
32708     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32709     "version": "0.0.0",
32710     "filename": "server/api/voiceQueue/index.js",
32711     "groupTitle": "Voice_Queues"
32712   },
32713   {
32714     "type": "get",
32715     "url": "/api/voice/queues/{id}",
32716     "title": "Gets a single Queue",
32717     "examples": [
32718       {
32719         "title": "Example usage:",
32720         "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password}",
32721         "type": "json"
32722       }
32723     ],
32724     "name": "ShowQueues",
32725     "group": "Voice_Queues",
32726     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32727     "version": "0.0.0",
32728     "filename": "server/api/voiceQueue/index.js",
32729     "groupTitle": "Voice_Queues"
32730   },
32731   {
32732     "type": "get",
32733     "url": "/api/voice/queues/{id}/blacks",
32734     "title": "Gets queue hopper blacks",
32735     "examples": [
32736       {
32737         "title": "Example usage:",
32738         "content": "curl https://{domain}/api/voice/queues/{id}/hopper_black -v -u {name}:{password}  -X GET",
32739         "type": "json"
32740       }
32741     ],
32742     "name": "getHopperBlacks",
32743     "group": "Voice_Queues",
32744     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32745     "version": "0.0.0",
32746     "filename": "server/api/voiceQueue/index.js",
32747     "groupTitle": "Voice_Queues"
32748   },
32749   {
32750     "type": "put",
32751     "url": "/api/voice/queues/{id}",
32752     "title": "Update an existing Queue",
32753     "examples": [
32754       {
32755         "title": "Example usage:",
32756         "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",
32757         "type": "json"
32758       }
32759     ],
32760     "name": "updateQueues",
32761     "group": "Voice_Queues",
32762     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32763     "version": "0.0.0",
32764     "filename": "server/api/voiceQueue/index.js",
32765     "groupTitle": "Voice_Queues"
32766   },
32767   {
32768     "type": "post",
32769     "url": "/api/voice/recordings",
32770     "title": "Creates a new Recording",
32771     "examples": [
32772       {
32773         "title": "Example usage:",
32774         "content": "curl https://{domain}/api/voice/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
32775         "type": "json"
32776       }
32777     ],
32778     "name": "CreateRecordings",
32779     "group": "Voice_Recordings",
32780     "parameter": {
32781       "fields": {
32782         "Body": [
32783           {
32784             "group": "Body",
32785             "type": "Virtual",
32786             "optional": true,
32787             "field": "format",
32788             "description": ""
32789           },
32790           {
32791             "group": "Body",
32792             "type": "String",
32793             "optional": true,
32794             "field": "uniqueid",
32795             "description": ""
32796           },
32797           {
32798             "group": "Body",
32799             "type": "String",
32800             "optional": true,
32801             "field": "channel",
32802             "description": ""
32803           },
32804           {
32805             "group": "Body",
32806             "type": "String",
32807             "optional": true,
32808             "field": "membername",
32809             "description": ""
32810           },
32811           {
32812             "group": "Body",
32813             "type": "String",
32814             "optional": true,
32815             "field": "calleridnum",
32816             "description": ""
32817           },
32818           {
32819             "group": "Body",
32820             "type": "String",
32821             "optional": true,
32822             "field": "calleridname",
32823             "description": ""
32824           },
32825           {
32826             "group": "Body",
32827             "type": "String",
32828             "optional": true,
32829             "field": "connectedlinenum",
32830             "description": ""
32831           },
32832           {
32833             "group": "Body",
32834             "type": "String",
32835             "optional": true,
32836             "field": "connectedlinename",
32837             "description": ""
32838           },
32839           {
32840             "group": "Body",
32841             "type": "String",
32842             "optional": true,
32843             "field": "accountcode",
32844             "description": ""
32845           },
32846           {
32847             "group": "Body",
32848             "type": "String",
32849             "optional": true,
32850             "field": "context",
32851             "description": ""
32852           },
32853           {
32854             "group": "Body",
32855             "type": "String",
32856             "optional": true,
32857             "field": "exten",
32858             "description": ""
32859           },
32860           {
32861             "group": "Body",
32862             "type": "String",
32863             "optional": true,
32864             "field": "value",
32865             "description": ""
32866           },
32867           {
32868             "group": "Body",
32869             "type": "String",
32870             "optional": true,
32871             "field": "type",
32872             "description": ""
32873           },
32874           {
32875             "group": "Body",
32876             "type": "Integer",
32877             "optional": true,
32878             "field": "rating",
32879             "description": ""
32880           },
32881           {
32882             "group": "Body",
32883             "type": "String",
32884             "optional": true,
32885             "field": "queue",
32886             "description": ""
32887           },
32888           {
32889             "group": "Body",
32890             "type": "String",
32891             "optional": true,
32892             "field": "userDisposition",
32893             "description": ""
32894           },
32895           {
32896             "group": "Body",
32897             "type": "String",
32898             "optional": true,
32899             "field": "userSecondDisposition",
32900             "description": ""
32901           },
32902           {
32903             "group": "Body",
32904             "type": "String",
32905             "optional": true,
32906             "field": "userThirdDisposition",
32907             "description": ""
32908           },
32909           {
32910             "group": "Body",
32911             "type": "Text",
32912             "optional": true,
32913             "field": "location",
32914             "description": ""
32915           },
32916           {
32917             "group": "Body",
32918             "type": "String",
32919             "optional": true,
32920             "field": "transcribeName",
32921             "description": ""
32922           },
32923           {
32924             "group": "Body",
32925             "type": "String",
32926             "optional": true,
32927             "field": "transcribeStatus",
32928             "description": ""
32929           },
32930           {
32931             "group": "Body",
32932             "type": "Text",
32933             "optional": true,
32934             "field": "fileUri",
32935             "description": ""
32936           },
32937           {
32938             "group": "Body",
32939             "type": "Text",
32940             "optional": true,
32941             "field": "fileText",
32942             "description": ""
32943           },
32944           {
32945             "group": "Body",
32946             "type": "Text",
32947             "optional": true,
32948             "field": "failureReason",
32949             "description": ""
32950           },
32951           {
32952             "group": "Body",
32953             "type": "String",
32954             "optional": true,
32955             "field": "sentiment",
32956             "description": ""
32957           },
32958           {
32959             "group": "Body",
32960             "type": "Float",
32961             "optional": true,
32962             "field": "sPositive",
32963             "description": ""
32964           },
32965           {
32966             "group": "Body",
32967             "type": "Float",
32968             "optional": true,
32969             "field": "sNegative",
32970             "description": ""
32971           },
32972           {
32973             "group": "Body",
32974             "type": "Float",
32975             "optional": true,
32976             "field": "sNeutral",
32977             "description": ""
32978           },
32979           {
32980             "group": "Body",
32981             "type": "Float",
32982             "optional": true,
32983             "field": "sMixed",
32984             "description": ""
32985           },
32986           {
32987             "group": "Body",
32988             "type": "Boolean",
32989             "optional": true,
32990             "field": "tempSentiment",
32991             "description": ""
32992           },
32993           {
32994             "group": "Body",
32995             "type": "String",
32996             "optional": true,
32997             "field": "createdAt",
32998             "description": ""
32999           },
33000           {
33001             "group": "Body",
33002             "type": "String",
33003             "optional": true,
33004             "field": "updatedAt",
33005             "description": ""
33006           }
33007         ]
33008       }
33009     },
33010     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33011     "version": "0.0.0",
33012     "filename": "server/api/voiceRecording/index.js",
33013     "groupTitle": "Voice_Recordings"
33014   },
33015   {
33016     "type": "get",
33017     "url": "/api/voice/recordings/describe",
33018     "title": "Gets table info about Recordings",
33019     "examples": [
33020       {
33021         "title": "Example usage:",
33022         "content": "curl https://{domain}/api/voice/recordings/describe -v -u {name}:{password}",
33023         "type": "json"
33024       }
33025     ],
33026     "name": "DescribeRecordings",
33027     "group": "Voice_Recordings",
33028     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33029     "version": "0.0.0",
33030     "filename": "server/api/voiceRecording/index.js",
33031     "groupTitle": "Voice_Recordings"
33032   },
33033   {
33034     "type": "get",
33035     "url": "/api/voice/recordings",
33036     "title": "Gets a list of Recordings",
33037     "examples": [
33038       {
33039         "title": "Example usage:",
33040         "content": "curl https://{domain}/api/voice/recordings -v -u {name}:{password}",
33041         "type": "json"
33042       }
33043     ],
33044     "name": "GetRecordings",
33045     "group": "Voice_Recordings",
33046     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33047     "version": "0.0.0",
33048     "filename": "server/api/voiceRecording/index.js",
33049     "groupTitle": "Voice_Recordings"
33050   },
33051   {
33052     "type": "get",
33053     "url": "/api/voice/recordings/{id}",
33054     "title": "Gets a single Recording",
33055     "examples": [
33056       {
33057         "title": "Example usage:",
33058         "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password}",
33059         "type": "json"
33060       }
33061     ],
33062     "name": "ShowRecordings",
33063     "group": "Voice_Recordings",
33064     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33065     "version": "0.0.0",
33066     "filename": "server/api/voiceRecording/index.js",
33067     "groupTitle": "Voice_Recordings"
33068   },
33069   {
33070     "type": "delete",
33071     "url": "/api/voice/recordings/{id}",
33072     "title": "Delete voice recording",
33073     "examples": [
33074       {
33075         "title": "Example usage:",
33076         "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password} -X DELETE",
33077         "type": "json"
33078       }
33079     ],
33080     "name": "destroy",
33081     "group": "Voice_Recordings",
33082     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33083     "version": "0.0.0",
33084     "filename": "server/api/voiceRecording/index.js",
33085     "groupTitle": "Voice_Recordings"
33086   },
33087   {
33088     "type": "get",
33089     "url": "/api/voice/recordings/{id}/download",
33090     "title": "Download Recording",
33091     "examples": [
33092       {
33093         "title": "Example usage:",
33094         "content": "curl https://{domain}/api/voice/recordings/{id}/download -v -u {name}:{password} -X GET",
33095         "type": "json"
33096       }
33097     ],
33098     "name": "download",
33099     "group": "Voice_Recordings",
33100     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33101     "version": "0.0.0",
33102     "filename": "server/api/voiceRecording/index.js",
33103     "groupTitle": "Voice_Recordings"
33104   },
33105   {
33106     "type": "get",
33107     "url": "/api/voice/recordings/{id}/downloads",
33108     "title": "Download Recording",
33109     "examples": [
33110       {
33111         "title": "Example usage:",
33112         "content": "curl https://{domain}/api/voice/recordings/{id}/downloads -v -u {name}:{password} -X GET",
33113         "type": "json"
33114       }
33115     ],
33116     "name": "downloads",
33117     "group": "Voice_Recordings",
33118     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33119     "version": "0.0.0",
33120     "filename": "server/api/voiceRecording/index.js",
33121     "groupTitle": "Voice_Recordings"
33122   },
33123   {
33124     "type": "post",
33125     "url": "/api/voice/recordings/{id}/transcribe",
33126     "title": "Run Transcribe Recording",
33127     "examples": [
33128       {
33129         "title": "Example usage:",
33130         "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -d '{\"runSentiment\": \"true\"}' -v -u {name}:{password} -X POST",
33131         "type": "json"
33132       }
33133     ],
33134     "name": "transcribe",
33135     "group": "Voice_Recordings",
33136     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33137     "version": "0.0.0",
33138     "filename": "server/api/voiceRecording/index.js",
33139     "groupTitle": "Voice_Recordings"
33140   },
33141   {
33142     "type": "get",
33143     "url": "/api/voice/recordings/{id}/transcribe",
33144     "title": "Run Transcribe Recording",
33145     "examples": [
33146       {
33147         "title": "Example usage:",
33148         "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -v -u {name}:{password} -X GET",
33149         "type": "json"
33150       }
33151     ],
33152     "name": "transcribe",
33153     "group": "Voice_Recordings",
33154     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33155     "version": "0.0.0",
33156     "filename": "server/api/voiceRecording/index.js",
33157     "groupTitle": "Voice_Recordings"
33158   },
33159   {
33160     "type": "put",
33161     "url": "/api/voice/recordings/{id}",
33162     "title": "Update an existing Recording",
33163     "examples": [
33164       {
33165         "title": "Example usage:",
33166         "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",
33167         "type": "json"
33168       }
33169     ],
33170     "name": "updateRecordings",
33171     "group": "Voice_Recordings",
33172     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33173     "version": "0.0.0",
33174     "filename": "server/api/voiceRecording/index.js",
33175     "groupTitle": "Voice_Recordings"
33176   },
33177   {
33178     "type": "post",
33179     "url": "/api/voice/transfers/reports",
33180     "title": "Creates a new Transfer Report",
33181     "examples": [
33182       {
33183         "title": "Example usage:",
33184         "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",
33185         "type": "json"
33186       }
33187     ],
33188     "name": "CreateTransfer_Reports",
33189     "group": "Voice_Transfer_Reports",
33190     "parameter": {
33191       "fields": {
33192         "Body": [
33193           {
33194             "group": "Body",
33195             "type": "String",
33196             "allowedValues": [
33197               "\"blind\"",
33198               "\"attended\""
33199             ],
33200             "optional": true,
33201             "field": "type",
33202             "description": ""
33203           },
33204           {
33205             "group": "Body",
33206             "type": "String",
33207             "optional": true,
33208             "field": "result",
33209             "description": ""
33210           },
33211           {
33212             "group": "Body",
33213             "type": "String",
33214             "optional": true,
33215             "field": "transfererchannel",
33216             "description": ""
33217           },
33218           {
33219             "group": "Body",
33220             "type": "String",
33221             "optional": true,
33222             "field": "transferercalleridnum",
33223             "description": ""
33224           },
33225           {
33226             "group": "Body",
33227             "type": "String",
33228             "optional": true,
33229             "field": "transferercalleridname",
33230             "description": ""
33231           },
33232           {
33233             "group": "Body",
33234             "type": "String",
33235             "optional": true,
33236             "field": "transfererconnectedlinenum",
33237             "description": ""
33238           },
33239           {
33240             "group": "Body",
33241             "type": "String",
33242             "optional": true,
33243             "field": "transfererconnectedlinename",
33244             "description": ""
33245           },
33246           {
33247             "group": "Body",
33248             "type": "String",
33249             "optional": true,
33250             "field": "transfereraccountcode",
33251             "description": ""
33252           },
33253           {
33254             "group": "Body",
33255             "type": "String",
33256             "optional": true,
33257             "field": "transferercontext",
33258             "description": ""
33259           },
33260           {
33261             "group": "Body",
33262             "type": "String",
33263             "optional": true,
33264             "field": "transfererexten",
33265             "description": ""
33266           },
33267           {
33268             "group": "Body",
33269             "type": "String",
33270             "optional": true,
33271             "field": "transfererlinkedid",
33272             "description": ""
33273           },
33274           {
33275             "group": "Body",
33276             "type": "String",
33277             "optional": true,
33278             "field": "transfereechannel",
33279             "description": ""
33280           },
33281           {
33282             "group": "Body",
33283             "type": "String",
33284             "optional": true,
33285             "field": "transfereecalleridnum",
33286             "description": ""
33287           },
33288           {
33289             "group": "Body",
33290             "type": "String",
33291             "optional": true,
33292             "field": "transfereecalleridname",
33293             "description": ""
33294           },
33295           {
33296             "group": "Body",
33297             "type": "String",
33298             "optional": true,
33299             "field": "transfereeconnectedlinenum",
33300             "description": ""
33301           },
33302           {
33303             "group": "Body",
33304             "type": "String",
33305             "optional": true,
33306             "field": "transfereeconnectedlinename",
33307             "description": ""
33308           },
33309           {
33310             "group": "Body",
33311             "type": "String",
33312             "optional": true,
33313             "field": "transfereeaccountcode",
33314             "description": ""
33315           },
33316           {
33317             "group": "Body",
33318             "type": "String",
33319             "optional": true,
33320             "field": "transfereecontext",
33321             "description": ""
33322           },
33323           {
33324             "group": "Body",
33325             "type": "String",
33326             "optional": true,
33327             "field": "transfereeexten",
33328             "description": ""
33329           },
33330           {
33331             "group": "Body",
33332             "type": "String",
33333             "optional": true,
33334             "field": "transfereelinkedid",
33335             "description": ""
33336           },
33337           {
33338             "group": "Body",
33339             "type": "String",
33340             "allowedValues": [
33341               "\"Yes\"",
33342               "\"No\""
33343             ],
33344             "optional": true,
33345             "field": "isexternal",
33346             "description": ""
33347           },
33348           {
33349             "group": "Body",
33350             "type": "String",
33351             "optional": true,
33352             "field": "context",
33353             "description": ""
33354           },
33355           {
33356             "group": "Body",
33357             "type": "String",
33358             "optional": true,
33359             "field": "extension",
33360             "description": ""
33361           }
33362         ]
33363       }
33364     },
33365     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33366     "version": "0.0.0",
33367     "filename": "server/api/voiceTransferReport/index.js",
33368     "groupTitle": "Voice_Transfer_Reports"
33369   },
33370   {
33371     "type": "delete",
33372     "url": "/api/voice/transfers/reports/{id}",
33373     "title": "Deletes a Transfer Report",
33374     "examples": [
33375       {
33376         "title": "Example usage:",
33377         "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password} -X DELETE",
33378         "type": "json"
33379       }
33380     ],
33381     "name": "DeleteTransfer_Reports",
33382     "group": "Voice_Transfer_Reports",
33383     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33384     "version": "0.0.0",
33385     "filename": "server/api/voiceTransferReport/index.js",
33386     "groupTitle": "Voice_Transfer_Reports"
33387   },
33388   {
33389     "type": "get",
33390     "url": "/api/voice/transfers/reports/describe",
33391     "title": "Gets table info about Transfer Reports",
33392     "examples": [
33393       {
33394         "title": "Example usage:",
33395         "content": "curl https://{domain}/api/voice/transfers/reports/describe -v -u {name}:{password}",
33396         "type": "json"
33397       }
33398     ],
33399     "name": "DescribeTransfer_Reports",
33400     "group": "Voice_Transfer_Reports",
33401     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33402     "version": "0.0.0",
33403     "filename": "server/api/voiceTransferReport/index.js",
33404     "groupTitle": "Voice_Transfer_Reports"
33405   },
33406   {
33407     "type": "get",
33408     "url": "/api/voice/transfers/reports",
33409     "title": "Gets a list of Transfer Reports",
33410     "examples": [
33411       {
33412         "title": "Example usage:",
33413         "content": "curl https://{domain}/api/voice/transfers/reports -v -u {name}:{password}",
33414         "type": "json"
33415       }
33416     ],
33417     "name": "GetTransfer_Reports",
33418     "group": "Voice_Transfer_Reports",
33419     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33420     "version": "0.0.0",
33421     "filename": "server/api/voiceTransferReport/index.js",
33422     "groupTitle": "Voice_Transfer_Reports"
33423   },
33424   {
33425     "type": "get",
33426     "url": "/api/voice/transfers/reports/{id}",
33427     "title": "Gets a single Transfer Report",
33428     "examples": [
33429       {
33430         "title": "Example usage:",
33431         "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password}",
33432         "type": "json"
33433       }
33434     ],
33435     "name": "ShowTransfer_Reports",
33436     "group": "Voice_Transfer_Reports",
33437     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33438     "version": "0.0.0",
33439     "filename": "server/api/voiceTransferReport/index.js",
33440     "groupTitle": "Voice_Transfer_Reports"
33441   },
33442   {
33443     "type": "put",
33444     "url": "/api/voice/transfers/reports/{id}",
33445     "title": "Update an existing Transfer Report",
33446     "examples": [
33447       {
33448         "title": "Example usage:",
33449         "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",
33450         "type": "json"
33451       }
33452     ],
33453     "name": "updateTransfer_Reports",
33454     "group": "Voice_Transfer_Reports",
33455     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33456     "version": "0.0.0",
33457     "filename": "server/api/voiceTransferReport/index.js",
33458     "groupTitle": "Voice_Transfer_Reports"
33459   },
33460   {
33461     "type": "post",
33462     "url": "/api/integrations/vtiger/accounts",
33463     "title": "Creates a new Vtiger Account",
33464     "examples": [
33465       {
33466         "title": "Example usage:",
33467         "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",
33468         "type": "json"
33469       }
33470     ],
33471     "name": "CreateVtiger_Accounts",
33472     "group": "Vtiger_Accounts",
33473     "parameter": {
33474       "fields": {
33475         "Body": [
33476           {
33477             "group": "Body",
33478             "type": "String",
33479             "optional": false,
33480             "field": "name",
33481             "description": ""
33482           },
33483           {
33484             "group": "Body",
33485             "type": "String",
33486             "optional": true,
33487             "field": "description",
33488             "description": ""
33489           },
33490           {
33491             "group": "Body",
33492             "type": "String",
33493             "optional": false,
33494             "field": "username",
33495             "description": ""
33496           },
33497           {
33498             "group": "Body",
33499             "type": "String",
33500             "optional": false,
33501             "field": "moduleName",
33502             "description": ""
33503           },
33504           {
33505             "group": "Body",
33506             "type": "String",
33507             "optional": false,
33508             "field": "remoteUri",
33509             "description": ""
33510           },
33511           {
33512             "group": "Body",
33513             "type": "String",
33514             "optional": false,
33515             "field": "serverUrl",
33516             "description": ""
33517           },
33518           {
33519             "group": "Body",
33520             "type": "String",
33521             "optional": false,
33522             "field": "accessKey",
33523             "description": ""
33524           }
33525         ]
33526       }
33527     },
33528     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33529     "version": "0.0.0",
33530     "filename": "server/api/intVtigerAccount/index.js",
33531     "groupTitle": "Vtiger_Accounts"
33532   },
33533   {
33534     "type": "delete",
33535     "url": "/api/integrations/vtiger/accounts/{id}",
33536     "title": "Deletes a Vtiger Account",
33537     "examples": [
33538       {
33539         "title": "Example usage:",
33540         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password} -X DELETE",
33541         "type": "json"
33542       }
33543     ],
33544     "name": "DeleteVtiger_Accounts",
33545     "group": "Vtiger_Accounts",
33546     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33547     "version": "0.0.0",
33548     "filename": "server/api/intVtigerAccount/index.js",
33549     "groupTitle": "Vtiger_Accounts"
33550   },
33551   {
33552     "type": "get",
33553     "url": "/api/integrations/vtiger/accounts",
33554     "title": "Gets a list of Vtiger Accounts",
33555     "examples": [
33556       {
33557         "title": "Example usage:",
33558         "content": "curl https://{domain}/api/integrations/vtiger/accounts -v -u {name}:{password}",
33559         "type": "json"
33560       }
33561     ],
33562     "name": "GetVtiger_Accounts",
33563     "group": "Vtiger_Accounts",
33564     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33565     "version": "0.0.0",
33566     "filename": "server/api/intVtigerAccount/index.js",
33567     "groupTitle": "Vtiger_Accounts"
33568   },
33569   {
33570     "type": "get",
33571     "url": "/api/integrations/vtiger/accounts/{id}",
33572     "title": "Gets a single Vtiger Account",
33573     "examples": [
33574       {
33575         "title": "Example usage:",
33576         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password}",
33577         "type": "json"
33578       }
33579     ],
33580     "name": "ShowVtiger_Accounts",
33581     "group": "Vtiger_Accounts",
33582     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33583     "version": "0.0.0",
33584     "filename": "server/api/intVtigerAccount/index.js",
33585     "groupTitle": "Vtiger_Accounts"
33586   },
33587   {
33588     "type": "post",
33589     "url": "/api/integrations/vtiger/accounts/{id}/configurations",
33590     "title": "Creates new configuration",
33591     "examples": [
33592       {
33593         "title": "Example usage:",
33594         "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",
33595         "type": "json"
33596       }
33597     ],
33598     "name": "addConfiguration",
33599     "group": "Vtiger_Accounts",
33600     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33601     "version": "0.0.0",
33602     "filename": "server/api/intVtigerAccount/index.js",
33603     "groupTitle": "Vtiger_Accounts"
33604   },
33605   {
33606     "type": "get",
33607     "url": "/api/integrations/vtiger/accounts/{id}/configurations",
33608     "title": "Gets account configurations",
33609     "examples": [
33610       {
33611         "title": "Example usage:",
33612         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/configurations -v -u {name}:{password} -X GET",
33613         "type": "json"
33614       }
33615     ],
33616     "name": "getConfigurations",
33617     "group": "Vtiger_Accounts",
33618     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33619     "version": "0.0.0",
33620     "filename": "server/api/intVtigerAccount/index.js",
33621     "groupTitle": "Vtiger_Accounts"
33622   },
33623   {
33624     "type": "get",
33625     "url": "/api/integrations/vtiger/accounts/{id}/fields",
33626     "title": "Gets account fields",
33627     "examples": [
33628       {
33629         "title": "Example usage:",
33630         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/fields -v -u {name}:{password} -X GET",
33631         "type": "json"
33632       }
33633     ],
33634     "name": "getFields",
33635     "group": "Vtiger_Accounts",
33636     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33637     "version": "0.0.0",
33638     "filename": "server/api/intVtigerAccount/index.js",
33639     "groupTitle": "Vtiger_Accounts"
33640   },
33641   {
33642     "type": "put",
33643     "url": "/api/integrations/vtiger/accounts/{id}",
33644     "title": "Update an existing Vtiger Account",
33645     "examples": [
33646       {
33647         "title": "Example usage:",
33648         "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",
33649         "type": "json"
33650       }
33651     ],
33652     "name": "updateVtiger_Accounts",
33653     "group": "Vtiger_Accounts",
33654     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33655     "version": "0.0.0",
33656     "filename": "server/api/intVtigerAccount/index.js",
33657     "groupTitle": "Vtiger_Accounts"
33658   },
33659   {
33660     "type": "post",
33661     "url": "/api/integrations/vtiger/configurations",
33662     "title": "Creates a new Vtiger Configuration",
33663     "examples": [
33664       {
33665         "title": "Example usage:",
33666         "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",
33667         "type": "json"
33668       }
33669     ],
33670     "name": "CreateVtiger_Configurations",
33671     "group": "Vtiger_Configurations",
33672     "parameter": {
33673       "fields": {
33674         "Body": [
33675           {
33676             "group": "Body",
33677             "type": "String",
33678             "optional": true,
33679             "field": "name",
33680             "description": ""
33681           },
33682           {
33683             "group": "Body",
33684             "type": "String",
33685             "optional": true,
33686             "field": "description",
33687             "description": ""
33688           }
33689         ]
33690       }
33691     },
33692     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33693     "version": "0.0.0",
33694     "filename": "server/api/intVtigerConfiguration/index.js",
33695     "groupTitle": "Vtiger_Configurations"
33696   },
33697   {
33698     "type": "delete",
33699     "url": "/api/integrations/vtiger/configurations/{id}",
33700     "title": "Deletes a Vtiger Configuration",
33701     "examples": [
33702       {
33703         "title": "Example usage:",
33704         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password} -X DELETE",
33705         "type": "json"
33706       }
33707     ],
33708     "name": "DeleteVtiger_Configurations",
33709     "group": "Vtiger_Configurations",
33710     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33711     "version": "0.0.0",
33712     "filename": "server/api/intVtigerConfiguration/index.js",
33713     "groupTitle": "Vtiger_Configurations"
33714   },
33715   {
33716     "type": "get",
33717     "url": "/api/integrations/vtiger/configurations",
33718     "title": "Gets a list of Vtiger Configurations",
33719     "examples": [
33720       {
33721         "title": "Example usage:",
33722         "content": "curl https://{domain}/api/integrations/vtiger/configurations -v -u {name}:{password}",
33723         "type": "json"
33724       }
33725     ],
33726     "name": "GetVtiger_Configurations",
33727     "group": "Vtiger_Configurations",
33728     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33729     "version": "0.0.0",
33730     "filename": "server/api/intVtigerConfiguration/index.js",
33731     "groupTitle": "Vtiger_Configurations"
33732   },
33733   {
33734     "type": "get",
33735     "url": "/api/integrations/vtiger/configurations/{id}",
33736     "title": "Gets a single Vtiger Configuration",
33737     "examples": [
33738       {
33739         "title": "Example usage:",
33740         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password}",
33741         "type": "json"
33742       }
33743     ],
33744     "name": "ShowVtiger_Configurations",
33745     "group": "Vtiger_Configurations",
33746     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33747     "version": "0.0.0",
33748     "filename": "server/api/intVtigerConfiguration/index.js",
33749     "groupTitle": "Vtiger_Configurations"
33750   },
33751   {
33752     "type": "get",
33753     "url": "/api/integrations/vtiger/configurations/{id}/descriptions",
33754     "title": "Gets configurations descriptions",
33755     "examples": [
33756       {
33757         "title": "Example usage:",
33758         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
33759         "type": "json"
33760       }
33761     ],
33762     "name": "getDescriptions",
33763     "group": "Vtiger_Configurations",
33764     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33765     "version": "0.0.0",
33766     "filename": "server/api/intVtigerConfiguration/index.js",
33767     "groupTitle": "Vtiger_Configurations"
33768   },
33769   {
33770     "type": "get",
33771     "url": "/api/integrations/vtiger/configurations/{id}/fields",
33772     "title": "Gets configurations fields",
33773     "examples": [
33774       {
33775         "title": "Example usage:",
33776         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/fields -v -u {name}:{password} -X GET",
33777         "type": "json"
33778       }
33779     ],
33780     "name": "getFields",
33781     "group": "Vtiger_Configurations",
33782     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33783     "version": "0.0.0",
33784     "filename": "server/api/intVtigerConfiguration/index.js",
33785     "groupTitle": "Vtiger_Configurations"
33786   },
33787   {
33788     "type": "get",
33789     "url": "/api/integrations/vtiger/configurations/{id}/subjects",
33790     "title": "Gets configurations subjects",
33791     "examples": [
33792       {
33793         "title": "Example usage:",
33794         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/subjects -v -u {name}:{password} -X GET",
33795         "type": "json"
33796       }
33797     ],
33798     "name": "getSubjects",
33799     "group": "Vtiger_Configurations",
33800     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33801     "version": "0.0.0",
33802     "filename": "server/api/intVtigerConfiguration/index.js",
33803     "groupTitle": "Vtiger_Configurations"
33804   },
33805   {
33806     "type": "put",
33807     "url": "/api/integrations/vtiger/configurations/{id}",
33808     "title": "Update an existing Vtiger Configuration",
33809     "examples": [
33810       {
33811         "title": "Example usage:",
33812         "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",
33813         "type": "json"
33814       }
33815     ],
33816     "name": "updateVtiger_Configurations",
33817     "group": "Vtiger_Configurations",
33818     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33819     "version": "0.0.0",
33820     "filename": "server/api/intVtigerConfiguration/index.js",
33821     "groupTitle": "Vtiger_Configurations"
33822   },
33823   {
33824     "type": "post",
33825     "url": "/api/integrations/vtiger/fields",
33826     "title": "Creates a new Vtiger Field",
33827     "examples": [
33828       {
33829         "title": "Example usage:",
33830         "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",
33831         "type": "json"
33832       }
33833     ],
33834     "name": "CreateVtiger_Fields",
33835     "group": "Vtiger_Fields",
33836     "parameter": {
33837       "fields": {
33838         "Body": [
33839           {
33840             "group": "Body",
33841             "type": "String",
33842             "allowedValues": [
33843               "\"string\"",
33844               "\"variable\"",
33845               "\"customVariable\"",
33846               "\"keyValue\""
33847             ],
33848             "optional": true,
33849             "field": "type",
33850             "description": ""
33851           },
33852           {
33853             "group": "Body",
33854             "type": "String",
33855             "optional": true,
33856             "field": "content",
33857             "description": ""
33858           },
33859           {
33860             "group": "Body",
33861             "type": "String",
33862             "optional": true,
33863             "field": "key",
33864             "description": ""
33865           },
33866           {
33867             "group": "Body",
33868             "type": "String",
33869             "allowedValues": [
33870               "\"string\"",
33871               "\"variable\"",
33872               "\"customVariable\""
33873             ],
33874             "optional": true,
33875             "field": "keyType",
33876             "description": ""
33877           },
33878           {
33879             "group": "Body",
33880             "type": "String",
33881             "optional": true,
33882             "field": "keyContent",
33883             "description": ""
33884           },
33885           {
33886             "group": "Body",
33887             "type": "String",
33888             "optional": true,
33889             "field": "idField",
33890             "description": ""
33891           },
33892           {
33893             "group": "Body",
33894             "type": "String",
33895             "optional": true,
33896             "field": "nameField",
33897             "description": ""
33898           },
33899           {
33900             "group": "Body",
33901             "type": "Boolean",
33902             "optional": true,
33903             "field": "customField",
33904             "description": ""
33905           },
33906           {
33907             "group": "Body",
33908             "type": "String",
33909             "optional": true,
33910             "field": "variableName",
33911             "description": ""
33912           }
33913         ]
33914       }
33915     },
33916     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33917     "version": "0.0.0",
33918     "filename": "server/api/intVtigerField/index.js",
33919     "groupTitle": "Vtiger_Fields"
33920   },
33921   {
33922     "type": "delete",
33923     "url": "/api/integrations/vtiger/fields/{id}",
33924     "title": "Deletes a Vtiger Field",
33925     "examples": [
33926       {
33927         "title": "Example usage:",
33928         "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password} -X DELETE",
33929         "type": "json"
33930       }
33931     ],
33932     "name": "DeleteVtiger_Fields",
33933     "group": "Vtiger_Fields",
33934     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33935     "version": "0.0.0",
33936     "filename": "server/api/intVtigerField/index.js",
33937     "groupTitle": "Vtiger_Fields"
33938   },
33939   {
33940     "type": "get",
33941     "url": "/api/integrations/vtiger/fields",
33942     "title": "Gets a list of Vtiger Fields",
33943     "examples": [
33944       {
33945         "title": "Example usage:",
33946         "content": "curl https://{domain}/api/integrations/vtiger/fields -v -u {name}:{password}",
33947         "type": "json"
33948       }
33949     ],
33950     "name": "GetVtiger_Fields",
33951     "group": "Vtiger_Fields",
33952     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33953     "version": "0.0.0",
33954     "filename": "server/api/intVtigerField/index.js",
33955     "groupTitle": "Vtiger_Fields"
33956   },
33957   {
33958     "type": "get",
33959     "url": "/api/integrations/vtiger/fields/{id}",
33960     "title": "Gets a single Vtiger Field",
33961     "examples": [
33962       {
33963         "title": "Example usage:",
33964         "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password}",
33965         "type": "json"
33966       }
33967     ],
33968     "name": "ShowVtiger_Fields",
33969     "group": "Vtiger_Fields",
33970     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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": "put",
33977     "url": "/api/integrations/vtiger/fields/{id}",
33978     "title": "Update an existing Vtiger Field",
33979     "examples": [
33980       {
33981         "title": "Example usage:",
33982         "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",
33983         "type": "json"
33984       }
33985     ],
33986     "name": "updateVtiger_Fields",
33987     "group": "Vtiger_Fields",
33988     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33989     "version": "0.0.0",
33990     "filename": "server/api/intVtigerField/index.js",
33991     "groupTitle": "Vtiger_Fields"
33992   },
33993   {
33994     "type": "post",
33995     "url": "/api/webbar/answer",
33996     "title": "answer webrtc call",
33997     "examples": [
33998       {
33999         "title": "Example usage:",
34000         "content": "curl https://{domain}/api/webbar/answer -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34001         "type": "json"
34002       }
34003     ],
34004     "name": "Web_Bar_answer",
34005     "group": "WebBar",
34006     "parameter": {
34007       "fields": {
34008         "Body": [
34009           {
34010             "group": "Body",
34011             "type": "String",
34012             "optional": false,
34013             "field": "sessionId",
34014             "description": ""
34015           },
34016           {
34017             "group": "Body",
34018             "type": "number",
34019             "optional": false,
34020             "field": "userId",
34021             "description": ""
34022           }
34023         ]
34024       }
34025     },
34026     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34027     "version": "0.0.0",
34028     "filename": "server/api/webbar/index.js",
34029     "groupTitle": "WebBar"
34030   },
34031   {
34032     "type": "post",
34033     "url": "/api/webbar/calls",
34034     "title": "webrtc call list",
34035     "examples": [
34036       {
34037         "title": "Example usage:",
34038         "content": "curl https://{domain}/api/webbar/calls -d '{\"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34039         "type": "json"
34040       }
34041     ],
34042     "name": "Web_Bar_calls",
34043     "group": "WebBar",
34044     "parameter": {
34045       "fields": {
34046         "Body": [
34047           {
34048             "group": "Body",
34049             "type": "number",
34050             "optional": false,
34051             "field": "userId",
34052             "description": ""
34053           }
34054         ]
34055       }
34056     },
34057     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34058     "version": "0.0.0",
34059     "filename": "server/api/webbar/index.js",
34060     "groupTitle": "WebBar"
34061   },
34062   {
34063     "type": "post",
34064     "url": "/api/webbar/hangup",
34065     "title": "hangup webrtc call",
34066     "examples": [
34067       {
34068         "title": "Example usage:",
34069         "content": "curl https://{domain}/api/webbar/hangup -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34070         "type": "json"
34071       }
34072     ],
34073     "name": "Web_Bar_hangup",
34074     "group": "WebBar",
34075     "parameter": {
34076       "fields": {
34077         "Body": [
34078           {
34079             "group": "Body",
34080             "type": "String",
34081             "optional": false,
34082             "field": "sessionId",
34083             "description": ""
34084           },
34085           {
34086             "group": "Body",
34087             "type": "number",
34088             "optional": false,
34089             "field": "userId",
34090             "description": ""
34091           }
34092         ]
34093       }
34094     },
34095     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34096     "version": "0.0.0",
34097     "filename": "server/api/webbar/index.js",
34098     "groupTitle": "WebBar"
34099   },
34100   {
34101     "type": "post",
34102     "url": "/api/webbar/hold",
34103     "title": "hold webrtc call",
34104     "examples": [
34105       {
34106         "title": "Example usage:",
34107         "content": "curl https://{domain}/api/webbar/hold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34108         "type": "json"
34109       }
34110     ],
34111     "name": "Web_Bar_hold",
34112     "group": "WebBar",
34113     "parameter": {
34114       "fields": {
34115         "Body": [
34116           {
34117             "group": "Body",
34118             "type": "String",
34119             "optional": true,
34120             "field": "sessionId",
34121             "description": ""
34122           },
34123           {
34124             "group": "Body",
34125             "type": "number",
34126             "optional": false,
34127             "field": "userId",
34128             "description": ""
34129           }
34130         ]
34131       }
34132     },
34133     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34134     "version": "0.0.0",
34135     "filename": "server/api/webbar/index.js",
34136     "groupTitle": "WebBar"
34137   },
34138   {
34139     "type": "post",
34140     "url": "/api/webbar/unhold",
34141     "title": "unhold webrtc call",
34142     "examples": [
34143       {
34144         "title": "Example usage:",
34145         "content": "curl https://{domain}/api/webbar/unhold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34146         "type": "json"
34147       }
34148     ],
34149     "name": "Web_Bar_hold",
34150     "group": "WebBar",
34151     "parameter": {
34152       "fields": {
34153         "Body": [
34154           {
34155             "group": "Body",
34156             "type": "String",
34157             "optional": false,
34158             "field": "sessionId",
34159             "description": ""
34160           },
34161           {
34162             "group": "Body",
34163             "type": "number",
34164             "optional": false,
34165             "field": "userId",
34166             "description": ""
34167           }
34168         ]
34169       }
34170     },
34171     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34172     "version": "0.0.0",
34173     "filename": "server/api/webbar/index.js",
34174     "groupTitle": "WebBar"
34175   },
34176   {
34177     "type": "post",
34178     "url": "/api/webbar/originate",
34179     "title": "Originate new webrtc call",
34180     "examples": [
34181       {
34182         "title": "Example usage:",
34183         "content": "curl https://{domain}/api/webbar/originate -d '{\"callNumber\": \"0119692844\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34184         "type": "json"
34185       }
34186     ],
34187     "name": "Web_Bar_originate",
34188     "group": "WebBar",
34189     "parameter": {
34190       "fields": {
34191         "Body": [
34192           {
34193             "group": "Body",
34194             "type": "String",
34195             "optional": false,
34196             "field": "callNumber",
34197             "description": ""
34198           },
34199           {
34200             "group": "Body",
34201             "type": "number",
34202             "optional": false,
34203             "field": "userId",
34204             "description": ""
34205           },
34206           {
34207             "group": "Body",
34208             "type": "String",
34209             "optional": false,
34210             "field": "callerId",
34211             "description": ""
34212           },
34213           {
34214             "group": "Body",
34215             "type": "String",
34216             "optional": false,
34217             "field": "callbackUrl",
34218             "description": ""
34219           }
34220         ]
34221       }
34222     },
34223     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34224     "version": "0.0.0",
34225     "filename": "server/api/webbar/index.js",
34226     "groupTitle": "WebBar"
34227   },
34228   {
34229     "type": "post",
34230     "url": "/api/webbar/transfer",
34231     "title": "blind transfer webrtc call",
34232     "examples": [
34233       {
34234         "title": "Example usage:",
34235         "content": "curl https://{domain}/api/webbar/transfer -d '{\"userId\": 54, \"sessionId\":\"<sessionId>\", \"transferNumber\":\"<transferNumber>\"}' \\\n -H \"Content-Type: application/json\" -X POST",
34236         "type": "json"
34237       }
34238     ],
34239     "name": "Web_Bar_transfer",
34240     "group": "WebBar",
34241     "parameter": {
34242       "fields": {
34243         "Body": [
34244           {
34245             "group": "Body",
34246             "type": "number",
34247             "optional": false,
34248             "field": "userId",
34249             "description": ""
34250           },
34251           {
34252             "group": "Body",
34253             "type": "string",
34254             "optional": false,
34255             "field": "sessionId",
34256             "description": ""
34257           },
34258           {
34259             "group": "Body",
34260             "type": "string",
34261             "optional": false,
34262             "field": "transferNumber",
34263             "description": ""
34264           }
34265         ]
34266       }
34267     },
34268     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34269     "version": "0.0.0",
34270     "filename": "server/api/webbar/index.js",
34271     "groupTitle": "WebBar"
34272   },
34273   {
34274     "type": "post",
34275     "url": "/api/whatsapp/accounts/{id}/users",
34276     "title": "Add agents to a whatsapp account",
34277     "examples": [
34278       {
34279         "title": "Example usage:",
34280         "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",
34281         "type": "json"
34282       }
34283     ],
34284     "name": "AddAgents",
34285     "group": "Whatsapp_Accounts",
34286     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34287     "version": "0.0.0",
34288     "filename": "server/api/whatsappAccount/index.js",
34289     "groupTitle": "Whatsapp_Accounts"
34290   },
34291   {
34292     "type": "post",
34293     "url": "/api/whatsapp/accounts",
34294     "title": "Creates a new Account",
34295     "examples": [
34296       {
34297         "title": "Example usage:",
34298         "content": "curl https://{domain}/api/whatsapp/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
34299         "type": "json"
34300       }
34301     ],
34302     "name": "CreateAccounts",
34303     "group": "Whatsapp_Accounts",
34304     "parameter": {
34305       "fields": {
34306         "Body": [
34307           {
34308             "group": "Body",
34309             "type": "String",
34310             "optional": false,
34311             "field": "name",
34312             "description": ""
34313           },
34314           {
34315             "group": "Body",
34316             "type": "String",
34317             "optional": false,
34318             "field": "key",
34319             "description": ""
34320           },
34321           {
34322             "group": "Body",
34323             "type": "String",
34324             "optional": false,
34325             "field": "remote",
34326             "description": ""
34327           },
34328           {
34329             "group": "Body",
34330             "type": "String",
34331             "optional": true,
34332             "field": "token",
34333             "description": ""
34334           },
34335           {
34336             "group": "Body",
34337             "type": "String",
34338             "optional": true,
34339             "field": "phone",
34340             "description": ""
34341           },
34342           {
34343             "group": "Body",
34344             "type": "String",
34345             "allowedValues": [
34346               "\"twilio\""
34347             ],
34348             "optional": true,
34349             "field": "type",
34350             "description": ""
34351           },
34352           {
34353             "group": "Body",
34354             "type": "String",
34355             "optional": true,
34356             "field": "accountSid",
34357             "description": ""
34358           },
34359           {
34360             "group": "Body",
34361             "type": "String",
34362             "optional": true,
34363             "field": "authToken",
34364             "description": ""
34365           },
34366           {
34367             "group": "Body",
34368             "type": "Text",
34369             "optional": true,
34370             "field": "notificationTemplate",
34371             "description": ""
34372           },
34373           {
34374             "group": "Body",
34375             "type": "Boolean",
34376             "optional": true,
34377             "field": "notificationSound",
34378             "description": ""
34379           },
34380           {
34381             "group": "Body",
34382             "type": "Boolean",
34383             "optional": true,
34384             "field": "notificationShake",
34385             "description": ""
34386           },
34387           {
34388             "group": "Body",
34389             "type": "Integer",
34390             "optional": true,
34391             "field": "waitForTheAssignedAgent",
34392             "description": ""
34393           },
34394           {
34395             "group": "Body",
34396             "type": "Boolean",
34397             "optional": true,
34398             "field": "queueTransfer",
34399             "description": ""
34400           },
34401           {
34402             "group": "Body",
34403             "type": "Integer",
34404             "optional": true,
34405             "field": "queueTransferTimeout",
34406             "description": ""
34407           },
34408           {
34409             "group": "Body",
34410             "type": "Boolean",
34411             "optional": true,
34412             "field": "agentTransfer",
34413             "description": ""
34414           },
34415           {
34416             "group": "Body",
34417             "type": "Integer",
34418             "optional": true,
34419             "field": "agentTransferTimeout",
34420             "description": ""
34421           },
34422           {
34423             "group": "Body",
34424             "type": "Integer",
34425             "optional": true,
34426             "field": "mandatoryDispositionPauseId",
34427             "description": "<p>Status to put when mandatory disposition is enabled</p>"
34428           },
34429           {
34430             "group": "Body",
34431             "type": "Boolean",
34432             "optional": true,
34433             "field": "mandatoryDisposition",
34434             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
34435           },
34436           {
34437             "group": "Body",
34438             "type": "String",
34439             "optional": true,
34440             "field": "description",
34441             "description": ""
34442           }
34443         ]
34444       }
34445     },
34446     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34447     "version": "0.0.0",
34448     "filename": "server/api/whatsappAccount/index.js",
34449     "groupTitle": "Whatsapp_Accounts"
34450   },
34451   {
34452     "type": "delete",
34453     "url": "/api/whatsapp/accounts/{id}",
34454     "title": "Deletes a Account",
34455     "examples": [
34456       {
34457         "title": "Example usage:",
34458         "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password} -X DELETE",
34459         "type": "json"
34460       }
34461     ],
34462     "name": "DeleteAccounts",
34463     "group": "Whatsapp_Accounts",
34464     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34465     "version": "0.0.0",
34466     "filename": "server/api/whatsappAccount/index.js",
34467     "groupTitle": "Whatsapp_Accounts"
34468   },
34469   {
34470     "type": "get",
34471     "url": "/api/whatsapp/accounts/describe",
34472     "title": "Gets table info about Accounts",
34473     "examples": [
34474       {
34475         "title": "Example usage:",
34476         "content": "curl https://{domain}/api/whatsapp/accounts/describe -v -u {name}:{password}",
34477         "type": "json"
34478       }
34479     ],
34480     "name": "DescribeAccounts",
34481     "group": "Whatsapp_Accounts",
34482     "description": "<p>Motion will return a HTTP status code <code>200</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": "get",
34489     "url": "/api/whatsapp/accounts",
34490     "title": "Gets a list of Accounts",
34491     "examples": [
34492       {
34493         "title": "Example usage:",
34494         "content": "curl https://{domain}/api/whatsapp/accounts -v -u {name}:{password}",
34495         "type": "json"
34496       }
34497     ],
34498     "name": "GetAccounts",
34499     "group": "Whatsapp_Accounts",
34500     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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/{id}/users",
34508     "title": "Gets agents from whatsapp account",
34509     "examples": [
34510       {
34511         "title": "Example usage:",
34512         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users -v -u {name}:{password} -X GET",
34513         "type": "json"
34514       }
34515     ],
34516     "name": "GetAgents",
34517     "group": "Whatsapp_Accounts",
34518     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "delete",
34525     "url": "/api/whatsapp/accounts/{id}/users",
34526     "title": "Removes agents from a whatsapp account",
34527     "examples": [
34528       {
34529         "title": "Example usage:",
34530         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
34531         "type": "json"
34532       }
34533     ],
34534     "name": "RemoveAgents",
34535     "group": "Whatsapp_Accounts",
34536     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34537     "version": "0.0.0",
34538     "filename": "server/api/whatsappAccount/index.js",
34539     "groupTitle": "Whatsapp_Accounts"
34540   },
34541   {
34542     "type": "delete",
34543     "url": "/api/whatsapp/accounts/{id}/canned_answers",
34544     "title": "Removes canned answers from account",
34545     "examples": [
34546       {
34547         "title": "Example usage:",
34548         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
34549         "type": "json"
34550       }
34551     ],
34552     "name": "RemoveAnswers",
34553     "group": "Whatsapp_Accounts",
34554     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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}/dispositions",
34562     "title": "Removes dispositions from account",
34563     "examples": [
34564       {
34565         "title": "Example usage:",
34566         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
34567         "type": "json"
34568       }
34569     ],
34570     "name": "RemoveDispositions",
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": "get",
34579     "url": "/api/whatsapp/accounts/{id}",
34580     "title": "Gets a single Account",
34581     "examples": [
34582       {
34583         "title": "Example usage:",
34584         "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password}",
34585         "type": "json"
34586       }
34587     ],
34588     "name": "ShowAccounts",
34589     "group": "Whatsapp_Accounts",
34590     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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": "put",
34597     "url": "/api/whatsapp/messages/{id}/accept",
34598     "title": "Accepts message",
34599     "examples": [
34600       {
34601         "title": "Example usage:",
34602         "content": "curl https://{domain}/api/whatsapp/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
34603         "type": "json"
34604       }
34605     ],
34606     "name": "acceptMessage",
34607     "group": "Whatsapp_Accounts",
34608     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/whatsappMessage/index.js",
34611     "groupTitle": "Whatsapp_Accounts"
34612   },
34613   {
34614     "type": "post",
34615     "url": "/api/whatsapp/accounts/{id}/canned_answers",
34616     "title": "Creates new canned answer",
34617     "examples": [
34618       {
34619         "title": "Example usage:",
34620         "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",
34621         "type": "json"
34622       }
34623     ],
34624     "name": "addAnswer",
34625     "group": "Whatsapp_Accounts",
34626     "parameter": {
34627       "fields": {
34628         "Body": [
34629           {
34630             "group": "Body",
34631             "type": "String",
34632             "optional": false,
34633             "field": "key",
34634             "description": ""
34635           },
34636           {
34637             "group": "Body",
34638             "type": "Text",
34639             "optional": false,
34640             "field": "value",
34641             "description": ""
34642           },
34643           {
34644             "group": "Body",
34645             "type": "String",
34646             "optional": true,
34647             "field": "description",
34648             "description": ""
34649           },
34650           {
34651             "group": "Body",
34652             "type": "Virtual",
34653             "optional": true,
34654             "field": "name",
34655             "description": ""
34656           }
34657         ]
34658       }
34659     },
34660     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34661     "version": "0.0.0",
34662     "filename": "server/api/whatsappAccount/index.js",
34663     "groupTitle": "Whatsapp_Accounts"
34664   },
34665   {
34666     "type": "post",
34667     "url": "/api/whatsapp/accounts/{id}/applications",
34668     "title": "Creates new applications",
34669     "examples": [
34670       {
34671         "title": "Example usage:",
34672         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
34673         "type": "json"
34674       }
34675     ],
34676     "name": "addApplications",
34677     "group": "Whatsapp_Accounts",
34678     "parameter": {
34679       "fields": {
34680         "Body": [
34681           {
34682             "group": "Body",
34683             "type": "Integer",
34684             "optional": false,
34685             "field": "priority",
34686             "description": ""
34687           },
34688           {
34689             "group": "Body",
34690             "type": "String",
34691             "optional": false,
34692             "field": "app",
34693             "description": ""
34694           },
34695           {
34696             "group": "Body",
34697             "type": "Text",
34698             "optional": true,
34699             "field": "appdata",
34700             "description": ""
34701           },
34702           {
34703             "group": "Body",
34704             "type": "String",
34705             "optional": true,
34706             "field": "description",
34707             "description": ""
34708           },
34709           {
34710             "group": "Body",
34711             "type": "String",
34712             "optional": true,
34713             "field": "interval",
34714             "description": ""
34715           }
34716         ]
34717       }
34718     },
34719     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34720     "version": "0.0.0",
34721     "filename": "server/api/whatsappAccount/index.js",
34722     "groupTitle": "Whatsapp_Accounts"
34723   },
34724   {
34725     "type": "post",
34726     "url": "/api/whatsapp/accounts/{id}/dispositions",
34727     "title": "Creates new disposition",
34728     "examples": [
34729       {
34730         "title": "Example usage:",
34731         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
34732         "type": "json"
34733       }
34734     ],
34735     "name": "addDisposition",
34736     "group": "Whatsapp_Accounts",
34737     "parameter": {
34738       "fields": {
34739         "Body": [
34740           {
34741             "group": "Body",
34742             "type": "String",
34743             "optional": false,
34744             "field": "name",
34745             "description": ""
34746           },
34747           {
34748             "group": "Body",
34749             "type": "String",
34750             "allowedValues": [
34751               "\"first\"",
34752               "\"second\"",
34753               "\"third\""
34754             ],
34755             "optional": false,
34756             "field": "level",
34757             "description": ""
34758           },
34759           {
34760             "group": "Body",
34761             "type": "String",
34762             "optional": true,
34763             "field": "description",
34764             "description": ""
34765           }
34766         ]
34767       }
34768     },
34769     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34770     "version": "0.0.0",
34771     "filename": "server/api/whatsappAccount/index.js",
34772     "groupTitle": "Whatsapp_Accounts"
34773   },
34774   {
34775     "type": "get",
34776     "url": "/api/whatsapp/accounts/{id}/canned_answers",
34777     "title": "Gets account canned answers",
34778     "examples": [
34779       {
34780         "title": "Example usage:",
34781         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
34782         "type": "json"
34783       }
34784     ],
34785     "name": "getAnswers",
34786     "group": "Whatsapp_Accounts",
34787     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34788     "version": "0.0.0",
34789     "filename": "server/api/whatsappAccount/index.js",
34790     "groupTitle": "Whatsapp_Accounts"
34791   },
34792   {
34793     "type": "get",
34794     "url": "/api/whatsapp/accounts/{id}/applications",
34795     "title": "Gets account applications",
34796     "examples": [
34797       {
34798         "title": "Example usage:",
34799         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -v -u {name}:{password} -X GET",
34800         "type": "json"
34801       }
34802     ],
34803     "name": "getApplications",
34804     "group": "Whatsapp_Accounts",
34805     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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}/dispositions",
34813     "title": "Gets account dispositions",
34814     "examples": [
34815       {
34816         "title": "Example usage:",
34817         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
34818         "type": "json"
34819       }
34820     ],
34821     "name": "getDispositions",
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": "post",
34830     "url": "/api/whatsapp/accounts/{id}/notify",
34831     "title": "Notify new message",
34832     "examples": [
34833       {
34834         "title": "Example usage:",
34835         "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",
34836         "type": "json"
34837       }
34838     ],
34839     "name": "notify",
34840     "group": "Whatsapp_Accounts",
34841     "description": "<p>Motion 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>",
34842     "version": "0.0.0",
34843     "filename": "server/api/whatsappAccount/index.js",
34844     "groupTitle": "Whatsapp_Accounts"
34845   },
34846   {
34847     "type": "put",
34848     "url": "/api/whatsapp/messages/{id}/reject",
34849     "title": "Rejects message",
34850     "examples": [
34851       {
34852         "title": "Example usage:",
34853         "content": "curl https://{domain}/api/whatsapp/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
34854         "type": "json"
34855       }
34856     ],
34857     "name": "rejectMessage",
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/whatsappMessage/index.js",
34862     "groupTitle": "Whatsapp_Accounts"
34863   },
34864   {
34865     "type": "post",
34866     "url": "/api/whatsapp/accounts/{id}/send",
34867     "title": "Send new whatsapp message",
34868     "examples": [
34869       {
34870         "title": "Example usage:",
34871         "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",
34872         "type": "json"
34873       }
34874     ],
34875     "name": "sendWhatsapp",
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>",
34878     "version": "0.0.0",
34879     "filename": "server/api/whatsappAccount/index.js",
34880     "groupTitle": "Whatsapp_Accounts"
34881   },
34882   {
34883     "type": "post",
34884     "url": "/api/whatsapp/messages/{id}/status",
34885     "title": "Receive message status",
34886     "examples": [
34887       {
34888         "title": "Example usage:",
34889         "content": "curl https://{domain}/api/whatsapp/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
34890         "type": "json"
34891       }
34892     ],
34893     "name": "statusMessage",
34894     "group": "Whatsapp_Accounts",
34895     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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": "put",
34902     "url": "/api/whatsapp/accounts/{id}",
34903     "title": "Update an existing Account",
34904     "examples": [
34905       {
34906         "title": "Example usage:",
34907         "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",
34908         "type": "json"
34909       }
34910     ],
34911     "name": "updateAccounts",
34912     "group": "Whatsapp_Accounts",
34913     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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/applications",
34921     "title": "Creates a new Application",
34922     "examples": [
34923       {
34924         "title": "Example usage:",
34925         "content": "curl https://{domain}/api/whatsapp/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
34926         "type": "json"
34927       }
34928     ],
34929     "name": "CreateApplications",
34930     "group": "Whatsapp_Applications",
34931     "parameter": {
34932       "fields": {
34933         "Body": [
34934           {
34935             "group": "Body",
34936             "type": "Integer",
34937             "optional": false,
34938             "field": "priority",
34939             "description": ""
34940           },
34941           {
34942             "group": "Body",
34943             "type": "String",
34944             "optional": false,
34945             "field": "app",
34946             "description": ""
34947           },
34948           {
34949             "group": "Body",
34950             "type": "Text",
34951             "optional": true,
34952             "field": "appdata",
34953             "description": ""
34954           },
34955           {
34956             "group": "Body",
34957             "type": "String",
34958             "optional": true,
34959             "field": "description",
34960             "description": ""
34961           },
34962           {
34963             "group": "Body",
34964             "type": "String",
34965             "optional": true,
34966             "field": "interval",
34967             "description": ""
34968           }
34969         ]
34970       }
34971     },
34972     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34973     "version": "0.0.0",
34974     "filename": "server/api/whatsappApplication/index.js",
34975     "groupTitle": "Whatsapp_Applications"
34976   },
34977   {
34978     "type": "delete",
34979     "url": "/api/whatsapp/applications/{id}",
34980     "title": "Deletes a Application",
34981     "examples": [
34982       {
34983         "title": "Example usage:",
34984         "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password} -X DELETE",
34985         "type": "json"
34986       }
34987     ],
34988     "name": "DeleteApplications",
34989     "group": "Whatsapp_Applications",
34990     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34991     "version": "0.0.0",
34992     "filename": "server/api/whatsappApplication/index.js",
34993     "groupTitle": "Whatsapp_Applications"
34994   },
34995   {
34996     "type": "get",
34997     "url": "/api/whatsapp/applications",
34998     "title": "Gets a list of Applications",
34999     "examples": [
35000       {
35001         "title": "Example usage:",
35002         "content": "curl https://{domain}/api/whatsapp/applications -v -u {name}:{password}",
35003         "type": "json"
35004       }
35005     ],
35006     "name": "GetApplications",
35007     "group": "Whatsapp_Applications",
35008     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35009     "version": "0.0.0",
35010     "filename": "server/api/whatsappApplication/index.js",
35011     "groupTitle": "Whatsapp_Applications"
35012   },
35013   {
35014     "type": "get",
35015     "url": "/api/whatsapp/applications/{id}",
35016     "title": "Gets a single Application",
35017     "examples": [
35018       {
35019         "title": "Example usage:",
35020         "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password}",
35021         "type": "json"
35022       }
35023     ],
35024     "name": "ShowApplications",
35025     "group": "Whatsapp_Applications",
35026     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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": "put",
35033     "url": "/api/whatsapp/applications/{id}",
35034     "title": "Update an existing Application",
35035     "examples": [
35036       {
35037         "title": "Example usage:",
35038         "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",
35039         "type": "json"
35040       }
35041     ],
35042     "name": "updateApplications",
35043     "group": "Whatsapp_Applications",
35044     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35045     "version": "0.0.0",
35046     "filename": "server/api/whatsappApplication/index.js",
35047     "groupTitle": "Whatsapp_Applications"
35048   },
35049   {
35050     "type": "post",
35051     "url": "/api/whatsapp/interactions/{id}/tags",
35052     "title": "Add tags to the interaction",
35053     "examples": [
35054       {
35055         "title": "Example usage:",
35056         "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",
35057         "type": "json"
35058       }
35059     ],
35060     "name": "AddTags",
35061     "group": "Whatsapp_Interactions",
35062     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35063     "version": "0.0.0",
35064     "filename": "server/api/whatsappInteraction/index.js",
35065     "groupTitle": "Whatsapp_Interactions"
35066   },
35067   {
35068     "type": "post",
35069     "url": "/api/whatsapp/interactions",
35070     "title": "Creates a new Interaction",
35071     "examples": [
35072       {
35073         "title": "Example usage:",
35074         "content": "curl https://{domain}/api/whatsapp/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35075         "type": "json"
35076       }
35077     ],
35078     "name": "CreateInteractions",
35079     "group": "Whatsapp_Interactions",
35080     "parameter": {
35081       "fields": {
35082         "Body": [
35083           {
35084             "group": "Body",
35085             "type": "Boolean",
35086             "optional": true,
35087             "field": "closed",
35088             "description": ""
35089           },
35090           {
35091             "group": "Body",
35092             "type": "String",
35093             "optional": true,
35094             "field": "closedAt",
35095             "description": ""
35096           },
35097           {
35098             "group": "Body",
35099             "type": "String",
35100             "optional": true,
35101             "field": "disposition",
35102             "description": ""
35103           },
35104           {
35105             "group": "Body",
35106             "type": "String",
35107             "optional": true,
35108             "field": "secondDisposition",
35109             "description": ""
35110           },
35111           {
35112             "group": "Body",
35113             "type": "String",
35114             "optional": true,
35115             "field": "thirdDisposition",
35116             "description": ""
35117           },
35118           {
35119             "group": "Body",
35120             "type": "String",
35121             "optional": true,
35122             "field": "note",
35123             "description": ""
35124           },
35125           {
35126             "group": "Body",
35127             "type": "String",
35128             "optional": true,
35129             "field": "phone",
35130             "description": ""
35131           },
35132           {
35133             "group": "Body",
35134             "type": "String",
35135             "optional": true,
35136             "field": "read1stAt",
35137             "description": ""
35138           },
35139           {
35140             "group": "Body",
35141             "type": "String",
35142             "allowedValues": [
35143               "\"in\"",
35144               "\"out\""
35145             ],
35146             "optional": false,
35147             "field": "firstMsgDirection",
35148             "description": ""
35149           },
35150           {
35151             "group": "Body",
35152             "type": "String",
35153             "optional": true,
35154             "field": "lastMsgAt",
35155             "description": ""
35156           },
35157           {
35158             "group": "Body",
35159             "type": "String",
35160             "allowedValues": [
35161               "\"in\"",
35162               "\"out\""
35163             ],
35164             "optional": false,
35165             "field": "lastMsgDirection",
35166             "description": ""
35167           }
35168         ]
35169       }
35170     },
35171     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35172     "version": "0.0.0",
35173     "filename": "server/api/whatsappInteraction/index.js",
35174     "groupTitle": "Whatsapp_Interactions"
35175   },
35176   {
35177     "type": "delete",
35178     "url": "/api/whatsapp/interactions/{id}",
35179     "title": "Deletes a Interaction",
35180     "examples": [
35181       {
35182         "title": "Example usage:",
35183         "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password} -X DELETE",
35184         "type": "json"
35185       }
35186     ],
35187     "name": "DeleteInteractions",
35188     "group": "Whatsapp_Interactions",
35189     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35190     "version": "0.0.0",
35191     "filename": "server/api/whatsappInteraction/index.js",
35192     "groupTitle": "Whatsapp_Interactions"
35193   },
35194   {
35195     "type": "get",
35196     "url": "/api/whatsapp/interactions/describe",
35197     "title": "Gets table info about Interactions",
35198     "examples": [
35199       {
35200         "title": "Example usage:",
35201         "content": "curl https://{domain}/api/whatsapp/interactions/describe -v -u {name}:{password}",
35202         "type": "json"
35203       }
35204     ],
35205     "name": "DescribeInteractions",
35206     "group": "Whatsapp_Interactions",
35207     "description": "<p>Motion will return a HTTP status code <code>200</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": "get",
35214     "url": "/api/whatsapp/interactions",
35215     "title": "Gets a list of Interactions",
35216     "examples": [
35217       {
35218         "title": "Example usage:",
35219         "content": "curl https://{domain}/api/whatsapp/interactions -v -u {name}:{password}",
35220         "type": "json"
35221       }
35222     ],
35223     "name": "GetInteractions",
35224     "group": "Whatsapp_Interactions",
35225     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35226     "version": "0.0.0",
35227     "filename": "server/api/whatsappInteraction/index.js",
35228     "groupTitle": "Whatsapp_Interactions"
35229   },
35230   {
35231     "type": "delete",
35232     "url": "/api/whatsapp/interactions/{id}/tags",
35233     "title": "Removes tags from interaction",
35234     "examples": [
35235       {
35236         "title": "Example usage:",
35237         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
35238         "type": "json"
35239       }
35240     ],
35241     "name": "RemoveTags",
35242     "group": "Whatsapp_Interactions",
35243     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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/{id}",
35251     "title": "Gets a single Interaction",
35252     "examples": [
35253       {
35254         "title": "Example usage:",
35255         "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password}",
35256         "type": "json"
35257       }
35258     ],
35259     "name": "ShowInteractions",
35260     "group": "Whatsapp_Interactions",
35261     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35262     "version": "0.0.0",
35263     "filename": "server/api/whatsappInteraction/index.js",
35264     "groupTitle": "Whatsapp_Interactions"
35265   },
35266   {
35267     "type": "post",
35268     "url": "/api/whatsapp/interactions/{id}/messages",
35269     "title": "Creates new messages",
35270     "examples": [
35271       {
35272         "title": "Example usage:",
35273         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35274         "type": "json"
35275       }
35276     ],
35277     "name": "addMessage",
35278     "group": "Whatsapp_Interactions",
35279     "parameter": {
35280       "fields": {
35281         "Body": [
35282           {
35283             "group": "Body",
35284             "type": "Text",
35285             "optional": false,
35286             "field": "body",
35287             "description": ""
35288           },
35289           {
35290             "group": "Body",
35291             "type": "Boolean",
35292             "optional": true,
35293             "field": "read",
35294             "description": ""
35295           },
35296           {
35297             "group": "Body",
35298             "type": "String",
35299             "allowedValues": [
35300               "\"in\"",
35301               "\"out\""
35302             ],
35303             "optional": false,
35304             "field": "direction",
35305             "description": ""
35306           },
35307           {
35308             "group": "Body",
35309             "type": "String",
35310             "optional": true,
35311             "field": "messageId",
35312             "description": ""
35313           },
35314           {
35315             "group": "Body",
35316             "type": "String",
35317             "optional": true,
35318             "field": "phone",
35319             "description": ""
35320           },
35321           {
35322             "group": "Body",
35323             "type": "String",
35324             "optional": true,
35325             "field": "readAt",
35326             "description": ""
35327           },
35328           {
35329             "group": "Body",
35330             "type": "Boolean",
35331             "optional": true,
35332             "field": "secret",
35333             "description": ""
35334           },
35335           {
35336             "group": "Body",
35337             "type": "String",
35338             "optional": true,
35339             "field": "providerName",
35340             "description": ""
35341           },
35342           {
35343             "group": "Body",
35344             "type": "Text",
35345             "optional": true,
35346             "field": "providerResponse",
35347             "description": ""
35348           }
35349         ]
35350       }
35351     },
35352     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35353     "version": "0.0.0",
35354     "filename": "server/api/whatsappInteraction/index.js",
35355     "groupTitle": "Whatsapp_Interactions"
35356   },
35357   {
35358     "type": "get",
35359     "url": "/api/whatsapp/interactions/{id}/download",
35360     "title": "Gets interaction",
35361     "examples": [
35362       {
35363         "title": "Example usage:",
35364         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/download -v -u {name}:{password} -X GET",
35365         "type": "json"
35366       }
35367     ],
35368     "name": "download",
35369     "group": "Whatsapp_Interactions",
35370     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35371     "version": "0.0.0",
35372     "filename": "server/api/whatsappInteraction/index.js",
35373     "groupTitle": "Whatsapp_Interactions"
35374   },
35375   {
35376     "type": "get",
35377     "url": "/api/whatsapp/interactions/{id}/messages",
35378     "title": "Gets interaction messages",
35379     "examples": [
35380       {
35381         "title": "Example usage:",
35382         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -v -u {name}:{password} -X GET",
35383         "type": "json"
35384       }
35385     ],
35386     "name": "getMessages",
35387     "group": "Whatsapp_Interactions",
35388     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "put",
35395     "url": "/api/whatsapp/interactions/{id}",
35396     "title": "Update an existing Interaction",
35397     "examples": [
35398       {
35399         "title": "Example usage:",
35400         "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",
35401         "type": "json"
35402       }
35403     ],
35404     "name": "updateInteractions",
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": "post",
35413     "url": "/api/whatsapp/messages",
35414     "title": "Creates a new Message",
35415     "examples": [
35416       {
35417         "title": "Example usage:",
35418         "content": "curl https://{domain}/api/whatsapp/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35419         "type": "json"
35420       }
35421     ],
35422     "name": "CreateMessages",
35423     "group": "Whatsapp_Messages",
35424     "parameter": {
35425       "fields": {
35426         "Body": [
35427           {
35428             "group": "Body",
35429             "type": "Text",
35430             "optional": false,
35431             "field": "body",
35432             "description": ""
35433           },
35434           {
35435             "group": "Body",
35436             "type": "Boolean",
35437             "optional": true,
35438             "field": "read",
35439             "description": ""
35440           },
35441           {
35442             "group": "Body",
35443             "type": "String",
35444             "allowedValues": [
35445               "\"in\"",
35446               "\"out\""
35447             ],
35448             "optional": false,
35449             "field": "direction",
35450             "description": ""
35451           },
35452           {
35453             "group": "Body",
35454             "type": "String",
35455             "optional": true,
35456             "field": "messageId",
35457             "description": ""
35458           },
35459           {
35460             "group": "Body",
35461             "type": "String",
35462             "optional": true,
35463             "field": "phone",
35464             "description": ""
35465           },
35466           {
35467             "group": "Body",
35468             "type": "String",
35469             "optional": true,
35470             "field": "readAt",
35471             "description": ""
35472           },
35473           {
35474             "group": "Body",
35475             "type": "Boolean",
35476             "optional": true,
35477             "field": "secret",
35478             "description": ""
35479           },
35480           {
35481             "group": "Body",
35482             "type": "String",
35483             "optional": true,
35484             "field": "providerName",
35485             "description": ""
35486           },
35487           {
35488             "group": "Body",
35489             "type": "Text",
35490             "optional": true,
35491             "field": "providerResponse",
35492             "description": ""
35493           }
35494         ]
35495       }
35496     },
35497     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35498     "version": "0.0.0",
35499     "filename": "server/api/whatsappMessage/index.js",
35500     "groupTitle": "Whatsapp_Messages"
35501   },
35502   {
35503     "type": "delete",
35504     "url": "/api/whatsapp/messages/{id}",
35505     "title": "Deletes a Message",
35506     "examples": [
35507       {
35508         "title": "Example usage:",
35509         "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password} -X DELETE",
35510         "type": "json"
35511       }
35512     ],
35513     "name": "DeleteMessages",
35514     "group": "Whatsapp_Messages",
35515     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35516     "version": "0.0.0",
35517     "filename": "server/api/whatsappMessage/index.js",
35518     "groupTitle": "Whatsapp_Messages"
35519   },
35520   {
35521     "type": "get",
35522     "url": "/api/whatsapp/messages/describe",
35523     "title": "Gets table info about Messages",
35524     "examples": [
35525       {
35526         "title": "Example usage:",
35527         "content": "curl https://{domain}/api/whatsapp/messages/describe -v -u {name}:{password}",
35528         "type": "json"
35529       }
35530     ],
35531     "name": "DescribeMessages",
35532     "group": "Whatsapp_Messages",
35533     "description": "<p>Motion will return a HTTP status code <code>200</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": "get",
35540     "url": "/api/whatsapp/messages",
35541     "title": "Gets a list of Messages",
35542     "examples": [
35543       {
35544         "title": "Example usage:",
35545         "content": "curl https://{domain}/api/whatsapp/messages -v -u {name}:{password}",
35546         "type": "json"
35547       }
35548     ],
35549     "name": "GetMessages",
35550     "group": "Whatsapp_Messages",
35551     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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/{id}",
35559     "title": "Gets a single Message",
35560     "examples": [
35561       {
35562         "title": "Example usage:",
35563         "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password}",
35564         "type": "json"
35565       }
35566     ],
35567     "name": "ShowMessages",
35568     "group": "Whatsapp_Messages",
35569     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "put",
35576     "url": "/api/whatsapp/messages/{id}",
35577     "title": "Update an existing Message",
35578     "examples": [
35579       {
35580         "title": "Example usage:",
35581         "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",
35582         "type": "json"
35583       }
35584     ],
35585     "name": "updateMessages",
35586     "group": "Whatsapp_Messages",
35587     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35588     "version": "0.0.0",
35589     "filename": "server/api/whatsappMessage/index.js",
35590     "groupTitle": "Whatsapp_Messages"
35591   },
35592   {
35593     "type": "post",
35594     "url": "/api/whatsapp/reports/queue",
35595     "title": "Creates a new Whatsapp Queue Report",
35596     "examples": [
35597       {
35598         "title": "Example usage:",
35599         "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",
35600         "type": "json"
35601       }
35602     ],
35603     "name": "CreateWhatsapp_Queue_Reports",
35604     "group": "Whatsapp_Queue_Reports",
35605     "parameter": {
35606       "fields": {
35607         "Body": [
35608           {
35609             "group": "Body",
35610             "type": "String",
35611             "optional": false,
35612             "field": "uniqueid",
35613             "description": ""
35614           },
35615           {
35616             "group": "Body",
35617             "type": "String",
35618             "optional": true,
35619             "field": "from",
35620             "description": ""
35621           },
35622           {
35623             "group": "Body",
35624             "type": "String",
35625             "optional": true,
35626             "field": "joinAt",
35627             "description": ""
35628           },
35629           {
35630             "group": "Body",
35631             "type": "String",
35632             "optional": true,
35633             "field": "leaveAt",
35634             "description": ""
35635           },
35636           {
35637             "group": "Body",
35638             "type": "String",
35639             "optional": true,
35640             "field": "acceptAt",
35641             "description": ""
35642           },
35643           {
35644             "group": "Body",
35645             "type": "String",
35646             "optional": true,
35647             "field": "exitAt",
35648             "description": ""
35649           },
35650           {
35651             "group": "Body",
35652             "type": "String",
35653             "optional": true,
35654             "field": "reason",
35655             "description": ""
35656           }
35657         ]
35658       }
35659     },
35660     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35661     "version": "0.0.0",
35662     "filename": "server/api/whatsappQueueReport/index.js",
35663     "groupTitle": "Whatsapp_Queue_Reports"
35664   },
35665   {
35666     "type": "delete",
35667     "url": "/api/whatsapp/reports/queue/{id}",
35668     "title": "Deletes a Whatsapp Queue Report",
35669     "examples": [
35670       {
35671         "title": "Example usage:",
35672         "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password} -X DELETE",
35673         "type": "json"
35674       }
35675     ],
35676     "name": "DeleteWhatsapp_Queue_Reports",
35677     "group": "Whatsapp_Queue_Reports",
35678     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35679     "version": "0.0.0",
35680     "filename": "server/api/whatsappQueueReport/index.js",
35681     "groupTitle": "Whatsapp_Queue_Reports"
35682   },
35683   {
35684     "type": "get",
35685     "url": "/api/whatsapp/reports/queue/describe",
35686     "title": "Gets table info about Whatsapp Queue Reports",
35687     "examples": [
35688       {
35689         "title": "Example usage:",
35690         "content": "curl https://{domain}/api/whatsapp/reports/queue/describe -v -u {name}:{password}",
35691         "type": "json"
35692       }
35693     ],
35694     "name": "DescribeWhatsapp_Queue_Reports",
35695     "group": "Whatsapp_Queue_Reports",
35696     "description": "<p>Motion will return a HTTP status code <code>200</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": "get",
35703     "url": "/api/whatsapp/reports/queue",
35704     "title": "Gets a list of Whatsapp Queue Reports",
35705     "examples": [
35706       {
35707         "title": "Example usage:",
35708         "content": "curl https://{domain}/api/whatsapp/reports/queue -v -u {name}:{password}",
35709         "type": "json"
35710       }
35711     ],
35712     "name": "GetWhatsapp_Queue_Reports",
35713     "group": "Whatsapp_Queue_Reports",
35714     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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/{id}",
35722     "title": "Gets a single Whatsapp Queue Report",
35723     "examples": [
35724       {
35725         "title": "Example usage:",
35726         "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password}",
35727         "type": "json"
35728       }
35729     ],
35730     "name": "ShowWhatsapp_Queue_Reports",
35731     "group": "Whatsapp_Queue_Reports",
35732     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "put",
35739     "url": "/api/whatsapp/reports/queue/{id}",
35740     "title": "Update an existing Whatsapp Queue Report",
35741     "examples": [
35742       {
35743         "title": "Example usage:",
35744         "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",
35745         "type": "json"
35746       }
35747     ],
35748     "name": "updateWhatsapp_Queue_Reports",
35749     "group": "Whatsapp_Queue_Reports",
35750     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35751     "version": "0.0.0",
35752     "filename": "server/api/whatsappQueueReport/index.js",
35753     "groupTitle": "Whatsapp_Queue_Reports"
35754   },
35755   {
35756     "type": "post",
35757     "url": "/api/whatsapp/queues/{id}/users",
35758     "title": "Add agents to a queue",
35759     "examples": [
35760       {
35761         "title": "Example usage:",
35762         "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",
35763         "type": "json"
35764       }
35765     ],
35766     "name": "AddAgents",
35767     "group": "Whatsapp_Queues",
35768     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35769     "version": "0.0.0",
35770     "filename": "server/api/whatsappQueue/index.js",
35771     "groupTitle": "Whatsapp_Queues"
35772   },
35773   {
35774     "type": "post",
35775     "url": "/api/whatsapp/queues/{id}/teams",
35776     "title": "Add teams to a queue",
35777     "examples": [
35778       {
35779         "title": "Example usage:",
35780         "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",
35781         "type": "json"
35782       }
35783     ],
35784     "name": "AddTeams",
35785     "group": "Whatsapp_Queues",
35786     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35787     "version": "0.0.0",
35788     "filename": "server/api/whatsappQueue/index.js",
35789     "groupTitle": "Whatsapp_Queues"
35790   },
35791   {
35792     "type": "post",
35793     "url": "/api/whatsapp/queues",
35794     "title": "Creates a new Queue",
35795     "examples": [
35796       {
35797         "title": "Example usage:",
35798         "content": "curl https://{domain}/api/whatsapp/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35799         "type": "json"
35800       }
35801     ],
35802     "name": "CreateQueues",
35803     "group": "Whatsapp_Queues",
35804     "parameter": {
35805       "fields": {
35806         "Body": [
35807           {
35808             "group": "Body",
35809             "type": "String",
35810             "optional": true,
35811             "field": "name",
35812             "description": ""
35813           },
35814           {
35815             "group": "Body",
35816             "type": "Integer",
35817             "optional": true,
35818             "field": "timeout",
35819             "description": ""
35820           },
35821           {
35822             "group": "Body",
35823             "type": "String",
35824             "allowedValues": [
35825               "\"rrmemory\"",
35826               "\"beepall\"",
35827               "\"roundrobin\""
35828             ],
35829             "optional": true,
35830             "field": "strategy",
35831             "description": ""
35832           },
35833           {
35834             "group": "Body",
35835             "type": "String",
35836             "optional": true,
35837             "field": "description",
35838             "description": ""
35839           }
35840         ]
35841       }
35842     },
35843     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35844     "version": "0.0.0",
35845     "filename": "server/api/whatsappQueue/index.js",
35846     "groupTitle": "Whatsapp_Queues"
35847   },
35848   {
35849     "type": "delete",
35850     "url": "/api/whatsapp/queues/{id}",
35851     "title": "Deletes a Queue",
35852     "examples": [
35853       {
35854         "title": "Example usage:",
35855         "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password} -X DELETE",
35856         "type": "json"
35857       }
35858     ],
35859     "name": "DeleteQueues",
35860     "group": "Whatsapp_Queues",
35861     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35862     "version": "0.0.0",
35863     "filename": "server/api/whatsappQueue/index.js",
35864     "groupTitle": "Whatsapp_Queues"
35865   },
35866   {
35867     "type": "get",
35868     "url": "/api/whatsapp/queues/describe",
35869     "title": "Gets table info about Queues",
35870     "examples": [
35871       {
35872         "title": "Example usage:",
35873         "content": "curl https://{domain}/api/whatsapp/queues/describe -v -u {name}:{password}",
35874         "type": "json"
35875       }
35876     ],
35877     "name": "DescribeQueues",
35878     "group": "Whatsapp_Queues",
35879     "description": "<p>Motion will return a HTTP status code <code>200</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": "get",
35886     "url": "/api/whatsapp/queues/{id}/users",
35887     "title": "Gets queue agents",
35888     "examples": [
35889       {
35890         "title": "Example usage:",
35891         "content": "curl https://{domain}/api/whatsapp/queues/{id}/users -v -u {name}:{password} -X POST",
35892         "type": "json"
35893       }
35894     ],
35895     "name": "GetAgents",
35896     "group": "Whatsapp_Queues",
35897     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/{id}/members",
35905     "title": "GetMembers",
35906     "examples": [
35907       {
35908         "title": "Example usage:",
35909         "content": "curl https://{domain}/api/whatsapp/queues/{id}/members  -v -u {name}:{password}",
35910         "type": "json"
35911       }
35912     ],
35913     "name": "GetMembers",
35914     "group": "Whatsapp_Queues",
35915     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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",
35923     "title": "Gets a list of Queues",
35924     "examples": [
35925       {
35926         "title": "Example usage:",
35927         "content": "curl https://{domain}/api/whatsapp/queues -v -u {name}:{password}",
35928         "type": "json"
35929       }
35930     ],
35931     "name": "GetQueues",
35932     "group": "Whatsapp_Queues",
35933     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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}/teams",
35941     "title": "Gets queues list",
35942     "examples": [
35943       {
35944         "title": "Example usage:",
35945         "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password}",
35946         "type": "json"
35947       }
35948     ],
35949     "name": "GetTeams",
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": "delete",
35958     "url": "/api/whatsapp/queues/{id}/users",
35959     "title": "Removes agents from a queue",
35960     "examples": [
35961       {
35962         "title": "Example usage:",
35963         "content": "curl https://{domain}/api/whatsapp/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
35964         "type": "json"
35965       }
35966     ],
35967     "name": "RemoveAgents",
35968     "group": "Whatsapp_Queues",
35969     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</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}",
35977     "title": "Gets a single Queue",
35978     "examples": [
35979       {
35980         "title": "Example usage:",
35981         "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password}",
35982         "type": "json"
35983       }
35984     ],
35985     "name": "ShowQueues",
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": "put",
35994     "url": "/api/whatsapp/queues/{id}",
35995     "title": "Update an existing Queue",
35996     "examples": [
35997       {
35998         "title": "Example usage:",
35999         "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",
36000         "type": "json"
36001       }
36002     ],
36003     "name": "updateQueues",
36004     "group": "Whatsapp_Queues",
36005     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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": "post",
36012     "url": "/api/whatsapp/reports/transfer",
36013     "title": "Creates a new Whatsapp Transfer Report",
36014     "examples": [
36015       {
36016         "title": "Example usage:",
36017         "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",
36018         "type": "json"
36019       }
36020     ],
36021     "name": "CreateWhatsapp_Transfer_Reports",
36022     "group": "Whatsapp_Transfer_Reports",
36023     "parameter": {
36024       "fields": {
36025         "Body": [
36026           {
36027             "group": "Body",
36028             "type": "String",
36029             "optional": false,
36030             "field": "uniqueid",
36031             "description": ""
36032           },
36033           {
36034             "group": "Body",
36035             "type": "String",
36036             "allowedValues": [
36037               "\"account\"",
36038               "\"agent\"",
36039               "\"queue\""
36040             ],
36041             "optional": false,
36042             "field": "type",
36043             "description": ""
36044           },
36045           {
36046             "group": "Body",
36047             "type": "String",
36048             "optional": true,
36049             "field": "transferredAt",
36050             "description": ""
36051           }
36052         ]
36053       }
36054     },
36055     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36056     "version": "0.0.0",
36057     "filename": "server/api/whatsappTransferReport/index.js",
36058     "groupTitle": "Whatsapp_Transfer_Reports"
36059   },
36060   {
36061     "type": "delete",
36062     "url": "/api/whatsapp/reports/transfer/{id}",
36063     "title": "Deletes a Whatsapp Transfer Report",
36064     "examples": [
36065       {
36066         "title": "Example usage:",
36067         "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
36068         "type": "json"
36069       }
36070     ],
36071     "name": "DeleteWhatsapp_Transfer_Reports",
36072     "group": "Whatsapp_Transfer_Reports",
36073     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36074     "version": "0.0.0",
36075     "filename": "server/api/whatsappTransferReport/index.js",
36076     "groupTitle": "Whatsapp_Transfer_Reports"
36077   },
36078   {
36079     "type": "get",
36080     "url": "/api/whatsapp/reports/transfer/describe",
36081     "title": "Gets table info about Whatsapp Transfer Reports",
36082     "examples": [
36083       {
36084         "title": "Example usage:",
36085         "content": "curl https://{domain}/api/whatsapp/reports/transfer/describe -v -u {name}:{password}",
36086         "type": "json"
36087       }
36088     ],
36089     "name": "DescribeWhatsapp_Transfer_Reports",
36090     "group": "Whatsapp_Transfer_Reports",
36091     "description": "<p>Motion will return a HTTP status code <code>200</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": "get",
36098     "url": "/api/whatsapp/reports/transfer",
36099     "title": "Gets a list of Whatsapp Transfer Reports",
36100     "examples": [
36101       {
36102         "title": "Example usage:",
36103         "content": "curl https://{domain}/api/whatsapp/reports/transfer -v -u {name}:{password}",
36104         "type": "json"
36105       }
36106     ],
36107     "name": "GetWhatsapp_Transfer_Reports",
36108     "group": "Whatsapp_Transfer_Reports",
36109     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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/{id}",
36117     "title": "Gets a single Whatsapp Transfer Report",
36118     "examples": [
36119       {
36120         "title": "Example usage:",
36121         "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password}",
36122         "type": "json"
36123       }
36124     ],
36125     "name": "ShowWhatsapp_Transfer_Reports",
36126     "group": "Whatsapp_Transfer_Reports",
36127     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36128     "version": "0.0.0",
36129     "filename": "server/api/whatsappTransferReport/index.js",
36130     "groupTitle": "Whatsapp_Transfer_Reports"
36131   },
36132   {
36133     "type": "put",
36134     "url": "/api/whatsapp/reports/transfer/{id}",
36135     "title": "Update an existing Whatsapp Transfer Report",
36136     "examples": [
36137       {
36138         "title": "Example usage:",
36139         "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",
36140         "type": "json"
36141       }
36142     ],
36143     "name": "updateWhatsapp_Transfer_Reports",
36144     "group": "Whatsapp_Transfer_Reports",
36145     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36146     "version": "0.0.0",
36147     "filename": "server/api/whatsappTransferReport/index.js",
36148     "groupTitle": "Whatsapp_Transfer_Reports"
36149   },
36150   {
36151     "type": "post",
36152     "url": "/api/integrations/zendesk/accounts",
36153     "title": "Creates a new Zendesk Account",
36154     "examples": [
36155       {
36156         "title": "Example usage:",
36157         "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",
36158         "type": "json"
36159       }
36160     ],
36161     "name": "CreateZendesk_Accounts",
36162     "group": "Zendesk_Accounts",
36163     "parameter": {
36164       "fields": {
36165         "Body": [
36166           {
36167             "group": "Body",
36168             "type": "String",
36169             "optional": true,
36170             "field": "name",
36171             "description": ""
36172           },
36173           {
36174             "group": "Body",
36175             "type": "String",
36176             "optional": true,
36177             "field": "description",
36178             "description": ""
36179           },
36180           {
36181             "group": "Body",
36182             "type": "String",
36183             "optional": true,
36184             "field": "username",
36185             "description": ""
36186           },
36187           {
36188             "group": "Body",
36189             "type": "String",
36190             "optional": true,
36191             "field": "password",
36192             "description": ""
36193           },
36194           {
36195             "group": "Body",
36196             "type": "String",
36197             "optional": true,
36198             "field": "token",
36199             "description": ""
36200           },
36201           {
36202             "group": "Body",
36203             "type": "String",
36204             "optional": true,
36205             "field": "remoteUri",
36206             "description": ""
36207           },
36208           {
36209             "group": "Body",
36210             "type": "String",
36211             "allowedValues": [
36212               "\"password\"",
36213               "\"token\""
36214             ],
36215             "optional": true,
36216             "field": "authType",
36217             "description": ""
36218           },
36219           {
36220             "group": "Body",
36221             "type": "String",
36222             "optional": false,
36223             "field": "serverUrl",
36224             "description": ""
36225           },
36226           {
36227             "group": "Body",
36228             "type": "String",
36229             "allowedValues": [
36230               "\"integrationTab\"",
36231               "\"newTab\""
36232             ],
36233             "optional": true,
36234             "field": "type",
36235             "description": ""
36236           }
36237         ]
36238       }
36239     },
36240     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36241     "version": "0.0.0",
36242     "filename": "server/api/intZendeskAccount/index.js",
36243     "groupTitle": "Zendesk_Accounts"
36244   },
36245   {
36246     "type": "delete",
36247     "url": "/api/integrations/zendesk/accounts/{id}",
36248     "title": "Deletes a Zendesk Account",
36249     "examples": [
36250       {
36251         "title": "Example usage:",
36252         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password} -X DELETE",
36253         "type": "json"
36254       }
36255     ],
36256     "name": "DeleteZendesk_Accounts",
36257     "group": "Zendesk_Accounts",
36258     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36259     "version": "0.0.0",
36260     "filename": "server/api/intZendeskAccount/index.js",
36261     "groupTitle": "Zendesk_Accounts"
36262   },
36263   {
36264     "type": "get",
36265     "url": "/api/integrations/zendesk/accounts",
36266     "title": "Gets a list of Zendesk Accounts",
36267     "examples": [
36268       {
36269         "title": "Example usage:",
36270         "content": "curl https://{domain}/api/integrations/zendesk/accounts -v -u {name}:{password}",
36271         "type": "json"
36272       }
36273     ],
36274     "name": "GetZendesk_Accounts",
36275     "group": "Zendesk_Accounts",
36276     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36277     "version": "0.0.0",
36278     "filename": "server/api/intZendeskAccount/index.js",
36279     "groupTitle": "Zendesk_Accounts"
36280   },
36281   {
36282     "type": "get",
36283     "url": "/api/integrations/zendesk/accounts/{id}",
36284     "title": "Gets a single Zendesk Account",
36285     "examples": [
36286       {
36287         "title": "Example usage:",
36288         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password}",
36289         "type": "json"
36290       }
36291     ],
36292     "name": "ShowZendesk_Accounts",
36293     "group": "Zendesk_Accounts",
36294     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36295     "version": "0.0.0",
36296     "filename": "server/api/intZendeskAccount/index.js",
36297     "groupTitle": "Zendesk_Accounts"
36298   },
36299   {
36300     "type": "post",
36301     "url": "/api/integrations/zendesk/accounts/{id}/configurations",
36302     "title": "Creates new configuration",
36303     "examples": [
36304       {
36305         "title": "Example usage:",
36306         "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",
36307         "type": "json"
36308       }
36309     ],
36310     "name": "addConfiguration",
36311     "group": "Zendesk_Accounts",
36312     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</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}/configurations",
36320     "title": "Gets account configurations",
36321     "examples": [
36322       {
36323         "title": "Example usage:",
36324         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
36325         "type": "json"
36326       }
36327     ],
36328     "name": "getConfigurations",
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": "get",
36337     "url": "/api/integrations/zendesk/accounts/{id}/fields",
36338     "title": "Gets account fields",
36339     "examples": [
36340       {
36341         "title": "Example usage:",
36342         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
36343         "type": "json"
36344       }
36345     ],
36346     "name": "getFields",
36347     "group": "Zendesk_Accounts",
36348     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "put",
36355     "url": "/api/integrations/zendesk/accounts/{id}",
36356     "title": "Update an existing Zendesk Account",
36357     "examples": [
36358       {
36359         "title": "Example usage:",
36360         "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",
36361         "type": "json"
36362       }
36363     ],
36364     "name": "updateZendesk_Accounts",
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": "post",
36373     "url": "/api/integrations/zendesk/configurations",
36374     "title": "Creates a new Zendesk Configuration",
36375     "examples": [
36376       {
36377         "title": "Example usage:",
36378         "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",
36379         "type": "json"
36380       }
36381     ],
36382     "name": "CreateZendesk_Configurations",
36383     "group": "Zendesk_Configurations",
36384     "parameter": {
36385       "fields": {
36386         "Body": [
36387           {
36388             "group": "Body",
36389             "type": "String",
36390             "optional": true,
36391             "field": "name",
36392             "description": ""
36393           },
36394           {
36395             "group": "Body",
36396             "type": "String",
36397             "optional": true,
36398             "field": "description",
36399             "description": ""
36400           }
36401         ]
36402       }
36403     },
36404     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36405     "version": "0.0.0",
36406     "filename": "server/api/intZendeskConfiguration/index.js",
36407     "groupTitle": "Zendesk_Configurations"
36408   },
36409   {
36410     "type": "delete",
36411     "url": "/api/integrations/zendesk/configurations/{id}",
36412     "title": "Deletes a Zendesk Configuration",
36413     "examples": [
36414       {
36415         "title": "Example usage:",
36416         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password} -X DELETE",
36417         "type": "json"
36418       }
36419     ],
36420     "name": "DeleteZendesk_Configurations",
36421     "group": "Zendesk_Configurations",
36422     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36423     "version": "0.0.0",
36424     "filename": "server/api/intZendeskConfiguration/index.js",
36425     "groupTitle": "Zendesk_Configurations"
36426   },
36427   {
36428     "type": "get",
36429     "url": "/api/integrations/zendesk/configurations",
36430     "title": "Gets a list of Zendesk Configurations",
36431     "examples": [
36432       {
36433         "title": "Example usage:",
36434         "content": "curl https://{domain}/api/integrations/zendesk/configurations -v -u {name}:{password}",
36435         "type": "json"
36436       }
36437     ],
36438     "name": "GetZendesk_Configurations",
36439     "group": "Zendesk_Configurations",
36440     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36441     "version": "0.0.0",
36442     "filename": "server/api/intZendeskConfiguration/index.js",
36443     "groupTitle": "Zendesk_Configurations"
36444   },
36445   {
36446     "type": "get",
36447     "url": "/api/integrations/zendesk/configurations/{id}",
36448     "title": "Gets a single Zendesk Configuration",
36449     "examples": [
36450       {
36451         "title": "Example usage:",
36452         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password}",
36453         "type": "json"
36454       }
36455     ],
36456     "name": "ShowZendesk_Configurations",
36457     "group": "Zendesk_Configurations",
36458     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/{id}/descriptions",
36466     "title": "Gets configurations descriptions",
36467     "examples": [
36468       {
36469         "title": "Example usage:",
36470         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
36471         "type": "json"
36472       }
36473     ],
36474     "name": "getDescriptions",
36475     "group": "Zendesk_Configurations",
36476     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</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}/fields",
36484     "title": "Gets configurations fields",
36485     "examples": [
36486       {
36487         "title": "Example usage:",
36488         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
36489         "type": "json"
36490       }
36491     ],
36492     "name": "getFields",
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}/subjects",
36502     "title": "Gets configurations subjects",
36503     "examples": [
36504       {
36505         "title": "Example usage:",
36506         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
36507         "type": "json"
36508       }
36509     ],
36510     "name": "getSubjects",
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}/tags",
36520     "title": "Gets configurations tags",
36521     "examples": [
36522       {
36523         "title": "Example usage:",
36524         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
36525         "type": "json"
36526       }
36527     ],
36528     "name": "getTags",
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": "post",
36537     "url": "/api/integrations/zendesk/configurations/{id}/tags",
36538     "title": "Sets new tags",
36539     "examples": [
36540       {
36541         "title": "Example usage:",
36542         "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",
36543         "type": "json"
36544       }
36545     ],
36546     "name": "setTags",
36547     "group": "Zendesk_Configurations",
36548     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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": "put",
36555     "url": "/api/integrations/zendesk/configurations/{id}",
36556     "title": "Update an existing Zendesk Configuration",
36557     "examples": [
36558       {
36559         "title": "Example usage:",
36560         "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",
36561         "type": "json"
36562       }
36563     ],
36564     "name": "updateZendesk_Configurations",
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/fields",
36574     "title": "Creates a new Zendesk Field",
36575     "examples": [
36576       {
36577         "title": "Example usage:",
36578         "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",
36579         "type": "json"
36580       }
36581     ],
36582     "name": "CreateZendesk_Fields",
36583     "group": "Zendesk_Fields",
36584     "parameter": {
36585       "fields": {
36586         "Body": [
36587           {
36588             "group": "Body",
36589             "type": "String",
36590             "allowedValues": [
36591               "\"string\"",
36592               "\"variable\"",
36593               "\"customVariable\"",
36594               "\"keyValue\""
36595             ],
36596             "optional": true,
36597             "field": "type",
36598             "description": ""
36599           },
36600           {
36601             "group": "Body",
36602             "type": "String",
36603             "optional": true,
36604             "field": "content",
36605             "description": ""
36606           },
36607           {
36608             "group": "Body",
36609             "type": "String",
36610             "optional": true,
36611             "field": "key",
36612             "description": ""
36613           },
36614           {
36615             "group": "Body",
36616             "type": "String",
36617             "allowedValues": [
36618               "\"string\"",
36619               "\"variable\"",
36620               "\"customVariable\""
36621             ],
36622             "optional": true,
36623             "field": "keyType",
36624             "description": ""
36625           },
36626           {
36627             "group": "Body",
36628             "type": "String",
36629             "optional": true,
36630             "field": "keyContent",
36631             "description": ""
36632           },
36633           {
36634             "group": "Body",
36635             "type": "String",
36636             "optional": true,
36637             "field": "idField",
36638             "description": ""
36639           },
36640           {
36641             "group": "Body",
36642             "type": "String",
36643             "optional": true,
36644             "field": "nameField",
36645             "description": ""
36646           },
36647           {
36648             "group": "Body",
36649             "type": "Boolean",
36650             "optional": true,
36651             "field": "customField",
36652             "description": ""
36653           },
36654           {
36655             "group": "Body",
36656             "type": "String",
36657             "optional": true,
36658             "field": "variableName",
36659             "description": ""
36660           }
36661         ]
36662       }
36663     },
36664     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36665     "version": "0.0.0",
36666     "filename": "server/api/intZendeskField/index.js",
36667     "groupTitle": "Zendesk_Fields"
36668   },
36669   {
36670     "type": "delete",
36671     "url": "/api/integrations/zendesk/fields/{id}",
36672     "title": "Deletes a Zendesk Field",
36673     "examples": [
36674       {
36675         "title": "Example usage:",
36676         "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password} -X DELETE",
36677         "type": "json"
36678       }
36679     ],
36680     "name": "DeleteZendesk_Fields",
36681     "group": "Zendesk_Fields",
36682     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36683     "version": "0.0.0",
36684     "filename": "server/api/intZendeskField/index.js",
36685     "groupTitle": "Zendesk_Fields"
36686   },
36687   {
36688     "type": "get",
36689     "url": "/api/integrations/zendesk/fields",
36690     "title": "Gets a list of Zendesk Fields",
36691     "examples": [
36692       {
36693         "title": "Example usage:",
36694         "content": "curl https://{domain}/api/integrations/zendesk/fields -v -u {name}:{password}",
36695         "type": "json"
36696       }
36697     ],
36698     "name": "GetZendesk_Fields",
36699     "group": "Zendesk_Fields",
36700     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36701     "version": "0.0.0",
36702     "filename": "server/api/intZendeskField/index.js",
36703     "groupTitle": "Zendesk_Fields"
36704   },
36705   {
36706     "type": "get",
36707     "url": "/api/integrations/zendesk/fields/{id}",
36708     "title": "Gets a single Zendesk Field",
36709     "examples": [
36710       {
36711         "title": "Example usage:",
36712         "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password}",
36713         "type": "json"
36714       }
36715     ],
36716     "name": "ShowZendesk_Fields",
36717     "group": "Zendesk_Fields",
36718     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36719     "version": "0.0.0",
36720     "filename": "server/api/intZendeskField/index.js",
36721     "groupTitle": "Zendesk_Fields"
36722   },
36723   {
36724     "type": "put",
36725     "url": "/api/integrations/zendesk/fields/{id}",
36726     "title": "Update an existing Zendesk Field",
36727     "examples": [
36728       {
36729         "title": "Example usage:",
36730         "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",
36731         "type": "json"
36732       }
36733     ],
36734     "name": "updateZendesk_Fields",
36735     "group": "Zendesk_Fields",
36736     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36737     "version": "0.0.0",
36738     "filename": "server/api/intZendeskField/index.js",
36739     "groupTitle": "Zendesk_Fields"
36740   },
36741   {
36742     "type": "post",
36743     "url": "/api/integrations/zoho/accounts",
36744     "title": "Creates a new Zoho Account",
36745     "examples": [
36746       {
36747         "title": "Example usage:",
36748         "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",
36749         "type": "json"
36750       }
36751     ],
36752     "name": "CreateZoho_Accounts",
36753     "group": "Zoho_Accounts",
36754     "parameter": {
36755       "fields": {
36756         "Body": [
36757           {
36758             "group": "Body",
36759             "type": "String",
36760             "optional": true,
36761             "field": "name",
36762             "description": ""
36763           },
36764           {
36765             "group": "Body",
36766             "type": "String",
36767             "optional": true,
36768             "field": "description",
36769             "description": ""
36770           },
36771           {
36772             "group": "Body",
36773             "type": "String",
36774             "optional": true,
36775             "field": "host",
36776             "description": ""
36777           },
36778           {
36779             "group": "Body",
36780             "type": "String",
36781             "optional": true,
36782             "field": "zone",
36783             "description": ""
36784           },
36785           {
36786             "group": "Body",
36787             "type": "String",
36788             "optional": true,
36789             "field": "clientId",
36790             "description": ""
36791           },
36792           {
36793             "group": "Body",
36794             "type": "String",
36795             "optional": true,
36796             "field": "clientSecret",
36797             "description": ""
36798           },
36799           {
36800             "group": "Body",
36801             "type": "String",
36802             "optional": false,
36803             "field": "serverUrl",
36804             "description": ""
36805           },
36806           {
36807             "group": "Body",
36808             "type": "String",
36809             "optional": true,
36810             "field": "code",
36811             "description": ""
36812           },
36813           {
36814             "group": "Body",
36815             "type": "String",
36816             "optional": true,
36817             "field": "refreshToken",
36818             "description": ""
36819           }
36820         ]
36821       }
36822     },
36823     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36824     "version": "0.0.0",
36825     "filename": "server/api/intZohoAccount/index.js",
36826     "groupTitle": "Zoho_Accounts"
36827   },
36828   {
36829     "type": "delete",
36830     "url": "/api/integrations/zoho/accounts/{id}",
36831     "title": "Deletes a Zoho Account",
36832     "examples": [
36833       {
36834         "title": "Example usage:",
36835         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password} -X DELETE",
36836         "type": "json"
36837       }
36838     ],
36839     "name": "DeleteZoho_Accounts",
36840     "group": "Zoho_Accounts",
36841     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36842     "version": "0.0.0",
36843     "filename": "server/api/intZohoAccount/index.js",
36844     "groupTitle": "Zoho_Accounts"
36845   },
36846   {
36847     "type": "get",
36848     "url": "/api/integrations/zoho/accounts",
36849     "title": "Gets a list of Zoho Accounts",
36850     "examples": [
36851       {
36852         "title": "Example usage:",
36853         "content": "curl https://{domain}/api/integrations/zoho/accounts -v -u {name}:{password}",
36854         "type": "json"
36855       }
36856     ],
36857     "name": "GetZoho_Accounts",
36858     "group": "Zoho_Accounts",
36859     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36860     "version": "0.0.0",
36861     "filename": "server/api/intZohoAccount/index.js",
36862     "groupTitle": "Zoho_Accounts"
36863   },
36864   {
36865     "type": "get",
36866     "url": "/api/integrations/zoho/accounts/{id}",
36867     "title": "Gets a single Zoho Account",
36868     "examples": [
36869       {
36870         "title": "Example usage:",
36871         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password}",
36872         "type": "json"
36873       }
36874     ],
36875     "name": "ShowZoho_Accounts",
36876     "group": "Zoho_Accounts",
36877     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36878     "version": "0.0.0",
36879     "filename": "server/api/intZohoAccount/index.js",
36880     "groupTitle": "Zoho_Accounts"
36881   },
36882   {
36883     "type": "post",
36884     "url": "/api/integrations/zoho/accounts/{id}/configurations",
36885     "title": "Creates new configuration",
36886     "examples": [
36887       {
36888         "title": "Example usage:",
36889         "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",
36890         "type": "json"
36891       }
36892     ],
36893     "name": "addConfiguration",
36894     "group": "Zoho_Accounts",
36895     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36896     "version": "0.0.0",
36897     "filename": "server/api/intZohoAccount/index.js",
36898     "groupTitle": "Zoho_Accounts"
36899   },
36900   {
36901     "type": "get",
36902     "url": "/api/integrations/zoho/accounts/{id}/configurations",
36903     "title": "Gets account configurations",
36904     "examples": [
36905       {
36906         "title": "Example usage:",
36907         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/configurations -v -u {name}:{password} -X GET",
36908         "type": "json"
36909       }
36910     ],
36911     "name": "getConfigurations",
36912     "group": "Zoho_Accounts",
36913     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36914     "version": "0.0.0",
36915     "filename": "server/api/intZohoAccount/index.js",
36916     "groupTitle": "Zoho_Accounts"
36917   },
36918   {
36919     "type": "get",
36920     "url": "/api/integrations/zoho/accounts/{id}/fields",
36921     "title": "Gets account fields",
36922     "examples": [
36923       {
36924         "title": "Example usage:",
36925         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/fields -v -u {name}:{password} -X GET",
36926         "type": "json"
36927       }
36928     ],
36929     "name": "getFields",
36930     "group": "Zoho_Accounts",
36931     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36932     "version": "0.0.0",
36933     "filename": "server/api/intZohoAccount/index.js",
36934     "groupTitle": "Zoho_Accounts"
36935   },
36936   {
36937     "type": "put",
36938     "url": "/api/integrations/zoho/accounts/{id}",
36939     "title": "Update an existing Zoho Account",
36940     "examples": [
36941       {
36942         "title": "Example usage:",
36943         "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",
36944         "type": "json"
36945       }
36946     ],
36947     "name": "updateZoho_Accounts",
36948     "group": "Zoho_Accounts",
36949     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36950     "version": "0.0.0",
36951     "filename": "server/api/intZohoAccount/index.js",
36952     "groupTitle": "Zoho_Accounts"
36953   },
36954   {
36955     "type": "post",
36956     "url": "/api/integrations/zoho/configurations",
36957     "title": "Creates a new Zoho Configuration",
36958     "examples": [
36959       {
36960         "title": "Example usage:",
36961         "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",
36962         "type": "json"
36963       }
36964     ],
36965     "name": "CreateZoho_Configurations",
36966     "group": "Zoho_Configurations",
36967     "parameter": {
36968       "fields": {
36969         "Body": [
36970           {
36971             "group": "Body",
36972             "type": "String",
36973             "optional": true,
36974             "field": "name",
36975             "description": ""
36976           },
36977           {
36978             "group": "Body",
36979             "type": "String",
36980             "allowedValues": [
36981               "\"lead\"",
36982               "\"contact\"",
36983               "\"nothing\""
36984             ],
36985             "optional": true,
36986             "field": "moduleCreate",
36987             "description": ""
36988           },
36989           {
36990             "group": "Body",
36991             "type": "String",
36992             "allowedValues": [
36993               "\"contact_lead\"",
36994               "\"contact\"",
36995               "\"lead\""
36996             ],
36997             "optional": true,
36998             "field": "moduleSearch",
36999             "description": ""
37000           },
37001           {
37002             "group": "Body",
37003             "type": "String",
37004             "optional": true,
37005             "field": "description",
37006             "description": ""
37007           }
37008         ]
37009       }
37010     },
37011     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37012     "version": "0.0.0",
37013     "filename": "server/api/intZohoConfiguration/index.js",
37014     "groupTitle": "Zoho_Configurations"
37015   },
37016   {
37017     "type": "delete",
37018     "url": "/api/integrations/zoho/configurations/{id}",
37019     "title": "Deletes a Zoho Configuration",
37020     "examples": [
37021       {
37022         "title": "Example usage:",
37023         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password} -X DELETE",
37024         "type": "json"
37025       }
37026     ],
37027     "name": "DeleteZoho_Configurations",
37028     "group": "Zoho_Configurations",
37029     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37030     "version": "0.0.0",
37031     "filename": "server/api/intZohoConfiguration/index.js",
37032     "groupTitle": "Zoho_Configurations"
37033   },
37034   {
37035     "type": "get",
37036     "url": "/api/integrations/zoho/configurations",
37037     "title": "Gets a list of Zoho Configurations",
37038     "examples": [
37039       {
37040         "title": "Example usage:",
37041         "content": "curl https://{domain}/api/integrations/zoho/configurations -v -u {name}:{password}",
37042         "type": "json"
37043       }
37044     ],
37045     "name": "GetZoho_Configurations",
37046     "group": "Zoho_Configurations",
37047     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37048     "version": "0.0.0",
37049     "filename": "server/api/intZohoConfiguration/index.js",
37050     "groupTitle": "Zoho_Configurations"
37051   },
37052   {
37053     "type": "get",
37054     "url": "/api/integrations/zoho/configurations/{id}",
37055     "title": "Gets a single Zoho Configuration",
37056     "examples": [
37057       {
37058         "title": "Example usage:",
37059         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password}",
37060         "type": "json"
37061       }
37062     ],
37063     "name": "ShowZoho_Configurations",
37064     "group": "Zoho_Configurations",
37065     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37066     "version": "0.0.0",
37067     "filename": "server/api/intZohoConfiguration/index.js",
37068     "groupTitle": "Zoho_Configurations"
37069   },
37070   {
37071     "type": "get",
37072     "url": "/api/integrations/zoho/configurations/{id}/descriptions",
37073     "title": "Gets configurations descriptions",
37074     "examples": [
37075       {
37076         "title": "Example usage:",
37077         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
37078         "type": "json"
37079       }
37080     ],
37081     "name": "getDescriptions",
37082     "group": "Zoho_Configurations",
37083     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37084     "version": "0.0.0",
37085     "filename": "server/api/intZohoConfiguration/index.js",
37086     "groupTitle": "Zoho_Configurations"
37087   },
37088   {
37089     "type": "get",
37090     "url": "/api/integrations/zoho/configurations/{id}/fields",
37091     "title": "Gets configurations fields",
37092     "examples": [
37093       {
37094         "title": "Example usage:",
37095         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
37096         "type": "json"
37097       }
37098     ],
37099     "name": "getFields",
37100     "group": "Zoho_Configurations",
37101     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37102     "version": "0.0.0",
37103     "filename": "server/api/intZohoConfiguration/index.js",
37104     "groupTitle": "Zoho_Configurations"
37105   },
37106   {
37107     "type": "get",
37108     "url": "/api/integrations/zoho/configurations/{id}/subjects",
37109     "title": "Gets configurations subjects",
37110     "examples": [
37111       {
37112         "title": "Example usage:",
37113         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/subjects -v -u {name}:{password} -X GET",
37114         "type": "json"
37115       }
37116     ],
37117     "name": "getSubjects",
37118     "group": "Zoho_Configurations",
37119     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37120     "version": "0.0.0",
37121     "filename": "server/api/intZohoConfiguration/index.js",
37122     "groupTitle": "Zoho_Configurations"
37123   },
37124   {
37125     "type": "put",
37126     "url": "/api/integrations/zoho/configurations/{id}",
37127     "title": "Update an existing Zoho Configuration",
37128     "examples": [
37129       {
37130         "title": "Example usage:",
37131         "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",
37132         "type": "json"
37133       }
37134     ],
37135     "name": "updateZoho_Configurations",
37136     "group": "Zoho_Configurations",
37137     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37138     "version": "0.0.0",
37139     "filename": "server/api/intZohoConfiguration/index.js",
37140     "groupTitle": "Zoho_Configurations"
37141   },
37142   {
37143     "type": "post",
37144     "url": "/api/integrations/zoho/fields",
37145     "title": "Creates a new Zoho Field",
37146     "examples": [
37147       {
37148         "title": "Example usage:",
37149         "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",
37150         "type": "json"
37151       }
37152     ],
37153     "name": "CreateZoho_Fields",
37154     "group": "Zoho_Fields",
37155     "parameter": {
37156       "fields": {
37157         "Body": [
37158           {
37159             "group": "Body",
37160             "type": "String",
37161             "allowedValues": [
37162               "\"string\"",
37163               "\"variable\"",
37164               "\"customVariable\"",
37165               "\"keyValue\""
37166             ],
37167             "optional": true,
37168             "field": "type",
37169             "description": ""
37170           },
37171           {
37172             "group": "Body",
37173             "type": "String",
37174             "optional": true,
37175             "field": "content",
37176             "description": ""
37177           },
37178           {
37179             "group": "Body",
37180             "type": "String",
37181             "optional": true,
37182             "field": "key",
37183             "description": ""
37184           },
37185           {
37186             "group": "Body",
37187             "type": "String",
37188             "allowedValues": [
37189               "\"string\"",
37190               "\"variable\"",
37191               "\"customVariable\""
37192             ],
37193             "optional": true,
37194             "field": "keyType",
37195             "description": ""
37196           },
37197           {
37198             "group": "Body",
37199             "type": "String",
37200             "optional": true,
37201             "field": "keyContent",
37202             "description": ""
37203           },
37204           {
37205             "group": "Body",
37206             "type": "String",
37207             "optional": true,
37208             "field": "idField",
37209             "description": ""
37210           },
37211           {
37212             "group": "Body",
37213             "type": "String",
37214             "optional": true,
37215             "field": "nameField",
37216             "description": ""
37217           },
37218           {
37219             "group": "Body",
37220             "type": "Boolean",
37221             "optional": true,
37222             "field": "customField",
37223             "description": ""
37224           },
37225           {
37226             "group": "Body",
37227             "type": "String",
37228             "optional": true,
37229             "field": "variableName",
37230             "description": ""
37231           }
37232         ]
37233       }
37234     },
37235     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37236     "version": "0.0.0",
37237     "filename": "server/api/intZohoField/index.js",
37238     "groupTitle": "Zoho_Fields"
37239   },
37240   {
37241     "type": "delete",
37242     "url": "/api/integrations/zoho/fields/{id}",
37243     "title": "Deletes a Zoho Field",
37244     "examples": [
37245       {
37246         "title": "Example usage:",
37247         "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password} -X DELETE",
37248         "type": "json"
37249       }
37250     ],
37251     "name": "DeleteZoho_Fields",
37252     "group": "Zoho_Fields",
37253     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37254     "version": "0.0.0",
37255     "filename": "server/api/intZohoField/index.js",
37256     "groupTitle": "Zoho_Fields"
37257   },
37258   {
37259     "type": "get",
37260     "url": "/api/integrations/zoho/fields",
37261     "title": "Gets a list of Zoho Fields",
37262     "examples": [
37263       {
37264         "title": "Example usage:",
37265         "content": "curl https://{domain}/api/integrations/zoho/fields -v -u {name}:{password}",
37266         "type": "json"
37267       }
37268     ],
37269     "name": "GetZoho_Fields",
37270     "group": "Zoho_Fields",
37271     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37272     "version": "0.0.0",
37273     "filename": "server/api/intZohoField/index.js",
37274     "groupTitle": "Zoho_Fields"
37275   },
37276   {
37277     "type": "get",
37278     "url": "/api/integrations/zoho/fields/{id}",
37279     "title": "Gets a single Zoho Field",
37280     "examples": [
37281       {
37282         "title": "Example usage:",
37283         "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password}",
37284         "type": "json"
37285       }
37286     ],
37287     "name": "ShowZoho_Fields",
37288     "group": "Zoho_Fields",
37289     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37290     "version": "0.0.0",
37291     "filename": "server/api/intZohoField/index.js",
37292     "groupTitle": "Zoho_Fields"
37293   },
37294   {
37295     "type": "put",
37296     "url": "/api/integrations/zoho/fields/{id}",
37297     "title": "Update an existing Zoho Field",
37298     "examples": [
37299       {
37300         "title": "Example usage:",
37301         "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",
37302         "type": "json"
37303       }
37304     ],
37305     "name": "updateZoho_Fields",
37306     "group": "Zoho_Fields",
37307     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37308     "version": "0.0.0",
37309     "filename": "server/api/intZohoField/index.js",
37310     "groupTitle": "Zoho_Fields"
37311   },
37312   {
37313     "type": "post",
37314     "url": "/api/cdr",
37315     "title": "Creates a new Cdr",
37316     "examples": [
37317       {
37318         "title": "Example usage:",
37319         "content": "curl https://{domain}/api/cdr -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
37320         "type": "json"
37321       }
37322     ],
37323     "name": "CreateCdrs",
37324     "group": "cdr",
37325     "parameter": {
37326       "fields": {
37327         "Body": [
37328           {
37329             "group": "Body",
37330             "type": "String",
37331             "optional": false,
37332             "field": "calldate",
37333             "description": ""
37334           },
37335           {
37336             "group": "Body",
37337             "type": "String",
37338             "optional": true,
37339             "field": "clid",
37340             "description": ""
37341           },
37342           {
37343             "group": "Body",
37344             "type": "String",
37345             "optional": true,
37346             "field": "src",
37347             "description": ""
37348           },
37349           {
37350             "group": "Body",
37351             "type": "String",
37352             "optional": true,
37353             "field": "dst",
37354             "description": ""
37355           },
37356           {
37357             "group": "Body",
37358             "type": "String",
37359             "optional": true,
37360             "field": "dcontext",
37361             "description": ""
37362           },
37363           {
37364             "group": "Body",
37365             "type": "String",
37366             "optional": true,
37367             "field": "channel",
37368             "description": ""
37369           },
37370           {
37371             "group": "Body",
37372             "type": "String",
37373             "optional": true,
37374             "field": "dstchannel",
37375             "description": ""
37376           },
37377           {
37378             "group": "Body",
37379             "type": "String",
37380             "optional": true,
37381             "field": "lastapp",
37382             "description": ""
37383           },
37384           {
37385             "group": "Body",
37386             "type": "String",
37387             "optional": true,
37388             "field": "lastdata",
37389             "description": ""
37390           },
37391           {
37392             "group": "Body",
37393             "type": "Integer",
37394             "optional": false,
37395             "field": "duration",
37396             "description": ""
37397           },
37398           {
37399             "group": "Body",
37400             "type": "Integer",
37401             "optional": false,
37402             "field": "billsec",
37403             "description": ""
37404           },
37405           {
37406             "group": "Body",
37407             "type": "String",
37408             "optional": true,
37409             "field": "disposition",
37410             "description": ""
37411           },
37412           {
37413             "group": "Body",
37414             "type": "Integer",
37415             "optional": false,
37416             "field": "amaflags",
37417             "description": ""
37418           },
37419           {
37420             "group": "Body",
37421             "type": "String",
37422             "optional": true,
37423             "field": "accountcode",
37424             "description": ""
37425           },
37426           {
37427             "group": "Body",
37428             "type": "String",
37429             "optional": true,
37430             "field": "userfield",
37431             "description": ""
37432           },
37433           {
37434             "group": "Body",
37435             "type": "String",
37436             "optional": true,
37437             "field": "uniqueid",
37438             "description": ""
37439           },
37440           {
37441             "group": "Body",
37442             "type": "String",
37443             "optional": true,
37444             "field": "linkedid",
37445             "description": ""
37446           },
37447           {
37448             "group": "Body",
37449             "type": "String",
37450             "optional": true,
37451             "field": "sequence",
37452             "description": ""
37453           },
37454           {
37455             "group": "Body",
37456             "type": "String",
37457             "optional": true,
37458             "field": "peeraccount",
37459             "description": ""
37460           },
37461           {
37462             "group": "Body",
37463             "type": "String",
37464             "optional": true,
37465             "field": "type",
37466             "description": ""
37467           },
37468           {
37469             "group": "Body",
37470             "type": "String",
37471             "optional": true,
37472             "field": "tag",
37473             "description": ""
37474           }
37475         ]
37476       }
37477     },
37478     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37479     "version": "0.0.0",
37480     "filename": "server/api/cdr/index.js",
37481     "groupTitle": "cdr"
37482   },
37483   {
37484     "type": "delete",
37485     "url": "/api/cdr/{id}",
37486     "title": "Deletes a Cdr",
37487     "examples": [
37488       {
37489         "title": "Example usage:",
37490         "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password} -X DELETE",
37491         "type": "json"
37492       }
37493     ],
37494     "name": "DeleteCdrs",
37495     "group": "cdr",
37496     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37497     "version": "0.0.0",
37498     "filename": "server/api/cdr/index.js",
37499     "groupTitle": "cdr"
37500   },
37501   {
37502     "type": "get",
37503     "url": "/api/cdr/describe",
37504     "title": "Gets table info about Cdrs",
37505     "examples": [
37506       {
37507         "title": "Example usage:",
37508         "content": "curl https://{domain}/api/cdr/describe -v -u {name}:{password}",
37509         "type": "json"
37510       }
37511     ],
37512     "name": "DescribeCdrs",
37513     "group": "cdr",
37514     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37515     "version": "0.0.0",
37516     "filename": "server/api/cdr/index.js",
37517     "groupTitle": "cdr"
37518   },
37519   {
37520     "type": "get",
37521     "url": "/api/cdr",
37522     "title": "Gets a list of Cdrs",
37523     "examples": [
37524       {
37525         "title": "Example usage:",
37526         "content": "curl https://{domain}/api/cdr -v -u {name}:{password}",
37527         "type": "json"
37528       }
37529     ],
37530     "name": "GetCdrs",
37531     "group": "cdr",
37532     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37533     "version": "0.0.0",
37534     "filename": "server/api/cdr/index.js",
37535     "groupTitle": "cdr"
37536   },
37537   {
37538     "type": "get",
37539     "url": "/api/cdr/{id}",
37540     "title": "Gets a single Cdr",
37541     "examples": [
37542       {
37543         "title": "Example usage:",
37544         "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password}",
37545         "type": "json"
37546       }
37547     ],
37548     "name": "ShowCdrs",
37549     "group": "cdr",
37550     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37551     "version": "0.0.0",
37552     "filename": "server/api/cdr/index.js",
37553     "groupTitle": "cdr"
37554   },
37555   {
37556     "type": "put",
37557     "url": "/api/cdr/{id}",
37558     "title": "Update an existing Cdr",
37559     "examples": [
37560       {
37561         "title": "Example usage:",
37562         "content": "curl https://{domain}/api/cdr/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
37563         "type": "json"
37564       }
37565     ],
37566     "name": "updateCdrs",
37567     "group": "cdr",
37568     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37569     "version": "0.0.0",
37570     "filename": "server/api/cdr/index.js",
37571     "groupTitle": "cdr"
37572   },
37573   {
37574     "type": "post",
37575     "url": "/api/voiceQueuesLog",
37576     "title": "Creates a new VoiceQueuesLog",
37577     "examples": [
37578       {
37579         "title": "Example usage:",
37580         "content": "curl https://{domain}/api/voiceQueuesLog -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
37581         "type": "json"
37582       }
37583     ],
37584     "name": "CreateVoiceQueuesLogs",
37585     "group": "voiceQueuesLog",
37586     "parameter": {
37587       "fields": {
37588         "Body": [
37589           {
37590             "group": "Body",
37591             "type": "String",
37592             "optional": true,
37593             "field": "time",
37594             "description": ""
37595           },
37596           {
37597             "group": "Body",
37598             "type": "String",
37599             "optional": false,
37600             "field": "callid",
37601             "description": ""
37602           },
37603           {
37604             "group": "Body",
37605             "type": "String",
37606             "optional": false,
37607             "field": "queuename",
37608             "description": ""
37609           },
37610           {
37611             "group": "Body",
37612             "type": "String",
37613             "optional": false,
37614             "field": "agent",
37615             "description": ""
37616           },
37617           {
37618             "group": "Body",
37619             "type": "String",
37620             "optional": false,
37621             "field": "event",
37622             "description": ""
37623           },
37624           {
37625             "group": "Body",
37626             "type": "String",
37627             "optional": false,
37628             "field": "data",
37629             "description": ""
37630           },
37631           {
37632             "group": "Body",
37633             "type": "String",
37634             "optional": false,
37635             "field": "data1",
37636             "description": ""
37637           },
37638           {
37639             "group": "Body",
37640             "type": "String",
37641             "optional": false,
37642             "field": "data2",
37643             "description": ""
37644           },
37645           {
37646             "group": "Body",
37647             "type": "String",
37648             "optional": false,
37649             "field": "data3",
37650             "description": ""
37651           },
37652           {
37653             "group": "Body",
37654             "type": "String",
37655             "optional": false,
37656             "field": "data4",
37657             "description": ""
37658           },
37659           {
37660             "group": "Body",
37661             "type": "String",
37662             "optional": false,
37663             "field": "data5",
37664             "description": ""
37665           },
37666           {
37667             "group": "Body",
37668             "type": "String",
37669             "optional": false,
37670             "field": "dtm",
37671             "description": ""
37672           }
37673         ]
37674       }
37675     },
37676     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37677     "version": "0.0.0",
37678     "filename": "server/api/voiceQueuesLog/index.js",
37679     "groupTitle": "voiceQueuesLog"
37680   },
37681   {
37682     "type": "delete",
37683     "url": "/api/voiceQueuesLog/{id}",
37684     "title": "Deletes a VoiceQueuesLog",
37685     "examples": [
37686       {
37687         "title": "Example usage:",
37688         "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password} -X DELETE",
37689         "type": "json"
37690       }
37691     ],
37692     "name": "DeleteVoiceQueuesLogs",
37693     "group": "voiceQueuesLog",
37694     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37695     "version": "0.0.0",
37696     "filename": "server/api/voiceQueuesLog/index.js",
37697     "groupTitle": "voiceQueuesLog"
37698   },
37699   {
37700     "type": "get",
37701     "url": "/api/voiceQueuesLog",
37702     "title": "Gets a list of VoiceQueuesLogs",
37703     "examples": [
37704       {
37705         "title": "Example usage:",
37706         "content": "curl https://{domain}/api/voiceQueuesLog -v -u {name}:{password}",
37707         "type": "json"
37708       }
37709     ],
37710     "name": "GetVoiceQueuesLogs",
37711     "group": "voiceQueuesLog",
37712     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37713     "version": "0.0.0",
37714     "filename": "server/api/voiceQueuesLog/index.js",
37715     "groupTitle": "voiceQueuesLog"
37716   },
37717   {
37718     "type": "get",
37719     "url": "/api/voiceQueuesLog/{id}",
37720     "title": "Gets a single VoiceQueuesLog",
37721     "examples": [
37722       {
37723         "title": "Example usage:",
37724         "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password}",
37725         "type": "json"
37726       }
37727     ],
37728     "name": "ShowVoiceQueuesLogs",
37729     "group": "voiceQueuesLog",
37730     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37731     "version": "0.0.0",
37732     "filename": "server/api/voiceQueuesLog/index.js",
37733     "groupTitle": "voiceQueuesLog"
37734   },
37735   {
37736     "type": "put",
37737     "url": "/api/voiceQueuesLog/{id}",
37738     "title": "Update an existing VoiceQueuesLog",
37739     "examples": [
37740       {
37741         "title": "Example usage:",
37742         "content": "curl https://{domain}/api/voiceQueuesLog/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
37743         "type": "json"
37744       }
37745     ],
37746     "name": "updateVoiceQueuesLogs",
37747     "group": "voiceQueuesLog",
37748     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37749     "version": "0.0.0",
37750     "filename": "server/api/voiceQueuesLog/index.js",
37751     "groupTitle": "voiceQueuesLog"
37752   }
37753 ]