apidoc/api_data.json

   1 [
   2   {
   3     "type": "delete",
   4     "url": "/api/actions/{id}",
   5     "title": "Deletes a Action",
   6     "examples": [
   7       {
   8         "title": "Example usage:",
   9         "content": "curl https://{domain}/api/actions/{id} -v -u {name}:{password} -X DELETE",
  10         "type": "json"
  11       }
  12     ],
  13     "name": "DeleteActions",
  14     "group": "Actions",
  15     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
  16     "version": "0.0.0",
  17     "filename": "server/api/action/index.js",
  18     "groupTitle": "Actions"
  19   },
  20   {
  21     "type": "put",
  22     "url": "/api/actions/{id}",
  23     "title": "Update an existing Action",
  24     "examples": [
  25       {
  26         "title": "Example usage:",
  27         "content": "curl https://{domain}/api/actions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
  28         "type": "json"
  29       }
  30     ],
  31     "name": "updateActions",
  32     "group": "Actions",
  33     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
  34     "version": "0.0.0",
  35     "filename": "server/api/action/index.js",
  36     "groupTitle": "Actions"
  37   },
  38   {
  39     "type": "post",
  40     "url": "/api/analytics/custom_reports",
  41     "title": "Creates a new Analytic Custom Report",
  42     "examples": [
  43       {
  44         "title": "Example usage:",
  45         "content": "curl https://{domain}/api/analytics/custom_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
  46         "type": "json"
  47       }
  48     ],
  49     "name": "CreateAnalytic_Custom_Reports",
  50     "group": "Analytic_Custom_Reports",
  51     "parameter": {
  52       "fields": {
  53         "Body": [
  54           {
  55             "group": "Body",
  56             "type": "String",
  57             "optional": false,
  58             "field": "name",
  59             "description": ""
  60           },
  61           {
  62             "group": "Body",
  63             "type": "String",
  64             "optional": true,
  65             "field": "description",
  66             "description": ""
  67           },
  68           {
  69             "group": "Body",
  70             "type": "String",
  71             "optional": true,
  72             "field": "parent",
  73             "description": ""
  74           },
  75           {
  76             "group": "Body",
  77             "type": "String",
  78             "optional": true,
  79             "field": "table",
  80             "description": ""
  81           },
  82           {
  83             "group": "Body",
  84             "type": "Text",
  85             "optional": true,
  86             "field": "conditions",
  87             "description": ""
  88           },
  89           {
  90             "group": "Body",
  91             "type": "Text",
  92             "optional": true,
  93             "field": "joins",
  94             "description": ""
  95           }
  96         ]
  97       }
  98     },
  99     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 100     "version": "0.0.0",
 101     "filename": "server/api/analyticCustomReport/index.js",
 102     "groupTitle": "Analytic_Custom_Reports"
 103   },
 104   {
 105     "type": "delete",
 106     "url": "/api/analytics/custom_reports/{id}",
 107     "title": "Deletes a Analytic Custom Report",
 108     "examples": [
 109       {
 110         "title": "Example usage:",
 111         "content": "curl https://{domain}/api/analytics/custom_reports/{id} -v -u {name}:{password} -X DELETE",
 112         "type": "json"
 113       }
 114     ],
 115     "name": "DeleteAnalytic_Custom_Reports",
 116     "group": "Analytic_Custom_Reports",
 117     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 118     "version": "0.0.0",
 119     "filename": "server/api/analyticCustomReport/index.js",
 120     "groupTitle": "Analytic_Custom_Reports"
 121   },
 122   {
 123     "type": "get",
 124     "url": "/api/analytics/custom_reports",
 125     "title": "Gets a list of Analytic Custom Reports",
 126     "examples": [
 127       {
 128         "title": "Example usage:",
 129         "content": "curl https://{domain}/api/analytics/custom_reports -v -u {name}:{password}",
 130         "type": "json"
 131       }
 132     ],
 133     "name": "GetAnalytic_Custom_Reports",
 134     "group": "Analytic_Custom_Reports",
 135     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/custom_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/custom_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/custom_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/custom_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/custom_reports?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
 136     "version": "0.0.0",
 137     "filename": "server/api/analyticCustomReport/index.js",
 138     "groupTitle": "Analytic_Custom_Reports"
 139   },
 140   {
 141     "type": "get",
 142     "url": "/api/analytics/custom_reports/{id}",
 143     "title": "Gets a single Analytic Custom Report",
 144     "examples": [
 145       {
 146         "title": "Example usage:",
 147         "content": "curl https://{domain}/api/analytics/custom_reports/{id} -v -u {name}:{password}",
 148         "type": "json"
 149       }
 150     ],
 151     "name": "ShowAnalytic_Custom_Reports",
 152     "group": "Analytic_Custom_Reports",
 153     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 154     "version": "0.0.0",
 155     "filename": "server/api/analyticCustomReport/index.js",
 156     "groupTitle": "Analytic_Custom_Reports"
 157   },
 158   {
 159     "type": "get",
 160     "url": "/api/analytics/custom_reports/{id}/preview",
 161     "title": "Report Preview",
 162     "examples": [
 163       {
 164         "title": "Example usage:",
 165         "content": "curl https://{domain}/api/analytics/custom_reports/{id}/preview -v -u {name}:{password} -X GET",
 166         "type": "json"
 167       }
 168     ],
 169     "name": "preview",
 170     "group": "Analytic_Custom_Reports",
 171     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 172     "version": "0.0.0",
 173     "filename": "server/api/analyticCustomReport/index.js",
 174     "groupTitle": "Analytic_Custom_Reports"
 175   },
 176   {
 177     "type": "get",
 178     "url": "/api/analytics/custom_reports/{id}/query",
 179     "title": "Report Query SQL",
 180     "examples": [
 181       {
 182         "title": "Example usage:",
 183         "content": "curl https://{domain}/api/analytics/custom_reports/{id}/query -v -u {name}:{password} -X GET",
 184         "type": "json"
 185       }
 186     ],
 187     "name": "query",
 188     "group": "Analytic_Custom_Reports",
 189     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 190     "version": "0.0.0",
 191     "filename": "server/api/analyticCustomReport/index.js",
 192     "groupTitle": "Analytic_Custom_Reports"
 193   },
 194   {
 195     "type": "get",
 196     "url": "/api/analytics/custom_reports/{id}/run",
 197     "title": "Report Run",
 198     "examples": [
 199       {
 200         "title": "Example usage:",
 201         "content": "curl https://{domain}/api/analytics/custom_reports/{id}/run -v -u {name}:{password} -X GET",
 202         "type": "json"
 203       }
 204     ],
 205     "name": "run",
 206     "group": "Analytic_Custom_Reports",
 207     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 208     "version": "0.0.0",
 209     "filename": "server/api/analyticCustomReport/index.js",
 210     "groupTitle": "Analytic_Custom_Reports"
 211   },
 212   {
 213     "type": "put",
 214     "url": "/api/analytics/custom_reports/{id}",
 215     "title": "Update an existing Analytic Custom Report",
 216     "examples": [
 217       {
 218         "title": "Example usage:",
 219         "content": "curl https://{domain}/api/analytics/custom_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
 220         "type": "json"
 221       }
 222     ],
 223     "name": "updateAnalytic_Custom_Reports",
 224     "group": "Analytic_Custom_Reports",
 225     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 226     "version": "0.0.0",
 227     "filename": "server/api/analyticCustomReport/index.js",
 228     "groupTitle": "Analytic_Custom_Reports"
 229   },
 230   {
 231     "type": "post",
 232     "url": "/api/analytics/default_reports",
 233     "title": "Creates a new Analytic Default Report",
 234     "examples": [
 235       {
 236         "title": "Example usage:",
 237         "content": "curl https://{domain}/api/analytics/default_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
 238         "type": "json"
 239       }
 240     ],
 241     "name": "CreateAnalytic_Default_Reports",
 242     "group": "Analytic_Default_Reports",
 243     "parameter": {
 244       "fields": {
 245         "Body": [
 246           {
 247             "group": "Body",
 248             "type": "String",
 249             "optional": false,
 250             "field": "name",
 251             "description": ""
 252           },
 253           {
 254             "group": "Body",
 255             "type": "String",
 256             "optional": true,
 257             "field": "description",
 258             "description": ""
 259           },
 260           {
 261             "group": "Body",
 262             "type": "String",
 263             "optional": true,
 264             "field": "parent",
 265             "description": ""
 266           },
 267           {
 268             "group": "Body",
 269             "type": "String",
 270             "optional": true,
 271             "field": "table",
 272             "description": ""
 273           },
 274           {
 275             "group": "Body",
 276             "type": "Text",
 277             "optional": true,
 278             "field": "conditions",
 279             "description": ""
 280           },
 281           {
 282             "group": "Body",
 283             "type": "Text",
 284             "optional": true,
 285             "field": "joins",
 286             "description": ""
 287           }
 288         ]
 289       }
 290     },
 291     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 292     "version": "0.0.0",
 293     "filename": "server/api/analyticDefaultReport/index.js",
 294     "groupTitle": "Analytic_Default_Reports"
 295   },
 296   {
 297     "type": "delete",
 298     "url": "/api/analytics/default_reports/{id}",
 299     "title": "Deletes a Analytic Default Report",
 300     "examples": [
 301       {
 302         "title": "Example usage:",
 303         "content": "curl https://{domain}/api/analytics/default_reports/{id} -v -u {name}:{password} -X DELETE",
 304         "type": "json"
 305       }
 306     ],
 307     "name": "DeleteAnalytic_Default_Reports",
 308     "group": "Analytic_Default_Reports",
 309     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 310     "version": "0.0.0",
 311     "filename": "server/api/analyticDefaultReport/index.js",
 312     "groupTitle": "Analytic_Default_Reports"
 313   },
 314   {
 315     "type": "get",
 316     "url": "/api/analytics/default_reports",
 317     "title": "Gets a list of Analytic Default Reports",
 318     "examples": [
 319       {
 320         "title": "Example usage:",
 321         "content": "curl https://{domain}/api/analytics/default_reports -v -u {name}:{password}",
 322         "type": "json"
 323       }
 324     ],
 325     "name": "GetAnalytic_Default_Reports",
 326     "group": "Analytic_Default_Reports",
 327     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/default_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/default_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/default_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/default_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/default_reports?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
 328     "version": "0.0.0",
 329     "filename": "server/api/analyticDefaultReport/index.js",
 330     "groupTitle": "Analytic_Default_Reports"
 331   },
 332   {
 333     "type": "get",
 334     "url": "/api/analytics/default_reports/{id}",
 335     "title": "Gets a single Analytic Default Report",
 336     "examples": [
 337       {
 338         "title": "Example usage:",
 339         "content": "curl https://{domain}/api/analytics/default_reports/{id} -v -u {name}:{password}",
 340         "type": "json"
 341       }
 342     ],
 343     "name": "ShowAnalytic_Default_Reports",
 344     "group": "Analytic_Default_Reports",
 345     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 346     "version": "0.0.0",
 347     "filename": "server/api/analyticDefaultReport/index.js",
 348     "groupTitle": "Analytic_Default_Reports"
 349   },
 350   {
 351     "type": "get",
 352     "url": "/api/analytics/default_reports/{id}/preview",
 353     "title": "Report Preview",
 354     "examples": [
 355       {
 356         "title": "Example usage:",
 357         "content": "curl https://{domain}/api/analytics/default_reports/{id}/preview -v -u {name}:{password} -X GET",
 358         "type": "json"
 359       }
 360     ],
 361     "name": "preview",
 362     "group": "Analytic_Default_Reports",
 363     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 364     "version": "0.0.0",
 365     "filename": "server/api/analyticDefaultReport/index.js",
 366     "groupTitle": "Analytic_Default_Reports"
 367   },
 368   {
 369     "type": "get",
 370     "url": "/api/analytics/default_reports/{id}/query",
 371     "title": "Report Query SQL",
 372     "examples": [
 373       {
 374         "title": "Example usage:",
 375         "content": "curl https://{domain}/api/analytics/default_reports/{id}/query -v -u {name}:{password} -X GET",
 376         "type": "json"
 377       }
 378     ],
 379     "name": "query",
 380     "group": "Analytic_Default_Reports",
 381     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 382     "version": "0.0.0",
 383     "filename": "server/api/analyticDefaultReport/index.js",
 384     "groupTitle": "Analytic_Default_Reports"
 385   },
 386   {
 387     "type": "get",
 388     "url": "/api/analytics/default_reports/{id}/run",
 389     "title": "Report Run",
 390     "examples": [
 391       {
 392         "title": "Example usage:",
 393         "content": "curl https://{domain}/api/analytics/default_reports/{id}/run -v -u {name}:{password} -X GET",
 394         "type": "json"
 395       }
 396     ],
 397     "name": "run",
 398     "group": "Analytic_Default_Reports",
 399     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 400     "version": "0.0.0",
 401     "filename": "server/api/analyticDefaultReport/index.js",
 402     "groupTitle": "Analytic_Default_Reports"
 403   },
 404   {
 405     "type": "put",
 406     "url": "/api/analytics/default_reports/{id}",
 407     "title": "Update an existing Analytic Default Report",
 408     "examples": [
 409       {
 410         "title": "Example usage:",
 411         "content": "curl https://{domain}/api/analytics/default_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
 412         "type": "json"
 413       }
 414     ],
 415     "name": "updateAnalytic_Default_Reports",
 416     "group": "Analytic_Default_Reports",
 417     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 418     "version": "0.0.0",
 419     "filename": "server/api/analyticDefaultReport/index.js",
 420     "groupTitle": "Analytic_Default_Reports"
 421   },
 422   {
 423     "type": "post",
 424     "url": "/api/analytics/extracted_reports",
 425     "title": "Creates a new Analytic Extracted Report",
 426     "examples": [
 427       {
 428         "title": "Example usage:",
 429         "content": "curl https://{domain}/api/analytics/extracted_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
 430         "type": "json"
 431       }
 432     ],
 433     "name": "CreateAnalytic_Extacted_Reports",
 434     "group": "Analytic_Extracted_Reports",
 435     "parameter": {
 436       "fields": {
 437         "Body": [
 438           {
 439             "group": "Body",
 440             "type": "String",
 441             "optional": false,
 442             "field": "name",
 443             "description": ""
 444           },
 445           {
 446             "group": "Body",
 447             "type": "String",
 448             "optional": false,
 449             "field": "basename",
 450             "description": ""
 451           },
 452           {
 453             "group": "Body",
 454             "type": "String",
 455             "allowedValues": [
 456               "\"csv\"",
 457               "\"pdf\"",
 458               "\"xlsx\""
 459             ],
 460             "optional": false,
 461             "field": "output",
 462             "description": ""
 463           },
 464           {
 465             "group": "Body",
 466             "type": "String",
 467             "optional": false,
 468             "field": "savename",
 469             "description": ""
 470           },
 471           {
 472             "group": "Body",
 473             "type": "String",
 474             "optional": true,
 475             "field": "startDate",
 476             "description": ""
 477           },
 478           {
 479             "group": "Body",
 480             "type": "String",
 481             "optional": true,
 482             "field": "endDate",
 483             "description": ""
 484           },
 485           {
 486             "group": "Body",
 487             "type": "String",
 488             "optional": true,
 489             "field": "status",
 490             "description": ""
 491           },
 492           {
 493             "group": "Body",
 494             "type": "String",
 495             "allowedValues": [
 496               "\"manual\"",
 497               "\"scheduled\""
 498             ],
 499             "optional": false,
 500             "field": "type",
 501             "description": ""
 502           },
 503           {
 504             "group": "Body",
 505             "type": "Integer",
 506             "optional": true,
 507             "field": "reportId",
 508             "description": ""
 509           },
 510           {
 511             "group": "Body",
 512             "type": "String",
 513             "optional": true,
 514             "field": "reportType",
 515             "description": ""
 516           }
 517         ]
 518       }
 519     },
 520     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 521     "version": "0.0.0",
 522     "filename": "server/api/analyticExtractedReport/index.js",
 523     "groupTitle": "Analytic_Extracted_Reports"
 524   },
 525   {
 526     "type": "delete",
 527     "url": "/api/analytics/extracted_reports/{id}",
 528     "title": "Deletes a Analytic Extracted Report",
 529     "examples": [
 530       {
 531         "title": "Example usage:",
 532         "content": "curl https://{domain}/api/analytics/extracted_reports/{id} -v -u {name}:{password} -X DELETE",
 533         "type": "json"
 534       }
 535     ],
 536     "name": "DeleteAnalytic_Extacted_Reports",
 537     "group": "Analytic_Extracted_Reports",
 538     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 539     "version": "0.0.0",
 540     "filename": "server/api/analyticExtractedReport/index.js",
 541     "groupTitle": "Analytic_Extracted_Reports"
 542   },
 543   {
 544     "type": "get",
 545     "url": "/api/analytics/extracted_reports",
 546     "title": "Gets a list of Analytic Extacted Reports",
 547     "examples": [
 548       {
 549         "title": "Example usage:",
 550         "content": "curl https://{domain}/api/analytics/extracted_reports -v -u {name}:{password}",
 551         "type": "json"
 552       }
 553     ],
 554     "name": "GetAnalytic_Extacted_Reports",
 555     "group": "Analytic_Extracted_Reports",
 556     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/extracted_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/extracted_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/extracted_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/extracted_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/extracted_reports?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
 557     "version": "0.0.0",
 558     "filename": "server/api/analyticExtractedReport/index.js",
 559     "groupTitle": "Analytic_Extracted_Reports"
 560   },
 561   {
 562     "type": "get",
 563     "url": "/api/analytics/extracted_reports/{id}",
 564     "title": "Gets a single Analytic Extracted Report",
 565     "examples": [
 566       {
 567         "title": "Example usage:",
 568         "content": "curl https://{domain}/api/analytics/extracted_reports/{id} -v -u {name}:{password}",
 569         "type": "json"
 570       }
 571     ],
 572     "name": "ShowAnalytic_Extacted_Reports",
 573     "group": "Analytic_Extracted_Reports",
 574     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 575     "version": "0.0.0",
 576     "filename": "server/api/analyticExtractedReport/index.js",
 577     "groupTitle": "Analytic_Extracted_Reports"
 578   },
 579   {
 580     "type": "get",
 581     "url": "/api/analytics/extracted_reports/{id}/download",
 582     "title": "Download Extracted Report",
 583     "examples": [
 584       {
 585         "title": "Example usage:",
 586         "content": "curl https://{domain}/api/analytics/extracted_reports/{id}/download -v -u {name}:{password} -X GET",
 587         "type": "json"
 588       }
 589     ],
 590     "name": "download",
 591     "group": "Analytic_Extracted_Reports",
 592     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 593     "version": "0.0.0",
 594     "filename": "server/api/analyticExtractedReport/index.js",
 595     "groupTitle": "Analytic_Extracted_Reports"
 596   },
 597   {
 598     "type": "put",
 599     "url": "/api/analytics/extracted_reports/{id}",
 600     "title": "Update an existing Analytic Extracted Report",
 601     "examples": [
 602       {
 603         "title": "Example usage:",
 604         "content": "curl https://{domain}/api/analytics/extracted_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
 605         "type": "json"
 606       }
 607     ],
 608     "name": "updateAnalytic_Extacted_Reports",
 609     "group": "Analytic_Extracted_Reports",
 610     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 611     "version": "0.0.0",
 612     "filename": "server/api/analyticExtractedReport/index.js",
 613     "groupTitle": "Analytic_Extracted_Reports"
 614   },
 615   {
 616     "type": "post",
 617     "url": "/api/analytics/field_reports/create_many",
 618     "title": "Creates many Analytic Field Reports",
 619     "examples": [
 620       {
 621         "title": "Example usage:",
 622         "content": "curl https://{domain}/api/analytics/field_reports/create_many -d '[{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}]' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
 623         "type": "json"
 624       }
 625     ],
 626     "name": "BulkCreateAnalytic_Field_Reports",
 627     "group": "Analytic_Field_Reports",
 628     "parameter": {
 629       "fields": {
 630         "Body": [
 631           {
 632             "group": "Body",
 633             "type": "Text",
 634             "optional": true,
 635             "field": "field",
 636             "description": ""
 637           },
 638           {
 639             "group": "Body",
 640             "type": "String",
 641             "optional": true,
 642             "field": "alias",
 643             "description": ""
 644           },
 645           {
 646             "group": "Body",
 647             "type": "String",
 648             "optional": true,
 649             "field": "function",
 650             "description": ""
 651           },
 652           {
 653             "group": "Body",
 654             "type": "String",
 655             "optional": true,
 656             "field": "format",
 657             "description": ""
 658           },
 659           {
 660             "group": "Body",
 661             "type": "Boolean",
 662             "optional": true,
 663             "field": "groupBy",
 664             "description": ""
 665           },
 666           {
 667             "group": "Body",
 668             "type": "String",
 669             "optional": true,
 670             "field": "orderBy",
 671             "description": ""
 672           },
 673           {
 674             "group": "Body",
 675             "type": "Boolean",
 676             "optional": true,
 677             "field": "custom",
 678             "description": ""
 679           }
 680         ]
 681       }
 682     },
 683     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 684     "version": "0.0.0",
 685     "filename": "server/api/analyticFieldReport/index.js",
 686     "groupTitle": "Analytic_Field_Reports"
 687   },
 688   {
 689     "type": "delete",
 690     "url": "/api/analytics/field_reports/destroy_many?ids={ids}",
 691     "title": "Deletes many Analytic Field Reports",
 692     "examples": [
 693       {
 694         "title": "Example usage:",
 695         "content": "curl https://{domain}/api/analytics/field_reports/destroy_many?ids=1&ids=2&ids=3 -v -u {name}:{password} -X DELETE",
 696         "type": "json"
 697       }
 698     ],
 699     "name": "BulkDeleteAnalytic_Field_Reports",
 700     "group": "Analytic_Field_Reports",
 701     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 702     "version": "0.0.0",
 703     "filename": "server/api/analyticFieldReport/index.js",
 704     "groupTitle": "Analytic_Field_Reports"
 705   },
 706   {
 707     "type": "post",
 708     "url": "/api/analytics/field_reports",
 709     "title": "Creates a new Analytic Field Report",
 710     "examples": [
 711       {
 712         "title": "Example usage:",
 713         "content": "curl https://{domain}/api/analytics/field_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
 714         "type": "json"
 715       }
 716     ],
 717     "name": "CreateAnalytic_Field_Reports",
 718     "group": "Analytic_Field_Reports",
 719     "parameter": {
 720       "fields": {
 721         "Body": [
 722           {
 723             "group": "Body",
 724             "type": "Text",
 725             "optional": true,
 726             "field": "field",
 727             "description": ""
 728           },
 729           {
 730             "group": "Body",
 731             "type": "String",
 732             "optional": true,
 733             "field": "alias",
 734             "description": ""
 735           },
 736           {
 737             "group": "Body",
 738             "type": "String",
 739             "optional": true,
 740             "field": "function",
 741             "description": ""
 742           },
 743           {
 744             "group": "Body",
 745             "type": "String",
 746             "optional": true,
 747             "field": "format",
 748             "description": ""
 749           },
 750           {
 751             "group": "Body",
 752             "type": "Boolean",
 753             "optional": true,
 754             "field": "groupBy",
 755             "description": ""
 756           },
 757           {
 758             "group": "Body",
 759             "type": "String",
 760             "optional": true,
 761             "field": "orderBy",
 762             "description": ""
 763           },
 764           {
 765             "group": "Body",
 766             "type": "Boolean",
 767             "optional": true,
 768             "field": "custom",
 769             "description": ""
 770           }
 771         ]
 772       }
 773     },
 774     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 775     "version": "0.0.0",
 776     "filename": "server/api/analyticFieldReport/index.js",
 777     "groupTitle": "Analytic_Field_Reports"
 778   },
 779   {
 780     "type": "delete",
 781     "url": "/api/analytics/field_reports/{id}",
 782     "title": "Deletes a Analytic Field Report",
 783     "examples": [
 784       {
 785         "title": "Example usage:",
 786         "content": "curl https://{domain}/api/analytics/field_reports/{id} -v -u {name}:{password} -X DELETE",
 787         "type": "json"
 788       }
 789     ],
 790     "name": "DeleteAnalytic_Field_Reports",
 791     "group": "Analytic_Field_Reports",
 792     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 793     "version": "0.0.0",
 794     "filename": "server/api/analyticFieldReport/index.js",
 795     "groupTitle": "Analytic_Field_Reports"
 796   },
 797   {
 798     "type": "get",
 799     "url": "/api/analytics/field_reports",
 800     "title": "Gets a list of Analytic Field Reports",
 801     "examples": [
 802       {
 803         "title": "Example usage:",
 804         "content": "curl https://{domain}/api/analytics/field_reports -v -u {name}:{password}",
 805         "type": "json"
 806       }
 807     ],
 808     "name": "GetAnalytic_Field_Reports",
 809     "group": "Analytic_Field_Reports",
 810     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/field_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/field_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/field_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/field_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/field_reports?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
 811     "version": "0.0.0",
 812     "filename": "server/api/analyticFieldReport/index.js",
 813     "groupTitle": "Analytic_Field_Reports"
 814   },
 815   {
 816     "type": "get",
 817     "url": "/api/analytics/field_reports/{id}",
 818     "title": "Gets a single Analytic Field Report",
 819     "examples": [
 820       {
 821         "title": "Example usage:",
 822         "content": "curl https://{domain}/api/analytics/field_reports/{id} -v -u {name}:{password}",
 823         "type": "json"
 824       }
 825     ],
 826     "name": "ShowAnalytic_Field_Reports",
 827     "group": "Analytic_Field_Reports",
 828     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 829     "version": "0.0.0",
 830     "filename": "server/api/analyticFieldReport/index.js",
 831     "groupTitle": "Analytic_Field_Reports"
 832   },
 833   {
 834     "type": "post",
 835     "url": "/api/analytics/field_reports/{id}/create_many",
 836     "title": "Rewrite fields set",
 837     "examples": [
 838       {
 839         "title": "Example usage:",
 840         "content": "curl https://{domain}/api/analytics/field_reports/{id}/create_many -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
 841         "type": "json"
 842       }
 843     ],
 844     "name": "addFields",
 845     "group": "Analytic_Field_Reports",
 846     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 847     "version": "0.0.0",
 848     "filename": "server/api/analyticFieldReport/index.js",
 849     "groupTitle": "Analytic_Field_Reports"
 850   },
 851   {
 852     "type": "put",
 853     "url": "/api/analytics/field_reports/{id}",
 854     "title": "Update an existing Analytic Field Report",
 855     "examples": [
 856       {
 857         "title": "Example usage:",
 858         "content": "curl https://{domain}/api/analytics/field_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
 859         "type": "json"
 860       }
 861     ],
 862     "name": "updateAnalytic_Field_Reports",
 863     "group": "Analytic_Field_Reports",
 864     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 865     "version": "0.0.0",
 866     "filename": "server/api/analyticFieldReport/index.js",
 867     "groupTitle": "Analytic_Field_Reports"
 868   },
 869   {
 870     "type": "post",
 871     "url": "/api/analytics/metrics",
 872     "title": "Creates a new Analytic Metrics",
 873     "examples": [
 874       {
 875         "title": "Example usage:",
 876         "content": "curl https://{domain}/api/analytics/metrics -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
 877         "type": "json"
 878       }
 879     ],
 880     "name": "CreateAnalytic_Metric",
 881     "group": "Analytic_Metrics",
 882     "parameter": {
 883       "fields": {
 884         "Body": [
 885           {
 886             "group": "Body",
 887             "type": "String",
 888             "optional": false,
 889             "field": "name",
 890             "description": ""
 891           },
 892           {
 893             "group": "Body",
 894             "type": "String",
 895             "optional": true,
 896             "field": "table",
 897             "description": ""
 898           },
 899           {
 900             "group": "Body",
 901             "type": "Text",
 902             "optional": true,
 903             "field": "metric",
 904             "description": ""
 905           },
 906           {
 907             "group": "Body",
 908             "type": "String",
 909             "optional": true,
 910             "field": "description",
 911             "description": ""
 912           }
 913         ]
 914       }
 915     },
 916     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 917     "version": "0.0.0",
 918     "filename": "server/api/analyticMetric/index.js",
 919     "groupTitle": "Analytic_Metrics"
 920   },
 921   {
 922     "type": "delete",
 923     "url": "/api/analytics/metrics/{id}",
 924     "title": "Deletes a Analytic Metrics",
 925     "examples": [
 926       {
 927         "title": "Example usage:",
 928         "content": "curl https://{domain}/api/analytics/metrics/{id} -v -u {name}:{password} -X DELETE",
 929         "type": "json"
 930       }
 931     ],
 932     "name": "DeleteAnalytic_Metric",
 933     "group": "Analytic_Metrics",
 934     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 935     "version": "0.0.0",
 936     "filename": "server/api/analyticMetric/index.js",
 937     "groupTitle": "Analytic_Metrics"
 938   },
 939   {
 940     "type": "get",
 941     "url": "/api/analytics/metrics",
 942     "title": "Gets a list of Analytic Metric",
 943     "examples": [
 944       {
 945         "title": "Example usage:",
 946         "content": "curl https://{domain}/api/analytics/metrics -v -u {name}:{password}",
 947         "type": "json"
 948       }
 949     ],
 950     "name": "GetAnalytic_Metric",
 951     "group": "Analytic_Metrics",
 952     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/metrics?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/metrics?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/metrics?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/metrics?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/metrics?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
 953     "version": "0.0.0",
 954     "filename": "server/api/analyticMetric/index.js",
 955     "groupTitle": "Analytic_Metrics"
 956   },
 957   {
 958     "type": "get",
 959     "url": "/api/analytics/metrics/{id}",
 960     "title": "Gets a single Analytic Metrics",
 961     "examples": [
 962       {
 963         "title": "Example usage:",
 964         "content": "curl https://{domain}/api/analytics/metrics/{id} -v -u {name}:{password}",
 965         "type": "json"
 966       }
 967     ],
 968     "name": "ShowAnalytic_Metric",
 969     "group": "Analytic_Metrics",
 970     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 971     "version": "0.0.0",
 972     "filename": "server/api/analyticMetric/index.js",
 973     "groupTitle": "Analytic_Metrics"
 974   },
 975   {
 976     "type": "put",
 977     "url": "/api/analytics/metrics/{id}",
 978     "title": "Update an existing Analytic Metrics",
 979     "examples": [
 980       {
 981         "title": "Example usage:",
 982         "content": "curl https://{domain}/api/analytics/metrics/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
 983         "type": "json"
 984       }
 985     ],
 986     "name": "updateAnalytic_Metric",
 987     "group": "Analytic_Metrics",
 988     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 989     "version": "0.0.0",
 990     "filename": "server/api/analyticMetric/index.js",
 991     "groupTitle": "Analytic_Metrics"
 992   },
 993   {
 994     "type": "post",
 995     "url": "/api/analytics/tree_reports",
 996     "title": "Creates a new Analytic Tree Report",
 997     "examples": [
 998       {
 999         "title": "Example usage:",
1000         "content": "curl https://{domain}/api/analytics/tree_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1001         "type": "json"
1002       }
1003     ],
1004     "name": "CreateAnalytic_Tree_Reports",
1005     "group": "Analytic_Tree_Reports",
1006     "parameter": {
1007       "fields": {
1008         "Body": [
1009           {
1010             "group": "Body",
1011             "type": "Text",
1012             "optional": false,
1013             "field": "tree",
1014             "description": ""
1015           }
1016         ]
1017       }
1018     },
1019     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1020     "version": "0.0.0",
1021     "filename": "server/api/analyticTreeReport/index.js",
1022     "groupTitle": "Analytic_Tree_Reports"
1023   },
1024   {
1025     "type": "delete",
1026     "url": "/api/analytics/tree_reports/{id}",
1027     "title": "Deletes a Analytic Tree Report",
1028     "examples": [
1029       {
1030         "title": "Example usage:",
1031         "content": "curl https://{domain}/api/analytics/tree_reports/{id} -v -u {name}:{password} -X DELETE",
1032         "type": "json"
1033       }
1034     ],
1035     "name": "DeleteAnalytic_Tree_Reports",
1036     "group": "Analytic_Tree_Reports",
1037     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1038     "version": "0.0.0",
1039     "filename": "server/api/analyticTreeReport/index.js",
1040     "groupTitle": "Analytic_Tree_Reports"
1041   },
1042   {
1043     "type": "get",
1044     "url": "/api/analytics/tree_reports",
1045     "title": "Gets a list of Analytic Tree Reports",
1046     "examples": [
1047       {
1048         "title": "Example usage:",
1049         "content": "curl https://{domain}/api/analytics/tree_reports -v -u {name}:{password}",
1050         "type": "json"
1051       }
1052     ],
1053     "name": "GetAnalytic_Tree_Reports",
1054     "group": "Analytic_Tree_Reports",
1055     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/tree_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/tree_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/tree_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/tree_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/tree_reports?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1056     "version": "0.0.0",
1057     "filename": "server/api/analyticTreeReport/index.js",
1058     "groupTitle": "Analytic_Tree_Reports"
1059   },
1060   {
1061     "type": "get",
1062     "url": "/api/analytics/tree_reports/{id}",
1063     "title": "Gets a single Analytic Tree Report",
1064     "examples": [
1065       {
1066         "title": "Example usage:",
1067         "content": "curl https://{domain}/api/analytics/tree_reports/{id} -v -u {name}:{password}",
1068         "type": "json"
1069       }
1070     ],
1071     "name": "ShowAnalytic_Tree_Reports",
1072     "group": "Analytic_Tree_Reports",
1073     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1074     "version": "0.0.0",
1075     "filename": "server/api/analyticTreeReport/index.js",
1076     "groupTitle": "Analytic_Tree_Reports"
1077   },
1078   {
1079     "type": "put",
1080     "url": "/api/analytics/tree_reports/{id}",
1081     "title": "Update an existing Analytic Tree Report",
1082     "examples": [
1083       {
1084         "title": "Example usage:",
1085         "content": "curl https://{domain}/api/analytics/tree_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1086         "type": "json"
1087       }
1088     ],
1089     "name": "updateAnalytic_Tree_Reports",
1090     "group": "Analytic_Tree_Reports",
1091     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1092     "version": "0.0.0",
1093     "filename": "server/api/analyticTreeReport/index.js",
1094     "groupTitle": "Analytic_Tree_Reports"
1095   },
1096   {
1097     "type": "post",
1098     "url": "/api/attachments/clone",
1099     "title": "Clone an existing Attachment",
1100     "examples": [
1101       {
1102         "title": "Example usage:",
1103         "content": "curl https://{domain}/api/attachments/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1104         "type": "json"
1105       }
1106     ],
1107     "name": "CloneAttachments",
1108     "group": "Attachments",
1109     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1110     "version": "0.0.0",
1111     "filename": "server/api/attachment/index.js",
1112     "groupTitle": "Attachments"
1113   },
1114   {
1115     "type": "delete",
1116     "url": "/api/attachments/{id}",
1117     "title": "Deletes a Attachment",
1118     "examples": [
1119       {
1120         "title": "Example usage:",
1121         "content": "curl https://{domain}/api/attachments/{id} -v -u {name}:{password} -X DELETE",
1122         "type": "json"
1123       }
1124     ],
1125     "name": "DeleteAttachments",
1126     "group": "Attachments",
1127     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1128     "version": "0.0.0",
1129     "filename": "server/api/attachment/index.js",
1130     "groupTitle": "Attachments"
1131   },
1132   {
1133     "type": "get",
1134     "url": "/api/attachments",
1135     "title": "Gets a list of Attachments",
1136     "examples": [
1137       {
1138         "title": "Example usage:",
1139         "content": "curl https://{domain}/api/attachments -v -u {name}:{password}",
1140         "type": "json"
1141       }
1142     ],
1143     "name": "GetAttachments",
1144     "group": "Attachments",
1145     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/attachments?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/attachments?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/attachments?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/attachments?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/attachments?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1146     "version": "0.0.0",
1147     "filename": "server/api/attachment/index.js",
1148     "groupTitle": "Attachments"
1149   },
1150   {
1151     "type": "get",
1152     "url": "/api/attachments/{id}",
1153     "title": "Gets a single Attachment",
1154     "examples": [
1155       {
1156         "title": "Example usage:",
1157         "content": "curl https://{domain}/api/attachments/{id} -v -u {name}:{password}",
1158         "type": "json"
1159       }
1160     ],
1161     "name": "ShowAttachments",
1162     "group": "Attachments",
1163     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1164     "version": "0.0.0",
1165     "filename": "server/api/attachment/index.js",
1166     "groupTitle": "Attachments"
1167   },
1168   {
1169     "type": "post",
1170     "url": "/api/attachments",
1171     "title": "Add attachment",
1172     "examples": [
1173       {
1174         "title": "Example usage:",
1175         "content": "curl https://{domain}/api/attachments -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
1176         "type": "json"
1177       }
1178     ],
1179     "name": "create",
1180     "group": "Attachments",
1181     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1182     "version": "0.0.0",
1183     "filename": "server/api/attachment/index.js",
1184     "groupTitle": "Attachments"
1185   },
1186   {
1187     "type": "get",
1188     "url": "/api/attachments/:id/download",
1189     "title": "Download attachment",
1190     "examples": [
1191       {
1192         "title": "Example usage:",
1193         "content": "curl https://{domain}/api/attachments/:id/download -v -u {name}:{password} -X GET",
1194         "type": "json"
1195       }
1196     ],
1197     "name": "download",
1198     "group": "Attachments",
1199     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1200     "version": "0.0.0",
1201     "filename": "server/api/attachment/index.js",
1202     "groupTitle": "Attachments"
1203   },
1204   {
1205     "type": "get",
1206     "url": "/api/chat/interactions/{id}/attachment_download",
1207     "title": "Download attachment",
1208     "examples": [
1209       {
1210         "title": "Example usage:",
1211         "content": "curl https://{domain}/api/chat/interactions/{id}/attachment_download -v -u {name}:{password} -X GET",
1212         "type": "json"
1213       }
1214     ],
1215     "name": "show",
1216     "group": "Attachments",
1217     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1218     "version": "0.0.0",
1219     "filename": "server/api/chatInteraction/index.js",
1220     "groupTitle": "Attachments"
1221   },
1222   {
1223     "type": "put",
1224     "url": "/api/attachments/{id}",
1225     "title": "Update an existing Attachment",
1226     "examples": [
1227       {
1228         "title": "Example usage:",
1229         "content": "curl https://{domain}/api/attachments/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1230         "type": "json"
1231       }
1232     ],
1233     "name": "updateAttachments",
1234     "group": "Attachments",
1235     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1236     "version": "0.0.0",
1237     "filename": "server/api/attachment/index.js",
1238     "groupTitle": "Attachments"
1239   },
1240   {
1241     "type": "post",
1242     "url": "/api/auth/local/forgot",
1243     "title": "Creates a new password reset token",
1244     "examples": [
1245       {
1246         "title": "Example usage:",
1247         "content": "curl https://{domain}/api/auth/local/forgot -d '{\"email\": \"john.doe@xcally.com\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1248         "type": "json"
1249       }
1250     ],
1251     "name": "Local_Forgot_Password",
1252     "group": "Authentication",
1253     "parameter": {
1254       "fields": {
1255         "Body": [
1256           {
1257             "group": "Body",
1258             "type": "String",
1259             "optional": false,
1260             "field": "email",
1261             "description": ""
1262           }
1263         ]
1264       }
1265     },
1266     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1267     "version": "0.0.0",
1268     "filename": "server/api/authLocal/index.js",
1269     "groupTitle": "Authentication"
1270   },
1271   {
1272     "type": "post",
1273     "url": "/api/auth/local/reset/:token",
1274     "title": "Reset user password",
1275     "examples": [
1276       {
1277         "title": "Example usage:",
1278         "content": "curl https://{domain}/api/auth/local/reset/94b422c1fkdjhg766a198da6997yu6gcc963641d -d '{\"password\": \"My_newP@ssw0rd\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1279         "type": "json"
1280       }
1281     ],
1282     "name": "Local_Reset_Password",
1283     "group": "Authentication",
1284     "parameter": {
1285       "fields": {
1286         "Body": [
1287           {
1288             "group": "Body",
1289             "type": "String",
1290             "optional": false,
1291             "field": "password",
1292             "description": ""
1293           }
1294         ]
1295       }
1296     },
1297     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1298     "version": "0.0.0",
1299     "filename": "server/api/authLocal/index.js",
1300     "groupTitle": "Authentication"
1301   },
1302   {
1303     "type": "post",
1304     "url": "/api/auth/google",
1305     "title": "Creates a new User token",
1306     "examples": [
1307       {
1308         "title": "Example usage:",
1309         "content": "curl https://{domain}/api/auth/google -d '{\"name\": \"john.doe\", \"password\": \"password\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1310         "type": "json"
1311       }
1312     ],
1313     "name": "Local_login",
1314     "group": "Authentication",
1315     "parameter": {
1316       "fields": {
1317         "Body": [
1318           {
1319             "group": "Body",
1320             "type": "String",
1321             "optional": false,
1322             "field": "name",
1323             "description": ""
1324           },
1325           {
1326             "group": "Body",
1327             "type": "String",
1328             "optional": false,
1329             "field": "password",
1330             "description": ""
1331           }
1332         ]
1333       }
1334     },
1335     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1336     "version": "0.0.0",
1337     "filename": "server/api/authGoogle/index.js",
1338     "groupTitle": "Authentication"
1339   },
1340   {
1341     "type": "post",
1342     "url": "/api/auth/local",
1343     "title": "Creates a new User token",
1344     "examples": [
1345       {
1346         "title": "Example usage:",
1347         "content": "curl https://{domain}/api/auth/local -d '{\"name\": \"john.doe\", \"password\": \"password\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1348         "type": "json"
1349       }
1350     ],
1351     "name": "Local_login",
1352     "group": "Authentication",
1353     "parameter": {
1354       "fields": {
1355         "Body": [
1356           {
1357             "group": "Body",
1358             "type": "String",
1359             "optional": false,
1360             "field": "name",
1361             "description": ""
1362           },
1363           {
1364             "group": "Body",
1365             "type": "String",
1366             "optional": false,
1367             "field": "password",
1368             "description": ""
1369           }
1370         ]
1371       }
1372     },
1373     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1374     "version": "0.0.0",
1375     "filename": "server/api/authLocal/index.js",
1376     "groupTitle": "Authentication"
1377   },
1378   {
1379     "type": "post",
1380     "url": "/api/automations",
1381     "title": "Creates a new Automation",
1382     "examples": [
1383       {
1384         "title": "Example usage:",
1385         "content": "curl https://{domain}/api/automations -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1386         "type": "json"
1387       }
1388     ],
1389     "name": "CreateAutomations",
1390     "group": "Automations",
1391     "parameter": {
1392       "fields": {
1393         "Body": [
1394           {
1395             "group": "Body",
1396             "type": "String",
1397             "optional": false,
1398             "field": "name",
1399             "description": ""
1400           },
1401           {
1402             "group": "Body",
1403             "type": "String",
1404             "optional": true,
1405             "field": "channel",
1406             "description": ""
1407           },
1408           {
1409             "group": "Body",
1410             "type": "String",
1411             "optional": true,
1412             "field": "description",
1413             "description": ""
1414           },
1415           {
1416             "group": "Body",
1417             "type": "Boolean",
1418             "optional": true,
1419             "field": "status",
1420             "description": ""
1421           },
1422           {
1423             "group": "Body",
1424             "type": "Integer",
1425             "optional": true,
1426             "field": "timeout",
1427             "description": ""
1428           }
1429         ]
1430       }
1431     },
1432     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1433     "version": "0.0.0",
1434     "filename": "server/api/automation/index.js",
1435     "groupTitle": "Automations"
1436   },
1437   {
1438     "type": "delete",
1439     "url": "/api/automations/{id}",
1440     "title": "Deletes a Automation",
1441     "examples": [
1442       {
1443         "title": "Example usage:",
1444         "content": "curl https://{domain}/api/automations/{id} -v -u {name}:{password} -X DELETE",
1445         "type": "json"
1446       }
1447     ],
1448     "name": "DeleteAutomations",
1449     "group": "Automations",
1450     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1451     "version": "0.0.0",
1452     "filename": "server/api/automation/index.js",
1453     "groupTitle": "Automations"
1454   },
1455   {
1456     "type": "get",
1457     "url": "/api/automations",
1458     "title": "Gets a list of Automations",
1459     "examples": [
1460       {
1461         "title": "Example usage:",
1462         "content": "curl https://{domain}/api/automations -v -u {name}:{password}",
1463         "type": "json"
1464       }
1465     ],
1466     "name": "GetAutomations",
1467     "group": "Automations",
1468     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/automations?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/automations?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/automations?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/automations?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/automations?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1469     "version": "0.0.0",
1470     "filename": "server/api/automation/index.js",
1471     "groupTitle": "Automations"
1472   },
1473   {
1474     "type": "get",
1475     "url": "/api/automations/{id}",
1476     "title": "Gets a single Automation",
1477     "examples": [
1478       {
1479         "title": "Example usage:",
1480         "content": "curl https://{domain}/api/automations/{id} -v -u {name}:{password}",
1481         "type": "json"
1482       }
1483     ],
1484     "name": "ShowAutomations",
1485     "group": "Automations",
1486     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1487     "version": "0.0.0",
1488     "filename": "server/api/automation/index.js",
1489     "groupTitle": "Automations"
1490   },
1491   {
1492     "type": "post",
1493     "url": "/api/automations/{id}/actions",
1494     "title": "Creates new actions",
1495     "examples": [
1496       {
1497         "title": "Example usage:",
1498         "content": "curl https://{domain}/api/automations/{id}/actions -d '[{\"firstName\": \"John Doe\", \"email\": \"john.doe@xcally.com\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
1499         "type": "json"
1500       }
1501     ],
1502     "name": "addActions",
1503     "group": "Automations",
1504     "parameter": {
1505       "fields": {
1506         "Body": [
1507           {
1508             "group": "Body",
1509             "type": "Virtual",
1510             "optional": true,
1511             "field": "name",
1512             "description": ""
1513           },
1514           {
1515             "group": "Body",
1516             "type": "String",
1517             "optional": false,
1518             "field": "action",
1519             "description": "<p>Allowed values: contactManager, integration, motionbar, jscripty, urlForward, browser, bot, script</p>"
1520           },
1521           {
1522             "group": "Body",
1523             "type": "String",
1524             "optional": true,
1525             "field": "data1",
1526             "description": "<p>contactManager[ListId], integration[intName(zendesk)], motionbar[Popup(0),URL(1),WinApp(2)], urlForward[GET,POST], browser[TemplateId(0),URL(1)]</p>"
1527           },
1528           {
1529             "group": "Body",
1530             "type": "String",
1531             "optional": true,
1532             "field": "data2",
1533             "description": "<p>integration[AccountId], motionbar[TemplateId,URL,WinAppPath], urlForward[URL]</p>"
1534           },
1535           {
1536             "group": "Body",
1537             "type": "String",
1538             "optional": true,
1539             "field": "data3",
1540             "description": "<p>motionbar[NULL,NULL,WinAppArguments]</p>"
1541           },
1542           {
1543             "group": "Body",
1544             "type": "String",
1545             "optional": true,
1546             "field": "data4",
1547             "description": ""
1548           },
1549           {
1550             "group": "Body",
1551             "type": "String",
1552             "optional": true,
1553             "field": "data5",
1554             "description": ""
1555           },
1556           {
1557             "group": "Body",
1558             "type": "String",
1559             "optional": true,
1560             "field": "data6",
1561             "description": ""
1562           },
1563           {
1564             "group": "Body",
1565             "type": "Text",
1566             "optional": true,
1567             "field": "data7",
1568             "description": ""
1569           }
1570         ]
1571       }
1572     },
1573     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1574     "version": "0.0.0",
1575     "filename": "server/api/automation/index.js",
1576     "groupTitle": "Automations"
1577   },
1578   {
1579     "type": "post",
1580     "url": "/api/automations/{id}/conditions",
1581     "title": "Creates new conditions",
1582     "examples": [
1583       {
1584         "title": "Example usage:",
1585         "content": "curl https://{domain}/api/automations/{id}/conditions -d '[{\"firstName\": \"John Doe\", \"email\": \"john.doe@xcally.com\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
1586         "type": "json"
1587       }
1588     ],
1589     "name": "addConditions",
1590     "group": "Automations",
1591     "parameter": {
1592       "fields": {
1593         "Body": [
1594           {
1595             "group": "Body",
1596             "type": "Virtual",
1597             "optional": true,
1598             "field": "name",
1599             "description": ""
1600           },
1601           {
1602             "group": "Body",
1603             "type": "String",
1604             "optional": false,
1605             "field": "field",
1606             "description": ""
1607           },
1608           {
1609             "group": "Body",
1610             "type": "String",
1611             "optional": false,
1612             "field": "operator",
1613             "description": ""
1614           },
1615           {
1616             "group": "Body",
1617             "type": "String",
1618             "optional": false,
1619             "field": "value",
1620             "description": ""
1621           }
1622         ]
1623       }
1624     },
1625     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1626     "version": "0.0.0",
1627     "filename": "server/api/automation/index.js",
1628     "groupTitle": "Automations"
1629   },
1630   {
1631     "type": "get",
1632     "url": "/api/automations/{id}/actions",
1633     "title": "Gets Automation Actions",
1634     "examples": [
1635       {
1636         "title": "Example usage:",
1637         "content": "curl https://{domain}/api/automations/{id}/actions -v -u {name}:{password} -X GET",
1638         "type": "json"
1639       }
1640     ],
1641     "name": "getActions",
1642     "group": "Automations",
1643     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1644     "version": "0.0.0",
1645     "filename": "server/api/automation/index.js",
1646     "groupTitle": "Automations"
1647   },
1648   {
1649     "type": "get",
1650     "url": "/api/automations/{id}/conditions",
1651     "title": "Gets Automation Conditions",
1652     "examples": [
1653       {
1654         "title": "Example usage:",
1655         "content": "curl https://{domain}/api/automations/{id}/conditions -v -u {name}:{password} -X GET",
1656         "type": "json"
1657       }
1658     ],
1659     "name": "getConditions",
1660     "group": "Automations",
1661     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1662     "version": "0.0.0",
1663     "filename": "server/api/automation/index.js",
1664     "groupTitle": "Automations"
1665   },
1666   {
1667     "type": "put",
1668     "url": "/api/automations/{id}",
1669     "title": "Update an existing Automation",
1670     "examples": [
1671       {
1672         "title": "Example usage:",
1673         "content": "curl https://{domain}/api/automations/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1674         "type": "json"
1675       }
1676     ],
1677     "name": "updateAutomations",
1678     "group": "Automations",
1679     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1680     "version": "0.0.0",
1681     "filename": "server/api/automation/index.js",
1682     "groupTitle": "Automations"
1683   },
1684   {
1685     "type": "post",
1686     "url": "/api/canned_answers",
1687     "title": "Create a new canned answer",
1688     "examples": [
1689       {
1690         "title": "Example usage:",
1691         "content": "curl https://{domain}/api/canned_answers -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
1692         "type": "json"
1693       }
1694     ],
1695     "name": "Create",
1696     "group": "Canned_Answers",
1697     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1698     "version": "0.0.0",
1699     "filename": "server/api/cannedAnswer/index.js",
1700     "groupTitle": "Canned_Answers"
1701   },
1702   {
1703     "type": "delete",
1704     "url": "/api/canned_answers/{id}",
1705     "title": "Deletes a Canned Answer",
1706     "examples": [
1707       {
1708         "title": "Example usage:",
1709         "content": "curl https://{domain}/api/canned_answers/{id} -v -u {name}:{password} -X DELETE",
1710         "type": "json"
1711       }
1712     ],
1713     "name": "DeleteCanned_Answers",
1714     "group": "Canned_Answers",
1715     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1716     "version": "0.0.0",
1717     "filename": "server/api/cannedAnswer/index.js",
1718     "groupTitle": "Canned_Answers"
1719   },
1720   {
1721     "type": "get",
1722     "url": "/api/canned_answers",
1723     "title": "Gets a list of Canned Answers",
1724     "examples": [
1725       {
1726         "title": "Example usage:",
1727         "content": "curl https://{domain}/api/canned_answers -v -u {name}:{password}",
1728         "type": "json"
1729       }
1730     ],
1731     "name": "GetCanned_Answers",
1732     "group": "Canned_Answers",
1733     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/canned_answers?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/canned_answers?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/canned_answers?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/canned_answers?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/canned_answers?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1734     "version": "0.0.0",
1735     "filename": "server/api/cannedAnswer/index.js",
1736     "groupTitle": "Canned_Answers"
1737   },
1738   {
1739     "type": "get",
1740     "url": "/api/canned_answers/{id}",
1741     "title": "Gets a single Canned Answer",
1742     "examples": [
1743       {
1744         "title": "Example usage:",
1745         "content": "curl https://{domain}/api/canned_answers/{id} -v -u {name}:{password}",
1746         "type": "json"
1747       }
1748     ],
1749     "name": "ShowCanned_Answers",
1750     "group": "Canned_Answers",
1751     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1752     "version": "0.0.0",
1753     "filename": "server/api/cannedAnswer/index.js",
1754     "groupTitle": "Canned_Answers"
1755   },
1756   {
1757     "type": "put",
1758     "url": "/api/canned_answers/{id}",
1759     "title": "Update an existing Canned Answer",
1760     "examples": [
1761       {
1762         "title": "Example usage:",
1763         "content": "curl https://{domain}/api/canned_answers/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1764         "type": "json"
1765       }
1766     ],
1767     "name": "updateCanned_Answers",
1768     "group": "Canned_Answers",
1769     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1770     "version": "0.0.0",
1771     "filename": "server/api/cannedAnswer/index.js",
1772     "groupTitle": "Canned_Answers"
1773   },
1774   {
1775     "type": "get",
1776     "url": "/chat/internal/users",
1777     "title": "Gets Users Last Messages",
1778     "examples": [
1779       {
1780         "title": "Example usage:",
1781         "content": "curl https://{domain}/chat/internal/users -v -u {name}:{password}  -X GET",
1782         "type": "json"
1783       }
1784     ],
1785     "name": "getLastUsersMessages",
1786     "group": "ChatInternalMessage",
1787     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1788     "version": "0.0.0",
1789     "filename": "server/api/chatInternalMessage/index.js",
1790     "groupTitle": "ChatInternalMessage"
1791   },
1792   {
1793     "type": "delete",
1794     "url": "/api/chat/applications/{id}",
1795     "title": "Deletes a Application",
1796     "examples": [
1797       {
1798         "title": "Example usage:",
1799         "content": "curl https://{domain}/api/chat/applications/{id} -v -u {name}:{password} -X DELETE",
1800         "type": "json"
1801       }
1802     ],
1803     "name": "DeleteApplications",
1804     "group": "Chat_Applications",
1805     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1806     "version": "0.0.0",
1807     "filename": "server/api/chatApplication/index.js",
1808     "groupTitle": "Chat_Applications"
1809   },
1810   {
1811     "type": "get",
1812     "url": "/api/chat/applications/{id}",
1813     "title": "Gets a single Application",
1814     "examples": [
1815       {
1816         "title": "Example usage:",
1817         "content": "curl https://{domain}/api/chat/applications/{id} -v -u {name}:{password}",
1818         "type": "json"
1819       }
1820     ],
1821     "name": "ShowApplications",
1822     "group": "Chat_Applications",
1823     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1824     "version": "0.0.0",
1825     "filename": "server/api/chatApplication/index.js",
1826     "groupTitle": "Chat_Applications"
1827   },
1828   {
1829     "type": "put",
1830     "url": "/api/chat/applications/{id}",
1831     "title": "Update an existing Application",
1832     "examples": [
1833       {
1834         "title": "Example usage:",
1835         "content": "curl https://{domain}/api/chat/applications/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1836         "type": "json"
1837       }
1838     ],
1839     "name": "updateApplications",
1840     "group": "Chat_Applications",
1841     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1842     "version": "0.0.0",
1843     "filename": "server/api/chatApplication/index.js",
1844     "groupTitle": "Chat_Applications"
1845   },
1846   {
1847     "type": "post",
1848     "url": "/api/chat/groups",
1849     "title": "Creates a new Group",
1850     "examples": [
1851       {
1852         "title": "Example usage:",
1853         "content": "curl https://{domain}/api/chat/groups -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1854         "type": "json"
1855       }
1856     ],
1857     "name": "CreateGroups",
1858     "group": "Chat_Groups",
1859     "parameter": {
1860       "fields": {
1861         "Body": [
1862           {
1863             "group": "Body",
1864             "type": "String",
1865             "optional": false,
1866             "field": "name",
1867             "description": ""
1868           },
1869           {
1870             "group": "Body",
1871             "type": "String",
1872             "optional": true,
1873             "field": "description",
1874             "description": ""
1875           },
1876           {
1877             "group": "Body",
1878             "type": "Boolean",
1879             "optional": true,
1880             "field": "write",
1881             "description": ""
1882           }
1883         ]
1884       }
1885     },
1886     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1887     "version": "0.0.0",
1888     "filename": "server/api/chatGroup/index.js",
1889     "groupTitle": "Chat_Groups"
1890   },
1891   {
1892     "type": "delete",
1893     "url": "/api/chat/groups/{id}",
1894     "title": "Deletes a Group",
1895     "examples": [
1896       {
1897         "title": "Example usage:",
1898         "content": "curl https://{domain}/api/chat/groups/{id} -v -u {name}:{password} -X DELETE",
1899         "type": "json"
1900       }
1901     ],
1902     "name": "DeleteGroups",
1903     "group": "Chat_Groups",
1904     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1905     "version": "0.0.0",
1906     "filename": "server/api/chatGroup/index.js",
1907     "groupTitle": "Chat_Groups"
1908   },
1909   {
1910     "type": "get",
1911     "url": "/api/chat/groups/describe",
1912     "title": "Gets table info about Groups",
1913     "examples": [
1914       {
1915         "title": "Example usage:",
1916         "content": "curl https://{domain}/api/chat/groups/describe -v -u {name}:{password}",
1917         "type": "json"
1918       }
1919     ],
1920     "name": "DescribeGroups",
1921     "group": "Chat_Groups",
1922     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1923     "version": "0.0.0",
1924     "filename": "server/api/chatGroup/index.js",
1925     "groupTitle": "Chat_Groups"
1926   },
1927   {
1928     "type": "get",
1929     "url": "/api/chat/groups",
1930     "title": "Gets a list of Groups",
1931     "examples": [
1932       {
1933         "title": "Example usage:",
1934         "content": "curl https://{domain}/api/chat/groups -v -u {name}:{password}",
1935         "type": "json"
1936       }
1937     ],
1938     "name": "GetGroups",
1939     "group": "Chat_Groups",
1940     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/groups?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/groups?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/groups?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/groups?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/groups?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1941     "version": "0.0.0",
1942     "filename": "server/api/chatGroup/index.js",
1943     "groupTitle": "Chat_Groups"
1944   },
1945   {
1946     "type": "delete",
1947     "url": "/api/chat/groups/{id}/members",
1948     "title": "Removes members from a group",
1949     "examples": [
1950       {
1951         "title": "Example usage:",
1952         "content": "curl https://{domain}/api/chat/groups/{id}/members?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
1953         "type": "json"
1954       }
1955     ],
1956     "name": "RemoveMembers",
1957     "group": "Chat_Groups",
1958     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1959     "version": "0.0.0",
1960     "filename": "server/api/chatGroup/index.js",
1961     "groupTitle": "Chat_Groups"
1962   },
1963   {
1964     "type": "get",
1965     "url": "/api/chat/groups/{id}",
1966     "title": "Gets a single Group",
1967     "examples": [
1968       {
1969         "title": "Example usage:",
1970         "content": "curl https://{domain}/api/chat/groups/{id} -v -u {name}:{password}",
1971         "type": "json"
1972       }
1973     ],
1974     "name": "ShowGroups",
1975     "group": "Chat_Groups",
1976     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1977     "version": "0.0.0",
1978     "filename": "server/api/chatGroup/index.js",
1979     "groupTitle": "Chat_Groups"
1980   },
1981   {
1982     "type": "post",
1983     "url": "/api/chat/groups/{id}/members",
1984     "title": "Add members to chat group",
1985     "examples": [
1986       {
1987         "title": "Example usage:",
1988         "content": "curl https://{domain}/api/chat/groups/{id}/members -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
1989         "type": "json"
1990       }
1991     ],
1992     "name": "addMembers",
1993     "group": "Chat_Groups",
1994     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1995     "version": "0.0.0",
1996     "filename": "server/api/chatGroup/index.js",
1997     "groupTitle": "Chat_Groups"
1998   },
1999   {
2000     "type": "post",
2001     "url": "/api/chat/groups/{id}/messages",
2002     "title": "Creates a new group message",
2003     "examples": [
2004       {
2005         "title": "Example usage:",
2006         "content": "curl https://{domain}/api/chat/groups/{id}/messages -d '{\"body\": \"Hi operator!\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2007         "type": "json"
2008       }
2009     ],
2010     "name": "addMessage",
2011     "group": "Chat_Groups",
2012     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2013     "version": "0.0.0",
2014     "filename": "server/api/chatGroup/index.js",
2015     "groupTitle": "Chat_Groups"
2016   },
2017   {
2018     "type": "get",
2019     "url": "/api/chat/groups/{id}/members",
2020     "title": "Gets Members",
2021     "examples": [
2022       {
2023         "title": "Example usage:",
2024         "content": "curl https://{domain}/api/chat/groups/{id}/members -v -u {name}:{password} -X GET",
2025         "type": "json"
2026       }
2027     ],
2028     "name": "getMembers",
2029     "group": "Chat_Groups",
2030     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2031     "version": "0.0.0",
2032     "filename": "server/api/chatGroup/index.js",
2033     "groupTitle": "Chat_Groups"
2034   },
2035   {
2036     "type": "get",
2037     "url": "/api/chat/groups/{id}/messages",
2038     "title": "Gets Messages",
2039     "examples": [
2040       {
2041         "title": "Example usage:",
2042         "content": "curl https://{domain}/api/chat/groups/{id}/messages -v -u {name}:{password} -X GET",
2043         "type": "json"
2044       }
2045     ],
2046     "name": "getMessages",
2047     "group": "Chat_Groups",
2048     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2049     "version": "0.0.0",
2050     "filename": "server/api/chatGroup/index.js",
2051     "groupTitle": "Chat_Groups"
2052   },
2053   {
2054     "type": "get",
2055     "url": "/api/chat/groups/{id}/unread",
2056     "title": "Get unread chat group messages",
2057     "examples": [
2058       {
2059         "title": "Example usage:",
2060         "content": "curl https://{domain}/api/chat/groups/{id}/unread -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
2061         "type": "json"
2062       }
2063     ],
2064     "name": "getUread",
2065     "group": "Chat_Groups",
2066     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2067     "version": "0.0.0",
2068     "filename": "server/api/chatGroup/index.js",
2069     "groupTitle": "Chat_Groups"
2070   },
2071   {
2072     "type": "put",
2073     "url": "/api/chat/groups/{id}",
2074     "title": "Update an existing Group",
2075     "examples": [
2076       {
2077         "title": "Example usage:",
2078         "content": "curl https://{domain}/api/chat/groups/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
2079         "type": "json"
2080       }
2081     ],
2082     "name": "updateGroups",
2083     "group": "Chat_Groups",
2084     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2085     "version": "0.0.0",
2086     "filename": "server/api/chatGroup/index.js",
2087     "groupTitle": "Chat_Groups"
2088   },
2089   {
2090     "type": "post",
2091     "url": "/api/chat/interactions/{id}/tags",
2092     "title": "Add tags to the interaction",
2093     "examples": [
2094       {
2095         "title": "Example usage:",
2096         "content": "curl https://{domain}/api/chat/interaction/{id}/tags -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2097         "type": "json"
2098       }
2099     ],
2100     "name": "AddTags",
2101     "group": "Chat_Interactions",
2102     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2103     "version": "0.0.0",
2104     "filename": "server/api/chatInteraction/index.js",
2105     "groupTitle": "Chat_Interactions"
2106   },
2107   {
2108     "type": "post",
2109     "url": "/api/chat/interactions",
2110     "title": "Creates a new Interaction",
2111     "examples": [
2112       {
2113         "title": "Example usage:",
2114         "content": "curl https://{domain}/api/chat/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2115         "type": "json"
2116       }
2117     ],
2118     "name": "CreateInteractions",
2119     "group": "Chat_Interactions",
2120     "parameter": {
2121       "fields": {
2122         "Body": [
2123           {
2124             "group": "Body",
2125             "type": "Boolean",
2126             "optional": true,
2127             "field": "closed",
2128             "description": ""
2129           },
2130           {
2131             "group": "Body",
2132             "type": "Integer",
2133             "optional": true,
2134             "field": "ratingValue",
2135             "description": ""
2136           },
2137           {
2138             "group": "Body",
2139             "type": "String",
2140             "allowedValues": [
2141               "\"star\"",
2142               "\"thumb\""
2143             ],
2144             "optional": true,
2145             "field": "ratingType",
2146             "description": ""
2147           },
2148           {
2149             "group": "Body",
2150             "type": "Text",
2151             "optional": true,
2152             "field": "ratingMessage",
2153             "description": ""
2154           },
2155           {
2156             "group": "Body",
2157             "type": "Text",
2158             "optional": true,
2159             "field": "pathTranscript",
2160             "description": ""
2161           },
2162           {
2163             "group": "Body",
2164             "type": "String",
2165             "optional": true,
2166             "field": "mailTranscript",
2167             "description": ""
2168           },
2169           {
2170             "group": "Body",
2171             "type": "String",
2172             "optional": true,
2173             "field": "closedAt",
2174             "description": ""
2175           },
2176           {
2177             "group": "Body",
2178             "type": "String",
2179             "optional": true,
2180             "field": "disposition",
2181             "description": ""
2182           },
2183           {
2184             "group": "Body",
2185             "type": "String",
2186             "optional": true,
2187             "field": "secondDisposition",
2188             "description": ""
2189           },
2190           {
2191             "group": "Body",
2192             "type": "String",
2193             "optional": true,
2194             "field": "thirdDisposition",
2195             "description": ""
2196           },
2197           {
2198             "group": "Body",
2199             "type": "String",
2200             "optional": true,
2201             "field": "note",
2202             "description": ""
2203           },
2204           {
2205             "group": "Body",
2206             "type": "String",
2207             "optional": true,
2208             "field": "browserName",
2209             "description": ""
2210           },
2211           {
2212             "group": "Body",
2213             "type": "String",
2214             "optional": true,
2215             "field": "browserVersion",
2216             "description": ""
2217           },
2218           {
2219             "group": "Body",
2220             "type": "String",
2221             "optional": true,
2222             "field": "osName",
2223             "description": ""
2224           },
2225           {
2226             "group": "Body",
2227             "type": "String",
2228             "optional": true,
2229             "field": "osVersion",
2230             "description": ""
2231           },
2232           {
2233             "group": "Body",
2234             "type": "String",
2235             "optional": true,
2236             "field": "deviceModel",
2237             "description": ""
2238           },
2239           {
2240             "group": "Body",
2241             "type": "String",
2242             "optional": true,
2243             "field": "deviceVendor",
2244             "description": ""
2245           },
2246           {
2247             "group": "Body",
2248             "type": "String",
2249             "optional": true,
2250             "field": "deviceType",
2251             "description": ""
2252           },
2253           {
2254             "group": "Body",
2255             "type": "Text",
2256             "optional": true,
2257             "field": "referer",
2258             "description": ""
2259           },
2260           {
2261             "group": "Body",
2262             "type": "String",
2263             "optional": true,
2264             "field": "customerIp",
2265             "description": ""
2266           },
2267           {
2268             "group": "Body",
2269             "type": "Text",
2270             "optional": true,
2271             "field": "formData",
2272             "description": ""
2273           },
2274           {
2275             "group": "Body",
2276             "type": "String",
2277             "optional": true,
2278             "field": "read1stAt",
2279             "description": ""
2280           },
2281           {
2282             "group": "Body",
2283             "type": "String",
2284             "optional": true,
2285             "field": "lastMsgAt",
2286             "description": ""
2287           },
2288           {
2289             "group": "Body",
2290             "type": "String",
2291             "allowedValues": [
2292               "\"in\"",
2293               "\"out\""
2294             ],
2295             "optional": false,
2296             "field": "lastMsgDirection",
2297             "description": ""
2298           },
2299           {
2300             "group": "Body",
2301             "type": "String",
2302             "optional": true,
2303             "field": "closeReason",
2304             "description": ""
2305           },
2306           {
2307             "group": "Body",
2308             "type": "String",
2309             "optional": true,
2310             "field": "customerPort",
2311             "description": ""
2312           },
2313           {
2314             "group": "Body",
2315             "type": "Text",
2316             "optional": true,
2317             "field": "vidaooSessionId",
2318             "description": ""
2319           }
2320         ]
2321       }
2322     },
2323     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2324     "version": "0.0.0",
2325     "filename": "server/api/chatInteraction/index.js",
2326     "groupTitle": "Chat_Interactions"
2327   },
2328   {
2329     "type": "delete",
2330     "url": "/api/chat/interactions/{id}",
2331     "title": "Deletes a Interaction",
2332     "examples": [
2333       {
2334         "title": "Example usage:",
2335         "content": "curl https://{domain}/api/chat/interactions/{id} -v -u {name}:{password} -X DELETE",
2336         "type": "json"
2337       }
2338     ],
2339     "name": "DeleteInteractions",
2340     "group": "Chat_Interactions",
2341     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2342     "version": "0.0.0",
2343     "filename": "server/api/chatInteraction/index.js",
2344     "groupTitle": "Chat_Interactions"
2345   },
2346   {
2347     "type": "get",
2348     "url": "/api/chat/interactions/describe",
2349     "title": "Gets table info about Interactions",
2350     "examples": [
2351       {
2352         "title": "Example usage:",
2353         "content": "curl https://{domain}/api/chat/interactions/describe -v -u {name}:{password}",
2354         "type": "json"
2355       }
2356     ],
2357     "name": "DescribeInteractions",
2358     "group": "Chat_Interactions",
2359     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2360     "version": "0.0.0",
2361     "filename": "server/api/chatInteraction/index.js",
2362     "groupTitle": "Chat_Interactions"
2363   },
2364   {
2365     "type": "get",
2366     "url": "/api/chat/interactions",
2367     "title": "Gets a list of Interactions",
2368     "examples": [
2369       {
2370         "title": "Example usage:",
2371         "content": "curl https://{domain}/api/chat/interactions -v -u {name}:{password}",
2372         "type": "json"
2373       }
2374     ],
2375     "name": "GetInteractions",
2376     "group": "Chat_Interactions",
2377     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/interactions?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/interactions?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/interactions?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/interactions?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/interactions?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
2378     "version": "0.0.0",
2379     "filename": "server/api/chatInteraction/index.js",
2380     "groupTitle": "Chat_Interactions"
2381   },
2382   {
2383     "type": "delete",
2384     "url": "/api/chat/interactions/{id}/tags",
2385     "title": "Removes tags from interaction",
2386     "examples": [
2387       {
2388         "title": "Example usage:",
2389         "content": "curl https://{domain}/api/chat/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
2390         "type": "json"
2391       }
2392     ],
2393     "name": "RemoveTags",
2394     "group": "Chat_Interactions",
2395     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2396     "version": "0.0.0",
2397     "filename": "server/api/chatInteraction/index.js",
2398     "groupTitle": "Chat_Interactions"
2399   },
2400   {
2401     "type": "get",
2402     "url": "/api/chat/interactions/{id}",
2403     "title": "Gets a single Interaction",
2404     "examples": [
2405       {
2406         "title": "Example usage:",
2407         "content": "curl https://{domain}/api/chat/interactions/{id} -v -u {name}:{password}",
2408         "type": "json"
2409       }
2410     ],
2411     "name": "ShowInteractions",
2412     "group": "Chat_Interactions",
2413     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2414     "version": "0.0.0",
2415     "filename": "server/api/chatInteraction/index.js",
2416     "groupTitle": "Chat_Interactions"
2417   },
2418   {
2419     "type": "put",
2420     "url": "/api/chat/interactions/{id}/abandon",
2421     "title": "Abandon interaction",
2422     "examples": [
2423       {
2424         "title": "Example usage:",
2425         "content": "curl https://{domain}/api/chat/interactions/{id}/abandon -d '{\"channel\": \"chat\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
2426         "type": "json"
2427       }
2428     ],
2429     "name": "abandon",
2430     "group": "Chat_Interactions",
2431     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <p>This API is used to set as abandon an interaction and stop the routing.</p>",
2432     "version": "0.0.0",
2433     "filename": "server/api/chatInteraction/index.js",
2434     "groupTitle": "Chat_Interactions"
2435   },
2436   {
2437     "type": "put",
2438     "url": "/api/chat/interactions/{id}/close",
2439     "title": "Close Interaction",
2440     "examples": [
2441       {
2442         "title": "Example usage:",
2443         "content": "curl https://{domain}/api/chat/interactions/{id}/close -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2444         "type": "json"
2445       }
2446     ],
2447     "name": "addMessage",
2448     "group": "Chat_Interactions",
2449     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2450     "version": "0.0.0",
2451     "filename": "server/api/chatInteraction/index.js",
2452     "groupTitle": "Chat_Interactions"
2453   },
2454   {
2455     "type": "post",
2456     "url": "/api/chat/interactions/{id}/messages",
2457     "title": "Creates new messages",
2458     "examples": [
2459       {
2460         "title": "Example usage:",
2461         "content": "curl https://{domain}/api/chat/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2462         "type": "json"
2463       }
2464     ],
2465     "name": "addMessage",
2466     "group": "Chat_Interactions",
2467     "parameter": {
2468       "fields": {
2469         "Body": [
2470           {
2471             "group": "Body",
2472             "type": "Text",
2473             "optional": false,
2474             "field": "body",
2475             "description": ""
2476           },
2477           {
2478             "group": "Body",
2479             "type": "Boolean",
2480             "optional": true,
2481             "field": "read",
2482             "description": ""
2483           },
2484           {
2485             "group": "Body",
2486             "type": "Boolean",
2487             "optional": true,
2488             "field": "secret",
2489             "description": ""
2490           },
2491           {
2492             "group": "Body",
2493             "type": "String",
2494             "allowedValues": [
2495               "\"in\"",
2496               "\"out\""
2497             ],
2498             "optional": false,
2499             "field": "direction",
2500             "description": ""
2501           },
2502           {
2503             "group": "Body",
2504             "type": "String",
2505             "optional": true,
2506             "field": "readAt",
2507             "description": ""
2508           },
2509           {
2510             "group": "Body",
2511             "type": "String",
2512             "optional": true,
2513             "field": "providerName",
2514             "description": ""
2515           },
2516           {
2517             "group": "Body",
2518             "type": "Text",
2519             "optional": true,
2520             "field": "providerResponse",
2521             "description": ""
2522           }
2523         ]
2524       }
2525     },
2526     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2527     "version": "0.0.0",
2528     "filename": "server/api/chatInteraction/index.js",
2529     "groupTitle": "Chat_Interactions"
2530   },
2531   {
2532     "type": "post",
2533     "url": "/api/chat/interactions/{id}/attachment_upload",
2534     "title": "Add attachment",
2535     "examples": [
2536       {
2537         "title": "Example usage:",
2538         "content": "curl https://{domain}/api/chat/interactions/{id}/attachment_upload -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
2539         "type": "json"
2540       }
2541     ],
2542     "name": "attachmentUpload",
2543     "group": "Chat_Interactions",
2544     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2545     "version": "0.0.0",
2546     "filename": "server/api/chatInteraction/index.js",
2547     "groupTitle": "Chat_Interactions"
2548   },
2549   {
2550     "type": "post",
2551     "url": "/api/chat/interactions/{id}/vidaoo",
2552     "title": "Create Vidaoo Session",
2553     "examples": [
2554       {
2555         "title": "Example usage:",
2556         "content": "curl https://{domain}/api/chat/interactions/{id}/vidaoo  -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2557         "type": "json"
2558       }
2559     ],
2560     "name": "createVidaooSession",
2561     "group": "Chat_Interactions",
2562     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2563     "version": "0.0.0",
2564     "filename": "server/api/chatInteraction/index.js",
2565     "groupTitle": "Chat_Interactions"
2566   },
2567   {
2568     "type": "put",
2569     "url": "/api/chat/interactions/{id}/custom_update",
2570     "title": "Update interaction",
2571     "examples": [
2572       {
2573         "title": "Example usage:",
2574         "content": "curl https://{domain}/api/chat/interactions/{id}/custom_update -d '{\"channel\": \"chat\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
2575         "type": "json"
2576       }
2577     ],
2578     "name": "customUpdate",
2579     "group": "Chat_Interactions",
2580     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <p>This API is used to update an interaction.</p>",
2581     "version": "0.0.0",
2582     "filename": "server/api/chatInteraction/index.js",
2583     "groupTitle": "Chat_Interactions"
2584   },
2585   {
2586     "type": "get",
2587     "url": "/api/chat/interactions/{id}/download",
2588     "title": "Gets interaction",
2589     "examples": [
2590       {
2591         "title": "Example usage:",
2592         "content": "curl https://{domain}/api/chat/interactions/{id}/download -v -u {name}:{password} -X GET",
2593         "type": "json"
2594       }
2595     ],
2596     "name": "download",
2597     "group": "Chat_Interactions",
2598     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2599     "version": "0.0.0",
2600     "filename": "server/api/chatInteraction/index.js",
2601     "groupTitle": "Chat_Interactions"
2602   },
2603   {
2604     "type": "get",
2605     "url": "/api/chat/interactions/{id}/messages",
2606     "title": "Gets interaction messages",
2607     "examples": [
2608       {
2609         "title": "Example usage:",
2610         "content": "curl https://{domain}/api/chat/interactions/{id}/messages -v -u {name}:{password} -X GET",
2611         "type": "json"
2612       }
2613     ],
2614     "name": "getMessages",
2615     "group": "Chat_Interactions",
2616     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2617     "version": "0.0.0",
2618     "filename": "server/api/chatInteraction/index.js",
2619     "groupTitle": "Chat_Interactions"
2620   },
2621   {
2622     "type": "get",
2623     "url": "/api/chat/interactions/{id}/my_messages",
2624     "title": "Gets interaction messages",
2625     "examples": [
2626       {
2627         "title": "Example usage:",
2628         "content": "curl https://{domain}/api/chat/interactions/{id}/my_messages -v -u {name}:{password} -X GET",
2629         "type": "json"
2630       }
2631     ],
2632     "name": "getMyMessages",
2633     "group": "Chat_Interactions",
2634     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2635     "version": "0.0.0",
2636     "filename": "server/api/chatInteraction/index.js",
2637     "groupTitle": "Chat_Interactions"
2638   },
2639   {
2640     "type": "put",
2641     "url": "/api/chat/interactions/{id}",
2642     "title": "Update an existing Interaction",
2643     "examples": [
2644       {
2645         "title": "Example usage:",
2646         "content": "curl https://{domain}/api/chat/interactions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
2647         "type": "json"
2648       }
2649     ],
2650     "name": "updateInteractions",
2651     "group": "Chat_Interactions",
2652     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2653     "version": "0.0.0",
2654     "filename": "server/api/chatInteraction/index.js",
2655     "groupTitle": "Chat_Interactions"
2656   },
2657   {
2658     "type": "post",
2659     "url": "/api/chat/internal/messages",
2660     "title": "Creates a new Message",
2661     "examples": [
2662       {
2663         "title": "Example usage:",
2664         "content": "curl https://{domain}/api/chat/internal/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2665         "type": "json"
2666       }
2667     ],
2668     "name": "CreateMessages",
2669     "group": "Chat_Internal_Messages",
2670     "parameter": {
2671       "fields": {
2672         "Body": [
2673           {
2674             "group": "Body",
2675             "type": "Text",
2676             "optional": false,
2677             "field": "body",
2678             "description": ""
2679           },
2680           {
2681             "group": "Body",
2682             "type": "Boolean",
2683             "optional": true,
2684             "field": "read",
2685             "description": ""
2686           },
2687           {
2688             "group": "Body",
2689             "type": "Integer",
2690             "optional": true,
2691             "field": "ChatInternalMessageId",
2692             "description": ""
2693           }
2694         ]
2695       }
2696     },
2697     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2698     "version": "0.0.0",
2699     "filename": "server/api/chatInternalMessage/index.js",
2700     "groupTitle": "Chat_Internal_Messages"
2701   },
2702   {
2703     "type": "delete",
2704     "url": "/api/chat/internal/messages/{id}",
2705     "title": "Deletes a Message",
2706     "examples": [
2707       {
2708         "title": "Example usage:",
2709         "content": "curl https://{domain}/api/chat/internal/messages/{id} -v -u {name}:{password} -X DELETE",
2710         "type": "json"
2711       }
2712     ],
2713     "name": "DeleteMessages",
2714     "group": "Chat_Internal_Messages",
2715     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2716     "version": "0.0.0",
2717     "filename": "server/api/chatInternalMessage/index.js",
2718     "groupTitle": "Chat_Internal_Messages"
2719   },
2720   {
2721     "type": "get",
2722     "url": "/api/chat/internal/messages/describe",
2723     "title": "Gets table info about Messages",
2724     "examples": [
2725       {
2726         "title": "Example usage:",
2727         "content": "curl https://{domain}/api/chat/internal/messages/describe -v -u {name}:{password}",
2728         "type": "json"
2729       }
2730     ],
2731     "name": "DescribeMessages",
2732     "group": "Chat_Internal_Messages",
2733     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2734     "version": "0.0.0",
2735     "filename": "server/api/chatInternalMessage/index.js",
2736     "groupTitle": "Chat_Internal_Messages"
2737   },
2738   {
2739     "type": "get",
2740     "url": "/api/chat/internal/messages",
2741     "title": "Gets a list of Messages",
2742     "examples": [
2743       {
2744         "title": "Example usage:",
2745         "content": "curl https://{domain}/api/chat/internal/messages -v -u {name}:{password}",
2746         "type": "json"
2747       }
2748     ],
2749     "name": "GetMessages",
2750     "group": "Chat_Internal_Messages",
2751     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/internal/messages?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/internal/messages?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/internal/messages?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/internal/messages?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/internal/messages?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
2752     "version": "0.0.0",
2753     "filename": "server/api/chatInternalMessage/index.js",
2754     "groupTitle": "Chat_Internal_Messages"
2755   },
2756   {
2757     "type": "get",
2758     "url": "/api/chat/internal/messages/{id}",
2759     "title": "Gets a single Message",
2760     "examples": [
2761       {
2762         "title": "Example usage:",
2763         "content": "curl https://{domain}/api/chat/internal/messages/{id} -v -u {name}:{password}",
2764         "type": "json"
2765       }
2766     ],
2767     "name": "ShowMessages",
2768     "group": "Chat_Internal_Messages",
2769     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2770     "version": "0.0.0",
2771     "filename": "server/api/chatInternalMessage/index.js",
2772     "groupTitle": "Chat_Internal_Messages"
2773   },
2774   {
2775     "type": "put",
2776     "url": "/api/chat/internal/messages/{id}",
2777     "title": "Update an existing Message",
2778     "examples": [
2779       {
2780         "title": "Example usage:",
2781         "content": "curl https://{domain}/api/chat/internal/messages/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
2782         "type": "json"
2783       }
2784     ],
2785     "name": "updateMessages",
2786     "group": "Chat_Internal_Messages",
2787     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2788     "version": "0.0.0",
2789     "filename": "server/api/chatInternalMessage/index.js",
2790     "groupTitle": "Chat_Internal_Messages"
2791   },
2792   {
2793     "type": "post",
2794     "url": "/api/chat/messages",
2795     "title": "Creates a new Message",
2796     "examples": [
2797       {
2798         "title": "Example usage:",
2799         "content": "curl https://{domain}/api/chat/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2800         "type": "json"
2801       }
2802     ],
2803     "name": "CreateMessages",
2804     "group": "Chat_Messages",
2805     "parameter": {
2806       "fields": {
2807         "Body": [
2808           {
2809             "group": "Body",
2810             "type": "Text",
2811             "optional": false,
2812             "field": "body",
2813             "description": ""
2814           },
2815           {
2816             "group": "Body",
2817             "type": "Boolean",
2818             "optional": true,
2819             "field": "read",
2820             "description": ""
2821           },
2822           {
2823             "group": "Body",
2824             "type": "Boolean",
2825             "optional": true,
2826             "field": "secret",
2827             "description": ""
2828           },
2829           {
2830             "group": "Body",
2831             "type": "String",
2832             "allowedValues": [
2833               "\"in\"",
2834               "\"out\""
2835             ],
2836             "optional": false,
2837             "field": "direction",
2838             "description": ""
2839           },
2840           {
2841             "group": "Body",
2842             "type": "String",
2843             "optional": true,
2844             "field": "readAt",
2845             "description": ""
2846           },
2847           {
2848             "group": "Body",
2849             "type": "String",
2850             "optional": true,
2851             "field": "providerName",
2852             "description": ""
2853           },
2854           {
2855             "group": "Body",
2856             "type": "Text",
2857             "optional": true,
2858             "field": "providerResponse",
2859             "description": ""
2860           }
2861         ]
2862       }
2863     },
2864     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2865     "version": "0.0.0",
2866     "filename": "server/api/chatMessage/index.js",
2867     "groupTitle": "Chat_Messages"
2868   },
2869   {
2870     "type": "delete",
2871     "url": "/api/chat/messages/{id}",
2872     "title": "Deletes a Message",
2873     "examples": [
2874       {
2875         "title": "Example usage:",
2876         "content": "curl https://{domain}/api/chat/messages/{id} -v -u {name}:{password} -X DELETE",
2877         "type": "json"
2878       }
2879     ],
2880     "name": "DeleteMessages",
2881     "group": "Chat_Messages",
2882     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2883     "version": "0.0.0",
2884     "filename": "server/api/chatMessage/index.js",
2885     "groupTitle": "Chat_Messages"
2886   },
2887   {
2888     "type": "get",
2889     "url": "/api/chat/messages/describe",
2890     "title": "Gets table info about Messages",
2891     "examples": [
2892       {
2893         "title": "Example usage:",
2894         "content": "curl https://{domain}/api/chat/messages/describe -v -u {name}:{password}",
2895         "type": "json"
2896       }
2897     ],
2898     "name": "DescribeMessages",
2899     "group": "Chat_Messages",
2900     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2901     "version": "0.0.0",
2902     "filename": "server/api/chatMessage/index.js",
2903     "groupTitle": "Chat_Messages"
2904   },
2905   {
2906     "type": "get",
2907     "url": "/api/chat/messages",
2908     "title": "Gets a list of Messages",
2909     "examples": [
2910       {
2911         "title": "Example usage:",
2912         "content": "curl https://{domain}/api/chat/messages -v -u {name}:{password}",
2913         "type": "json"
2914       }
2915     ],
2916     "name": "GetMessages",
2917     "group": "Chat_Messages",
2918     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/messages?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/messages?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/messages?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/messages?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/messages?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
2919     "version": "0.0.0",
2920     "filename": "server/api/chatMessage/index.js",
2921     "groupTitle": "Chat_Messages"
2922   },
2923   {
2924     "type": "get",
2925     "url": "/api/chat/messages/{id}",
2926     "title": "Gets a single Message",
2927     "examples": [
2928       {
2929         "title": "Example usage:",
2930         "content": "curl https://{domain}/api/chat/messages/{id} -v -u {name}:{password}",
2931         "type": "json"
2932       }
2933     ],
2934     "name": "ShowMessages",
2935     "group": "Chat_Messages",
2936     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2937     "version": "0.0.0",
2938     "filename": "server/api/chatMessage/index.js",
2939     "groupTitle": "Chat_Messages"
2940   },
2941   {
2942     "type": "put",
2943     "url": "/api/chat/messages/{id}",
2944     "title": "Update an existing Message",
2945     "examples": [
2946       {
2947         "title": "Example usage:",
2948         "content": "curl https://{domain}/api/chat/messages/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
2949         "type": "json"
2950       }
2951     ],
2952     "name": "updateMessages",
2953     "group": "Chat_Messages",
2954     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2955     "version": "0.0.0",
2956     "filename": "server/api/chatMessage/index.js",
2957     "groupTitle": "Chat_Messages"
2958   },
2959   {
2960     "type": "post",
2961     "url": "/api/chat/offline_messages",
2962     "title": "Creates a new OfflineMessage",
2963     "examples": [
2964       {
2965         "title": "Example usage:",
2966         "content": "curl https://{domain}/api/chat/offline_messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2967         "type": "json"
2968       }
2969     ],
2970     "name": "CreateOfflineMessages",
2971     "group": "Chat_Offline_Messages",
2972     "parameter": {
2973       "fields": {
2974         "Body": [
2975           {
2976             "group": "Body",
2977             "type": "Text",
2978             "optional": false,
2979             "field": "body",
2980             "description": ""
2981           }
2982         ]
2983       }
2984     },
2985     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2986     "version": "0.0.0",
2987     "filename": "server/api/chatOfflineMessage/index.js",
2988     "groupTitle": "Chat_Offline_Messages"
2989   },
2990   {
2991     "type": "delete",
2992     "url": "/api/chat/offline_messages/{id}",
2993     "title": "Deletes a OfflineMessage",
2994     "examples": [
2995       {
2996         "title": "Example usage:",
2997         "content": "curl https://{domain}/api/chat/offline_messages/{id} -v -u {name}:{password} -X DELETE",
2998         "type": "json"
2999       }
3000     ],
3001     "name": "DeleteOfflineMessages",
3002     "group": "Chat_Offline_Messages",
3003     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3004     "version": "0.0.0",
3005     "filename": "server/api/chatOfflineMessage/index.js",
3006     "groupTitle": "Chat_Offline_Messages"
3007   },
3008   {
3009     "type": "get",
3010     "url": "/api/chat/offline_messages/describe",
3011     "title": "Gets table info about OfflineMessages",
3012     "examples": [
3013       {
3014         "title": "Example usage:",
3015         "content": "curl https://{domain}/api/chat/offline_messages/describe -v -u {name}:{password}",
3016         "type": "json"
3017       }
3018     ],
3019     "name": "DescribeOfflineMessages",
3020     "group": "Chat_Offline_Messages",
3021     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3022     "version": "0.0.0",
3023     "filename": "server/api/chatOfflineMessage/index.js",
3024     "groupTitle": "Chat_Offline_Messages"
3025   },
3026   {
3027     "type": "get",
3028     "url": "/api/chat/offline_messages",
3029     "title": "Gets a list of OfflineMessages",
3030     "examples": [
3031       {
3032         "title": "Example usage:",
3033         "content": "curl https://{domain}/api/chat/offline_messages -v -u {name}:{password}",
3034         "type": "json"
3035       }
3036     ],
3037     "name": "GetOfflineMessages",
3038     "group": "Chat_Offline_Messages",
3039     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/offline_messages?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/offline_messages?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/offline_messages?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/offline_messages?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/offline_messages?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
3040     "version": "0.0.0",
3041     "filename": "server/api/chatOfflineMessage/index.js",
3042     "groupTitle": "Chat_Offline_Messages"
3043   },
3044   {
3045     "type": "get",
3046     "url": "/api/chat/offline_messages/{id}",
3047     "title": "Gets a single OfflineMessage",
3048     "examples": [
3049       {
3050         "title": "Example usage:",
3051         "content": "curl https://{domain}/api/chat/offline_messages/{id} -v -u {name}:{password}",
3052         "type": "json"
3053       }
3054     ],
3055     "name": "ShowOfflineMessages",
3056     "group": "Chat_Offline_Messages",
3057     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3058     "version": "0.0.0",
3059     "filename": "server/api/chatOfflineMessage/index.js",
3060     "groupTitle": "Chat_Offline_Messages"
3061   },
3062   {
3063     "type": "put",
3064     "url": "/api/chat/offline_messages/{id}",
3065     "title": "Update an existing OfflineMessage",
3066     "examples": [
3067       {
3068         "title": "Example usage:",
3069         "content": "curl https://{domain}/api/chat/offline_messages/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
3070         "type": "json"
3071       }
3072     ],
3073     "name": "updateOfflineMessages",
3074     "group": "Chat_Offline_Messages",
3075     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3076     "version": "0.0.0",
3077     "filename": "server/api/chatOfflineMessage/index.js",
3078     "groupTitle": "Chat_Offline_Messages"
3079   },
3080   {
3081     "type": "post",
3082     "url": "/api/chat/proactive_actions",
3083     "title": "Creates a new Proactive Action",
3084     "examples": [
3085       {
3086         "title": "Example usage:",
3087         "content": "curl https://{domain}/api/chat/proactive_actions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3088         "type": "json"
3089       }
3090     ],
3091     "name": "CreateProactive_Actions",
3092     "group": "Chat_Proactive_Actions",
3093     "parameter": {
3094       "fields": {
3095         "Body": [
3096           {
3097             "group": "Body",
3098             "type": "String",
3099             "optional": false,
3100             "field": "name",
3101             "description": ""
3102           },
3103           {
3104             "group": "Body",
3105             "type": "String",
3106             "allowedValues": [
3107               "\"mouseOver\"",
3108               "\"timeout\""
3109             ],
3110             "optional": true,
3111             "field": "type",
3112             "description": ""
3113           },
3114           {
3115             "group": "Body",
3116             "type": "String",
3117             "optional": true,
3118             "field": "selector",
3119             "description": ""
3120           },
3121           {
3122             "group": "Body",
3123             "type": "Integer",
3124             "optional": true,
3125             "field": "timeout",
3126             "description": ""
3127           }
3128         ]
3129       }
3130     },
3131     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3132     "version": "0.0.0",
3133     "filename": "server/api/chatProactiveAction/index.js",
3134     "groupTitle": "Chat_Proactive_Actions"
3135   },
3136   {
3137     "type": "delete",
3138     "url": "/api/chat/proactive_actions/{id}",
3139     "title": "Deletes a Proactive Action",
3140     "examples": [
3141       {
3142         "title": "Example usage:",
3143         "content": "curl https://{domain}/api/chat/proactive_actions/{id} -v -u {name}:{password} -X DELETE",
3144         "type": "json"
3145       }
3146     ],
3147     "name": "DeleteProactive_Actions",
3148     "group": "Chat_Proactive_Actions",
3149     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3150     "version": "0.0.0",
3151     "filename": "server/api/chatProactiveAction/index.js",
3152     "groupTitle": "Chat_Proactive_Actions"
3153   },
3154   {
3155     "type": "get",
3156     "url": "/api/chat/proactive_actions/{id}",
3157     "title": "Gets a single Proactive Action",
3158     "examples": [
3159       {
3160         "title": "Example usage:",
3161         "content": "curl https://{domain}/api/chat/proactive_actions/{id} -v -u {name}:{password}",
3162         "type": "json"
3163       }
3164     ],
3165     "name": "ShowProactive_Actions",
3166     "group": "Chat_Proactive_Actions",
3167     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3168     "version": "0.0.0",
3169     "filename": "server/api/chatProactiveAction/index.js",
3170     "groupTitle": "Chat_Proactive_Actions"
3171   },
3172   {
3173     "type": "put",
3174     "url": "/api/chat/proactive_actions/{id}",
3175     "title": "Update an existing Proactive Action",
3176     "examples": [
3177       {
3178         "title": "Example usage:",
3179         "content": "curl https://{domain}/api/chat/proactive_actions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
3180         "type": "json"
3181       }
3182     ],
3183     "name": "updateProactive_Actions",
3184     "group": "Chat_Proactive_Actions",
3185     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3186     "version": "0.0.0",
3187     "filename": "server/api/chatProactiveAction/index.js",
3188     "groupTitle": "Chat_Proactive_Actions"
3189   },
3190   {
3191     "type": "post",
3192     "url": "/api/chat/reports/queue",
3193     "title": "Creates a new Chat Queue Report",
3194     "examples": [
3195       {
3196         "title": "Example usage:",
3197         "content": "curl https://{domain}/api/chat/reports/queue -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3198         "type": "json"
3199       }
3200     ],
3201     "name": "CreateChat_Queue_Reports",
3202     "group": "Chat_Queue_Reports",
3203     "parameter": {
3204       "fields": {
3205         "Body": [
3206           {
3207             "group": "Body",
3208             "type": "String",
3209             "optional": false,
3210             "field": "uniqueid",
3211             "description": ""
3212           },
3213           {
3214             "group": "Body",
3215             "type": "String",
3216             "optional": true,
3217             "field": "from",
3218             "description": ""
3219           },
3220           {
3221             "group": "Body",
3222             "type": "String",
3223             "optional": true,
3224             "field": "joinAt",
3225             "description": ""
3226           },
3227           {
3228             "group": "Body",
3229             "type": "String",
3230             "optional": true,
3231             "field": "leaveAt",
3232             "description": ""
3233           },
3234           {
3235             "group": "Body",
3236             "type": "String",
3237             "optional": true,
3238             "field": "acceptAt",
3239             "description": ""
3240           },
3241           {
3242             "group": "Body",
3243             "type": "String",
3244             "optional": true,
3245             "field": "exitAt",
3246             "description": ""
3247           },
3248           {
3249             "group": "Body",
3250             "type": "String",
3251             "optional": true,
3252             "field": "reason",
3253             "description": ""
3254           }
3255         ]
3256       }
3257     },
3258     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3259     "version": "0.0.0",
3260     "filename": "server/api/chatQueueReport/index.js",
3261     "groupTitle": "Chat_Queue_Reports"
3262   },
3263   {
3264     "type": "delete",
3265     "url": "/api/chat/reports/queue/{id}",
3266     "title": "Deletes a Chat Queue Report",
3267     "examples": [
3268       {
3269         "title": "Example usage:",
3270         "content": "curl https://{domain}/api/chat/reports/queue/{id} -v -u {name}:{password} -X DELETE",
3271         "type": "json"
3272       }
3273     ],
3274     "name": "DeleteChat_Queue_Reports",
3275     "group": "Chat_Queue_Reports",
3276     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3277     "version": "0.0.0",
3278     "filename": "server/api/chatQueueReport/index.js",
3279     "groupTitle": "Chat_Queue_Reports"
3280   },
3281   {
3282     "type": "get",
3283     "url": "/api/chat/reports/queue/describe",
3284     "title": "Gets table info about Chat Queue Reports",
3285     "examples": [
3286       {
3287         "title": "Example usage:",
3288         "content": "curl https://{domain}/api/chat/reports/queue/describe -v -u {name}:{password}",
3289         "type": "json"
3290       }
3291     ],
3292     "name": "DescribeChat_Queue_Reports",
3293     "group": "Chat_Queue_Reports",
3294     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3295     "version": "0.0.0",
3296     "filename": "server/api/chatQueueReport/index.js",
3297     "groupTitle": "Chat_Queue_Reports"
3298   },
3299   {
3300     "type": "get",
3301     "url": "/api/chat/reports/queue",
3302     "title": "Gets a list of Chat Queue Reports",
3303     "examples": [
3304       {
3305         "title": "Example usage:",
3306         "content": "curl https://{domain}/api/chat/reports/queue -v -u {name}:{password}",
3307         "type": "json"
3308       }
3309     ],
3310     "name": "GetChat_Queue_Reports",
3311     "group": "Chat_Queue_Reports",
3312     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/reports/queue?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/reports/queue?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/reports/queue?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/reports/queue?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/reports/queue?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
3313     "version": "0.0.0",
3314     "filename": "server/api/chatQueueReport/index.js",
3315     "groupTitle": "Chat_Queue_Reports"
3316   },
3317   {
3318     "type": "get",
3319     "url": "/api/chat/reports/queue/{id}",
3320     "title": "Gets a single Chat Queue Report",
3321     "examples": [
3322       {
3323         "title": "Example usage:",
3324         "content": "curl https://{domain}/api/chat/reports/queue/{id} -v -u {name}:{password}",
3325         "type": "json"
3326       }
3327     ],
3328     "name": "ShowChat_Queue_Reports",
3329     "group": "Chat_Queue_Reports",
3330     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3331     "version": "0.0.0",
3332     "filename": "server/api/chatQueueReport/index.js",
3333     "groupTitle": "Chat_Queue_Reports"
3334   },
3335   {
3336     "type": "put",
3337     "url": "/api/chat/reports/queue/{id}",
3338     "title": "Update an existing Chat Queue Report",
3339     "examples": [
3340       {
3341         "title": "Example usage:",
3342         "content": "curl https://{domain}/api/chat/reports/queue/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
3343         "type": "json"
3344       }
3345     ],
3346     "name": "updateChat_Queue_Reports",
3347     "group": "Chat_Queue_Reports",
3348     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3349     "version": "0.0.0",
3350     "filename": "server/api/chatQueueReport/index.js",
3351     "groupTitle": "Chat_Queue_Reports"
3352   },
3353   {
3354     "type": "post",
3355     "url": "/api/chat/queues/{id}/users",
3356     "title": "Add agents to a queue",
3357     "examples": [
3358       {
3359         "title": "Example usage:",
3360         "content": "curl https://{domain}/api/chat/queues/{id}/users -d '{\"ids\": [1,2], \"penalty\": 2}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
3361         "type": "json"
3362       }
3363     ],
3364     "name": "AddAgents",
3365     "group": "Chat_Queues",
3366     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3367     "version": "0.0.0",
3368     "filename": "server/api/chatQueue/index.js",
3369     "groupTitle": "Chat_Queues"
3370   },
3371   {
3372     "type": "post",
3373     "url": "/api/chat/queues/{id}/teams",
3374     "title": "Add teams to a queue",
3375     "examples": [
3376       {
3377         "title": "Example usage:",
3378         "content": "curl https://{domain}/api/chat/queues/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
3379         "type": "json"
3380       }
3381     ],
3382     "name": "AddTeams",
3383     "group": "Chat_Queues",
3384     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3385     "version": "0.0.0",
3386     "filename": "server/api/chatQueue/index.js",
3387     "groupTitle": "Chat_Queues"
3388   },
3389   {
3390     "type": "post",
3391     "url": "/api/chat/queues",
3392     "title": "Creates a new Queue",
3393     "examples": [
3394       {
3395         "title": "Example usage:",
3396         "content": "curl https://{domain}/api/chat/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3397         "type": "json"
3398       }
3399     ],
3400     "name": "CreateQueues",
3401     "group": "Chat_Queues",
3402     "parameter": {
3403       "fields": {
3404         "Body": [
3405           {
3406             "group": "Body",
3407             "type": "String",
3408             "optional": false,
3409             "field": "name",
3410             "description": ""
3411           },
3412           {
3413             "group": "Body",
3414             "type": "String",
3415             "optional": true,
3416             "field": "description",
3417             "description": ""
3418           },
3419           {
3420             "group": "Body",
3421             "type": "Integer",
3422             "optional": true,
3423             "field": "timeout",
3424             "description": ""
3425           },
3426           {
3427             "group": "Body",
3428             "type": "String",
3429             "allowedValues": [
3430               "\"rrmemory\"",
3431               "\"beepall\"",
3432               "\"roundrobin\""
3433             ],
3434             "optional": true,
3435             "field": "strategy",
3436             "description": ""
3437           }
3438         ]
3439       }
3440     },
3441     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3442     "version": "0.0.0",
3443     "filename": "server/api/chatQueue/index.js",
3444     "groupTitle": "Chat_Queues"
3445   },
3446   {
3447     "type": "delete",
3448     "url": "/api/chat/queues/{id}",
3449     "title": "Deletes a Queue",
3450     "examples": [
3451       {
3452         "title": "Example usage:",
3453         "content": "curl https://{domain}/api/chat/queues/{id} -v -u {name}:{password} -X DELETE",
3454         "type": "json"
3455       }
3456     ],
3457     "name": "DeleteQueues",
3458     "group": "Chat_Queues",
3459     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3460     "version": "0.0.0",
3461     "filename": "server/api/chatQueue/index.js",
3462     "groupTitle": "Chat_Queues"
3463   },
3464   {
3465     "type": "get",
3466     "url": "/api/chat/queues/describe",
3467     "title": "Gets table info about Queues",
3468     "examples": [
3469       {
3470         "title": "Example usage:",
3471         "content": "curl https://{domain}/api/chat/queues/describe -v -u {name}:{password}",
3472         "type": "json"
3473       }
3474     ],
3475     "name": "DescribeQueues",
3476     "group": "Chat_Queues",
3477     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3478     "version": "0.0.0",
3479     "filename": "server/api/chatQueue/index.js",
3480     "groupTitle": "Chat_Queues"
3481   },
3482   {
3483     "type": "get",
3484     "url": "/api/chat/queues/{id}/users",
3485     "title": "Gets queue agents",
3486     "examples": [
3487       {
3488         "title": "Example usage:",
3489         "content": "curl https://{domain}/api/chat/queues/{id}/users -v -u {name}:{password} -X POST",
3490         "type": "json"
3491       }
3492     ],
3493     "name": "GetAgents",
3494     "group": "Chat_Queues",
3495     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3496     "version": "0.0.0",
3497     "filename": "server/api/chatQueue/index.js",
3498     "groupTitle": "Chat_Queues"
3499   },
3500   {
3501     "type": "get",
3502     "url": "/api/chat/queues/{id}/members",
3503     "title": "GetMembers",
3504     "examples": [
3505       {
3506         "title": "Example usage:",
3507         "content": "curl https://{domain}/api/chat/queues/{id}/members  -v -u {name}:{password}",
3508         "type": "json"
3509       }
3510     ],
3511     "name": "GetMembers",
3512     "group": "Chat_Queues",
3513     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3514     "version": "0.0.0",
3515     "filename": "server/api/chatQueue/index.js",
3516     "groupTitle": "Chat_Queues"
3517   },
3518   {
3519     "type": "get",
3520     "url": "/api/chat/queues",
3521     "title": "Gets a list of Queues",
3522     "examples": [
3523       {
3524         "title": "Example usage:",
3525         "content": "curl https://{domain}/api/chat/queues -v -u {name}:{password}",
3526         "type": "json"
3527       }
3528     ],
3529     "name": "GetQueues",
3530     "group": "Chat_Queues",
3531     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/queues?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/queues?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/queues?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/queues?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/queues?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
3532     "version": "0.0.0",
3533     "filename": "server/api/chatQueue/index.js",
3534     "groupTitle": "Chat_Queues"
3535   },
3536   {
3537     "type": "get",
3538     "url": "/api/chat/queues/{id}/teams",
3539     "title": "Gets queues list",
3540     "examples": [
3541       {
3542         "title": "Example usage:",
3543         "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password}",
3544         "type": "json"
3545       }
3546     ],
3547     "name": "GetTeams",
3548     "group": "Chat_Queues",
3549     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3550     "version": "0.0.0",
3551     "filename": "server/api/chatQueue/index.js",
3552     "groupTitle": "Chat_Queues"
3553   },
3554   {
3555     "type": "delete",
3556     "url": "/api/chat/queues/{id}/users",
3557     "title": "Removes agents from a queue",
3558     "examples": [
3559       {
3560         "title": "Example usage:",
3561         "content": "curl https://{domain}/api/chat/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
3562         "type": "json"
3563       }
3564     ],
3565     "name": "RemoveAgents",
3566     "group": "Chat_Queues",
3567     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3568     "version": "0.0.0",
3569     "filename": "server/api/chatQueue/index.js",
3570     "groupTitle": "Chat_Queues"
3571   },
3572   {
3573     "type": "get",
3574     "url": "/api/chat/queues/{id}",
3575     "title": "Gets a single Queue",
3576     "examples": [
3577       {
3578         "title": "Example usage:",
3579         "content": "curl https://{domain}/api/chat/queues/{id} -v -u {name}:{password}",
3580         "type": "json"
3581       }
3582     ],
3583     "name": "ShowQueues",
3584     "group": "Chat_Queues",
3585     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3586     "version": "0.0.0",
3587     "filename": "server/api/chatQueue/index.js",
3588     "groupTitle": "Chat_Queues"
3589   },
3590   {
3591     "type": "put",
3592     "url": "/api/chat/queues/{id}",
3593     "title": "Update an existing Queue",
3594     "examples": [
3595       {
3596         "title": "Example usage:",
3597         "content": "curl https://{domain}/api/chat/queues/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
3598         "type": "json"
3599       }
3600     ],
3601     "name": "updateQueues",
3602     "group": "Chat_Queues",
3603     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3604     "version": "0.0.0",
3605     "filename": "server/api/chatQueue/index.js",
3606     "groupTitle": "Chat_Queues"
3607   },
3608   {
3609     "type": "post",
3610     "url": "/api/chat/reports/transfer",
3611     "title": "Creates a new Chat Transfer Report",
3612     "examples": [
3613       {
3614         "title": "Example usage:",
3615         "content": "curl https://{domain}/api/chat/reports/transfer -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3616         "type": "json"
3617       }
3618     ],
3619     "name": "CreateChat_Transfer_Reports",
3620     "group": "Chat_Transfer_Reports",
3621     "parameter": {
3622       "fields": {
3623         "Body": [
3624           {
3625             "group": "Body",
3626             "type": "String",
3627             "optional": false,
3628             "field": "uniqueid",
3629             "description": ""
3630           },
3631           {
3632             "group": "Body",
3633             "type": "String",
3634             "allowedValues": [
3635               "\"account\"",
3636               "\"agent\"",
3637               "\"queue\""
3638             ],
3639             "optional": false,
3640             "field": "type",
3641             "description": ""
3642           },
3643           {
3644             "group": "Body",
3645             "type": "String",
3646             "optional": false,
3647             "field": "transferredAt",
3648             "description": ""
3649           }
3650         ]
3651       }
3652     },
3653     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3654     "version": "0.0.0",
3655     "filename": "server/api/chatTransferReport/index.js",
3656     "groupTitle": "Chat_Transfer_Reports"
3657   },
3658   {
3659     "type": "delete",
3660     "url": "/api/chat/reports/transfer/{id}",
3661     "title": "Deletes a Chat Transfer Report",
3662     "examples": [
3663       {
3664         "title": "Example usage:",
3665         "content": "curl https://{domain}/api/chat/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
3666         "type": "json"
3667       }
3668     ],
3669     "name": "DeleteChat_Transfer_Reports",
3670     "group": "Chat_Transfer_Reports",
3671     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3672     "version": "0.0.0",
3673     "filename": "server/api/chatTransferReport/index.js",
3674     "groupTitle": "Chat_Transfer_Reports"
3675   },
3676   {
3677     "type": "get",
3678     "url": "/api/chat/reports/transfer/describe",
3679     "title": "Gets table info about Chat Transfer Reports",
3680     "examples": [
3681       {
3682         "title": "Example usage:",
3683         "content": "curl https://{domain}/api/chat/reports/transfer/describe -v -u {name}:{password}",
3684         "type": "json"
3685       }
3686     ],
3687     "name": "DescribeChat_Transfer_Reports",
3688     "group": "Chat_Transfer_Reports",
3689     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3690     "version": "0.0.0",
3691     "filename": "server/api/chatTransferReport/index.js",
3692     "groupTitle": "Chat_Transfer_Reports"
3693   },
3694   {
3695     "type": "get",
3696     "url": "/api/chat/reports/transfer",
3697     "title": "Gets a list of Chat Transfer Reports",
3698     "examples": [
3699       {
3700         "title": "Example usage:",
3701         "content": "curl https://{domain}/api/chat/reports/transfer -v -u {name}:{password}",
3702         "type": "json"
3703       }
3704     ],
3705     "name": "GetChat_Transfer_Reports",
3706     "group": "Chat_Transfer_Reports",
3707     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/reports/transfer?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/reports/transfer?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/reports/transfer?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/reports/transfer?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/reports/transfer?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
3708     "version": "0.0.0",
3709     "filename": "server/api/chatTransferReport/index.js",
3710     "groupTitle": "Chat_Transfer_Reports"
3711   },
3712   {
3713     "type": "get",
3714     "url": "/api/chat/reports/transfer/{id}",
3715     "title": "Gets a single Chat Transfer Report",
3716     "examples": [
3717       {
3718         "title": "Example usage:",
3719         "content": "curl https://{domain}/api/chat/reports/transfer/{id} -v -u {name}:{password}",
3720         "type": "json"
3721       }
3722     ],
3723     "name": "ShowChat_Transfer_Reports",
3724     "group": "Chat_Transfer_Reports",
3725     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3726     "version": "0.0.0",
3727     "filename": "server/api/chatTransferReport/index.js",
3728     "groupTitle": "Chat_Transfer_Reports"
3729   },
3730   {
3731     "type": "put",
3732     "url": "/api/chat/reports/transfer/{id}",
3733     "title": "Update an existing Chat Transfer Report",
3734     "examples": [
3735       {
3736         "title": "Example usage:",
3737         "content": "curl https://{domain}/api/chat/reports/transfer/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
3738         "type": "json"
3739       }
3740     ],
3741     "name": "updateChat_Transfer_Reports",
3742     "group": "Chat_Transfer_Reports",
3743     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3744     "version": "0.0.0",
3745     "filename": "server/api/chatTransferReport/index.js",
3746     "groupTitle": "Chat_Transfer_Reports"
3747   },
3748   {
3749     "type": "post",
3750     "url": "/api/chat/websites/{id}/users",
3751     "title": "Add agents to a website",
3752     "examples": [
3753       {
3754         "title": "Example usage:",
3755         "content": "curl https://{domain}/api/chat/websites/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
3756         "type": "json"
3757       }
3758     ],
3759     "name": "AddAgents",
3760     "group": "Chat_Websites",
3761     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3762     "version": "0.0.0",
3763     "filename": "server/api/chatWebsite/index.js",
3764     "groupTitle": "Chat_Websites"
3765   },
3766   {
3767     "type": "post",
3768     "url": "/api/chat/websites",
3769     "title": "Creates a new Website",
3770     "examples": [
3771       {
3772         "title": "Example usage:",
3773         "content": "curl https://{domain}/api/chat/websites -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3774         "type": "json"
3775       }
3776     ],
3777     "name": "CreateWebsites",
3778     "group": "Chat_Websites",
3779     "parameter": {
3780       "fields": {
3781         "Body": [
3782           {
3783             "group": "Body",
3784             "type": "String",
3785             "optional": false,
3786             "field": "name",
3787             "description": ""
3788           },
3789           {
3790             "group": "Body",
3791             "type": "String",
3792             "optional": false,
3793             "field": "address",
3794             "description": ""
3795           },
3796           {
3797             "group": "Body",
3798             "type": "String",
3799             "optional": true,
3800             "field": "description",
3801             "description": ""
3802           },
3803           {
3804             "group": "Body",
3805             "type": "String",
3806             "optional": true,
3807             "field": "mapKey",
3808             "description": ""
3809           },
3810           {
3811             "group": "Body",
3812             "type": "String",
3813             "optional": true,
3814             "field": "mapKeyOffline",
3815             "description": ""
3816           },
3817           {
3818             "group": "Body",
3819             "type": "String",
3820             "optional": false,
3821             "field": "key",
3822             "description": ""
3823           },
3824           {
3825             "group": "Body",
3826             "type": "String",
3827             "optional": true,
3828             "field": "agentAlias",
3829             "description": ""
3830           },
3831           {
3832             "group": "Body",
3833             "type": "String",
3834             "optional": true,
3835             "field": "customerAlias",
3836             "description": ""
3837           },
3838           {
3839             "group": "Body",
3840             "type": "String",
3841             "optional": false,
3842             "field": "color",
3843             "description": ""
3844           },
3845           {
3846             "group": "Body",
3847             "type": "String",
3848             "optional": false,
3849             "field": "color_button",
3850             "description": ""
3851           },
3852           {
3853             "group": "Body",
3854             "type": "String",
3855             "optional": false,
3856             "field": "textColor",
3857             "description": ""
3858           },
3859           {
3860             "group": "Body",
3861             "type": "Integer",
3862             "optional": true,
3863             "field": "fontSize",
3864             "description": ""
3865           },
3866           {
3867             "group": "Body",
3868             "type": "String",
3869             "optional": true,
3870             "field": "remote",
3871             "description": ""
3872           },
3873           {
3874             "group": "Body",
3875             "type": "Boolean",
3876             "optional": true,
3877             "field": "animation",
3878             "description": ""
3879           },
3880           {
3881             "group": "Body",
3882             "type": "String",
3883             "allowedValues": [
3884               "\"rounded\"",
3885               "\"squared\""
3886             ],
3887             "optional": true,
3888             "field": "header_shape",
3889             "description": ""
3890           },
3891           {
3892             "group": "Body",
3893             "type": "String",
3894             "optional": true,
3895             "field": "header_online",
3896             "description": ""
3897           },
3898           {
3899             "group": "Body",
3900             "type": "String",
3901             "optional": true,
3902             "field": "start_chat_button",
3903             "description": ""
3904           },
3905           {
3906             "group": "Body",
3907             "type": "String",
3908             "optional": true,
3909             "field": "offline_chat_button",
3910             "description": ""
3911           },
3912           {
3913             "group": "Body",
3914             "type": "String",
3915             "optional": true,
3916             "field": "header_offline",
3917             "description": ""
3918           },
3919           {
3920             "group": "Body",
3921             "type": "Boolean",
3922             "optional": true,
3923             "field": "download_transcript",
3924             "description": ""
3925           },
3926           {
3927             "group": "Body",
3928             "type": "Integer",
3929             "optional": true,
3930             "field": "timeout",
3931             "description": ""
3932           },
3933           {
3934             "group": "Body",
3935             "type": "String",
3936             "optional": true,
3937             "field": "whiteLabel",
3938             "description": ""
3939           },
3940           {
3941             "group": "Body",
3942             "type": "Boolean",
3943             "optional": true,
3944             "field": "defaultWhiteLabel",
3945             "description": ""
3946           },
3947           {
3948             "group": "Body",
3949             "type": "Text",
3950             "optional": true,
3951             "field": "sitepic",
3952             "description": ""
3953           },
3954           {
3955             "group": "Body",
3956             "type": "String",
3957             "optional": true,
3958             "field": "closingQuestion",
3959             "description": ""
3960           },
3961           {
3962             "group": "Body",
3963             "type": "String",
3964             "optional": true,
3965             "field": "formSubmitSuccessMessage",
3966             "description": ""
3967           },
3968           {
3969             "group": "Body",
3970             "type": "String",
3971             "optional": true,
3972             "field": "formSubmitFailureMessage",
3973             "description": ""
3974           },
3975           {
3976             "group": "Body",
3977             "type": "String",
3978             "optional": true,
3979             "field": "noteTitle",
3980             "description": ""
3981           },
3982           {
3983             "group": "Body",
3984             "type": "String",
3985             "optional": true,
3986             "field": "placeholderMessage",
3987             "description": ""
3988           },
3989           {
3990             "group": "Body",
3991             "type": "String",
3992             "optional": true,
3993             "field": "closingMessage",
3994             "description": ""
3995           },
3996           {
3997             "group": "Body",
3998             "type": "String",
3999             "optional": true,
4000             "field": "closingMessageButton",
4001             "description": ""
4002           },
4003           {
4004             "group": "Body",
4005             "type": "String",
4006             "optional": true,
4007             "field": "skipMessageButton",
4008             "description": ""
4009           },
4010           {
4011             "group": "Body",
4012             "type": "Boolean",
4013             "optional": true,
4014             "field": "conditionAgreement",
4015             "description": ""
4016           },
4017           {
4018             "group": "Body",
4019             "type": "Boolean",
4020             "optional": true,
4021             "field": "enableRating",
4022             "description": ""
4023           },
4024           {
4025             "group": "Body",
4026             "type": "Boolean",
4027             "optional": true,
4028             "field": "enableFeedback",
4029             "description": ""
4030           },
4031           {
4032             "group": "Body",
4033             "type": "Boolean",
4034             "optional": true,
4035             "field": "enableSendButton",
4036             "description": ""
4037           },
4038           {
4039             "group": "Body",
4040             "type": "String",
4041             "optional": true,
4042             "field": "feedbackTitle",
4043             "description": ""
4044           },
4045           {
4046             "group": "Body",
4047             "type": "String",
4048             "allowedValues": [
4049               "\"star\"",
4050               "\"thumb\""
4051             ],
4052             "optional": true,
4053             "field": "ratingType",
4054             "description": ""
4055           },
4056           {
4057             "group": "Body",
4058             "type": "Integer",
4059             "optional": true,
4060             "field": "ratingStarsNumber",
4061             "description": ""
4062           },
4063           {
4064             "group": "Body",
4065             "type": "Text",
4066             "optional": true,
4067             "field": "onlineForm",
4068             "description": ""
4069           },
4070           {
4071             "group": "Body",
4072             "type": "Text",
4073             "optional": true,
4074             "field": "offlineForm",
4075             "description": ""
4076           },
4077           {
4078             "group": "Body",
4079             "type": "String",
4080             "optional": true,
4081             "field": "token",
4082             "description": ""
4083           },
4084           {
4085             "group": "Body",
4086             "type": "Boolean",
4087             "optional": true,
4088             "field": "autoclose",
4089             "description": ""
4090           },
4091           {
4092             "group": "Body",
4093             "type": "Boolean",
4094             "optional": true,
4095             "field": "enableCustomerWriting",
4096             "description": ""
4097           },
4098           {
4099             "group": "Body",
4100             "type": "Boolean",
4101             "optional": true,
4102             "field": "forwardTranscript",
4103             "description": ""
4104           },
4105           {
4106             "group": "Body",
4107             "type": "String",
4108             "optional": true,
4109             "field": "forwardTranscriptMessage",
4110             "description": ""
4111           },
4112           {
4113             "group": "Body",
4114             "type": "Boolean",
4115             "optional": true,
4116             "field": "forwardOffline",
4117             "description": ""
4118           },
4119           {
4120             "group": "Body",
4121             "type": "String",
4122             "optional": true,
4123             "field": "forwardOfflineAddress",
4124             "description": ""
4125           },
4126           {
4127             "group": "Body",
4128             "type": "String",
4129             "optional": true,
4130             "field": "waitingTitle",
4131             "description": ""
4132           },
4133           {
4134             "group": "Body",
4135             "type": "String",
4136             "optional": true,
4137             "field": "waitingMessage",
4138             "description": ""
4139           },
4140           {
4141             "group": "Body",
4142             "type": "String",
4143             "optional": true,
4144             "field": "offlineMessageSubject",
4145             "description": ""
4146           },
4147           {
4148             "group": "Body",
4149             "type": "String",
4150             "optional": true,
4151             "field": "offlineMessageBody",
4152             "description": ""
4153           },
4154           {
4155             "group": "Body",
4156             "type": "Boolean",
4157             "optional": true,
4158             "field": "enableUnmanagedNote",
4159             "description": ""
4160           },
4161           {
4162             "group": "Body",
4163             "type": "String",
4164             "optional": true,
4165             "field": "unmanagedMessage",
4166             "description": ""
4167           },
4168           {
4169             "group": "Body",
4170             "type": "String",
4171             "optional": true,
4172             "field": "skipUnmanaged",
4173             "description": ""
4174           },
4175           {
4176             "group": "Body",
4177             "type": "String",
4178             "optional": true,
4179             "field": "sendUnmanaged",
4180             "description": ""
4181           },
4182           {
4183             "group": "Body",
4184             "type": "Boolean",
4185             "optional": true,
4186             "field": "enableCustomerAttachment",
4187             "description": ""
4188           },
4189           {
4190             "group": "Body",
4191             "type": "Boolean",
4192             "optional": true,
4193             "field": "enableCustomerCheckmarks",
4194             "description": ""
4195           },
4196           {
4197             "group": "Body",
4198             "type": "Text",
4199             "optional": true,
4200             "field": "agentAvatar",
4201             "description": ""
4202           },
4203           {
4204             "group": "Body",
4205             "type": "Boolean",
4206             "optional": true,
4207             "field": "showAgentAvatar",
4208             "description": ""
4209           },
4210           {
4211             "group": "Body",
4212             "type": "String",
4213             "optional": true,
4214             "field": "timezone",
4215             "description": ""
4216           },
4217           {
4218             "group": "Body",
4219             "type": "Text",
4220             "optional": true,
4221             "field": "notificationTemplate",
4222             "description": ""
4223           },
4224           {
4225             "group": "Body",
4226             "type": "Boolean",
4227             "optional": true,
4228             "field": "notificationSound",
4229             "description": ""
4230           },
4231           {
4232             "group": "Body",
4233             "type": "Boolean",
4234             "optional": true,
4235             "field": "notificationShake",
4236             "description": ""
4237           },
4238           {
4239             "group": "Body",
4240             "type": "Boolean",
4241             "optional": true,
4242             "field": "hideWhenOffline",
4243             "description": ""
4244           },
4245           {
4246             "group": "Body",
4247             "type": "String",
4248             "optional": true,
4249             "field": "agentIdentifier",
4250             "description": ""
4251           },
4252           {
4253             "group": "Body",
4254             "type": "Integer",
4255             "optional": true,
4256             "field": "waitForTheAssignedAgent",
4257             "description": ""
4258           },
4259           {
4260             "group": "Body",
4261             "type": "String",
4262             "optional": true,
4263             "field": "alignment",
4264             "description": ""
4265           },
4266           {
4267             "group": "Body",
4268             "type": "Integer",
4269             "optional": true,
4270             "field": "verticalAlignment",
4271             "description": ""
4272           },
4273           {
4274             "group": "Body",
4275             "type": "String",
4276             "optional": true,
4277             "field": "messagesAlignment",
4278             "description": ""
4279           },
4280           {
4281             "group": "Body",
4282             "type": "String",
4283             "optional": true,
4284             "field": "defaultTitle",
4285             "description": ""
4286           },
4287           {
4288             "group": "Body",
4289             "type": "Text",
4290             "optional": true,
4291             "field": "customerAvatar",
4292             "description": ""
4293           },
4294           {
4295             "group": "Body",
4296             "type": "Boolean",
4297             "optional": true,
4298             "field": "showCustomerAvatar",
4299             "description": ""
4300           },
4301           {
4302             "group": "Body",
4303             "type": "Integer",
4304             "optional": true,
4305             "field": "messageFontSize",
4306             "description": ""
4307           },
4308           {
4309             "group": "Body",
4310             "type": "String",
4311             "optional": false,
4312             "field": "backgroundColor",
4313             "description": ""
4314           },
4315           {
4316             "group": "Body",
4317             "type": "Boolean",
4318             "optional": true,
4319             "field": "queueTransfer",
4320             "description": ""
4321           },
4322           {
4323             "group": "Body",
4324             "type": "Integer",
4325             "optional": true,
4326             "field": "queueTransferTimeout",
4327             "description": ""
4328           },
4329           {
4330             "group": "Body",
4331             "type": "Boolean",
4332             "optional": true,
4333             "field": "agentTransfer",
4334             "description": ""
4335           },
4336           {
4337             "group": "Body",
4338             "type": "Integer",
4339             "optional": true,
4340             "field": "agentTransferTimeout",
4341             "description": ""
4342           },
4343           {
4344             "group": "Body",
4345             "type": "String",
4346             "optional": true,
4347             "field": "systemAlias",
4348             "description": ""
4349           },
4350           {
4351             "group": "Body",
4352             "type": "Text",
4353             "optional": true,
4354             "field": "systemAvatar",
4355             "description": ""
4356           },
4357           {
4358             "group": "Body",
4359             "type": "Integer",
4360             "optional": true,
4361             "field": "mandatoryDispositionPauseId",
4362             "description": "<p>Status to put when mandatory disposition is enabled</p>"
4363           },
4364           {
4365             "group": "Body",
4366             "type": "Boolean",
4367             "optional": true,
4368             "field": "mandatoryDisposition",
4369             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
4370           },
4371           {
4372             "group": "Body",
4373             "type": "Boolean",
4374             "optional": true,
4375             "field": "vidaooEscalation",
4376             "description": ""
4377           },
4378           {
4379             "group": "Body",
4380             "type": "String",
4381             "optional": true,
4382             "field": "vidaooApiKey",
4383             "description": ""
4384           }
4385         ]
4386       }
4387     },
4388     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4389     "version": "0.0.0",
4390     "filename": "server/api/chatWebsite/index.js",
4391     "groupTitle": "Chat_Websites"
4392   },
4393   {
4394     "type": "delete",
4395     "url": "/api/chat/websites/{id}",
4396     "title": "Deletes a Website",
4397     "examples": [
4398       {
4399         "title": "Example usage:",
4400         "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password} -X DELETE",
4401         "type": "json"
4402       }
4403     ],
4404     "name": "DeleteWebsites",
4405     "group": "Chat_Websites",
4406     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4407     "version": "0.0.0",
4408     "filename": "server/api/chatWebsite/index.js",
4409     "groupTitle": "Chat_Websites"
4410   },
4411   {
4412     "type": "get",
4413     "url": "/api/chat/websites/describe",
4414     "title": "Gets table info about Websites",
4415     "examples": [
4416       {
4417         "title": "Example usage:",
4418         "content": "curl https://{domain}/api/chat/websites/describe -v -u {name}:{password}",
4419         "type": "json"
4420       }
4421     ],
4422     "name": "DescribeWebsites",
4423     "group": "Chat_Websites",
4424     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4425     "version": "0.0.0",
4426     "filename": "server/api/chatWebsite/index.js",
4427     "groupTitle": "Chat_Websites"
4428   },
4429   {
4430     "type": "get",
4431     "url": "/api/chat/websites/{id}/users",
4432     "title": "Gets agents from website",
4433     "examples": [
4434       {
4435         "title": "Example usage:",
4436         "content": "curl https://{domain}/api/chat/websites/{id}/users -v -u {name}:{password} -X GET",
4437         "type": "json"
4438       }
4439     ],
4440     "name": "GetAgents",
4441     "group": "Chat_Websites",
4442     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4443     "version": "0.0.0",
4444     "filename": "server/api/chatWebsite/index.js",
4445     "groupTitle": "Chat_Websites"
4446   },
4447   {
4448     "type": "get",
4449     "url": "/api/chat/websites",
4450     "title": "Gets a list of Websites",
4451     "examples": [
4452       {
4453         "title": "Example usage:",
4454         "content": "curl https://{domain}/api/chat/websites -v -u {name}:{password}",
4455         "type": "json"
4456       }
4457     ],
4458     "name": "GetWebsites",
4459     "group": "Chat_Websites",
4460     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/websites?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/websites?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/websites?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/websites?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/websites?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
4461     "version": "0.0.0",
4462     "filename": "server/api/chatWebsite/index.js",
4463     "groupTitle": "Chat_Websites"
4464   },
4465   {
4466     "type": "delete",
4467     "url": "/api/chat/websites/{id}/users",
4468     "title": "Removes agents from a website",
4469     "examples": [
4470       {
4471         "title": "Example usage:",
4472         "content": "curl https://{domain}/api/chat/websites/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4473         "type": "json"
4474       }
4475     ],
4476     "name": "RemoveAgents",
4477     "group": "Chat_Websites",
4478     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4479     "version": "0.0.0",
4480     "filename": "server/api/chatWebsite/index.js",
4481     "groupTitle": "Chat_Websites"
4482   },
4483   {
4484     "type": "delete",
4485     "url": "/api/chat/websites/{id}/canned_answers",
4486     "title": "Removes canned answers from account",
4487     "examples": [
4488       {
4489         "title": "Example usage:",
4490         "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4491         "type": "json"
4492       }
4493     ],
4494     "name": "RemoveAnswers",
4495     "group": "Chat_Websites",
4496     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4497     "version": "0.0.0",
4498     "filename": "server/api/chatWebsite/index.js",
4499     "groupTitle": "Chat_Websites"
4500   },
4501   {
4502     "type": "delete",
4503     "url": "/api/chat/websites/{id}/dispositions",
4504     "title": "Removes canned answers from account",
4505     "examples": [
4506       {
4507         "title": "Example usage:",
4508         "content": "curl https://{domain}/api/chat/websites/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4509         "type": "json"
4510       }
4511     ],
4512     "name": "RemoveDispositions",
4513     "group": "Chat_Websites",
4514     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4515     "version": "0.0.0",
4516     "filename": "server/api/chatWebsite/index.js",
4517     "groupTitle": "Chat_Websites"
4518   },
4519   {
4520     "type": "get",
4521     "url": "/api/chat/websites/{id}",
4522     "title": "Gets a single Website",
4523     "examples": [
4524       {
4525         "title": "Example usage:",
4526         "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password}",
4527         "type": "json"
4528       }
4529     ],
4530     "name": "ShowWebsites",
4531     "group": "Chat_Websites",
4532     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4533     "version": "0.0.0",
4534     "filename": "server/api/chatWebsite/index.js",
4535     "groupTitle": "Chat_Websites"
4536   },
4537   {
4538     "type": "put",
4539     "url": "/api/chat/messages/{id}/accept",
4540     "title": "Accepts message",
4541     "examples": [
4542       {
4543         "title": "Example usage:",
4544         "content": "curl https://{domain}/api/chat/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
4545         "type": "json"
4546       }
4547     ],
4548     "name": "acceptMessage",
4549     "group": "Chat_Websites",
4550     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4551     "version": "0.0.0",
4552     "filename": "server/api/chatMessage/index.js",
4553     "groupTitle": "Chat_Websites"
4554   },
4555   {
4556     "type": "post",
4557     "url": "/api/chat/websites/{id}/canned_answers",
4558     "title": "Creates new canned answer",
4559     "examples": [
4560       {
4561         "title": "Example usage:",
4562         "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers -d '{\"name\": \"vip\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4563         "type": "json"
4564       }
4565     ],
4566     "name": "addAnswer",
4567     "group": "Chat_Websites",
4568     "parameter": {
4569       "fields": {
4570         "Body": [
4571           {
4572             "group": "Body",
4573             "type": "String",
4574             "optional": false,
4575             "field": "key",
4576             "description": ""
4577           },
4578           {
4579             "group": "Body",
4580             "type": "Text",
4581             "optional": false,
4582             "field": "value",
4583             "description": ""
4584           },
4585           {
4586             "group": "Body",
4587             "type": "String",
4588             "optional": true,
4589             "field": "description",
4590             "description": ""
4591           },
4592           {
4593             "group": "Body",
4594             "type": "Virtual",
4595             "optional": true,
4596             "field": "name",
4597             "description": ""
4598           }
4599         ]
4600       }
4601     },
4602     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4603     "version": "0.0.0",
4604     "filename": "server/api/chatWebsite/index.js",
4605     "groupTitle": "Chat_Websites"
4606   },
4607   {
4608     "type": "post",
4609     "url": "/api/chat/websites/{id}/applications",
4610     "title": "Creates new applications",
4611     "examples": [
4612       {
4613         "title": "Example usage:",
4614         "content": "curl https://{domain}/api/chat/websites/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4615         "type": "json"
4616       }
4617     ],
4618     "name": "addApplications",
4619     "group": "Chat_Websites",
4620     "parameter": {
4621       "fields": {
4622         "Body": [
4623           {
4624             "group": "Body",
4625             "type": "Integer",
4626             "optional": false,
4627             "field": "priority",
4628             "description": ""
4629           },
4630           {
4631             "group": "Body",
4632             "type": "String",
4633             "optional": false,
4634             "field": "app",
4635             "description": ""
4636           },
4637           {
4638             "group": "Body",
4639             "type": "Text",
4640             "optional": true,
4641             "field": "appdata",
4642             "description": ""
4643           },
4644           {
4645             "group": "Body",
4646             "type": "String",
4647             "optional": true,
4648             "field": "description",
4649             "description": ""
4650           },
4651           {
4652             "group": "Body",
4653             "type": "String",
4654             "optional": true,
4655             "field": "interval",
4656             "description": ""
4657           }
4658         ]
4659       }
4660     },
4661     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4662     "version": "0.0.0",
4663     "filename": "server/api/chatWebsite/index.js",
4664     "groupTitle": "Chat_Websites"
4665   },
4666   {
4667     "type": "post",
4668     "url": "/api/chat/websites/{id}/avatar",
4669     "title": "Add avatar",
4670     "examples": [
4671       {
4672         "title": "Example usage:",
4673         "content": "curl https://{domain}/api/chat/websites/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
4674         "type": "json"
4675       }
4676     ],
4677     "name": "addAvatar",
4678     "group": "Chat_Websites",
4679     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4680     "version": "0.0.0",
4681     "filename": "server/api/chatWebsite/index.js",
4682     "groupTitle": "Chat_Websites"
4683   },
4684   {
4685     "type": "post",
4686     "url": "/api/chat/websites/{id}/customer_avatar",
4687     "title": "Add customer avatar",
4688     "examples": [
4689       {
4690         "title": "Example usage:",
4691         "content": "curl https://{domain}/api/chat/websites/{id}/customer_avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
4692         "type": "json"
4693       }
4694     ],
4695     "name": "addCustomerAvatar",
4696     "group": "Chat_Websites",
4697     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4698     "version": "0.0.0",
4699     "filename": "server/api/chatWebsite/index.js",
4700     "groupTitle": "Chat_Websites"
4701   },
4702   {
4703     "type": "post",
4704     "url": "/api/chat/websites/{id}/dispositions",
4705     "title": "Creates new disposition",
4706     "examples": [
4707       {
4708         "title": "Example usage:",
4709         "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4710         "type": "json"
4711       }
4712     ],
4713     "name": "addDisposition",
4714     "group": "Chat_Websites",
4715     "parameter": {
4716       "fields": {
4717         "Body": [
4718           {
4719             "group": "Body",
4720             "type": "String",
4721             "optional": false,
4722             "field": "name",
4723             "description": ""
4724           },
4725           {
4726             "group": "Body",
4727             "type": "String",
4728             "allowedValues": [
4729               "\"first\"",
4730               "\"second\"",
4731               "\"third\""
4732             ],
4733             "optional": false,
4734             "field": "level",
4735             "description": ""
4736           },
4737           {
4738             "group": "Body",
4739             "type": "String",
4740             "optional": true,
4741             "field": "description",
4742             "description": ""
4743           }
4744         ]
4745       }
4746     },
4747     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4748     "version": "0.0.0",
4749     "filename": "server/api/chatWebsite/index.js",
4750     "groupTitle": "Chat_Websites"
4751   },
4752   {
4753     "type": "post",
4754     "url": "/api/chat/accounts/{id}/interactions",
4755     "title": "Creates new interactions",
4756     "examples": [
4757       {
4758         "title": "Example usage:",
4759         "content": "curl https://{domain}/api/chat/websites/{id}/interactions -d '{\"host\": \"host\", \"username\": \"username\", \"password\": \"password\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4760         "type": "json"
4761       }
4762     ],
4763     "name": "addInteraction",
4764     "group": "Chat_Websites",
4765     "parameter": {
4766       "fields": {
4767         "Body": [
4768           {
4769             "group": "Body",
4770             "type": "Boolean",
4771             "optional": true,
4772             "field": "closed",
4773             "description": ""
4774           },
4775           {
4776             "group": "Body",
4777             "type": "Integer",
4778             "optional": true,
4779             "field": "ratingValue",
4780             "description": ""
4781           },
4782           {
4783             "group": "Body",
4784             "type": "String",
4785             "allowedValues": [
4786               "\"star\"",
4787               "\"thumb\""
4788             ],
4789             "optional": true,
4790             "field": "ratingType",
4791             "description": ""
4792           },
4793           {
4794             "group": "Body",
4795             "type": "Text",
4796             "optional": true,
4797             "field": "ratingMessage",
4798             "description": ""
4799           },
4800           {
4801             "group": "Body",
4802             "type": "Text",
4803             "optional": true,
4804             "field": "pathTranscript",
4805             "description": ""
4806           },
4807           {
4808             "group": "Body",
4809             "type": "String",
4810             "optional": true,
4811             "field": "mailTranscript",
4812             "description": ""
4813           },
4814           {
4815             "group": "Body",
4816             "type": "String",
4817             "optional": true,
4818             "field": "closedAt",
4819             "description": ""
4820           },
4821           {
4822             "group": "Body",
4823             "type": "String",
4824             "optional": true,
4825             "field": "disposition",
4826             "description": ""
4827           },
4828           {
4829             "group": "Body",
4830             "type": "String",
4831             "optional": true,
4832             "field": "secondDisposition",
4833             "description": ""
4834           },
4835           {
4836             "group": "Body",
4837             "type": "String",
4838             "optional": true,
4839             "field": "thirdDisposition",
4840             "description": ""
4841           },
4842           {
4843             "group": "Body",
4844             "type": "String",
4845             "optional": true,
4846             "field": "note",
4847             "description": ""
4848           },
4849           {
4850             "group": "Body",
4851             "type": "String",
4852             "optional": true,
4853             "field": "browserName",
4854             "description": ""
4855           },
4856           {
4857             "group": "Body",
4858             "type": "String",
4859             "optional": true,
4860             "field": "browserVersion",
4861             "description": ""
4862           },
4863           {
4864             "group": "Body",
4865             "type": "String",
4866             "optional": true,
4867             "field": "osName",
4868             "description": ""
4869           },
4870           {
4871             "group": "Body",
4872             "type": "String",
4873             "optional": true,
4874             "field": "osVersion",
4875             "description": ""
4876           },
4877           {
4878             "group": "Body",
4879             "type": "String",
4880             "optional": true,
4881             "field": "deviceModel",
4882             "description": ""
4883           },
4884           {
4885             "group": "Body",
4886             "type": "String",
4887             "optional": true,
4888             "field": "deviceVendor",
4889             "description": ""
4890           },
4891           {
4892             "group": "Body",
4893             "type": "String",
4894             "optional": true,
4895             "field": "deviceType",
4896             "description": ""
4897           },
4898           {
4899             "group": "Body",
4900             "type": "Text",
4901             "optional": true,
4902             "field": "referer",
4903             "description": ""
4904           },
4905           {
4906             "group": "Body",
4907             "type": "String",
4908             "optional": true,
4909             "field": "customerIp",
4910             "description": ""
4911           },
4912           {
4913             "group": "Body",
4914             "type": "Text",
4915             "optional": true,
4916             "field": "formData",
4917             "description": ""
4918           },
4919           {
4920             "group": "Body",
4921             "type": "String",
4922             "optional": true,
4923             "field": "read1stAt",
4924             "description": ""
4925           },
4926           {
4927             "group": "Body",
4928             "type": "String",
4929             "optional": true,
4930             "field": "lastMsgAt",
4931             "description": ""
4932           },
4933           {
4934             "group": "Body",
4935             "type": "String",
4936             "allowedValues": [
4937               "\"in\"",
4938               "\"out\""
4939             ],
4940             "optional": false,
4941             "field": "lastMsgDirection",
4942             "description": ""
4943           },
4944           {
4945             "group": "Body",
4946             "type": "String",
4947             "optional": true,
4948             "field": "closeReason",
4949             "description": ""
4950           },
4951           {
4952             "group": "Body",
4953             "type": "String",
4954             "optional": true,
4955             "field": "customerPort",
4956             "description": ""
4957           },
4958           {
4959             "group": "Body",
4960             "type": "Text",
4961             "optional": true,
4962             "field": "vidaooSessionId",
4963             "description": ""
4964           }
4965         ]
4966       }
4967     },
4968     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4969     "version": "0.0.0",
4970     "filename": "server/api/chatWebsite/index.js",
4971     "groupTitle": "Chat_Websites"
4972   },
4973   {
4974     "type": "post",
4975     "url": "/api/chat/websites/{id}/logo",
4976     "title": "Add logo",
4977     "examples": [
4978       {
4979         "title": "Example usage:",
4980         "content": "curl https://{domain}/api/chat/websites/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
4981         "type": "json"
4982       }
4983     ],
4984     "name": "addLogo",
4985     "group": "Chat_Websites",
4986     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4987     "version": "0.0.0",
4988     "filename": "server/api/chatWebsite/index.js",
4989     "groupTitle": "Chat_Websites"
4990   },
4991   {
4992     "type": "post",
4993     "url": "/api/chat/websites/{id}/proactive_actions",
4994     "title": "Creates new Proactive Actions",
4995     "examples": [
4996       {
4997         "title": "Example usage:",
4998         "content": "curl https://{domain}/api/chat/websites/{id}/proactive_actions -d '[{\"name\": \"Satisfied\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4999         "type": "json"
5000       }
5001     ],
5002     "name": "addProactiveActions",
5003     "group": "Chat_Websites",
5004     "parameter": {
5005       "fields": {
5006         "Body": [
5007           {
5008             "group": "Body",
5009             "type": "String",
5010             "optional": false,
5011             "field": "name",
5012             "description": ""
5013           },
5014           {
5015             "group": "Body",
5016             "type": "String",
5017             "allowedValues": [
5018               "\"mouseOver\"",
5019               "\"timeout\""
5020             ],
5021             "optional": true,
5022             "field": "type",
5023             "description": ""
5024           },
5025           {
5026             "group": "Body",
5027             "type": "String",
5028             "optional": true,
5029             "field": "selector",
5030             "description": ""
5031           },
5032           {
5033             "group": "Body",
5034             "type": "Integer",
5035             "optional": true,
5036             "field": "timeout",
5037             "description": ""
5038           }
5039         ]
5040       }
5041     },
5042     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5043     "version": "0.0.0",
5044     "filename": "server/api/chatWebsite/index.js",
5045     "groupTitle": "Chat_Websites"
5046   },
5047   {
5048     "type": "post",
5049     "url": "/api/chat/websites/{id}/system_avatar",
5050     "title": "Add system avatar",
5051     "examples": [
5052       {
5053         "title": "Example usage:",
5054         "content": "curl https://{domain}/api/chat/websites/{id}/system_avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
5055         "type": "json"
5056       }
5057     ],
5058     "name": "addSystemAvatar",
5059     "group": "Chat_Websites",
5060     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5061     "version": "0.0.0",
5062     "filename": "server/api/chatWebsite/index.js",
5063     "groupTitle": "Chat_Websites"
5064   },
5065   {
5066     "type": "get",
5067     "url": "/api/chat/websites/{id}/canned_answers",
5068     "title": "Gets account canned answers",
5069     "examples": [
5070       {
5071         "title": "Example usage:",
5072         "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers -v -u {name}:{password} -X GET",
5073         "type": "json"
5074       }
5075     ],
5076     "name": "getAnswers",
5077     "group": "Chat_Websites",
5078     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5079     "version": "0.0.0",
5080     "filename": "server/api/chatWebsite/index.js",
5081     "groupTitle": "Chat_Websites"
5082   },
5083   {
5084     "type": "get",
5085     "url": "/api/chat/websites/{id}/applications",
5086     "title": "Gets Website Applications",
5087     "examples": [
5088       {
5089         "title": "Example usage:",
5090         "content": "curl https://{domain}/api/chat/websites/{id}/applications -v -u {name}:{password} -X GET",
5091         "type": "json"
5092       }
5093     ],
5094     "name": "getApplications",
5095     "group": "Chat_Websites",
5096     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5097     "version": "0.0.0",
5098     "filename": "server/api/chatWebsite/index.js",
5099     "groupTitle": "Chat_Websites"
5100   },
5101   {
5102     "type": "get",
5103     "url": "/api/chat/websites/{id}/avatar",
5104     "title": "Get avatar",
5105     "examples": [
5106       {
5107         "title": "Example usage:",
5108         "content": "curl https://{domain}/api/chat/websites/{id}/avatar -v -u {name}:{password} -X GET",
5109         "type": "json"
5110       }
5111     ],
5112     "name": "getAvatar",
5113     "group": "Chat_Websites",
5114     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5115     "version": "0.0.0",
5116     "filename": "server/api/chatWebsite/index.js",
5117     "groupTitle": "Chat_Websites"
5118   },
5119   {
5120     "type": "get",
5121     "url": "/api/chat/websites/{id}/customer_avatar",
5122     "title": "Get Customer Avatar",
5123     "examples": [
5124       {
5125         "title": "Example usage:",
5126         "content": "curl https://{domain}/api/chat/websites/{id}/customer_avatar -v -u {name}:{password} -X GET",
5127         "type": "json"
5128       }
5129     ],
5130     "name": "getCustomerAvatar",
5131     "group": "Chat_Websites",
5132     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5133     "version": "0.0.0",
5134     "filename": "server/api/chatWebsite/index.js",
5135     "groupTitle": "Chat_Websites"
5136   },
5137   {
5138     "type": "get",
5139     "url": "/api/chat/websites/{id}/dispositions",
5140     "title": "Gets account dispositions",
5141     "examples": [
5142       {
5143         "title": "Example usage:",
5144         "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -v -u {name}:{password} -X GET",
5145         "type": "json"
5146       }
5147     ],
5148     "name": "getDispositions",
5149     "group": "Chat_Websites",
5150     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5151     "version": "0.0.0",
5152     "filename": "server/api/chatWebsite/index.js",
5153     "groupTitle": "Chat_Websites"
5154   },
5155   {
5156     "type": "get",
5157     "url": "/api/chat/websites/{id}/fields",
5158     "title": "Gets Website Fields",
5159     "examples": [
5160       {
5161         "title": "Example usage:",
5162         "content": "curl https://{domain}/api/chat/websites/{id}/fields -v -u {name}:{password} -X GET",
5163         "type": "json"
5164       }
5165     ],
5166     "name": "getFields",
5167     "group": "Chat_Websites",
5168     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5169     "version": "0.0.0",
5170     "filename": "server/api/chatWebsite/index.js",
5171     "groupTitle": "Chat_Websites"
5172   },
5173   {
5174     "type": "get",
5175     "url": "/api/chat/websites/{id}/interactions",
5176     "title": "Gets Website Interactions",
5177     "examples": [
5178       {
5179         "title": "Example usage:",
5180         "content": "curl https://{domain}/api/chat/websites/{id}/interactions -v -u {name}:{password} -X GET",
5181         "type": "json"
5182       }
5183     ],
5184     "name": "getInteraction",
5185     "group": "Chat_Websites",
5186     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5187     "version": "0.0.0",
5188     "filename": "server/api/chatWebsite/index.js",
5189     "groupTitle": "Chat_Websites"
5190   },
5191   {
5192     "type": "get",
5193     "url": "/api/chat/websites/{id}/logo",
5194     "title": "Get logo",
5195     "examples": [
5196       {
5197         "title": "Example usage:",
5198         "content": "curl https://{domain}/api/chat/websites/{id}/logo -v -u {name}:{password} -X GET",
5199         "type": "json"
5200       }
5201     ],
5202     "name": "getLogo",
5203     "group": "Chat_Websites",
5204     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5205     "version": "0.0.0",
5206     "filename": "server/api/chatWebsite/index.js",
5207     "groupTitle": "Chat_Websites"
5208   },
5209   {
5210     "type": "get",
5211     "url": "/api/chat/websites/{id}/offline_messages",
5212     "title": "Gets Website Offline Messages",
5213     "examples": [
5214       {
5215         "title": "Example usage:",
5216         "content": "curl https://{domain}/api/chat/websites/{id}/offline_messages -v -u {name}:{password} -X GET",
5217         "type": "json"
5218       }
5219     ],
5220     "name": "getOfflineMessages",
5221     "group": "Chat_Websites",
5222     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5223     "version": "0.0.0",
5224     "filename": "server/api/chatWebsite/index.js",
5225     "groupTitle": "Chat_Websites"
5226   },
5227   {
5228     "type": "get",
5229     "url": "/api/chat/websites/{id}/proactive_actions",
5230     "title": "Gets Website Proactive Actions",
5231     "examples": [
5232       {
5233         "title": "Example usage:",
5234         "content": "curl https://{domain}/api/chat/websites/{id}/proactive_actions -v -u {name}:{password} -X GET",
5235         "type": "json"
5236       }
5237     ],
5238     "name": "getProactiveActions",
5239     "group": "Chat_Websites",
5240     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5241     "version": "0.0.0",
5242     "filename": "server/api/chatWebsite/index.js",
5243     "groupTitle": "Chat_Websites"
5244   },
5245   {
5246     "type": "get",
5247     "url": "/api/chat/websites/{id}/snippet",
5248     "title": "Gets Website Snippet",
5249     "examples": [
5250       {
5251         "title": "Example usage:",
5252         "content": "curl https://{domain}/api/chat/websites/{id}/snippet -v -u {name}:{password} -X GET",
5253         "type": "json"
5254       }
5255     ],
5256     "name": "getSnippet",
5257     "group": "Chat_Websites",
5258     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5259     "version": "0.0.0",
5260     "filename": "server/api/chatWebsite/index.js",
5261     "groupTitle": "Chat_Websites"
5262   },
5263   {
5264     "type": "get",
5265     "url": "/api/chat/websites/{id}/system_avatar",
5266     "title": "Get System Avatar",
5267     "examples": [
5268       {
5269         "title": "Example usage:",
5270         "content": "curl https://{domain}/api/chat/websites/{id}/system_avatar -v -u {name}:{password} -X GET",
5271         "type": "json"
5272       }
5273     ],
5274     "name": "getSystemAvatar",
5275     "group": "Chat_Websites",
5276     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5277     "version": "0.0.0",
5278     "filename": "server/api/chatWebsite/index.js",
5279     "groupTitle": "Chat_Websites"
5280   },
5281   {
5282     "type": "post",
5283     "url": "/api/chat/websites/{id}/notify",
5284     "title": "Notify new message",
5285     "examples": [
5286       {
5287         "title": "Example usage:",
5288         "content": "curl https://{domain}/api/chat/websites/{id}/notify -d '{\"body\": \"hello world\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
5289         "type": "json"
5290       }
5291     ],
5292     "name": "notify",
5293     "group": "Chat_Websites",
5294     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <p>This API is used to create a new chat message to be sent to the system.</p>",
5295     "version": "0.0.0",
5296     "filename": "server/api/chatWebsite/index.js",
5297     "groupTitle": "Chat_Websites"
5298   },
5299   {
5300     "type": "post",
5301     "url": "/api/chat/websites/{id}/offline",
5302     "title": "Offline message",
5303     "examples": [
5304       {
5305         "title": "Example usage:",
5306         "content": "curl https://{domain}/api/chat/websites/{id}/offline -d '{\"body\": \"hello world\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
5307         "type": "json"
5308       }
5309     ],
5310     "name": "offline",
5311     "group": "Chat_Websites",
5312     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5313     "version": "0.0.0",
5314     "filename": "server/api/chatWebsite/index.js",
5315     "groupTitle": "Chat_Websites"
5316   },
5317   {
5318     "type": "put",
5319     "url": "/api/chat/messages/{id}/reject",
5320     "title": "Rejects message",
5321     "examples": [
5322       {
5323         "title": "Example usage:",
5324         "content": "curl https://{domain}/api/chat/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
5325         "type": "json"
5326       }
5327     ],
5328     "name": "rejectMessage",
5329     "group": "Chat_Websites",
5330     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5331     "version": "0.0.0",
5332     "filename": "server/api/chatMessage/index.js",
5333     "groupTitle": "Chat_Websites"
5334   },
5335   {
5336     "type": "put",
5337     "url": "/api/chat/websites/{id}",
5338     "title": "Update an existing Website",
5339     "examples": [
5340       {
5341         "title": "Example usage:",
5342         "content": "curl https://{domain}/api/chat/websites/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
5343         "type": "json"
5344       }
5345     ],
5346     "name": "updateWebsites",
5347     "group": "Chat_Websites",
5348     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5349     "version": "0.0.0",
5350     "filename": "server/api/chatWebsite/index.js",
5351     "groupTitle": "Chat_Websites"
5352   },
5353   {
5354     "type": "post",
5355     "url": "/api/cloudProviders",
5356     "title": "Creates a new CloudProvider",
5357     "examples": [
5358       {
5359         "title": "Example usage:",
5360         "content": "curl https://{domain}/api/cloudProviders -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5361         "type": "json"
5362       }
5363     ],
5364     "name": "CreateCloudProviders",
5365     "group": "CloudProviders",
5366     "parameter": {
5367       "fields": {
5368         "Body": [
5369           {
5370             "group": "Body",
5371             "type": "String",
5372             "optional": false,
5373             "field": "name",
5374             "description": ""
5375           },
5376           {
5377             "group": "Body",
5378             "type": "String",
5379             "allowedValues": [
5380               "\"AmazonAWS\"",
5381               "\"Google\""
5382             ],
5383             "optional": false,
5384             "field": "service",
5385             "description": ""
5386           },
5387           {
5388             "group": "Body",
5389             "type": "String",
5390             "optional": true,
5391             "field": "data1",
5392             "description": ""
5393           },
5394           {
5395             "group": "Body",
5396             "type": "String",
5397             "optional": true,
5398             "field": "data2",
5399             "description": ""
5400           }
5401         ]
5402       }
5403     },
5404     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5405     "version": "0.0.0",
5406     "filename": "server/api/cloudProvider/index.js",
5407     "groupTitle": "CloudProviders"
5408   },
5409   {
5410     "type": "delete",
5411     "url": "/api/cloudProviders/{id}",
5412     "title": "Deletes a CloudProvider",
5413     "examples": [
5414       {
5415         "title": "Example usage:",
5416         "content": "curl https://{domain}/api/cloudProviders/{id} -v -u {name}:{password} -X DELETE",
5417         "type": "json"
5418       }
5419     ],
5420     "name": "DeleteCloudProviders",
5421     "group": "CloudProviders",
5422     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5423     "version": "0.0.0",
5424     "filename": "server/api/cloudProvider/index.js",
5425     "groupTitle": "CloudProviders"
5426   },
5427   {
5428     "type": "get",
5429     "url": "/api/cloudProviders",
5430     "title": "Gets a list of CloudProviders",
5431     "examples": [
5432       {
5433         "title": "Example usage:",
5434         "content": "curl https://{domain}/api/cloudProviders -v -u {name}:{password}",
5435         "type": "json"
5436       }
5437     ],
5438     "name": "GetCloudProviders",
5439     "group": "CloudProviders",
5440     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/cloudProviders?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/cloudProviders?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/cloudProviders?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/cloudProviders?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/cloudProviders?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
5441     "version": "0.0.0",
5442     "filename": "server/api/cloudProvider/index.js",
5443     "groupTitle": "CloudProviders"
5444   },
5445   {
5446     "type": "get",
5447     "url": "/api/cloudProviders/{id}",
5448     "title": "Gets a single CloudProvider",
5449     "examples": [
5450       {
5451         "title": "Example usage:",
5452         "content": "curl https://{domain}/api/cloudProviders/{id} -v -u {name}:{password}",
5453         "type": "json"
5454       }
5455     ],
5456     "name": "ShowCloudProviders",
5457     "group": "CloudProviders",
5458     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5459     "version": "0.0.0",
5460     "filename": "server/api/cloudProvider/index.js",
5461     "groupTitle": "CloudProviders"
5462   },
5463   {
5464     "type": "put",
5465     "url": "/api/cloudProviders/{id}",
5466     "title": "Update an existing CloudProvider",
5467     "examples": [
5468       {
5469         "title": "Example usage:",
5470         "content": "curl https://{domain}/api/cloudProviders/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
5471         "type": "json"
5472       }
5473     ],
5474     "name": "updateCloudProviders",
5475     "group": "CloudProviders",
5476     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5477     "version": "0.0.0",
5478     "filename": "server/api/cloudProvider/index.js",
5479     "groupTitle": "CloudProviders"
5480   },
5481   {
5482     "type": "post",
5483     "url": "/api/cm/companies",
5484     "title": "Creates a new Company",
5485     "examples": [
5486       {
5487         "title": "Example usage:",
5488         "content": "curl https://{domain}/api/cm/companies -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5489         "type": "json"
5490       }
5491     ],
5492     "name": "CreateCompanies",
5493     "group": "Cm_Companies",
5494     "parameter": {
5495       "fields": {
5496         "Body": [
5497           {
5498             "group": "Body",
5499             "type": "String",
5500             "optional": false,
5501             "field": "name",
5502             "description": ""
5503           },
5504           {
5505             "group": "Body",
5506             "type": "String",
5507             "optional": true,
5508             "field": "vat",
5509             "description": ""
5510           },
5511           {
5512             "group": "Body",
5513             "type": "String",
5514             "optional": true,
5515             "field": "companyId",
5516             "description": ""
5517           },
5518           {
5519             "group": "Body",
5520             "type": "String",
5521             "optional": true,
5522             "field": "website",
5523             "description": ""
5524           },
5525           {
5526             "group": "Body",
5527             "type": "String",
5528             "optional": true,
5529             "field": "phone",
5530             "description": ""
5531           },
5532           {
5533             "group": "Body",
5534             "type": "String",
5535             "optional": true,
5536             "field": "fax",
5537             "description": ""
5538           },
5539           {
5540             "group": "Body",
5541             "type": "String",
5542             "optional": true,
5543             "field": "type",
5544             "description": ""
5545           },
5546           {
5547             "group": "Body",
5548             "type": "String",
5549             "optional": true,
5550             "field": "street",
5551             "description": ""
5552           },
5553           {
5554             "group": "Body",
5555             "type": "String",
5556             "optional": true,
5557             "field": "postalCode",
5558             "description": ""
5559           },
5560           {
5561             "group": "Body",
5562             "type": "String",
5563             "optional": true,
5564             "field": "city",
5565             "description": ""
5566           },
5567           {
5568             "group": "Body",
5569             "type": "String",
5570             "optional": true,
5571             "field": "country",
5572             "description": ""
5573           },
5574           {
5575             "group": "Body",
5576             "type": "String",
5577             "optional": true,
5578             "field": "email",
5579             "description": ""
5580           },
5581           {
5582             "group": "Body",
5583             "type": "String",
5584             "optional": true,
5585             "field": "emailDomain",
5586             "description": ""
5587           },
5588           {
5589             "group": "Body",
5590             "type": "String",
5591             "optional": true,
5592             "field": "sStreet",
5593             "description": ""
5594           },
5595           {
5596             "group": "Body",
5597             "type": "String",
5598             "optional": true,
5599             "field": "sPostalCode",
5600             "description": ""
5601           },
5602           {
5603             "group": "Body",
5604             "type": "String",
5605             "optional": true,
5606             "field": "sCity",
5607             "description": ""
5608           },
5609           {
5610             "group": "Body",
5611             "type": "String",
5612             "optional": true,
5613             "field": "sCountry",
5614             "description": ""
5615           },
5616           {
5617             "group": "Body",
5618             "type": "String",
5619             "optional": true,
5620             "field": "description",
5621             "description": ""
5622           }
5623         ]
5624       }
5625     },
5626     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5627     "version": "0.0.0",
5628     "filename": "server/api/cmCompany/index.js",
5629     "groupTitle": "Cm_Companies"
5630   },
5631   {
5632     "type": "delete",
5633     "url": "/api/cm/companies/{id}",
5634     "title": "Deletes a Company",
5635     "examples": [
5636       {
5637         "title": "Example usage:",
5638         "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password} -X DELETE",
5639         "type": "json"
5640       }
5641     ],
5642     "name": "DeleteCompanies",
5643     "group": "Cm_Companies",
5644     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5645     "version": "0.0.0",
5646     "filename": "server/api/cmCompany/index.js",
5647     "groupTitle": "Cm_Companies"
5648   },
5649   {
5650     "type": "get",
5651     "url": "/api/cm/companies/describe",
5652     "title": "Gets table info about Companies",
5653     "examples": [
5654       {
5655         "title": "Example usage:",
5656         "content": "curl https://{domain}/api/cm/companies/describe -v -u {name}:{password}",
5657         "type": "json"
5658       }
5659     ],
5660     "name": "DescribeCompanies",
5661     "group": "Cm_Companies",
5662     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5663     "version": "0.0.0",
5664     "filename": "server/api/cmCompany/index.js",
5665     "groupTitle": "Cm_Companies"
5666   },
5667   {
5668     "type": "get",
5669     "url": "/api/cm/companies",
5670     "title": "Gets a list of Companies",
5671     "examples": [
5672       {
5673         "title": "Example usage:",
5674         "content": "curl https://{domain}/api/cm/companies -v -u {name}:{password}",
5675         "type": "json"
5676       }
5677     ],
5678     "name": "GetCompanies",
5679     "group": "Cm_Companies",
5680     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/cm/companies?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/cm/companies?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/cm/companies?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/cm/companies?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/cm/companies?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
5681     "version": "0.0.0",
5682     "filename": "server/api/cmCompany/index.js",
5683     "groupTitle": "Cm_Companies"
5684   },
5685   {
5686     "type": "get",
5687     "url": "/api/cm/companies/{id}",
5688     "title": "Gets a single Company",
5689     "examples": [
5690       {
5691         "title": "Example usage:",
5692         "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password}",
5693         "type": "json"
5694       }
5695     ],
5696     "name": "ShowCompanies",
5697     "group": "Cm_Companies",
5698     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5699     "version": "0.0.0",
5700     "filename": "server/api/cmCompany/index.js",
5701     "groupTitle": "Cm_Companies"
5702   },
5703   {
5704     "type": "post",
5705     "url": "/api/cm/companies/{id}/contacts",
5706     "title": "Creates new contacts",
5707     "examples": [
5708       {
5709         "title": "Example usage:",
5710         "content": "curl https://{domain}/api/cm/companies/{id}/contacts -d '[{\"firstName\": \"John Doe\", \"email\": \"john.doe@xcally.com\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
5711         "type": "json"
5712       }
5713     ],
5714     "name": "addContacts",
5715     "group": "Cm_Companies",
5716     "parameter": {
5717       "fields": {
5718         "Body": [
5719           {
5720             "group": "Body",
5721             "type": "String",
5722             "optional": false,
5723             "field": "firstName",
5724             "description": ""
5725           },
5726           {
5727             "group": "Body",
5728             "type": "String",
5729             "optional": true,
5730             "field": "lastName",
5731             "description": ""
5732           },
5733           {
5734             "group": "Body",
5735             "type": "String",
5736             "optional": true,
5737             "field": "street",
5738             "description": ""
5739           },
5740           {
5741             "group": "Body",
5742             "type": "String",
5743             "optional": true,
5744             "field": "postalCode",
5745             "description": ""
5746           },
5747           {
5748             "group": "Body",
5749             "type": "String",
5750             "optional": true,
5751             "field": "city",
5752             "description": ""
5753           },
5754           {
5755             "group": "Body",
5756             "type": "String",
5757             "optional": true,
5758             "field": "country",
5759             "description": ""
5760           },
5761           {
5762             "group": "Body",
5763             "type": "String",
5764             "optional": true,
5765             "field": "dateOfBirth",
5766             "description": ""
5767           },
5768           {
5769             "group": "Body",
5770             "type": "Text",
5771             "optional": true,
5772             "field": "description",
5773             "description": ""
5774           },
5775           {
5776             "group": "Body",
5777             "type": "String",
5778             "optional": true,
5779             "field": "phone",
5780             "description": ""
5781           },
5782           {
5783             "group": "Body",
5784             "type": "String",
5785             "optional": true,
5786             "field": "mobile",
5787             "description": ""
5788           },
5789           {
5790             "group": "Body",
5791             "type": "String",
5792             "optional": true,
5793             "field": "fax",
5794             "description": ""
5795           },
5796           {
5797             "group": "Body",
5798             "type": "String",
5799             "optional": true,
5800             "field": "email",
5801             "description": ""
5802           },
5803           {
5804             "group": "Body",
5805             "type": "String",
5806             "optional": true,
5807             "field": "url",
5808             "description": ""
5809           },
5810           {
5811             "group": "Body",
5812             "type": "String",
5813             "optional": true,
5814             "field": "facebook",
5815             "description": ""
5816           },
5817           {
5818             "group": "Body",
5819             "type": "String",
5820             "optional": true,
5821             "field": "fb_data",
5822             "description": ""
5823           },
5824           {
5825             "group": "Body",
5826             "type": "String",
5827             "optional": true,
5828             "field": "twitter",
5829             "description": ""
5830           },
5831           {
5832             "group": "Body",
5833             "type": "String",
5834             "optional": true,
5835             "field": "skype",
5836             "description": ""
5837           },
5838           {
5839             "group": "Body",
5840             "type": "String",
5841             "optional": true,
5842             "field": "teams",
5843             "description": ""
5844           },
5845           {
5846             "group": "Body",
5847             "type": "String",
5848             "optional": true,
5849             "field": "viber",
5850             "description": ""
5851           },
5852           {
5853             "group": "Body",
5854             "type": "String",
5855             "optional": true,
5856             "field": "line",
5857             "description": ""
5858           },
5859           {
5860             "group": "Body",
5861             "type": "String",
5862             "optional": true,
5863             "field": "wechat",
5864             "description": ""
5865           },
5866           {
5867             "group": "Body",
5868             "type": "String",
5869             "optional": true,
5870             "field": "telegram",
5871             "description": ""
5872           },
5873           {
5874             "group": "Body",
5875             "type": "Integer",
5876             "optional": true,
5877             "field": "UserId",
5878             "description": ""
5879           },
5880           {
5881             "group": "Body",
5882             "type": "Integer",
5883             "optional": true,
5884             "field": "priority",
5885             "description": ""
5886           },
5887           {
5888             "group": "Body",
5889             "type": "String",
5890             "optional": true,
5891             "field": "scheduledat",
5892             "description": ""
5893           }
5894         ]
5895       }
5896     },
5897     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5898     "version": "0.0.0",
5899     "filename": "server/api/cmCompany/index.js",
5900     "groupTitle": "Cm_Companies"
5901   },
5902   {
5903     "type": "get",
5904     "url": "/api/cm/companies/{id}/contacts",
5905     "title": "Gets List Contacts",
5906     "examples": [
5907       {
5908         "title": "Example usage:",
5909         "content": "curl https://{domain}/api/fax/companies/{id}/contacts -v -u {name}:{password} -X GET",
5910         "type": "json"
5911       }
5912     ],
5913     "name": "getContacts",
5914     "group": "Cm_Companies",
5915     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5916     "version": "0.0.0",
5917     "filename": "server/api/cmCompany/index.js",
5918     "groupTitle": "Cm_Companies"
5919   },
5920   {
5921     "type": "put",
5922     "url": "/api/cm/companies/{id}",
5923     "title": "Update an existing Company",
5924     "examples": [
5925       {
5926         "title": "Example usage:",
5927         "content": "curl https://{domain}/api/cm/companies/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
5928         "type": "json"
5929       }
5930     ],
5931     "name": "updateCompanies",
5932     "group": "Cm_Companies",
5933     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5934     "version": "0.0.0",
5935     "filename": "server/api/cmCompany/index.js",
5936     "groupTitle": "Cm_Companies"
5937   },
5938   {
5939     "type": "delete",
5940     "url": "/api/cm/contacts/{id}",
5941     "title": "Deletes a Contact",
5942     "examples": [
5943       {
5944         "title": "Example usage:",
5945         "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X DELETE",
5946         "type": "json"
5947       }
5948     ],
5949     "name": "DeleteContacts",
5950     "group": "Cm_Contacts",
5951     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5952     "version": "0.0.0",
5953     "filename": "server/api/cmContact/index.js",
5954     "groupTitle": "Cm_Contacts"
5955   },
5956   {
5957     "type": "get",
5958     "url": "/api/cm/contacts/describe",
5959     "title": "Gets table info about Contacts",
5960     "examples": [
5961       {
5962         "title": "Example usage:",
5963         "content": "curl https://{domain}/api/cm/contacts/describe -v -u {name}:{password}",
5964         "type": "json"
5965       }
5966     ],
5967     "name": "DescribeContacts",
5968     "group": "Cm_Contacts",
5969     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5970     "version": "0.0.0",
5971     "filename": "server/api/cmContact/index.js",
5972     "groupTitle": "Cm_Contacts"
5973   },
5974   {
5975     "type": "get",
5976     "url": "/api/cm/contacts",
5977     "title": "Gets a list of Contacts",
5978     "examples": [
5979       {
5980         "title": "Example usage:",
5981         "content": "curl https://{domain}/api/cm/contacts -v -u {name}:{password}",
5982         "type": "json"
5983       }
5984     ],
5985     "name": "GetContacts",
5986     "group": "Cm_Contacts",
5987     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/cm/contacts?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/cm/contacts?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/cm/contacts?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/cm/contacts?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/cm/contacts?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
5988     "version": "0.0.0",
5989     "filename": "server/api/cmContact/index.js",
5990     "groupTitle": "Cm_Contacts"
5991   },
5992   {
5993     "type": "get",
5994     "url": "/api/cm/contacts/{id}/finals",
5995     "title": "Gets contact hopper finals",
5996     "examples": [
5997       {
5998         "title": "Example usage:",
5999         "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_finals -v -u {name}:{password}  -X GET",
6000         "type": "json"
6001       }
6002     ],
6003     "name": "GetHopperFinals",
6004     "group": "Cm_Contacts",
6005     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6006     "version": "0.0.0",
6007     "filename": "server/api/cmContact/index.js",
6008     "groupTitle": "Cm_Contacts"
6009   },
6010   {
6011     "type": "get",
6012     "url": "/api/cm/contacts/{id}/hopper_histories",
6013     "title": "Gets contact hopper histories",
6014     "examples": [
6015       {
6016         "title": "Example usage:",
6017         "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_histories -v -u {name}:{password} -X GET",
6018         "type": "json"
6019       }
6020     ],
6021     "name": "GetHopperHistories",
6022     "group": "Cm_Contacts",
6023     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6024     "version": "0.0.0",
6025     "filename": "server/api/cmContact/index.js",
6026     "groupTitle": "Cm_Contacts"
6027   },
6028   {
6029     "type": "get",
6030     "url": "/api/cm/contacts/{id}/hoppers",
6031     "title": "Gets contact hoppers",
6032     "examples": [
6033       {
6034         "title": "Example usage:",
6035         "content": "curl https://{domain}/api/cm/contacts/{id}/hoppers -v -u {name}:{password} -X GET",
6036         "type": "json"
6037       }
6038     ],
6039     "name": "GetHoppers",
6040     "group": "Cm_Contacts",
6041     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6042     "version": "0.0.0",
6043     "filename": "server/api/cmContact/index.js",
6044     "groupTitle": "Cm_Contacts"
6045   },
6046   {
6047     "type": "post",
6048     "url": "/api/cm/contacts/create_many",
6049     "title": "Create Contacts",
6050     "examples": [
6051       {
6052         "title": "Example usage:",
6053         "content": "curl https://{domain}/api/cm/contacts/create_many -d '[{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",
6054         "type": "json"
6055       }
6056     ],
6057     "name": "bulkCreate",
6058     "group": "Cm_Contacts",
6059     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6060     "version": "0.0.0",
6061     "filename": "server/api/cmContact/index.js",
6062     "groupTitle": "Cm_Contacts"
6063   },
6064   {
6065     "type": "post",
6066     "url": "/api/cm/contacts",
6067     "title": "Create Contact",
6068     "examples": [
6069       {
6070         "title": "Example usage:",
6071         "content": "curl https://{domain}/api/cm/contacts -d '{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}' -v -u {name}:{password} -X POST",
6072         "type": "json"
6073       }
6074     ],
6075     "name": "create",
6076     "group": "Cm_Contacts",
6077     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6078     "version": "0.0.0",
6079     "filename": "server/api/cmContact/index.js",
6080     "groupTitle": "Cm_Contacts"
6081   },
6082   {
6083     "type": "get",
6084     "url": "/api/cm/contacts/{id}/jscripty_sessions",
6085     "title": "Gets contact hopper blacks",
6086     "examples": [
6087       {
6088         "title": "Example usage:",
6089         "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_black -v -u {name}:{password}  -X GET",
6090         "type": "json"
6091       }
6092     ],
6093     "name": "getJscriptySessions",
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}/tags",
6103     "title": "Gets configurations tags",
6104     "examples": [
6105       {
6106         "title": "Example usage:",
6107         "content": "curl https://{domain}/api/cm/contacts/{id}/tags -v -u {name}:{password} -X GET",
6108         "type": "json"
6109       }
6110     ],
6111     "name": "getTags",
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": "post",
6120     "url": "/api/cm/contacts/merge",
6121     "title": "Merge Contact",
6122     "examples": [
6123       {
6124         "title": "Example usage:",
6125         "content": "curl https://{domain}/api/cm/contacts/merge -d '{\"from\": 1, \"to\": 2}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6126         "type": "json"
6127       }
6128     ],
6129     "name": "merge",
6130     "group": "Cm_Contacts",
6131     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/{id}/tags",
6139     "title": "Sets new tags",
6140     "examples": [
6141       {
6142         "title": "Example usage:",
6143         "content": "curl https://{domain}/api/cm/contacts/{id}/tags -d '{\"ids\": [1,12]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6144         "type": "json"
6145       }
6146     ],
6147     "name": "setTags",
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": "get",
6156     "url": "/api/cm/contacts/{id}",
6157     "title": "Gets a single Contact",
6158     "examples": [
6159       {
6160         "title": "Example usage:",
6161         "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X GET",
6162         "type": "json"
6163       }
6164     ],
6165     "name": "show",
6166     "group": "Cm_Contacts",
6167     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "put",
6174     "url": "/api/cm/contacts/{id}",
6175     "title": "Update a single Contact",
6176     "examples": [
6177       {
6178         "title": "Example usage:",
6179         "content": "curl https://{domain}/api/cm/contacts/{id} -d '{\"firstName\": \"John\", \"lastName\": \"Doe\"}' -v -u {name}:{password} -X PUT",
6180         "type": "json"
6181       }
6182     ],
6183     "name": "update",
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": "delete",
6192     "url": "/api/cm/custom_fields/{id}",
6193     "title": "Deletes a Custom Field",
6194     "examples": [
6195       {
6196         "title": "Example usage:",
6197         "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password} -X DELETE",
6198         "type": "json"
6199       }
6200     ],
6201     "name": "DeleteCustom_Fields",
6202     "group": "Cm_Custom_Fields",
6203     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/cmCustomField/index.js",
6206     "groupTitle": "Cm_Custom_Fields"
6207   },
6208   {
6209     "type": "get",
6210     "url": "/api/cm/custom_fields",
6211     "title": "Gets a list of Custom Fields",
6212     "examples": [
6213       {
6214         "title": "Example usage:",
6215         "content": "curl https://{domain}/api/cm/custom_fields -v -u {name}:{password}",
6216         "type": "json"
6217       }
6218     ],
6219     "name": "GetCustom_Fields",
6220     "group": "Cm_Custom_Fields",
6221     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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/{id}",
6229     "title": "Gets a single Custom Field",
6230     "examples": [
6231       {
6232         "title": "Example usage:",
6233         "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password}",
6234         "type": "json"
6235       }
6236     ],
6237     "name": "ShowCustom_Fields",
6238     "group": "Cm_Custom_Fields",
6239     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6240     "version": "0.0.0",
6241     "filename": "server/api/cmCustomField/index.js",
6242     "groupTitle": "Cm_Custom_Fields"
6243   },
6244   {
6245     "type": "put",
6246     "url": "/api/cm/custom_fields/{id}",
6247     "title": "Update an existing Custom Field",
6248     "examples": [
6249       {
6250         "title": "Example usage:",
6251         "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",
6252         "type": "json"
6253       }
6254     ],
6255     "name": "updateCustom_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": "post",
6264     "url": "/api/cm/hopper",
6265     "title": "Creates a new Hopper",
6266     "examples": [
6267       {
6268         "title": "Example usage:",
6269         "content": "curl https://{domain}/api/cm/hopper -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
6270         "type": "json"
6271       }
6272     ],
6273     "name": "CreateHopper",
6274     "group": "Cm_Hopper",
6275     "parameter": {
6276       "fields": {
6277         "Body": [
6278           {
6279             "group": "Body",
6280             "type": "String",
6281             "optional": false,
6282             "field": "phone",
6283             "description": ""
6284           },
6285           {
6286             "group": "Body",
6287             "type": "Boolean",
6288             "optional": true,
6289             "field": "active",
6290             "description": ""
6291           },
6292           {
6293             "group": "Body",
6294             "type": "String",
6295             "optional": true,
6296             "field": "scheduledat",
6297             "description": ""
6298           },
6299           {
6300             "group": "Body",
6301             "type": "Integer",
6302             "optional": true,
6303             "field": "countbusyretry",
6304             "description": ""
6305           },
6306           {
6307             "group": "Body",
6308             "type": "Integer",
6309             "optional": true,
6310             "field": "countcongestionretry",
6311             "description": ""
6312           },
6313           {
6314             "group": "Body",
6315             "type": "Integer",
6316             "optional": true,
6317             "field": "countnoanswerretry",
6318             "description": ""
6319           },
6320           {
6321             "group": "Body",
6322             "type": "Boolean",
6323             "optional": true,
6324             "field": "callback",
6325             "description": ""
6326           },
6327           {
6328             "group": "Body",
6329             "type": "String",
6330             "optional": true,
6331             "field": "callbackuniqueid",
6332             "description": ""
6333           },
6334           {
6335             "group": "Body",
6336             "type": "String",
6337             "optional": true,
6338             "field": "callbackat",
6339             "description": ""
6340           },
6341           {
6342             "group": "Body",
6343             "type": "Integer",
6344             "optional": true,
6345             "field": "priority",
6346             "description": ""
6347           },
6348           {
6349             "group": "Body",
6350             "type": "Boolean",
6351             "optional": true,
6352             "field": "recallme",
6353             "description": ""
6354           },
6355           {
6356             "group": "Body",
6357             "type": "Integer",
6358             "optional": true,
6359             "field": "ContactId",
6360             "description": ""
6361           },
6362           {
6363             "group": "Body",
6364             "type": "Integer",
6365             "optional": true,
6366             "field": "ListId",
6367             "description": ""
6368           },
6369           {
6370             "group": "Body",
6371             "type": "Integer",
6372             "optional": true,
6373             "field": "UserId",
6374             "description": ""
6375           },
6376           {
6377             "group": "Body",
6378             "type": "Integer",
6379             "optional": true,
6380             "field": "VoiceQueueId",
6381             "description": ""
6382           },
6383           {
6384             "group": "Body",
6385             "type": "Integer",
6386             "optional": true,
6387             "field": "CampaignId",
6388             "description": ""
6389           },
6390           {
6391             "group": "Body",
6392             "type": "Integer",
6393             "optional": true,
6394             "field": "countnosuchnumberretry",
6395             "description": ""
6396           },
6397           {
6398             "group": "Body",
6399             "type": "Integer",
6400             "optional": true,
6401             "field": "countdropretry",
6402             "description": ""
6403           },
6404           {
6405             "group": "Body",
6406             "type": "Integer",
6407             "optional": true,
6408             "field": "countabandonedretry",
6409             "description": ""
6410           },
6411           {
6412             "group": "Body",
6413             "type": "Integer",
6414             "optional": true,
6415             "field": "countmachineretry",
6416             "description": ""
6417           },
6418           {
6419             "group": "Body",
6420             "type": "Integer",
6421             "optional": true,
6422             "field": "countagentrejectretry",
6423             "description": ""
6424           }
6425         ]
6426       }
6427     },
6428     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6429     "version": "0.0.0",
6430     "filename": "server/api/cmHopper/index.js",
6431     "groupTitle": "Cm_Hopper"
6432   },
6433   {
6434     "type": "get",
6435     "url": "/api/cm/hopper/describe",
6436     "title": "Gets table info about Hopper",
6437     "examples": [
6438       {
6439         "title": "Example usage:",
6440         "content": "curl https://{domain}/api/cm/hopper/describe -v -u {name}:{password}",
6441         "type": "json"
6442       }
6443     ],
6444     "name": "DescribeHopper",
6445     "group": "Cm_Hopper",
6446     "description": "<p>Motion will return a HTTP status code <code>200</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",
6454     "title": "Gets a list of Hopper",
6455     "examples": [
6456       {
6457         "title": "Example usage:",
6458         "content": "curl https://{domain}/api/cm/hopper -v -u {name}:{password}",
6459         "type": "json"
6460       }
6461     ],
6462     "name": "GetHopper",
6463     "group": "Cm_Hopper",
6464     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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/{id}",
6472     "title": "Gets a single Hopper",
6473     "examples": [
6474       {
6475         "title": "Example usage:",
6476         "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password}",
6477         "type": "json"
6478       }
6479     ],
6480     "name": "ShowHopper",
6481     "group": "Cm_Hopper",
6482     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6483     "version": "0.0.0",
6484     "filename": "server/api/cmHopper/index.js",
6485     "groupTitle": "Cm_Hopper"
6486   },
6487   {
6488     "type": "delete",
6489     "url": "/api/cm/hopper_black/{id}",
6490     "title": "Deletes a Hopper Black",
6491     "examples": [
6492       {
6493         "title": "Example usage:",
6494         "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password} -X DELETE",
6495         "type": "json"
6496       }
6497     ],
6498     "name": "DeleteHopper_Black",
6499     "group": "Cm_Hopper_Black",
6500     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/cmHopperBlack/index.js",
6503     "groupTitle": "Cm_Hopper_Black"
6504   },
6505   {
6506     "type": "get",
6507     "url": "/api/cm/hopper_black/describe",
6508     "title": "Gets table info about Hopper Black",
6509     "examples": [
6510       {
6511         "title": "Example usage:",
6512         "content": "curl https://{domain}/api/cm/hopper_black/describe -v -u {name}:{password}",
6513         "type": "json"
6514       }
6515     ],
6516     "name": "DescribeHopper_Black",
6517     "group": "Cm_Hopper_Black",
6518     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</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",
6526     "title": "Gets a list of Hopper Black",
6527     "examples": [
6528       {
6529         "title": "Example usage:",
6530         "content": "curl https://{domain}/api/cm/hopper_black -v -u {name}:{password}",
6531         "type": "json"
6532       }
6533     ],
6534     "name": "GetHopper_Black",
6535     "group": "Cm_Hopper_Black",
6536     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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/{id}",
6544     "title": "Gets a single Hopper Black",
6545     "examples": [
6546       {
6547         "title": "Example usage:",
6548         "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password}",
6549         "type": "json"
6550       }
6551     ],
6552     "name": "ShowHopper_Black",
6553     "group": "Cm_Hopper_Black",
6554     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6555     "version": "0.0.0",
6556     "filename": "server/api/cmHopperBlack/index.js",
6557     "groupTitle": "Cm_Hopper_Black"
6558   },
6559   {
6560     "type": "put",
6561     "url": "/api/cm/hopper_black/{id}",
6562     "title": "Update an existing Hopper Black",
6563     "examples": [
6564       {
6565         "title": "Example usage:",
6566         "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",
6567         "type": "json"
6568       }
6569     ],
6570     "name": "updateHopper_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": "post",
6579     "url": "/api/cm/hopper_final/checkContactHopper",
6580     "title": "Check if contact is in hopper",
6581     "examples": [
6582       {
6583         "title": "Example usage:",
6584         "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",
6585         "type": "json"
6586       }
6587     ],
6588     "name": "/checkContactHopper",
6589     "group": "Cm_Hopper_Final",
6590     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6591     "version": "0.0.0",
6592     "filename": "server/api/cmHopperFinal/index.js",
6593     "groupTitle": "Cm_Hopper_Final"
6594   },
6595   {
6596     "type": "get",
6597     "url": "/api/cm/hopper_final/describe",
6598     "title": "Gets table info about HopperFinal",
6599     "examples": [
6600       {
6601         "title": "Example usage:",
6602         "content": "curl https://{domain}/api/cm/hopper_final/describe -v -u {name}:{password}",
6603         "type": "json"
6604       }
6605     ],
6606     "name": "DescribeHopperFinal",
6607     "group": "Cm_Hopper_Final",
6608     "description": "<p>Motion will return a HTTP status code <code>200</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",
6616     "title": "Gets a list of HopperFinal",
6617     "examples": [
6618       {
6619         "title": "Example usage:",
6620         "content": "curl https://{domain}/api/cm/hopper_final -v -u {name}:{password}",
6621         "type": "json"
6622       }
6623     ],
6624     "name": "GetHopperFinal",
6625     "group": "Cm_Hopper_Final",
6626     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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/{id}",
6634     "title": "Gets a single HopperFinal",
6635     "examples": [
6636       {
6637         "title": "Example usage:",
6638         "content": "curl https://{domain}/api/cm/hopper_final/{id} -v -u {name}:{password}",
6639         "type": "json"
6640       }
6641     ],
6642     "name": "ShowHopperFinal",
6643     "group": "Cm_Hopper_Final",
6644     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</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/campaign/countAttributes/{id}",
6652     "title": "Return number contacts for attributes",
6653     "examples": [
6654       {
6655         "title": "Example usage:",
6656         "content": "curl https://{domain}/api/hopper_final/campaign/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
6657         "type": "json"
6658       }
6659     ],
6660     "name": "countContactsIvrCampaignHopperFinal",
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/voice/queue/countAttributes/{id}",
6670     "title": "Return number contacts for attributes",
6671     "examples": [
6672       {
6673         "title": "Example usage:",
6674         "content": "curl https://{domain}/api/hopper_final/voice/queue/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
6675         "type": "json"
6676       }
6677     ],
6678     "name": "countContactsQueueCampaignHopperFinal",
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": "post",
6687     "url": "/api/cm/hopper_final/campaign/{id}",
6688     "title": "Move contacts in hopper",
6689     "examples": [
6690       {
6691         "title": "Example usage:",
6692         "content": "curl https://{domain}/api/hopper_final/campaign/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6693         "type": "json"
6694       }
6695     ],
6696     "name": "moveContactsIvrCampaignHopperFinal",
6697     "group": "Cm_Hopper_Final",
6698     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/voice/queue/{id}",
6706     "title": "Move contacts in hopper",
6707     "examples": [
6708       {
6709         "title": "Example usage:",
6710         "content": "curl https://{domain}/api/hopper_final/voice/queue/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password}",
6711         "type": "json"
6712       }
6713     ],
6714     "name": "moveContactsQueueCampaignHopperFinal",
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": "put",
6723     "url": "/api/cm/hopper_final/{id}",
6724     "title": "Update a single hopper final",
6725     "examples": [
6726       {
6727         "title": "Example usage:",
6728         "content": "curl https://{domain}/api/hopper_final/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
6729         "type": "json"
6730       }
6731     ],
6732     "name": "update",
6733     "group": "Cm_Hopper_Final",
6734     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "post",
6741     "url": "/api/cm/hopper_history",
6742     "title": "Creates a new HopperHistory",
6743     "examples": [
6744       {
6745         "title": "Example usage:",
6746         "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",
6747         "type": "json"
6748       }
6749     ],
6750     "name": "CreateHopperHistory",
6751     "group": "Cm_Hopper_History",
6752     "parameter": {
6753       "fields": {
6754         "Body": [
6755           {
6756             "group": "Body",
6757             "type": "Integer",
6758             "optional": true,
6759             "field": "state",
6760             "description": ""
6761           },
6762           {
6763             "group": "Body",
6764             "type": "String",
6765             "optional": true,
6766             "field": "statedesc",
6767             "description": ""
6768           },
6769           {
6770             "group": "Body",
6771             "type": "String",
6772             "optional": true,
6773             "field": "scheduledat",
6774             "description": ""
6775           },
6776           {
6777             "group": "Body",
6778             "type": "Integer",
6779             "optional": true,
6780             "field": "countbusyretry",
6781             "description": ""
6782           },
6783           {
6784             "group": "Body",
6785             "type": "Integer",
6786             "optional": true,
6787             "field": "countcongestionretry",
6788             "description": ""
6789           },
6790           {
6791             "group": "Body",
6792             "type": "Integer",
6793             "optional": true,
6794             "field": "countnoanswerretry",
6795             "description": ""
6796           },
6797           {
6798             "group": "Body",
6799             "type": "Integer",
6800             "optional": true,
6801             "field": "countglobal",
6802             "description": ""
6803           },
6804           {
6805             "group": "Body",
6806             "type": "String",
6807             "optional": true,
6808             "field": "uniqueid",
6809             "description": ""
6810           },
6811           {
6812             "group": "Body",
6813             "type": "String",
6814             "optional": true,
6815             "field": "originatecalleridnum",
6816             "description": ""
6817           },
6818           {
6819             "group": "Body",
6820             "type": "String",
6821             "optional": true,
6822             "field": "originatecalleridname",
6823             "description": ""
6824           },
6825           {
6826             "group": "Body",
6827             "type": "String",
6828             "optional": true,
6829             "field": "calleridnum",
6830             "description": ""
6831           },
6832           {
6833             "group": "Body",
6834             "type": "String",
6835             "optional": true,
6836             "field": "calleridname",
6837             "description": ""
6838           },
6839           {
6840             "group": "Body",
6841             "type": "String",
6842             "optional": true,
6843             "field": "starttime",
6844             "description": ""
6845           },
6846           {
6847             "group": "Body",
6848             "type": "String",
6849             "optional": true,
6850             "field": "responsetime",
6851             "description": ""
6852           },
6853           {
6854             "group": "Body",
6855             "type": "String",
6856             "optional": true,
6857             "field": "answertime",
6858             "description": ""
6859           },
6860           {
6861             "group": "Body",
6862             "type": "String",
6863             "optional": true,
6864             "field": "droptime",
6865             "description": ""
6866           },
6867           {
6868             "group": "Body",
6869             "type": "String",
6870             "optional": true,
6871             "field": "endtime",
6872             "description": ""
6873           },
6874           {
6875             "group": "Body",
6876             "type": "Integer",
6877             "optional": true,
6878             "field": "ringtime",
6879             "description": ""
6880           },
6881           {
6882             "group": "Body",
6883             "type": "Integer",
6884             "optional": true,
6885             "field": "holdtime",
6886             "description": ""
6887           },
6888           {
6889             "group": "Body",
6890             "type": "Integer",
6891             "optional": true,
6892             "field": "talktime",
6893             "description": ""
6894           },
6895           {
6896             "group": "Body",
6897             "type": "Integer",
6898             "optional": true,
6899             "field": "followuptime",
6900             "description": ""
6901           },
6902           {
6903             "group": "Body",
6904             "type": "String",
6905             "optional": true,
6906             "field": "dropreason",
6907             "description": ""
6908           },
6909           {
6910             "group": "Body",
6911             "type": "String",
6912             "optional": true,
6913             "field": "campaign",
6914             "description": ""
6915           },
6916           {
6917             "group": "Body",
6918             "type": "String",
6919             "optional": true,
6920             "field": "campaigntype",
6921             "description": ""
6922           },
6923           {
6924             "group": "Body",
6925             "type": "String",
6926             "optional": true,
6927             "field": "membername",
6928             "description": ""
6929           },
6930           {
6931             "group": "Body",
6932             "type": "String",
6933             "optional": true,
6934             "field": "reason",
6935             "description": ""
6936           },
6937           {
6938             "group": "Body",
6939             "type": "Boolean",
6940             "optional": true,
6941             "field": "amd",
6942             "description": ""
6943           },
6944           {
6945             "group": "Body",
6946             "type": "Boolean",
6947             "optional": true,
6948             "field": "fax",
6949             "description": ""
6950           },
6951           {
6952             "group": "Body",
6953             "type": "Boolean",
6954             "optional": true,
6955             "field": "callback",
6956             "description": ""
6957           },
6958           {
6959             "group": "Body",
6960             "type": "String",
6961             "optional": true,
6962             "field": "callbackuniqueid",
6963             "description": ""
6964           },
6965           {
6966             "group": "Body",
6967             "type": "String",
6968             "optional": true,
6969             "field": "callbackat",
6970             "description": ""
6971           },
6972           {
6973             "group": "Body",
6974             "type": "Boolean",
6975             "optional": true,
6976             "field": "recallme",
6977             "description": ""
6978           },
6979           {
6980             "group": "Body",
6981             "type": "String",
6982             "optional": true,
6983             "field": "editedat",
6984             "description": ""
6985           },
6986           {
6987             "group": "Body",
6988             "type": "Boolean",
6989             "optional": true,
6990             "field": "edited",
6991             "description": ""
6992           },
6993           {
6994             "group": "Body",
6995             "type": "Integer",
6996             "optional": true,
6997             "field": "countnosuchnumberretry",
6998             "description": ""
6999           },
7000           {
7001             "group": "Body",
7002             "type": "Integer",
7003             "optional": true,
7004             "field": "countdropretry",
7005             "description": ""
7006           },
7007           {
7008             "group": "Body",
7009             "type": "Integer",
7010             "optional": true,
7011             "field": "countabandonedretry",
7012             "description": ""
7013           },
7014           {
7015             "group": "Body",
7016             "type": "Integer",
7017             "optional": true,
7018             "field": "countmachineretry",
7019             "description": ""
7020           },
7021           {
7022             "group": "Body",
7023             "type": "Integer",
7024             "optional": true,
7025             "field": "countagentrejectretry",
7026             "description": ""
7027           }
7028         ]
7029       }
7030     },
7031     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7032     "version": "0.0.0",
7033     "filename": "server/api/cmHopperHistory/index.js",
7034     "groupTitle": "Cm_Hopper_History"
7035   },
7036   {
7037     "type": "get",
7038     "url": "/api/cm/hopper_history/describe",
7039     "title": "Gets table info about HopperHistory",
7040     "examples": [
7041       {
7042         "title": "Example usage:",
7043         "content": "curl https://{domain}/api/cm/hopper_history/describe -v -u {name}:{password}",
7044         "type": "json"
7045       }
7046     ],
7047     "name": "DescribeHopperHistory",
7048     "group": "Cm_Hopper_History",
7049     "description": "<p>Motion will return a HTTP status code <code>200</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",
7057     "title": "Gets a list of HopperHistory",
7058     "examples": [
7059       {
7060         "title": "Example usage:",
7061         "content": "curl https://{domain}/api/cm/hopper_history -v -u {name}:{password}",
7062         "type": "json"
7063       }
7064     ],
7065     "name": "GetHopperHistory",
7066     "group": "Cm_Hopper_History",
7067     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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/{id}",
7075     "title": "Gets a single HopperHistory",
7076     "examples": [
7077       {
7078         "title": "Example usage:",
7079         "content": "curl https://{domain}/api/cm/hopper_history/{id} -v -u {name}:{password}",
7080         "type": "json"
7081       }
7082     ],
7083     "name": "ShowHopperHistory",
7084     "group": "Cm_Hopper_History",
7085     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7086     "version": "0.0.0",
7087     "filename": "server/api/cmHopperHistory/index.js",
7088     "groupTitle": "Cm_Hopper_History"
7089   },
7090   {
7091     "type": "put",
7092     "url": "/api/cm/hopper_history/{id}",
7093     "title": "Update a single hopper history",
7094     "examples": [
7095       {
7096         "title": "Example usage:",
7097         "content": "curl https://{domain}/api/hopper_history/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
7098         "type": "json"
7099       }
7100     ],
7101     "name": "update",
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": "delete",
7110     "url": "/api/cm/hopper/{id}",
7111     "title": "Delete Hopper",
7112     "examples": [
7113       {
7114         "title": "Example usage:",
7115         "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password} -X DELETE",
7116         "type": "json"
7117       }
7118     ],
7119     "name": "destroy",
7120     "group": "Cm_Hopper",
7121     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/cmHopper/index.js",
7124     "groupTitle": "Cm_Hopper"
7125   },
7126   {
7127     "type": "get",
7128     "url": "/api/cm/hopper/opencontacts",
7129     "title": "Gets Open Contacts",
7130     "examples": [
7131       {
7132         "title": "Example usage:",
7133         "content": "curl https://{domain}/api/cm/hopper/opencontacts -v -u {name}:{password} -X GET",
7134         "type": "json"
7135       }
7136     ],
7137     "name": "getOpenContacts",
7138     "group": "Cm_Hopper",
7139     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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": "post",
7146     "url": "/api/cm/hopper/preview",
7147     "title": "Gets Preview Dialer Contacts",
7148     "examples": [
7149       {
7150         "title": "Example usage:",
7151         "content": "curl https://{domain}/api/cm/hopper/preview -d '{\"hopperIds\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
7152         "type": "json"
7153       }
7154     ],
7155     "name": "getPreview",
7156     "group": "Cm_Hopper",
7157     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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": "put",
7164     "url": "/api/cm/hopper/{id}",
7165     "title": "Update an existing Hopper",
7166     "examples": [
7167       {
7168         "title": "Example usage:",
7169         "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",
7170         "type": "json"
7171       }
7172     ],
7173     "name": "updateHopper",
7174     "group": "Cm_Hopper",
7175     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "post",
7182     "url": "/api/cm/lists",
7183     "title": "Creates a new List",
7184     "examples": [
7185       {
7186         "title": "Example usage:",
7187         "content": "curl https://{domain}/api/cm/lists -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7188         "type": "json"
7189       }
7190     ],
7191     "name": "CreateLists",
7192     "group": "Cm_Lists",
7193     "parameter": {
7194       "fields": {
7195         "Body": [
7196           {
7197             "group": "Body",
7198             "type": "String",
7199             "optional": false,
7200             "field": "name",
7201             "description": ""
7202           },
7203           {
7204             "group": "Body",
7205             "type": "String",
7206             "optional": true,
7207             "field": "description",
7208             "description": ""
7209           },
7210           {
7211             "group": "Body",
7212             "type": "String",
7213             "optional": true,
7214             "field": "dialPrefix",
7215             "description": ""
7216           }
7217         ]
7218       }
7219     },
7220     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7221     "version": "0.0.0",
7222     "filename": "server/api/cmList/index.js",
7223     "groupTitle": "Cm_Lists"
7224   },
7225   {
7226     "type": "delete",
7227     "url": "/api/cm/lists/{id}",
7228     "title": "Deletes a List",
7229     "examples": [
7230       {
7231         "title": "Example usage:",
7232         "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password} -X DELETE",
7233         "type": "json"
7234       }
7235     ],
7236     "name": "DeleteLists",
7237     "group": "Cm_Lists",
7238     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "get",
7245     "url": "/api/cm/lists/describe",
7246     "title": "Gets table info about Lists",
7247     "examples": [
7248       {
7249         "title": "Example usage:",
7250         "content": "curl https://{domain}/api/cm/lists/describe -v -u {name}:{password}",
7251         "type": "json"
7252       }
7253     ],
7254     "name": "DescribeLists",
7255     "group": "Cm_Lists",
7256     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</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/{id}/users",
7264     "title": "Gets agents from list",
7265     "examples": [
7266       {
7267         "title": "Example usage:",
7268         "content": "curl https://{domain}/api/cm/lists/{id}/users -v -u {name}:{password} -X GET",
7269         "type": "json"
7270       }
7271     ],
7272     "name": "GetAgents",
7273     "group": "Cm_Lists",
7274     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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",
7282     "title": "Gets a list of Lists",
7283     "examples": [
7284       {
7285         "title": "Example usage:",
7286         "content": "curl https://{domain}/api/cm/lists -v -u {name}:{password}",
7287         "type": "json"
7288       }
7289     ],
7290     "name": "GetLists",
7291     "group": "Cm_Lists",
7292     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
7293     "version": "0.0.0",
7294     "filename": "server/api/cmList/index.js",
7295     "groupTitle": "Cm_Lists"
7296   },
7297   {
7298     "type": "delete",
7299     "url": "/api/cm/lists/{id}/users",
7300     "title": "Removes agents from a list",
7301     "examples": [
7302       {
7303         "title": "Example usage:",
7304         "content": "curl https://{domain}/api/cm/lists/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
7305         "type": "json"
7306       }
7307     ],
7308     "name": "RemoveAgents",
7309     "group": "Cm_Lists",
7310     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</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}/dispositions",
7318     "title": "Removes dispositions from account",
7319     "examples": [
7320       {
7321         "title": "Example usage:",
7322         "content": "curl https://{domain}/api/cm/lists/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
7323         "type": "json"
7324       }
7325     ],
7326     "name": "RemoveDispositions",
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": "get",
7335     "url": "/api/cm/lists/{id}",
7336     "title": "Gets a single List",
7337     "examples": [
7338       {
7339         "title": "Example usage:",
7340         "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password}",
7341         "type": "json"
7342       }
7343     ],
7344     "name": "ShowLists",
7345     "group": "Cm_Lists",
7346     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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": "post",
7353     "url": "/api/cm/lists/{id}/users",
7354     "title": "Adds agents to a list",
7355     "examples": [
7356       {
7357         "title": "Example usage:",
7358         "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",
7359         "type": "json"
7360       }
7361     ],
7362     "name": "addAgents",
7363     "group": "Cm_Lists",
7364     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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}/contacts",
7372     "title": "Creates new contacts",
7373     "examples": [
7374       {
7375         "title": "Example usage:",
7376         "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",
7377         "type": "json"
7378       }
7379     ],
7380     "name": "addContacts",
7381     "group": "Cm_Lists",
7382     "parameter": {
7383       "fields": {
7384         "Body": [
7385           {
7386             "group": "Body",
7387             "type": "String",
7388             "optional": false,
7389             "field": "firstName",
7390             "description": ""
7391           },
7392           {
7393             "group": "Body",
7394             "type": "String",
7395             "optional": true,
7396             "field": "lastName",
7397             "description": ""
7398           },
7399           {
7400             "group": "Body",
7401             "type": "String",
7402             "optional": true,
7403             "field": "street",
7404             "description": ""
7405           },
7406           {
7407             "group": "Body",
7408             "type": "String",
7409             "optional": true,
7410             "field": "postalCode",
7411             "description": ""
7412           },
7413           {
7414             "group": "Body",
7415             "type": "String",
7416             "optional": true,
7417             "field": "city",
7418             "description": ""
7419           },
7420           {
7421             "group": "Body",
7422             "type": "String",
7423             "optional": true,
7424             "field": "country",
7425             "description": ""
7426           },
7427           {
7428             "group": "Body",
7429             "type": "String",
7430             "optional": true,
7431             "field": "dateOfBirth",
7432             "description": ""
7433           },
7434           {
7435             "group": "Body",
7436             "type": "Text",
7437             "optional": true,
7438             "field": "description",
7439             "description": ""
7440           },
7441           {
7442             "group": "Body",
7443             "type": "String",
7444             "optional": true,
7445             "field": "phone",
7446             "description": ""
7447           },
7448           {
7449             "group": "Body",
7450             "type": "String",
7451             "optional": true,
7452             "field": "mobile",
7453             "description": ""
7454           },
7455           {
7456             "group": "Body",
7457             "type": "String",
7458             "optional": true,
7459             "field": "fax",
7460             "description": ""
7461           },
7462           {
7463             "group": "Body",
7464             "type": "String",
7465             "optional": true,
7466             "field": "email",
7467             "description": ""
7468           },
7469           {
7470             "group": "Body",
7471             "type": "String",
7472             "optional": true,
7473             "field": "url",
7474             "description": ""
7475           },
7476           {
7477             "group": "Body",
7478             "type": "String",
7479             "optional": true,
7480             "field": "facebook",
7481             "description": ""
7482           },
7483           {
7484             "group": "Body",
7485             "type": "String",
7486             "optional": true,
7487             "field": "fb_data",
7488             "description": ""
7489           },
7490           {
7491             "group": "Body",
7492             "type": "String",
7493             "optional": true,
7494             "field": "twitter",
7495             "description": ""
7496           },
7497           {
7498             "group": "Body",
7499             "type": "String",
7500             "optional": true,
7501             "field": "skype",
7502             "description": ""
7503           },
7504           {
7505             "group": "Body",
7506             "type": "String",
7507             "optional": true,
7508             "field": "teams",
7509             "description": ""
7510           },
7511           {
7512             "group": "Body",
7513             "type": "String",
7514             "optional": true,
7515             "field": "viber",
7516             "description": ""
7517           },
7518           {
7519             "group": "Body",
7520             "type": "String",
7521             "optional": true,
7522             "field": "line",
7523             "description": ""
7524           },
7525           {
7526             "group": "Body",
7527             "type": "String",
7528             "optional": true,
7529             "field": "wechat",
7530             "description": ""
7531           },
7532           {
7533             "group": "Body",
7534             "type": "String",
7535             "optional": true,
7536             "field": "telegram",
7537             "description": ""
7538           },
7539           {
7540             "group": "Body",
7541             "type": "Integer",
7542             "optional": true,
7543             "field": "UserId",
7544             "description": ""
7545           },
7546           {
7547             "group": "Body",
7548             "type": "Integer",
7549             "optional": true,
7550             "field": "priority",
7551             "description": ""
7552           },
7553           {
7554             "group": "Body",
7555             "type": "String",
7556             "optional": true,
7557             "field": "scheduledat",
7558             "description": ""
7559           }
7560         ]
7561       }
7562     },
7563     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7564     "version": "0.0.0",
7565     "filename": "server/api/cmList/index.js",
7566     "groupTitle": "Cm_Lists"
7567   },
7568   {
7569     "type": "post",
7570     "url": "/api/cm/lists/{id}/fields",
7571     "title": "Creates a new custom field",
7572     "examples": [
7573       {
7574         "title": "Example usage:",
7575         "content": "curl https://{domain}/api/cm/lists/{id}/fields -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7576         "type": "json"
7577       }
7578     ],
7579     "name": "addCustomField",
7580     "group": "Cm_Lists",
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}/dispositions",
7589     "title": "Creates new disposition",
7590     "examples": [
7591       {
7592         "title": "Example usage:",
7593         "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7594         "type": "json"
7595       }
7596     ],
7597     "name": "addDisposition",
7598     "group": "Cm_Lists",
7599     "parameter": {
7600       "fields": {
7601         "Body": [
7602           {
7603             "group": "Body",
7604             "type": "String",
7605             "optional": false,
7606             "field": "name",
7607             "description": ""
7608           },
7609           {
7610             "group": "Body",
7611             "type": "String",
7612             "allowedValues": [
7613               "\"first\"",
7614               "\"second\"",
7615               "\"third\""
7616             ],
7617             "optional": false,
7618             "field": "level",
7619             "description": ""
7620           },
7621           {
7622             "group": "Body",
7623             "type": "String",
7624             "optional": true,
7625             "field": "description",
7626             "description": ""
7627           }
7628         ]
7629       }
7630     },
7631     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7632     "version": "0.0.0",
7633     "filename": "server/api/cmList/index.js",
7634     "groupTitle": "Cm_Lists"
7635   },
7636   {
7637     "type": "get",
7638     "url": "/api/cm/lists/{id}/contacts",
7639     "title": "Gets List Contacts",
7640     "examples": [
7641       {
7642         "title": "Example usage:",
7643         "content": "curl https://{domain}/api/cm/lists/{id}/contacts -v -u {name}:{password} -X GET",
7644         "type": "json"
7645       }
7646     ],
7647     "name": "getContacts",
7648     "group": "Cm_Lists",
7649     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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}/fields",
7657     "title": "Gets Custom Fields",
7658     "examples": [
7659       {
7660         "title": "Example usage:",
7661         "content": "curl https://{domain}/api/cm/lists/{id}/fields -v -u {name}:{password} -X GET",
7662         "type": "json"
7663       }
7664     ],
7665     "name": "getCustomFields",
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}/dispositions",
7675     "title": "Gets list dispositions",
7676     "examples": [
7677       {
7678         "title": "Example usage:",
7679         "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -v -u {name}:{password} -X GET",
7680         "type": "json"
7681       }
7682     ],
7683     "name": "getDispositions",
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}/contacts/csv",
7693     "title": "Gets CSV List Contacts",
7694     "examples": [
7695       {
7696         "title": "Example usage:",
7697         "content": "curl https://{domain}/api/cm/lists/{id}/contacts/csv -v -u {name}:{password} -X GET",
7698         "type": "json"
7699       }
7700     ],
7701     "name": "grunt",
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": "put",
7710     "url": "/api/cm/lists/{id}",
7711     "title": "Update an existing List",
7712     "examples": [
7713       {
7714         "title": "Example usage:",
7715         "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",
7716         "type": "json"
7717       }
7718     ],
7719     "name": "updateLists",
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": "post",
7728     "url": "/api/cm/contacts/upload/:id",
7729     "title": "Import new contacts by csv",
7730     "examples": [
7731       {
7732         "title": "Example usage:",
7733         "content": "curl https://{domain}/api/cm/contacts/upload/:id -v -u {name}:{password} -X POST",
7734         "type": "json"
7735       }
7736     ],
7737     "name": "import",
7738     "group": "Cm_contacts",
7739     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7740     "version": "0.0.0",
7741     "filename": "server/api/cmContact/index.js",
7742     "groupTitle": "Cm_contacts"
7743   },
7744   {
7745     "type": "post",
7746     "url": "/api/cm/contacts/upload",
7747     "title": "Upload csv",
7748     "examples": [
7749       {
7750         "title": "Example usage:",
7751         "content": "curl https://{domain}/api/cm/contacts/upload -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
7752         "type": "json"
7753       }
7754     ],
7755     "name": "upload",
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/csv",
7765     "title": "Create new contacts by csv",
7766     "examples": [
7767       {
7768         "title": "Example usage:",
7769         "content": "curl https://{domain}/api/cm/contacts/csv -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
7770         "type": "json"
7771       }
7772     ],
7773     "name": "uploadCsv",
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": "delete",
7782     "url": "/api/conditions/{id}",
7783     "title": "Deletes a Condition",
7784     "examples": [
7785       {
7786         "title": "Example usage:",
7787         "content": "curl https://{domain}/api/conditions/{id} -v -u {name}:{password} -X DELETE",
7788         "type": "json"
7789       }
7790     ],
7791     "name": "DeleteConditions",
7792     "group": "Conditions",
7793     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7794     "version": "0.0.0",
7795     "filename": "server/api/condition/index.js",
7796     "groupTitle": "Conditions"
7797   },
7798   {
7799     "type": "put",
7800     "url": "/api/conditions/{id}",
7801     "title": "Update an existing Condition",
7802     "examples": [
7803       {
7804         "title": "Example usage:",
7805         "content": "curl https://{domain}/api/conditions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
7806         "type": "json"
7807       }
7808     ],
7809     "name": "updateConditions",
7810     "group": "Conditions",
7811     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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": "post",
7818     "url": "/api/cm/custom_field",
7819     "title": "Create a new custom field",
7820     "examples": [
7821       {
7822         "title": "Example usage:",
7823         "content": "curl https://{domain}/api/cm/custom_field  -d '{\"name\": \"mycf\", \"type\": \"text\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7824         "type": "json"
7825       }
7826     ],
7827     "name": "CreateCustomField",
7828     "group": "Custom_Fields",
7829     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7830     "version": "0.0.0",
7831     "filename": "server/api/cmCustomField/index.js",
7832     "groupTitle": "Custom_Fields"
7833   },
7834   {
7835     "type": "post",
7836     "url": "/api/dashboards/items",
7837     "title": "Create dasboard item",
7838     "examples": [
7839       {
7840         "title": "Example usage:",
7841         "content": "curl https://{domain}/api/dashboards/items \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
7842         "type": "json"
7843       }
7844     ],
7845     "name": "Create",
7846     "group": "Dashboard_Items",
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/dashboardItem/index.js",
7850     "groupTitle": "Dashboard_Items"
7851   },
7852   {
7853     "type": "delete",
7854     "url": "/api/dashboards/items/{id}",
7855     "title": "Deletes a Dashboard Item",
7856     "examples": [
7857       {
7858         "title": "Example usage:",
7859         "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X DELETE",
7860         "type": "json"
7861       }
7862     ],
7863     "name": "DeleteDashboard_Items",
7864     "group": "Dashboard_Items",
7865     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "get",
7872     "url": "/api/dashboards/items/{id}",
7873     "title": "Gets a single Dashboard Item",
7874     "examples": [
7875       {
7876         "title": "Example usage:",
7877         "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password}",
7878         "type": "json"
7879       }
7880     ],
7881     "name": "ShowDashboard_Items",
7882     "group": "Dashboard_Items",
7883     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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": "put",
7890     "url": "/api/dashboards/items/{id}",
7891     "title": "Update an existing item",
7892     "examples": [
7893       {
7894         "title": "Example usage:",
7895         "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X PUT",
7896         "type": "json"
7897       }
7898     ],
7899     "name": "Update",
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": "post",
7908     "url": "/api/dashboards/clone",
7909     "title": "Clone an existing Dashboard",
7910     "examples": [
7911       {
7912         "title": "Example usage:",
7913         "content": "curl https://{domain}/api/dashboards/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7914         "type": "json"
7915       }
7916     ],
7917     "name": "CloneDashboards",
7918     "group": "Dashboards",
7919     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7920     "version": "0.0.0",
7921     "filename": "server/api/dashboard/index.js",
7922     "groupTitle": "Dashboards"
7923   },
7924   {
7925     "type": "post",
7926     "url": "/api/dashboards",
7927     "title": "Creates a new Dashboard",
7928     "examples": [
7929       {
7930         "title": "Example usage:",
7931         "content": "curl https://{domain}/api/dashboards -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7932         "type": "json"
7933       }
7934     ],
7935     "name": "CreateDashboards",
7936     "group": "Dashboards",
7937     "parameter": {
7938       "fields": {
7939         "Body": [
7940           {
7941             "group": "Body",
7942             "type": "String",
7943             "optional": false,
7944             "field": "name",
7945             "description": ""
7946           },
7947           {
7948             "group": "Body",
7949             "type": "String",
7950             "optional": true,
7951             "field": "description",
7952             "description": ""
7953           }
7954         ]
7955       }
7956     },
7957     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7958     "version": "0.0.0",
7959     "filename": "server/api/dashboard/index.js",
7960     "groupTitle": "Dashboards"
7961   },
7962   {
7963     "type": "delete",
7964     "url": "/api/dashboards/{id}",
7965     "title": "Deletes a Dashboard",
7966     "examples": [
7967       {
7968         "title": "Example usage:",
7969         "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password} -X DELETE",
7970         "type": "json"
7971       }
7972     ],
7973     "name": "DeleteDashboards",
7974     "group": "Dashboards",
7975     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "get",
7982     "url": "/api/dashboards",
7983     "title": "Gets a list of Dashboards",
7984     "examples": [
7985       {
7986         "title": "Example usage:",
7987         "content": "curl https://{domain}/api/dashboards -v -u {name}:{password}",
7988         "type": "json"
7989       }
7990     ],
7991     "name": "GetDashboards",
7992     "group": "Dashboards",
7993     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
7994     "version": "0.0.0",
7995     "filename": "server/api/dashboard/index.js",
7996     "groupTitle": "Dashboards"
7997   },
7998   {
7999     "type": "get",
8000     "url": "/api/dashboards/{id}",
8001     "title": "Gets a single Dashboard",
8002     "examples": [
8003       {
8004         "title": "Example usage:",
8005         "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password}",
8006         "type": "json"
8007       }
8008     ],
8009     "name": "ShowDashboards",
8010     "group": "Dashboards",
8011     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8012     "version": "0.0.0",
8013     "filename": "server/api/dashboard/index.js",
8014     "groupTitle": "Dashboards"
8015   },
8016   {
8017     "type": "post",
8018     "url": "/api/dashboards/{id}/items",
8019     "title": "Creates new item",
8020     "examples": [
8021       {
8022         "title": "Example usage:",
8023         "content": "curl https://{domain}/api/dashboards/{id}/items -d '{\"type\": \"counter\", \"...\": \"...\"}]' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
8024         "type": "json"
8025       }
8026     ],
8027     "name": "addItem",
8028     "group": "Dashboards",
8029     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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": "get",
8036     "url": "/api/dashboards/{id}/items",
8037     "title": "Gets items",
8038     "examples": [
8039       {
8040         "title": "Example usage:",
8041         "content": "curl https://{domain}/api/dashboards/{id}/items -v -u {name}:{password} -X GET",
8042         "type": "json"
8043       }
8044     ],
8045     "name": "getItems",
8046     "group": "Dashboards",
8047     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "put",
8054     "url": "/api/dashboards/{id}",
8055     "title": "Update an existing Dashboard",
8056     "examples": [
8057       {
8058         "title": "Example usage:",
8059         "content": "curl https://{domain}/api/dashboards/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8060         "type": "json"
8061       }
8062     ],
8063     "name": "updateDashboards",
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": "post",
8072     "url": "/api/integrations/desk/accounts",
8073     "title": "Creates a new Desk Account",
8074     "examples": [
8075       {
8076         "title": "Example usage:",
8077         "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",
8078         "type": "json"
8079       }
8080     ],
8081     "name": "CreateDesk_Accounts",
8082     "group": "Desk_Accounts",
8083     "parameter": {
8084       "fields": {
8085         "Body": [
8086           {
8087             "group": "Body",
8088             "type": "String",
8089             "optional": true,
8090             "field": "name",
8091             "description": ""
8092           },
8093           {
8094             "group": "Body",
8095             "type": "String",
8096             "optional": true,
8097             "field": "description",
8098             "description": ""
8099           },
8100           {
8101             "group": "Body",
8102             "type": "String",
8103             "optional": true,
8104             "field": "username",
8105             "description": ""
8106           },
8107           {
8108             "group": "Body",
8109             "type": "String",
8110             "optional": true,
8111             "field": "remoteUri",
8112             "description": ""
8113           },
8114           {
8115             "group": "Body",
8116             "type": "String",
8117             "allowedValues": [
8118               "\"basic\""
8119             ],
8120             "optional": true,
8121             "field": "authType",
8122             "description": ""
8123           },
8124           {
8125             "group": "Body",
8126             "type": "String",
8127             "optional": true,
8128             "field": "password",
8129             "description": ""
8130           },
8131           {
8132             "group": "Body",
8133             "type": "String",
8134             "optional": true,
8135             "field": "consumerKey",
8136             "description": ""
8137           },
8138           {
8139             "group": "Body",
8140             "type": "String",
8141             "optional": true,
8142             "field": "consumerSecret",
8143             "description": ""
8144           },
8145           {
8146             "group": "Body",
8147             "type": "String",
8148             "optional": true,
8149             "field": "token",
8150             "description": ""
8151           },
8152           {
8153             "group": "Body",
8154             "type": "String",
8155             "optional": true,
8156             "field": "tokenSecret",
8157             "description": ""
8158           },
8159           {
8160             "group": "Body",
8161             "type": "String",
8162             "optional": true,
8163             "field": "serverUrl",
8164             "description": ""
8165           },
8166           {
8167             "group": "Body",
8168             "type": "String",
8169             "allowedValues": [
8170               "\"integrationTab\"",
8171               "\"newTab\""
8172             ],
8173             "optional": true,
8174             "field": "type",
8175             "description": ""
8176           }
8177         ]
8178       }
8179     },
8180     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8181     "version": "0.0.0",
8182     "filename": "server/api/intDeskAccount/index.js",
8183     "groupTitle": "Desk_Accounts"
8184   },
8185   {
8186     "type": "delete",
8187     "url": "/api/integrations/desk/accounts/{id}",
8188     "title": "Deletes a Desk Account",
8189     "examples": [
8190       {
8191         "title": "Example usage:",
8192         "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password} -X DELETE",
8193         "type": "json"
8194       }
8195     ],
8196     "name": "DeleteDesk_Accounts",
8197     "group": "Desk_Accounts",
8198     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "get",
8205     "url": "/api/integrations/desk/accounts",
8206     "title": "Gets a list of Desk Accounts",
8207     "examples": [
8208       {
8209         "title": "Example usage:",
8210         "content": "curl https://{domain}/api/integrations/desk/accounts -v -u {name}:{password}",
8211         "type": "json"
8212       }
8213     ],
8214     "name": "GetDesk_Accounts",
8215     "group": "Desk_Accounts",
8216     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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/{id}",
8224     "title": "Gets a single Desk Account",
8225     "examples": [
8226       {
8227         "title": "Example usage:",
8228         "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password}",
8229         "type": "json"
8230       }
8231     ],
8232     "name": "ShowDesk_Accounts",
8233     "group": "Desk_Accounts",
8234     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8235     "version": "0.0.0",
8236     "filename": "server/api/intDeskAccount/index.js",
8237     "groupTitle": "Desk_Accounts"
8238   },
8239   {
8240     "type": "post",
8241     "url": "/api/integrations/desk/accounts/{id}/configurations",
8242     "title": "Creates new configuration",
8243     "examples": [
8244       {
8245         "title": "Example usage:",
8246         "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",
8247         "type": "json"
8248       }
8249     ],
8250     "name": "addConfiguration",
8251     "group": "Desk_Accounts",
8252     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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": "get",
8259     "url": "/api/integrations/desk/accounts/{id}/configurations",
8260     "title": "Gets account configurations",
8261     "examples": [
8262       {
8263         "title": "Example usage:",
8264         "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
8265         "type": "json"
8266       }
8267     ],
8268     "name": "getConfigurations",
8269     "group": "Desk_Accounts",
8270     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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}/fields",
8278     "title": "Gets account fields",
8279     "examples": [
8280       {
8281         "title": "Example usage:",
8282         "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/fields -v -u {name}:{password} -X GET",
8283         "type": "json"
8284       }
8285     ],
8286     "name": "getFields",
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": "put",
8295     "url": "/api/integrations/desk/accounts/{id}",
8296     "title": "Update an existing Desk Account",
8297     "examples": [
8298       {
8299         "title": "Example usage:",
8300         "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",
8301         "type": "json"
8302       }
8303     ],
8304     "name": "updateDesk_Accounts",
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": "post",
8313     "url": "/api/integrations/desk/configurations",
8314     "title": "Creates a new Desk Configuration",
8315     "examples": [
8316       {
8317         "title": "Example usage:",
8318         "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",
8319         "type": "json"
8320       }
8321     ],
8322     "name": "CreateDesk_Configurations",
8323     "group": "Desk_Configurations",
8324     "parameter": {
8325       "fields": {
8326         "Body": [
8327           {
8328             "group": "Body",
8329             "type": "String",
8330             "optional": true,
8331             "field": "name",
8332             "description": ""
8333           },
8334           {
8335             "group": "Body",
8336             "type": "String",
8337             "optional": true,
8338             "field": "description",
8339             "description": ""
8340           }
8341         ]
8342       }
8343     },
8344     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8345     "version": "0.0.0",
8346     "filename": "server/api/intDeskConfiguration/index.js",
8347     "groupTitle": "Desk_Configurations"
8348   },
8349   {
8350     "type": "delete",
8351     "url": "/api/integrations/desk/configurations/{id}",
8352     "title": "Deletes a Desk Configuration",
8353     "examples": [
8354       {
8355         "title": "Example usage:",
8356         "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password} -X DELETE",
8357         "type": "json"
8358       }
8359     ],
8360     "name": "DeleteDesk_Configurations",
8361     "group": "Desk_Configurations",
8362     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "get",
8369     "url": "/api/integrations/desk/configurations",
8370     "title": "Gets a list of Desk Configurations",
8371     "examples": [
8372       {
8373         "title": "Example usage:",
8374         "content": "curl https://{domain}/api/integrations/desk/configurations -v -u {name}:{password}",
8375         "type": "json"
8376       }
8377     ],
8378     "name": "GetDesk_Configurations",
8379     "group": "Desk_Configurations",
8380     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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/{id}",
8388     "title": "Gets a single Desk Configuration",
8389     "examples": [
8390       {
8391         "title": "Example usage:",
8392         "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password}",
8393         "type": "json"
8394       }
8395     ],
8396     "name": "ShowDesk_Configurations",
8397     "group": "Desk_Configurations",
8398     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</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}/descriptions",
8406     "title": "Gets configurations descriptions",
8407     "examples": [
8408       {
8409         "title": "Example usage:",
8410         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
8411         "type": "json"
8412       }
8413     ],
8414     "name": "getDescriptions",
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}/fields",
8424     "title": "Gets configurations fields",
8425     "examples": [
8426       {
8427         "title": "Example usage:",
8428         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/fields -v -u {name}:{password} -X GET",
8429         "type": "json"
8430       }
8431     ],
8432     "name": "getFields",
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}/subjects",
8442     "title": "Gets configurations subjects",
8443     "examples": [
8444       {
8445         "title": "Example usage:",
8446         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
8447         "type": "json"
8448       }
8449     ],
8450     "name": "getSubjects",
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}/tags",
8460     "title": "Gets configurations tags",
8461     "examples": [
8462       {
8463         "title": "Example usage:",
8464         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/tags -v -u {name}:{password} -X GET",
8465         "type": "json"
8466       }
8467     ],
8468     "name": "getTags",
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": "post",
8477     "url": "/api/integrations/desk/configurations/{id}/tags",
8478     "title": "Sets new tags",
8479     "examples": [
8480       {
8481         "title": "Example usage:",
8482         "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",
8483         "type": "json"
8484       }
8485     ],
8486     "name": "setTags",
8487     "group": "Desk_Configurations",
8488     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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": "put",
8495     "url": "/api/integrations/desk/configurations/{id}",
8496     "title": "Update an existing Desk Configuration",
8497     "examples": [
8498       {
8499         "title": "Example usage:",
8500         "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",
8501         "type": "json"
8502       }
8503     ],
8504     "name": "updateDesk_Configurations",
8505     "group": "Desk_Configurations",
8506     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "post",
8513     "url": "/api/integrations/desk/fields",
8514     "title": "Creates a new Desk Field",
8515     "examples": [
8516       {
8517         "title": "Example usage:",
8518         "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",
8519         "type": "json"
8520       }
8521     ],
8522     "name": "CreateDesk_Fields",
8523     "group": "Desk_Fields",
8524     "parameter": {
8525       "fields": {
8526         "Body": [
8527           {
8528             "group": "Body",
8529             "type": "String",
8530             "allowedValues": [
8531               "\"string\"",
8532               "\"variable\"",
8533               "\"customVariable\"",
8534               "\"keyValue\""
8535             ],
8536             "optional": true,
8537             "field": "type",
8538             "description": ""
8539           },
8540           {
8541             "group": "Body",
8542             "type": "String",
8543             "optional": true,
8544             "field": "content",
8545             "description": ""
8546           },
8547           {
8548             "group": "Body",
8549             "type": "String",
8550             "optional": true,
8551             "field": "key",
8552             "description": ""
8553           },
8554           {
8555             "group": "Body",
8556             "type": "String",
8557             "allowedValues": [
8558               "\"string\"",
8559               "\"variable\"",
8560               "\"customVariable\""
8561             ],
8562             "optional": true,
8563             "field": "keyType",
8564             "description": ""
8565           },
8566           {
8567             "group": "Body",
8568             "type": "String",
8569             "optional": true,
8570             "field": "keyContent",
8571             "description": ""
8572           },
8573           {
8574             "group": "Body",
8575             "type": "String",
8576             "optional": true,
8577             "field": "idField",
8578             "description": ""
8579           },
8580           {
8581             "group": "Body",
8582             "type": "String",
8583             "optional": true,
8584             "field": "nameField",
8585             "description": ""
8586           },
8587           {
8588             "group": "Body",
8589             "type": "Boolean",
8590             "optional": true,
8591             "field": "customField",
8592             "description": ""
8593           },
8594           {
8595             "group": "Body",
8596             "type": "String",
8597             "optional": true,
8598             "field": "variableName",
8599             "description": ""
8600           }
8601         ]
8602       }
8603     },
8604     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8605     "version": "0.0.0",
8606     "filename": "server/api/intDeskField/index.js",
8607     "groupTitle": "Desk_Fields"
8608   },
8609   {
8610     "type": "delete",
8611     "url": "/api/integrations/desk/fields/{id}",
8612     "title": "Deletes a Desk Field",
8613     "examples": [
8614       {
8615         "title": "Example usage:",
8616         "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password} -X DELETE",
8617         "type": "json"
8618       }
8619     ],
8620     "name": "DeleteDesk_Fields",
8621     "group": "Desk_Fields",
8622     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "get",
8629     "url": "/api/integrations/desk/fields",
8630     "title": "Gets a list of Desk Fields",
8631     "examples": [
8632       {
8633         "title": "Example usage:",
8634         "content": "curl https://{domain}/api/integrations/desk/fields -v -u {name}:{password}",
8635         "type": "json"
8636       }
8637     ],
8638     "name": "GetDesk_Fields",
8639     "group": "Desk_Fields",
8640     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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/{id}",
8648     "title": "Gets a single Desk Field",
8649     "examples": [
8650       {
8651         "title": "Example usage:",
8652         "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password}",
8653         "type": "json"
8654       }
8655     ],
8656     "name": "ShowDesk_Fields",
8657     "group": "Desk_Fields",
8658     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8659     "version": "0.0.0",
8660     "filename": "server/api/intDeskField/index.js",
8661     "groupTitle": "Desk_Fields"
8662   },
8663   {
8664     "type": "put",
8665     "url": "/api/integrations/desk/fields/{id}",
8666     "title": "Update an existing Desk Field",
8667     "examples": [
8668       {
8669         "title": "Example usage:",
8670         "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",
8671         "type": "json"
8672       }
8673     ],
8674     "name": "updateDesk_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": "post",
8683     "url": "/api/dispositions",
8684     "title": "Creates a new Disposition",
8685     "examples": [
8686       {
8687         "title": "Example usage:",
8688         "content": "curl https://{domain}/api/dispositions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8689         "type": "json"
8690       }
8691     ],
8692     "name": "CreateDispositions",
8693     "group": "Dispositions",
8694     "parameter": {
8695       "fields": {
8696         "Body": [
8697           {
8698             "group": "Body",
8699             "type": "String",
8700             "optional": false,
8701             "field": "name",
8702             "description": ""
8703           },
8704           {
8705             "group": "Body",
8706             "type": "String",
8707             "allowedValues": [
8708               "\"first\"",
8709               "\"second\"",
8710               "\"third\""
8711             ],
8712             "optional": false,
8713             "field": "level",
8714             "description": ""
8715           },
8716           {
8717             "group": "Body",
8718             "type": "String",
8719             "optional": true,
8720             "field": "description",
8721             "description": ""
8722           }
8723         ]
8724       }
8725     },
8726     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8727     "version": "0.0.0",
8728     "filename": "server/api/disposition/index.js",
8729     "groupTitle": "Dispositions"
8730   },
8731   {
8732     "type": "delete",
8733     "url": "/api/dispositions/{id}",
8734     "title": "Deletes a Disposition",
8735     "examples": [
8736       {
8737         "title": "Example usage:",
8738         "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password} -X DELETE",
8739         "type": "json"
8740       }
8741     ],
8742     "name": "DeleteDispositions",
8743     "group": "Dispositions",
8744     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "get",
8751     "url": "/api/dispositions",
8752     "title": "Gets a list of Dispositions",
8753     "examples": [
8754       {
8755         "title": "Example usage:",
8756         "content": "curl https://{domain}/api/dispositions -v -u {name}:{password}",
8757         "type": "json"
8758       }
8759     ],
8760     "name": "GetDispositions",
8761     "group": "Dispositions",
8762     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8763     "version": "0.0.0",
8764     "filename": "server/api/disposition/index.js",
8765     "groupTitle": "Dispositions"
8766   },
8767   {
8768     "type": "get",
8769     "url": "/api/dispositions/{id}",
8770     "title": "Gets a single Disposition",
8771     "examples": [
8772       {
8773         "title": "Example usage:",
8774         "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password}",
8775         "type": "json"
8776       }
8777     ],
8778     "name": "ShowDispositions",
8779     "group": "Dispositions",
8780     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8781     "version": "0.0.0",
8782     "filename": "server/api/disposition/index.js",
8783     "groupTitle": "Dispositions"
8784   },
8785   {
8786     "type": "put",
8787     "url": "/api/dispositions/{id}",
8788     "title": "Update an existing Disposition",
8789     "examples": [
8790       {
8791         "title": "Example usage:",
8792         "content": "curl https://{domain}/api/dispositions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8793         "type": "json"
8794       }
8795     ],
8796     "name": "updateDispositions",
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": "post",
8805     "url": "/api/integrations/dynamics365/accounts",
8806     "title": "Creates a new Dynamics365 Account",
8807     "examples": [
8808       {
8809         "title": "Example usage:",
8810         "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",
8811         "type": "json"
8812       }
8813     ],
8814     "name": "CreateDynamics365_Accounts",
8815     "group": "Dynamics365_Accounts",
8816     "parameter": {
8817       "fields": {
8818         "Body": [
8819           {
8820             "group": "Body",
8821             "type": "String",
8822             "optional": true,
8823             "field": "name",
8824             "description": ""
8825           },
8826           {
8827             "group": "Body",
8828             "type": "String",
8829             "optional": true,
8830             "field": "username",
8831             "description": ""
8832           },
8833           {
8834             "group": "Body",
8835             "type": "String",
8836             "optional": true,
8837             "field": "password",
8838             "description": ""
8839           },
8840           {
8841             "group": "Body",
8842             "type": "String",
8843             "optional": true,
8844             "field": "remoteUri",
8845             "description": ""
8846           },
8847           {
8848             "group": "Body",
8849             "type": "String",
8850             "optional": true,
8851             "field": "tenantId",
8852             "description": ""
8853           },
8854           {
8855             "group": "Body",
8856             "type": "String",
8857             "optional": true,
8858             "field": "clientId",
8859             "description": ""
8860           },
8861           {
8862             "group": "Body",
8863             "type": "String",
8864             "optional": true,
8865             "field": "clientSecret",
8866             "description": ""
8867           },
8868           {
8869             "group": "Body",
8870             "type": "String",
8871             "optional": true,
8872             "field": "serverUrl",
8873             "description": ""
8874           },
8875           {
8876             "group": "Body",
8877             "type": "String",
8878             "optional": true,
8879             "field": "description",
8880             "description": ""
8881           }
8882         ]
8883       }
8884     },
8885     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8886     "version": "0.0.0",
8887     "filename": "server/api/intDynamics365Account/index.js",
8888     "groupTitle": "Dynamics365_Accounts"
8889   },
8890   {
8891     "type": "delete",
8892     "url": "/api/integrations/dynamics365/accounts/{id}",
8893     "title": "Deletes a Dynamics365 Account",
8894     "examples": [
8895       {
8896         "title": "Example usage:",
8897         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password} -X DELETE",
8898         "type": "json"
8899       }
8900     ],
8901     "name": "DeleteDynamics365_Accounts",
8902     "group": "Dynamics365_Accounts",
8903     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "get",
8910     "url": "/api/integrations/dynamics365/accounts",
8911     "title": "Gets a list of Dynamics365 Accounts",
8912     "examples": [
8913       {
8914         "title": "Example usage:",
8915         "content": "curl https://{domain}/api/integrations/dynamics365/accounts -v -u {name}:{password}",
8916         "type": "json"
8917       }
8918     ],
8919     "name": "GetDynamics365_Accounts",
8920     "group": "Dynamics365_Accounts",
8921     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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/{id}",
8929     "title": "Gets a single Dynamics365 Account",
8930     "examples": [
8931       {
8932         "title": "Example usage:",
8933         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password}",
8934         "type": "json"
8935       }
8936     ],
8937     "name": "ShowDynamics365_Accounts",
8938     "group": "Dynamics365_Accounts",
8939     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8940     "version": "0.0.0",
8941     "filename": "server/api/intDynamics365Account/index.js",
8942     "groupTitle": "Dynamics365_Accounts"
8943   },
8944   {
8945     "type": "post",
8946     "url": "/api/integrations/dynamics365/accounts/{id}/configurations",
8947     "title": "Creates new configuration",
8948     "examples": [
8949       {
8950         "title": "Example usage:",
8951         "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",
8952         "type": "json"
8953       }
8954     ],
8955     "name": "addConfiguration",
8956     "group": "Dynamics365_Accounts",
8957     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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": "get",
8964     "url": "/api/integrations/dynamics365/accounts/{id}/configurations",
8965     "title": "Gets account configurations",
8966     "examples": [
8967       {
8968         "title": "Example usage:",
8969         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/configurations -v -u {name}:{password} -X GET",
8970         "type": "json"
8971       }
8972     ],
8973     "name": "getConfigurations",
8974     "group": "Dynamics365_Accounts",
8975     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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}/fields",
8983     "title": "Gets account fields",
8984     "examples": [
8985       {
8986         "title": "Example usage:",
8987         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/fields -v -u {name}:{password} -X GET",
8988         "type": "json"
8989       }
8990     ],
8991     "name": "getFields",
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": "put",
9000     "url": "/api/integrations/dynamics365/accounts/{id}",
9001     "title": "Update an existing Dynamics365 Account",
9002     "examples": [
9003       {
9004         "title": "Example usage:",
9005         "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",
9006         "type": "json"
9007       }
9008     ],
9009     "name": "updateDynamics365_Accounts",
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": "post",
9018     "url": "/api/integrations/dynamics365/configurations",
9019     "title": "Creates a new Dynamics365 Configuration",
9020     "examples": [
9021       {
9022         "title": "Example usage:",
9023         "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",
9024         "type": "json"
9025       }
9026     ],
9027     "name": "CreateDynamics365_Configurations",
9028     "group": "Dynamics365_Configurations",
9029     "parameter": {
9030       "fields": {
9031         "Body": [
9032           {
9033             "group": "Body",
9034             "type": "String",
9035             "optional": true,
9036             "field": "name",
9037             "description": ""
9038           },
9039           {
9040             "group": "Body",
9041             "type": "String",
9042             "optional": true,
9043             "field": "description",
9044             "description": ""
9045           },
9046           {
9047             "group": "Body",
9048             "type": "String",
9049             "allowedValues": [
9050               "\"incident\"",
9051               "\"phonecall\""
9052             ],
9053             "optional": true,
9054             "field": "ticketType",
9055             "description": ""
9056           }
9057         ]
9058       }
9059     },
9060     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9061     "version": "0.0.0",
9062     "filename": "server/api/intDynamics365Configuration/index.js",
9063     "groupTitle": "Dynamics365_Configurations"
9064   },
9065   {
9066     "type": "delete",
9067     "url": "/api/integrations/dynamics365/configurations/{id}",
9068     "title": "Deletes a Dynamics365 Configuration",
9069     "examples": [
9070       {
9071         "title": "Example usage:",
9072         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password} -X DELETE",
9073         "type": "json"
9074       }
9075     ],
9076     "name": "DeleteDynamics365_Configurations",
9077     "group": "Dynamics365_Configurations",
9078     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "get",
9085     "url": "/api/integrations/dynamics365/configurations",
9086     "title": "Gets a list of Dynamics365 Configurations",
9087     "examples": [
9088       {
9089         "title": "Example usage:",
9090         "content": "curl https://{domain}/api/integrations/dynamics365/configurations -v -u {name}:{password}",
9091         "type": "json"
9092       }
9093     ],
9094     "name": "GetDynamics365_Configurations",
9095     "group": "Dynamics365_Configurations",
9096     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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/{id}",
9104     "title": "Gets a single Dynamics365 Configuration",
9105     "examples": [
9106       {
9107         "title": "Example usage:",
9108         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password}",
9109         "type": "json"
9110       }
9111     ],
9112     "name": "ShowDynamics365_Configurations",
9113     "group": "Dynamics365_Configurations",
9114     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</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}/descriptions",
9122     "title": "Gets configurations descriptions",
9123     "examples": [
9124       {
9125         "title": "Example usage:",
9126         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
9127         "type": "json"
9128       }
9129     ],
9130     "name": "getDescriptions",
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}/fields",
9140     "title": "Gets configurations fields",
9141     "examples": [
9142       {
9143         "title": "Example usage:",
9144         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
9145         "type": "json"
9146       }
9147     ],
9148     "name": "getFields",
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/zoho/configurations/{id}/subjects",
9158     "title": "Gets configurations subjects",
9159     "examples": [
9160       {
9161         "title": "Example usage:",
9162         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/subjects -v -u {name}:{password} -X GET",
9163         "type": "json"
9164       }
9165     ],
9166     "name": "getSubjects",
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": "put",
9175     "url": "/api/integrations/dynamics365/configurations/{id}",
9176     "title": "Update an existing Dynamics365 Configuration",
9177     "examples": [
9178       {
9179         "title": "Example usage:",
9180         "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",
9181         "type": "json"
9182       }
9183     ],
9184     "name": "updateDynamics365_Configurations",
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": "post",
9193     "url": "/api/integrations/dynamics365/fields",
9194     "title": "Creates a new Dynamics365 Field",
9195     "examples": [
9196       {
9197         "title": "Example usage:",
9198         "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",
9199         "type": "json"
9200       }
9201     ],
9202     "name": "CreateDynamics365_Fields",
9203     "group": "Dynamics365_Fields",
9204     "parameter": {
9205       "fields": {
9206         "Body": [
9207           {
9208             "group": "Body",
9209             "type": "String",
9210             "allowedValues": [
9211               "\"string\"",
9212               "\"variable\"",
9213               "\"customVariable\"",
9214               "\"keyValue\""
9215             ],
9216             "optional": true,
9217             "field": "type",
9218             "description": ""
9219           },
9220           {
9221             "group": "Body",
9222             "type": "String",
9223             "optional": true,
9224             "field": "content",
9225             "description": ""
9226           },
9227           {
9228             "group": "Body",
9229             "type": "String",
9230             "optional": true,
9231             "field": "key",
9232             "description": ""
9233           },
9234           {
9235             "group": "Body",
9236             "type": "String",
9237             "allowedValues": [
9238               "\"string\"",
9239               "\"variable\"",
9240               "\"customVariable\""
9241             ],
9242             "optional": true,
9243             "field": "keyType",
9244             "description": ""
9245           },
9246           {
9247             "group": "Body",
9248             "type": "String",
9249             "optional": true,
9250             "field": "keyContent",
9251             "description": ""
9252           },
9253           {
9254             "group": "Body",
9255             "type": "String",
9256             "optional": true,
9257             "field": "idField",
9258             "description": ""
9259           },
9260           {
9261             "group": "Body",
9262             "type": "String",
9263             "optional": true,
9264             "field": "nameField",
9265             "description": ""
9266           },
9267           {
9268             "group": "Body",
9269             "type": "Boolean",
9270             "optional": true,
9271             "field": "customField",
9272             "description": ""
9273           },
9274           {
9275             "group": "Body",
9276             "type": "String",
9277             "optional": true,
9278             "field": "variableName",
9279             "description": ""
9280           }
9281         ]
9282       }
9283     },
9284     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9285     "version": "0.0.0",
9286     "filename": "server/api/intDynamics365Field/index.js",
9287     "groupTitle": "Dynamics365_Fields"
9288   },
9289   {
9290     "type": "delete",
9291     "url": "/api/integrations/dynamics365/fields/{id}",
9292     "title": "Deletes a Dynamics365 Field",
9293     "examples": [
9294       {
9295         "title": "Example usage:",
9296         "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password} -X DELETE",
9297         "type": "json"
9298       }
9299     ],
9300     "name": "DeleteDynamics365_Fields",
9301     "group": "Dynamics365_Fields",
9302     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "get",
9309     "url": "/api/integrations/dynamics365/fields",
9310     "title": "Gets a list of Dynamics365 Fields",
9311     "examples": [
9312       {
9313         "title": "Example usage:",
9314         "content": "curl https://{domain}/api/integrations/dynamics365/fields -v -u {name}:{password}",
9315         "type": "json"
9316       }
9317     ],
9318     "name": "GetDynamics365_Fields",
9319     "group": "Dynamics365_Fields",
9320     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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/{id}",
9328     "title": "Gets a single Dynamics365 Field",
9329     "examples": [
9330       {
9331         "title": "Example usage:",
9332         "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password}",
9333         "type": "json"
9334       }
9335     ],
9336     "name": "ShowDynamics365_Fields",
9337     "group": "Dynamics365_Fields",
9338     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9339     "version": "0.0.0",
9340     "filename": "server/api/intDynamics365Field/index.js",
9341     "groupTitle": "Dynamics365_Fields"
9342   },
9343   {
9344     "type": "put",
9345     "url": "/api/integrations/dynamics365/fields/{id}",
9346     "title": "Update an existing Dynamics365 Field",
9347     "examples": [
9348       {
9349         "title": "Example usage:",
9350         "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",
9351         "type": "json"
9352       }
9353     ],
9354     "name": "updateDynamics365_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": "post",
9363     "url": "/api/fax/accounts/{id}/users",
9364     "title": "Add agents to a fax account",
9365     "examples": [
9366       {
9367         "title": "Example usage:",
9368         "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",
9369         "type": "json"
9370       }
9371     ],
9372     "name": "AddAgents",
9373     "group": "Fax_Accounts",
9374     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9375     "version": "0.0.0",
9376     "filename": "server/api/faxAccount/index.js",
9377     "groupTitle": "Fax_Accounts"
9378   },
9379   {
9380     "type": "post",
9381     "url": "/api/fax/accounts",
9382     "title": "Creates a new Account",
9383     "examples": [
9384       {
9385         "title": "Example usage:",
9386         "content": "curl https://{domain}/api/fax/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
9387         "type": "json"
9388       }
9389     ],
9390     "name": "CreateAccounts",
9391     "group": "Fax_Accounts",
9392     "parameter": {
9393       "fields": {
9394         "Body": [
9395           {
9396             "group": "Body",
9397             "type": "String",
9398             "optional": false,
9399             "field": "name",
9400             "description": ""
9401           },
9402           {
9403             "group": "Body",
9404             "type": "String",
9405             "optional": true,
9406             "field": "description",
9407             "description": ""
9408           },
9409           {
9410             "group": "Body",
9411             "type": "String",
9412             "allowedValues": [
9413               "\"yes\"",
9414               "\"no\""
9415             ],
9416             "optional": true,
9417             "field": "ecm",
9418             "description": ""
9419           },
9420           {
9421             "group": "Body",
9422             "type": "String",
9423             "optional": true,
9424             "field": "headerinfo",
9425             "description": ""
9426           },
9427           {
9428             "group": "Body",
9429             "type": "String",
9430             "optional": true,
9431             "field": "localstationid",
9432             "description": ""
9433           },
9434           {
9435             "group": "Body",
9436             "type": "String",
9437             "allowedValues": [
9438               "\"2400\"",
9439               "\"4800\"",
9440               "\"7200\"",
9441               "\"9600\"",
9442               "\"12000\"",
9443               "\"14400\""
9444             ],
9445             "optional": true,
9446             "field": "minrate",
9447             "description": ""
9448           },
9449           {
9450             "group": "Body",
9451             "type": "String",
9452             "allowedValues": [
9453               "\"2400\"",
9454               "\"4800\"",
9455               "\"7200\"",
9456               "\"9600\"",
9457               "\"12000\"",
9458               "\"14400\""
9459             ],
9460             "optional": true,
9461             "field": "maxrate",
9462             "description": ""
9463           },
9464           {
9465             "group": "Body",
9466             "type": "String",
9467             "optional": true,
9468             "field": "modem",
9469             "description": ""
9470           },
9471           {
9472             "group": "Body",
9473             "type": "String",
9474             "optional": true,
9475             "field": "gateway",
9476             "description": ""
9477           },
9478           {
9479             "group": "Body",
9480             "type": "String",
9481             "optional": true,
9482             "field": "faxdetect",
9483             "description": ""
9484           },
9485           {
9486             "group": "Body",
9487             "type": "Integer",
9488             "optional": true,
9489             "field": "t38timeout",
9490             "description": ""
9491           },
9492           {
9493             "group": "Body",
9494             "type": "String",
9495             "allowedValues": [
9496               "\"SIP\"",
9497               "\"IAX\"",
9498               "\"DADHI\"",
9499               "\"KHOMP\""
9500             ],
9501             "optional": true,
9502             "field": "tech",
9503             "description": ""
9504           },
9505           {
9506             "group": "Body",
9507             "type": "String",
9508             "optional": false,
9509             "field": "key",
9510             "description": ""
9511           },
9512           {
9513             "group": "Body",
9514             "type": "Text",
9515             "optional": true,
9516             "field": "notificationTemplate",
9517             "description": ""
9518           },
9519           {
9520             "group": "Body",
9521             "type": "Boolean",
9522             "optional": true,
9523             "field": "notificationSound",
9524             "description": ""
9525           },
9526           {
9527             "group": "Body",
9528             "type": "Boolean",
9529             "optional": true,
9530             "field": "notificationShake",
9531             "description": ""
9532           },
9533           {
9534             "group": "Body",
9535             "type": "Integer",
9536             "optional": true,
9537             "field": "waitForTheAssignedAgent",
9538             "description": ""
9539           },
9540           {
9541             "group": "Body",
9542             "type": "Boolean",
9543             "optional": true,
9544             "field": "queueTransfer",
9545             "description": ""
9546           },
9547           {
9548             "group": "Body",
9549             "type": "Integer",
9550             "optional": true,
9551             "field": "queueTransferTimeout",
9552             "description": ""
9553           },
9554           {
9555             "group": "Body",
9556             "type": "Boolean",
9557             "optional": true,
9558             "field": "agentTransfer",
9559             "description": ""
9560           },
9561           {
9562             "group": "Body",
9563             "type": "Integer",
9564             "optional": true,
9565             "field": "agentTransferTimeout",
9566             "description": ""
9567           },
9568           {
9569             "group": "Body",
9570             "type": "Integer",
9571             "optional": true,
9572             "field": "mandatoryDispositionPauseId",
9573             "description": "<p>Status to put when mandatory disposition is enabled</p>"
9574           },
9575           {
9576             "group": "Body",
9577             "type": "Boolean",
9578             "optional": true,
9579             "field": "mandatoryDisposition",
9580             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
9581           }
9582         ]
9583       }
9584     },
9585     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9586     "version": "0.0.0",
9587     "filename": "server/api/faxAccount/index.js",
9588     "groupTitle": "Fax_Accounts"
9589   },
9590   {
9591     "type": "delete",
9592     "url": "/api/fax/accounts/{id}",
9593     "title": "Deletes a Account",
9594     "examples": [
9595       {
9596         "title": "Example usage:",
9597         "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password} -X DELETE",
9598         "type": "json"
9599       }
9600     ],
9601     "name": "DeleteAccounts",
9602     "group": "Fax_Accounts",
9603     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "get",
9610     "url": "/api/fax/accounts/describe",
9611     "title": "Gets table info about Accounts",
9612     "examples": [
9613       {
9614         "title": "Example usage:",
9615         "content": "curl https://{domain}/api/fax/accounts/describe -v -u {name}:{password}",
9616         "type": "json"
9617       }
9618     ],
9619     "name": "DescribeAccounts",
9620     "group": "Fax_Accounts",
9621     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</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",
9629     "title": "Gets a list of Accounts",
9630     "examples": [
9631       {
9632         "title": "Example usage:",
9633         "content": "curl https://{domain}/api/fax/accounts -v -u {name}:{password}",
9634         "type": "json"
9635       }
9636     ],
9637     "name": "GetAccounts",
9638     "group": "Fax_Accounts",
9639     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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/{id}/users",
9647     "title": "Gets agents from fax account",
9648     "examples": [
9649       {
9650         "title": "Example usage:",
9651         "content": "curl https://{domain}/api/fax/accounts/{id}/users -v -u {name}:{password} -X GET",
9652         "type": "json"
9653       }
9654     ],
9655     "name": "GetAgents",
9656     "group": "Fax_Accounts",
9657     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9658     "version": "0.0.0",
9659     "filename": "server/api/faxAccount/index.js",
9660     "groupTitle": "Fax_Accounts"
9661   },
9662   {
9663     "type": "delete",
9664     "url": "/api/fax/accounts/{id}/users",
9665     "title": "Removes agents from a fax account",
9666     "examples": [
9667       {
9668         "title": "Example usage:",
9669         "content": "curl https://{domain}/api/fax/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9670         "type": "json"
9671       }
9672     ],
9673     "name": "RemoveAgents",
9674     "group": "Fax_Accounts",
9675     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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}/canned_answers",
9683     "title": "Removes canned answers from account",
9684     "examples": [
9685       {
9686         "title": "Example usage:",
9687         "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9688         "type": "json"
9689       }
9690     ],
9691     "name": "RemoveAnswers",
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}/dispositions",
9701     "title": "Removes dispositions from account",
9702     "examples": [
9703       {
9704         "title": "Example usage:",
9705         "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9706         "type": "json"
9707       }
9708     ],
9709     "name": "RemoveDispositions",
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": "get",
9718     "url": "/api/fax/accounts/{id}",
9719     "title": "Gets a single Account",
9720     "examples": [
9721       {
9722         "title": "Example usage:",
9723         "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password}",
9724         "type": "json"
9725       }
9726     ],
9727     "name": "ShowAccounts",
9728     "group": "Fax_Accounts",
9729     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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": "post",
9736     "url": "/api/fax/accounts/{id}/canned_answers",
9737     "title": "Creates new canned answer",
9738     "examples": [
9739       {
9740         "title": "Example usage:",
9741         "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",
9742         "type": "json"
9743       }
9744     ],
9745     "name": "addAnswer",
9746     "group": "Fax_Accounts",
9747     "parameter": {
9748       "fields": {
9749         "Body": [
9750           {
9751             "group": "Body",
9752             "type": "String",
9753             "optional": false,
9754             "field": "key",
9755             "description": ""
9756           },
9757           {
9758             "group": "Body",
9759             "type": "Text",
9760             "optional": false,
9761             "field": "value",
9762             "description": ""
9763           },
9764           {
9765             "group": "Body",
9766             "type": "String",
9767             "optional": true,
9768             "field": "description",
9769             "description": ""
9770           },
9771           {
9772             "group": "Body",
9773             "type": "Virtual",
9774             "optional": true,
9775             "field": "name",
9776             "description": ""
9777           }
9778         ]
9779       }
9780     },
9781     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9782     "version": "0.0.0",
9783     "filename": "server/api/faxAccount/index.js",
9784     "groupTitle": "Fax_Accounts"
9785   },
9786   {
9787     "type": "post",
9788     "url": "/api/fax/accounts/{id}/applications",
9789     "title": "Creates new applications",
9790     "examples": [
9791       {
9792         "title": "Example usage:",
9793         "content": "curl https://{domain}/api/fax/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9794         "type": "json"
9795       }
9796     ],
9797     "name": "addApplications",
9798     "group": "Fax_Accounts",
9799     "parameter": {
9800       "fields": {
9801         "Body": [
9802           {
9803             "group": "Body",
9804             "type": "Integer",
9805             "optional": false,
9806             "field": "priority",
9807             "description": ""
9808           },
9809           {
9810             "group": "Body",
9811             "type": "String",
9812             "optional": false,
9813             "field": "app",
9814             "description": ""
9815           },
9816           {
9817             "group": "Body",
9818             "type": "Text",
9819             "optional": true,
9820             "field": "appdata",
9821             "description": ""
9822           },
9823           {
9824             "group": "Body",
9825             "type": "String",
9826             "optional": true,
9827             "field": "description",
9828             "description": ""
9829           },
9830           {
9831             "group": "Body",
9832             "type": "String",
9833             "optional": true,
9834             "field": "interval",
9835             "description": ""
9836           }
9837         ]
9838       }
9839     },
9840     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9841     "version": "0.0.0",
9842     "filename": "server/api/faxAccount/index.js",
9843     "groupTitle": "Fax_Accounts"
9844   },
9845   {
9846     "type": "post",
9847     "url": "/api/fax/accounts/addaccountapplications",
9848     "title": "Creates new account and applications",
9849     "examples": [
9850       {
9851         "title": "Example usage:",
9852         "content": "curl https://{domain}/api/fax/accounts/addaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9853         "type": "json"
9854       }
9855     ],
9856     "name": "addApplications",
9857     "group": "Fax_Accounts",
9858     "parameter": {
9859       "fields": {
9860         "Body": [
9861           {
9862             "group": "Body",
9863             "type": "Integer",
9864             "optional": false,
9865             "field": "priority",
9866             "description": ""
9867           },
9868           {
9869             "group": "Body",
9870             "type": "String",
9871             "optional": false,
9872             "field": "app",
9873             "description": ""
9874           },
9875           {
9876             "group": "Body",
9877             "type": "Text",
9878             "optional": true,
9879             "field": "appdata",
9880             "description": ""
9881           },
9882           {
9883             "group": "Body",
9884             "type": "String",
9885             "optional": true,
9886             "field": "description",
9887             "description": ""
9888           },
9889           {
9890             "group": "Body",
9891             "type": "String",
9892             "optional": true,
9893             "field": "interval",
9894             "description": ""
9895           }
9896         ]
9897       }
9898     },
9899     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9900     "version": "0.0.0",
9901     "filename": "server/api/faxAccount/index.js",
9902     "groupTitle": "Fax_Accounts"
9903   },
9904   {
9905     "type": "post",
9906     "url": "/api/fax/accounts/{id}/dispositions",
9907     "title": "Creates new disposition",
9908     "examples": [
9909       {
9910         "title": "Example usage:",
9911         "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9912         "type": "json"
9913       }
9914     ],
9915     "name": "addDisposition",
9916     "group": "Fax_Accounts",
9917     "parameter": {
9918       "fields": {
9919         "Body": [
9920           {
9921             "group": "Body",
9922             "type": "String",
9923             "optional": false,
9924             "field": "name",
9925             "description": ""
9926           },
9927           {
9928             "group": "Body",
9929             "type": "String",
9930             "allowedValues": [
9931               "\"first\"",
9932               "\"second\"",
9933               "\"third\""
9934             ],
9935             "optional": false,
9936             "field": "level",
9937             "description": ""
9938           },
9939           {
9940             "group": "Body",
9941             "type": "String",
9942             "optional": true,
9943             "field": "description",
9944             "description": ""
9945           }
9946         ]
9947       }
9948     },
9949     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9950     "version": "0.0.0",
9951     "filename": "server/api/faxAccount/index.js",
9952     "groupTitle": "Fax_Accounts"
9953   },
9954   {
9955     "type": "post",
9956     "url": "/api/fax/accounts/{id}/interactions",
9957     "title": "Creates new interactions",
9958     "examples": [
9959       {
9960         "title": "Example usage:",
9961         "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",
9962         "type": "json"
9963       }
9964     ],
9965     "name": "addInteraction",
9966     "group": "Fax_Accounts",
9967     "parameter": {
9968       "fields": {
9969         "Body": [
9970           {
9971             "group": "Body",
9972             "type": "Boolean",
9973             "optional": true,
9974             "field": "closed",
9975             "description": ""
9976           },
9977           {
9978             "group": "Body",
9979             "type": "String",
9980             "optional": true,
9981             "field": "closedAt",
9982             "description": ""
9983           },
9984           {
9985             "group": "Body",
9986             "type": "String",
9987             "optional": true,
9988             "field": "disposition",
9989             "description": ""
9990           },
9991           {
9992             "group": "Body",
9993             "type": "String",
9994             "optional": true,
9995             "field": "secondDisposition",
9996             "description": ""
9997           },
9998           {
9999             "group": "Body",
10000             "type": "String",
10001             "optional": true,
10002             "field": "thirdDisposition",
10003             "description": ""
10004           },
10005           {
10006             "group": "Body",
10007             "type": "String",
10008             "optional": true,
10009             "field": "note",
10010             "description": ""
10011           },
10012           {
10013             "group": "Body",
10014             "type": "String",
10015             "optional": true,
10016             "field": "read1stAt",
10017             "description": ""
10018           },
10019           {
10020             "group": "Body",
10021             "type": "String",
10022             "optional": true,
10023             "field": "fax",
10024             "description": ""
10025           },
10026           {
10027             "group": "Body",
10028             "type": "String",
10029             "allowedValues": [
10030               "\"in\"",
10031               "\"out\""
10032             ],
10033             "optional": false,
10034             "field": "firstMsgDirection",
10035             "description": ""
10036           },
10037           {
10038             "group": "Body",
10039             "type": "String",
10040             "optional": true,
10041             "field": "lastMsgAt",
10042             "description": ""
10043           },
10044           {
10045             "group": "Body",
10046             "type": "String",
10047             "allowedValues": [
10048               "\"in\"",
10049               "\"out\""
10050             ],
10051             "optional": false,
10052             "field": "lastMsgDirection",
10053             "description": ""
10054           }
10055         ]
10056       }
10057     },
10058     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10059     "version": "0.0.0",
10060     "filename": "server/api/faxAccount/index.js",
10061     "groupTitle": "Fax_Accounts"
10062   },
10063   {
10064     "type": "get",
10065     "url": "/api/fax/accounts/{id}/canned_answers",
10066     "title": "Gets account canned answers",
10067     "examples": [
10068       {
10069         "title": "Example usage:",
10070         "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
10071         "type": "json"
10072       }
10073     ],
10074     "name": "getAnswers",
10075     "group": "Fax_Accounts",
10076     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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}/applications",
10084     "title": "Gets account pplications",
10085     "examples": [
10086       {
10087         "title": "Example usage:",
10088         "content": "curl https://{domain}/api/fax/accounts/{id}/applications -v -u {name}:{password} -X GET",
10089         "type": "json"
10090       }
10091     ],
10092     "name": "getApplications",
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}/dispositions",
10102     "title": "Gets account dispositions",
10103     "examples": [
10104       {
10105         "title": "Example usage:",
10106         "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
10107         "type": "json"
10108       }
10109     ],
10110     "name": "getDispositions",
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}/interactions",
10120     "title": "Gets account interactions",
10121     "examples": [
10122       {
10123         "title": "Example usage:",
10124         "content": "curl https://{domain}/api/fax/accounts/{id}/interactions -v -u {name}:{password} -X GET",
10125         "type": "json"
10126       }
10127     ],
10128     "name": "getInteraction",
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}/messages",
10138     "title": "Gets account messages",
10139     "examples": [
10140       {
10141         "title": "Example usage:",
10142         "content": "curl https://{domain}/api/fax/accounts/{id}/messages -v -u {name}:{password} -X GET",
10143         "type": "json"
10144       }
10145     ],
10146     "name": "getMessages",
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": "post",
10155     "url": "/api/fax/accounts/{id}/send",
10156     "title": "Send new fax",
10157     "examples": [
10158       {
10159         "title": "Example usage:",
10160         "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",
10161         "type": "json"
10162       }
10163     ],
10164     "name": "sendFax",
10165     "group": "Fax_Accounts",
10166     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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": "put",
10173     "url": "/api/fax/accounts/{id}",
10174     "title": "Update an existing Account",
10175     "examples": [
10176       {
10177         "title": "Example usage:",
10178         "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",
10179         "type": "json"
10180       }
10181     ],
10182     "name": "updateAccounts",
10183     "group": "Fax_Accounts",
10184     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "post",
10191     "url": "/api/fax/accounts/updateaccountapplications",
10192     "title": "Update account and applications",
10193     "examples": [
10194       {
10195         "title": "Example usage:",
10196         "content": "curl https://{domain}/api/fax/accounts/updateaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10197         "type": "json"
10198       }
10199     ],
10200     "name": "updateApplications",
10201     "group": "Fax_Accounts",
10202     "parameter": {
10203       "fields": {
10204         "Body": [
10205           {
10206             "group": "Body",
10207             "type": "Integer",
10208             "optional": false,
10209             "field": "priority",
10210             "description": ""
10211           },
10212           {
10213             "group": "Body",
10214             "type": "String",
10215             "optional": false,
10216             "field": "app",
10217             "description": ""
10218           },
10219           {
10220             "group": "Body",
10221             "type": "Text",
10222             "optional": true,
10223             "field": "appdata",
10224             "description": ""
10225           },
10226           {
10227             "group": "Body",
10228             "type": "String",
10229             "optional": true,
10230             "field": "description",
10231             "description": ""
10232           },
10233           {
10234             "group": "Body",
10235             "type": "String",
10236             "optional": true,
10237             "field": "interval",
10238             "description": ""
10239           }
10240         ]
10241       }
10242     },
10243     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10244     "version": "0.0.0",
10245     "filename": "server/api/faxAccount/index.js",
10246     "groupTitle": "Fax_Accounts"
10247   },
10248   {
10249     "type": "post",
10250     "url": "/api/fax/applications",
10251     "title": "Creates a new Application",
10252     "examples": [
10253       {
10254         "title": "Example usage:",
10255         "content": "curl https://{domain}/api/fax/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
10256         "type": "json"
10257       }
10258     ],
10259     "name": "CreateApplications",
10260     "group": "Fax_Applications",
10261     "parameter": {
10262       "fields": {
10263         "Body": [
10264           {
10265             "group": "Body",
10266             "type": "Integer",
10267             "optional": false,
10268             "field": "priority",
10269             "description": ""
10270           },
10271           {
10272             "group": "Body",
10273             "type": "String",
10274             "optional": false,
10275             "field": "app",
10276             "description": ""
10277           },
10278           {
10279             "group": "Body",
10280             "type": "Text",
10281             "optional": true,
10282             "field": "appdata",
10283             "description": ""
10284           },
10285           {
10286             "group": "Body",
10287             "type": "String",
10288             "optional": true,
10289             "field": "description",
10290             "description": ""
10291           },
10292           {
10293             "group": "Body",
10294             "type": "String",
10295             "optional": true,
10296             "field": "interval",
10297             "description": ""
10298           }
10299         ]
10300       }
10301     },
10302     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10303     "version": "0.0.0",
10304     "filename": "server/api/faxApplication/index.js",
10305     "groupTitle": "Fax_Applications"
10306   },
10307   {
10308     "type": "delete",
10309     "url": "/api/fax/applications/{id}",
10310     "title": "Deletes a Application",
10311     "examples": [
10312       {
10313         "title": "Example usage:",
10314         "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password} -X DELETE",
10315         "type": "json"
10316       }
10317     ],
10318     "name": "DeleteApplications",
10319     "group": "Fax_Applications",
10320     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "get",
10327     "url": "/api/fax/applications",
10328     "title": "Gets a list of Applications",
10329     "examples": [
10330       {
10331         "title": "Example usage:",
10332         "content": "curl https://{domain}/api/fax/applications -v -u {name}:{password}",
10333         "type": "json"
10334       }
10335     ],
10336     "name": "GetApplications",
10337     "group": "Fax_Applications",
10338     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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/{id}",
10346     "title": "Gets a single Application",
10347     "examples": [
10348       {
10349         "title": "Example usage:",
10350         "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password}",
10351         "type": "json"
10352       }
10353     ],
10354     "name": "ShowApplications",
10355     "group": "Fax_Applications",
10356     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10357     "version": "0.0.0",
10358     "filename": "server/api/faxApplication/index.js",
10359     "groupTitle": "Fax_Applications"
10360   },
10361   {
10362     "type": "put",
10363     "url": "/api/fax/applications/{id}",
10364     "title": "Update an existing Application",
10365     "examples": [
10366       {
10367         "title": "Example usage:",
10368         "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",
10369         "type": "json"
10370       }
10371     ],
10372     "name": "updateApplications",
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": "post",
10381     "url": "/api/fax/interactions/{id}/tags",
10382     "title": "Add tags to the interaction",
10383     "examples": [
10384       {
10385         "title": "Example usage:",
10386         "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",
10387         "type": "json"
10388       }
10389     ],
10390     "name": "AddTags",
10391     "group": "Fax_Interactions",
10392     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10393     "version": "0.0.0",
10394     "filename": "server/api/faxInteraction/index.js",
10395     "groupTitle": "Fax_Interactions"
10396   },
10397   {
10398     "type": "post",
10399     "url": "/api/fax/interactions",
10400     "title": "Creates a new Interaction",
10401     "examples": [
10402       {
10403         "title": "Example usage:",
10404         "content": "curl https://{domain}/api/fax/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
10405         "type": "json"
10406       }
10407     ],
10408     "name": "CreateInteractions",
10409     "group": "Fax_Interactions",
10410     "parameter": {
10411       "fields": {
10412         "Body": [
10413           {
10414             "group": "Body",
10415             "type": "Boolean",
10416             "optional": true,
10417             "field": "closed",
10418             "description": ""
10419           },
10420           {
10421             "group": "Body",
10422             "type": "String",
10423             "optional": true,
10424             "field": "closedAt",
10425             "description": ""
10426           },
10427           {
10428             "group": "Body",
10429             "type": "String",
10430             "optional": true,
10431             "field": "disposition",
10432             "description": ""
10433           },
10434           {
10435             "group": "Body",
10436             "type": "String",
10437             "optional": true,
10438             "field": "secondDisposition",
10439             "description": ""
10440           },
10441           {
10442             "group": "Body",
10443             "type": "String",
10444             "optional": true,
10445             "field": "thirdDisposition",
10446             "description": ""
10447           },
10448           {
10449             "group": "Body",
10450             "type": "String",
10451             "optional": true,
10452             "field": "note",
10453             "description": ""
10454           },
10455           {
10456             "group": "Body",
10457             "type": "String",
10458             "optional": true,
10459             "field": "read1stAt",
10460             "description": ""
10461           },
10462           {
10463             "group": "Body",
10464             "type": "String",
10465             "optional": true,
10466             "field": "fax",
10467             "description": ""
10468           },
10469           {
10470             "group": "Body",
10471             "type": "String",
10472             "allowedValues": [
10473               "\"in\"",
10474               "\"out\""
10475             ],
10476             "optional": false,
10477             "field": "firstMsgDirection",
10478             "description": ""
10479           },
10480           {
10481             "group": "Body",
10482             "type": "String",
10483             "optional": true,
10484             "field": "lastMsgAt",
10485             "description": ""
10486           },
10487           {
10488             "group": "Body",
10489             "type": "String",
10490             "allowedValues": [
10491               "\"in\"",
10492               "\"out\""
10493             ],
10494             "optional": false,
10495             "field": "lastMsgDirection",
10496             "description": ""
10497           }
10498         ]
10499       }
10500     },
10501     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10502     "version": "0.0.0",
10503     "filename": "server/api/faxInteraction/index.js",
10504     "groupTitle": "Fax_Interactions"
10505   },
10506   {
10507     "type": "delete",
10508     "url": "/api/fax/interactions/{id}",
10509     "title": "Deletes a Interaction",
10510     "examples": [
10511       {
10512         "title": "Example usage:",
10513         "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password} -X DELETE",
10514         "type": "json"
10515       }
10516     ],
10517     "name": "DeleteInteractions",
10518     "group": "Fax_Interactions",
10519     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "get",
10526     "url": "/api/fax/interactions/describe",
10527     "title": "Gets table info about Interactions",
10528     "examples": [
10529       {
10530         "title": "Example usage:",
10531         "content": "curl https://{domain}/api/fax/interactions/describe -v -u {name}:{password}",
10532         "type": "json"
10533       }
10534     ],
10535     "name": "DescribeInteractions",
10536     "group": "Fax_Interactions",
10537     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</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",
10545     "title": "Gets a list of Interactions",
10546     "examples": [
10547       {
10548         "title": "Example usage:",
10549         "content": "curl https://{domain}/api/fax/interactions -v -u {name}:{password}",
10550         "type": "json"
10551       }
10552     ],
10553     "name": "GetInteractions",
10554     "group": "Fax_Interactions",
10555     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10556     "version": "0.0.0",
10557     "filename": "server/api/faxInteraction/index.js",
10558     "groupTitle": "Fax_Interactions"
10559   },
10560   {
10561     "type": "delete",
10562     "url": "/api/fax/interactions/{id}/tags",
10563     "title": "Removes tags from interaction",
10564     "examples": [
10565       {
10566         "title": "Example usage:",
10567         "content": "curl https://{domain}/api/fax/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
10568         "type": "json"
10569       }
10570     ],
10571     "name": "RemoveTags",
10572     "group": "Fax_Interactions",
10573     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10574     "version": "0.0.0",
10575     "filename": "server/api/faxInteraction/index.js",
10576     "groupTitle": "Fax_Interactions"
10577   },
10578   {
10579     "type": "get",
10580     "url": "/api/fax/interactions/{id}",
10581     "title": "Gets a single Interaction",
10582     "examples": [
10583       {
10584         "title": "Example usage:",
10585         "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password}",
10586         "type": "json"
10587       }
10588     ],
10589     "name": "ShowInteractions",
10590     "group": "Fax_Interactions",
10591     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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": "post",
10598     "url": "/api/fax/interactions/{id}/messages",
10599     "title": "Creates new messages",
10600     "examples": [
10601       {
10602         "title": "Example usage:",
10603         "content": "curl https://{domain}/api/fax/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10604         "type": "json"
10605       }
10606     ],
10607     "name": "addMessage",
10608     "group": "Fax_Interactions",
10609     "parameter": {
10610       "fields": {
10611         "Body": [
10612           {
10613             "group": "Body",
10614             "type": "Text",
10615             "optional": false,
10616             "field": "body",
10617             "description": ""
10618           },
10619           {
10620             "group": "Body",
10621             "type": "Boolean",
10622             "optional": true,
10623             "field": "read",
10624             "description": ""
10625           },
10626           {
10627             "group": "Body",
10628             "type": "String",
10629             "allowedValues": [
10630               "\"in\"",
10631               "\"out\""
10632             ],
10633             "optional": false,
10634             "field": "direction",
10635             "description": ""
10636           },
10637           {
10638             "group": "Body",
10639             "type": "Text",
10640             "optional": true,
10641             "field": "failMessage",
10642             "description": ""
10643           },
10644           {
10645             "group": "Body",
10646             "type": "String",
10647             "optional": true,
10648             "field": "readAt",
10649             "description": ""
10650           }
10651         ]
10652       }
10653     },
10654     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10655     "version": "0.0.0",
10656     "filename": "server/api/faxInteraction/index.js",
10657     "groupTitle": "Fax_Interactions"
10658   },
10659   {
10660     "type": "get",
10661     "url": "/api/fax/interactions/{id}/download",
10662     "title": "Get interactions",
10663     "examples": [
10664       {
10665         "title": "Example usage:",
10666         "content": "curl https://{domain}/api/fax/interactions/{id}/download -v -u {name}:{password} -X GET",
10667         "type": "json"
10668       }
10669     ],
10670     "name": "download",
10671     "group": "Fax_Interactions",
10672     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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}/messages",
10680     "title": "Gets interaction messages",
10681     "examples": [
10682       {
10683         "title": "Example usage:",
10684         "content": "curl https://{domain}/api/fax/interactions/{id}/messages -v -u {name}:{password} -X GET",
10685         "type": "json"
10686       }
10687     ],
10688     "name": "getMessages",
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": "put",
10697     "url": "/api/fax/interactions/{id}",
10698     "title": "Update an existing Interaction",
10699     "examples": [
10700       {
10701         "title": "Example usage:",
10702         "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",
10703         "type": "json"
10704       }
10705     ],
10706     "name": "updateInteractions",
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": "get",
10715     "url": "/api/fax/messages/{id}/download",
10716     "title": "Get message",
10717     "examples": [
10718       {
10719         "title": "Example usage:",
10720         "content": "curl https://{domain}/api/fax/messages/{id}/download -v -u {name}:{password} -X GET",
10721         "type": "json"
10722       }
10723     ],
10724     "name": "download",
10725     "group": "Fax_Message",
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/faxMessage/index.js",
10729     "groupTitle": "Fax_Message"
10730   },
10731   {
10732     "type": "delete",
10733     "url": "/api/fax/messages/{id}",
10734     "title": "Deletes a Message",
10735     "examples": [
10736       {
10737         "title": "Example usage:",
10738         "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password} -X DELETE",
10739         "type": "json"
10740       }
10741     ],
10742     "name": "DeleteMessages",
10743     "group": "Fax_Messages",
10744     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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_Messages"
10748   },
10749   {
10750     "type": "get",
10751     "url": "/api/fax/messages/describe",
10752     "title": "Gets table info about Messages",
10753     "examples": [
10754       {
10755         "title": "Example usage:",
10756         "content": "curl https://{domain}/api/fax/messages/describe -v -u {name}:{password}",
10757         "type": "json"
10758       }
10759     ],
10760     "name": "DescribeMessages",
10761     "group": "Fax_Messages",
10762     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</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",
10770     "title": "Gets a list of Messages",
10771     "examples": [
10772       {
10773         "title": "Example usage:",
10774         "content": "curl https://{domain}/api/fax/messages -v -u {name}:{password}",
10775         "type": "json"
10776       }
10777     ],
10778     "name": "GetMessages",
10779     "group": "Fax_Messages",
10780     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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/{id}",
10788     "title": "Gets a single Message",
10789     "examples": [
10790       {
10791         "title": "Example usage:",
10792         "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password}",
10793         "type": "json"
10794       }
10795     ],
10796     "name": "ShowMessages",
10797     "group": "Fax_Messages",
10798     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10799     "version": "0.0.0",
10800     "filename": "server/api/faxMessage/index.js",
10801     "groupTitle": "Fax_Messages"
10802   },
10803   {
10804     "type": "put",
10805     "url": "/api/fax/messages/{id}/accept",
10806     "title": "Accepts message",
10807     "examples": [
10808       {
10809         "title": "Example usage:",
10810         "content": "curl https://{domain}/api/fax/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
10811         "type": "json"
10812       }
10813     ],
10814     "name": "acceptMessage",
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": "post",
10823     "url": "/api/fax/messages",
10824     "title": "Create message and send Fax",
10825     "examples": [
10826       {
10827         "title": "Example usage:",
10828         "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
10829         "type": "json"
10830       }
10831     ],
10832     "name": "rejectMessage",
10833     "group": "Fax_Messages",
10834     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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": "put",
10841     "url": "/api/fax/messages/{id}/reject",
10842     "title": "Rejects message",
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>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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}",
10860     "title": "Update an existing Message",
10861     "examples": [
10862       {
10863         "title": "Example usage:",
10864         "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",
10865         "type": "json"
10866       }
10867     ],
10868     "name": "updateMessages",
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": "post",
10877     "url": "/api/fax/reports/queue",
10878     "title": "Creates a new Fax Queue Report",
10879     "examples": [
10880       {
10881         "title": "Example usage:",
10882         "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",
10883         "type": "json"
10884       }
10885     ],
10886     "name": "CreateFax_Queue_Reports",
10887     "group": "Fax_Queue_Reports",
10888     "parameter": {
10889       "fields": {
10890         "Body": [
10891           {
10892             "group": "Body",
10893             "type": "String",
10894             "optional": false,
10895             "field": "uniqueid",
10896             "description": ""
10897           },
10898           {
10899             "group": "Body",
10900             "type": "String",
10901             "optional": true,
10902             "field": "from",
10903             "description": ""
10904           },
10905           {
10906             "group": "Body",
10907             "type": "String",
10908             "optional": true,
10909             "field": "joinAt",
10910             "description": ""
10911           },
10912           {
10913             "group": "Body",
10914             "type": "String",
10915             "optional": true,
10916             "field": "leaveAt",
10917             "description": ""
10918           },
10919           {
10920             "group": "Body",
10921             "type": "String",
10922             "optional": true,
10923             "field": "acceptAt",
10924             "description": ""
10925           },
10926           {
10927             "group": "Body",
10928             "type": "String",
10929             "optional": true,
10930             "field": "exitAt",
10931             "description": ""
10932           },
10933           {
10934             "group": "Body",
10935             "type": "String",
10936             "optional": true,
10937             "field": "reason",
10938             "description": ""
10939           }
10940         ]
10941       }
10942     },
10943     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10944     "version": "0.0.0",
10945     "filename": "server/api/faxQueueReport/index.js",
10946     "groupTitle": "Fax_Queue_Reports"
10947   },
10948   {
10949     "type": "delete",
10950     "url": "/api/fax/reports/queue/{id}",
10951     "title": "Deletes a Fax Queue Report",
10952     "examples": [
10953       {
10954         "title": "Example usage:",
10955         "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password} -X DELETE",
10956         "type": "json"
10957       }
10958     ],
10959     "name": "DeleteFax_Queue_Reports",
10960     "group": "Fax_Queue_Reports",
10961     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "get",
10968     "url": "/api/fax/reports/queue/describe",
10969     "title": "Gets table info about Fax Queue Reports",
10970     "examples": [
10971       {
10972         "title": "Example usage:",
10973         "content": "curl https://{domain}/api/fax/reports/queue/describe -v -u {name}:{password}",
10974         "type": "json"
10975       }
10976     ],
10977     "name": "DescribeFax_Queue_Reports",
10978     "group": "Fax_Queue_Reports",
10979     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</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",
10987     "title": "Gets a list of Fax Queue Reports",
10988     "examples": [
10989       {
10990         "title": "Example usage:",
10991         "content": "curl https://{domain}/api/fax/reports/queue -v -u {name}:{password}",
10992         "type": "json"
10993       }
10994     ],
10995     "name": "GetFax_Queue_Reports",
10996     "group": "Fax_Queue_Reports",
10997     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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/{id}",
11005     "title": "Gets a single Fax Queue Report",
11006     "examples": [
11007       {
11008         "title": "Example usage:",
11009         "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password}",
11010         "type": "json"
11011       }
11012     ],
11013     "name": "ShowFax_Queue_Reports",
11014     "group": "Fax_Queue_Reports",
11015     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11016     "version": "0.0.0",
11017     "filename": "server/api/faxQueueReport/index.js",
11018     "groupTitle": "Fax_Queue_Reports"
11019   },
11020   {
11021     "type": "put",
11022     "url": "/api/fax/reports/queue/{id}",
11023     "title": "Update an existing Fax Queue Report",
11024     "examples": [
11025       {
11026         "title": "Example usage:",
11027         "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",
11028         "type": "json"
11029       }
11030     ],
11031     "name": "updateFax_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": "post",
11040     "url": "/api/fax/queues/{id}/users",
11041     "title": "Add agents to a queue",
11042     "examples": [
11043       {
11044         "title": "Example usage:",
11045         "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",
11046         "type": "json"
11047       }
11048     ],
11049     "name": "AddAgents",
11050     "group": "Fax_Queues",
11051     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11052     "version": "0.0.0",
11053     "filename": "server/api/faxQueue/index.js",
11054     "groupTitle": "Fax_Queues"
11055   },
11056   {
11057     "type": "post",
11058     "url": "/api/fax/queues/{id}/teams",
11059     "title": "Add teams to a queue",
11060     "examples": [
11061       {
11062         "title": "Example usage:",
11063         "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",
11064         "type": "json"
11065       }
11066     ],
11067     "name": "AddTeams",
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",
11077     "title": "Creates a new Queue",
11078     "examples": [
11079       {
11080         "title": "Example usage:",
11081         "content": "curl https://{domain}/api/fax/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
11082         "type": "json"
11083       }
11084     ],
11085     "name": "CreateQueues",
11086     "group": "Fax_Queues",
11087     "parameter": {
11088       "fields": {
11089         "Body": [
11090           {
11091             "group": "Body",
11092             "type": "String",
11093             "optional": false,
11094             "field": "name",
11095             "description": ""
11096           },
11097           {
11098             "group": "Body",
11099             "type": "String",
11100             "optional": true,
11101             "field": "description",
11102             "description": ""
11103           },
11104           {
11105             "group": "Body",
11106             "type": "Integer",
11107             "optional": false,
11108             "field": "timeout",
11109             "description": ""
11110           },
11111           {
11112             "group": "Body",
11113             "type": "String",
11114             "allowedValues": [
11115               "\"rrmemory\"",
11116               "\"beepall\"",
11117               "\"roundrobin\""
11118             ],
11119             "optional": false,
11120             "field": "strategy",
11121             "description": ""
11122           },
11123           {
11124             "group": "Body",
11125             "type": "Integer",
11126             "optional": true,
11127             "field": "lastAgent",
11128             "description": ""
11129           }
11130         ]
11131       }
11132     },
11133     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11134     "version": "0.0.0",
11135     "filename": "server/api/faxQueue/index.js",
11136     "groupTitle": "Fax_Queues"
11137   },
11138   {
11139     "type": "delete",
11140     "url": "/api/fax/queues/{id}",
11141     "title": "Deletes a Queue",
11142     "examples": [
11143       {
11144         "title": "Example usage:",
11145         "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password} -X DELETE",
11146         "type": "json"
11147       }
11148     ],
11149     "name": "DeleteQueues",
11150     "group": "Fax_Queues",
11151     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "get",
11158     "url": "/api/fax/queues/describe",
11159     "title": "Gets table info about Queues",
11160     "examples": [
11161       {
11162         "title": "Example usage:",
11163         "content": "curl https://{domain}/api/fax/queues/describe -v -u {name}:{password}",
11164         "type": "json"
11165       }
11166     ],
11167     "name": "DescribeQueues",
11168     "group": "Fax_Queues",
11169     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</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/{id}/users",
11177     "title": "Gets queue agents",
11178     "examples": [
11179       {
11180         "title": "Example usage:",
11181         "content": "curl https://{domain}/api/fax/queues/{id}/users -v -u {name}:{password} -X POST",
11182         "type": "json"
11183       }
11184     ],
11185     "name": "GetAgents",
11186     "group": "Fax_Queues",
11187     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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}/members",
11195     "title": "GetMembers",
11196     "examples": [
11197       {
11198         "title": "Example usage:",
11199         "content": "curl https://{domain}/api/fax/queues/{id}/members  -v -u {name}:{password}",
11200         "type": "json"
11201       }
11202     ],
11203     "name": "GetMembers",
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",
11213     "title": "Gets a list of Queues",
11214     "examples": [
11215       {
11216         "title": "Example usage:",
11217         "content": "curl https://{domain}/api/fax/queues -v -u {name}:{password}",
11218         "type": "json"
11219       }
11220     ],
11221     "name": "GetQueues",
11222     "group": "Fax_Queues",
11223     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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/{id}/teams",
11231     "title": "Gets queues list",
11232     "examples": [
11233       {
11234         "title": "Example usage:",
11235         "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password}",
11236         "type": "json"
11237       }
11238     ],
11239     "name": "GetTeams",
11240     "group": "Fax_Queues",
11241     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11242     "version": "0.0.0",
11243     "filename": "server/api/faxQueue/index.js",
11244     "groupTitle": "Fax_Queues"
11245   },
11246   {
11247     "type": "delete",
11248     "url": "/api/fax/queues/{id}/users",
11249     "title": "Removes agents from a queue",
11250     "examples": [
11251       {
11252         "title": "Example usage:",
11253         "content": "curl https://{domain}/api/fax/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
11254         "type": "json"
11255       }
11256     ],
11257     "name": "RemoveAgents",
11258     "group": "Fax_Queues",
11259     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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": "get",
11266     "url": "/api/fax/queues/{id}",
11267     "title": "Gets a single Queue",
11268     "examples": [
11269       {
11270         "title": "Example usage:",
11271         "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password}",
11272         "type": "json"
11273       }
11274     ],
11275     "name": "ShowQueues",
11276     "group": "Fax_Queues",
11277     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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": "put",
11284     "url": "/api/fax/queues/{id}",
11285     "title": "Update an existing Queue",
11286     "examples": [
11287       {
11288         "title": "Example usage:",
11289         "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",
11290         "type": "json"
11291       }
11292     ],
11293     "name": "updateQueues",
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": "post",
11302     "url": "/api/fax/reports/transfer",
11303     "title": "Creates a new Fax Transfer Report",
11304     "examples": [
11305       {
11306         "title": "Example usage:",
11307         "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",
11308         "type": "json"
11309       }
11310     ],
11311     "name": "CreateFax_Transfer_Reports",
11312     "group": "Fax_Transfer_Reports",
11313     "parameter": {
11314       "fields": {
11315         "Body": [
11316           {
11317             "group": "Body",
11318             "type": "String",
11319             "optional": false,
11320             "field": "uniqueid",
11321             "description": ""
11322           },
11323           {
11324             "group": "Body",
11325             "type": "String",
11326             "allowedValues": [
11327               "\"account\"",
11328               "\"agent\"",
11329               "\"queue\""
11330             ],
11331             "optional": false,
11332             "field": "type",
11333             "description": ""
11334           },
11335           {
11336             "group": "Body",
11337             "type": "String",
11338             "optional": false,
11339             "field": "transferredAt",
11340             "description": ""
11341           }
11342         ]
11343       }
11344     },
11345     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11346     "version": "0.0.0",
11347     "filename": "server/api/faxTransferReport/index.js",
11348     "groupTitle": "Fax_Transfer_Reports"
11349   },
11350   {
11351     "type": "delete",
11352     "url": "/api/fax/reports/transfer/{id}",
11353     "title": "Deletes a Fax Transfer Report",
11354     "examples": [
11355       {
11356         "title": "Example usage:",
11357         "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
11358         "type": "json"
11359       }
11360     ],
11361     "name": "DeleteFax_Transfer_Reports",
11362     "group": "Fax_Transfer_Reports",
11363     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "get",
11370     "url": "/api/fax/reports/transfer/describe",
11371     "title": "Gets table info about Fax Transfer Reports",
11372     "examples": [
11373       {
11374         "title": "Example usage:",
11375         "content": "curl https://{domain}/api/fax/reports/transfer/describe -v -u {name}:{password}",
11376         "type": "json"
11377       }
11378     ],
11379     "name": "DescribeFax_Transfer_Reports",
11380     "group": "Fax_Transfer_Reports",
11381     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</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",
11389     "title": "Gets a list of Fax Transfer Reports",
11390     "examples": [
11391       {
11392         "title": "Example usage:",
11393         "content": "curl https://{domain}/api/fax/reports/transfer -v -u {name}:{password}",
11394         "type": "json"
11395       }
11396     ],
11397     "name": "GetFax_Transfer_Reports",
11398     "group": "Fax_Transfer_Reports",
11399     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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/{id}",
11407     "title": "Gets a single Fax Transfer Report",
11408     "examples": [
11409       {
11410         "title": "Example usage:",
11411         "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password}",
11412         "type": "json"
11413       }
11414     ],
11415     "name": "ShowFax_Transfer_Reports",
11416     "group": "Fax_Transfer_Reports",
11417     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11418     "version": "0.0.0",
11419     "filename": "server/api/faxTransferReport/index.js",
11420     "groupTitle": "Fax_Transfer_Reports"
11421   },
11422   {
11423     "type": "put",
11424     "url": "/api/fax/reports/transfer/{id}",
11425     "title": "Update an existing Fax Transfer Report",
11426     "examples": [
11427       {
11428         "title": "Example usage:",
11429         "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",
11430         "type": "json"
11431       }
11432     ],
11433     "name": "updateFax_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": "post",
11442     "url": "/api/integrations/freshdesk/accounts",
11443     "title": "Creates a new Freshdesk Account",
11444     "examples": [
11445       {
11446         "title": "Example usage:",
11447         "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",
11448         "type": "json"
11449       }
11450     ],
11451     "name": "CreateFreshdesk_Accounts",
11452     "group": "Freshdesk_Accounts",
11453     "parameter": {
11454       "fields": {
11455         "Body": [
11456           {
11457             "group": "Body",
11458             "type": "String",
11459             "optional": true,
11460             "field": "name",
11461             "description": ""
11462           },
11463           {
11464             "group": "Body",
11465             "type": "String",
11466             "optional": true,
11467             "field": "description",
11468             "description": ""
11469           },
11470           {
11471             "group": "Body",
11472             "type": "String",
11473             "optional": true,
11474             "field": "username",
11475             "description": ""
11476           },
11477           {
11478             "group": "Body",
11479             "type": "String",
11480             "optional": true,
11481             "field": "apiKey",
11482             "description": ""
11483           },
11484           {
11485             "group": "Body",
11486             "type": "String",
11487             "optional": true,
11488             "field": "remoteUri",
11489             "description": ""
11490           },
11491           {
11492             "group": "Body",
11493             "type": "String",
11494             "optional": true,
11495             "field": "serverUrl",
11496             "description": ""
11497           }
11498         ]
11499       }
11500     },
11501     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11502     "version": "0.0.0",
11503     "filename": "server/api/intFreshdeskAccount/index.js",
11504     "groupTitle": "Freshdesk_Accounts"
11505   },
11506   {
11507     "type": "delete",
11508     "url": "/api/integrations/freshdesk/accounts/{id}",
11509     "title": "Deletes a Freshdesk Account",
11510     "examples": [
11511       {
11512         "title": "Example usage:",
11513         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password} -X DELETE",
11514         "type": "json"
11515       }
11516     ],
11517     "name": "DeleteFreshdesk_Accounts",
11518     "group": "Freshdesk_Accounts",
11519     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "get",
11526     "url": "/api/integrations/freshdesk/accounts",
11527     "title": "Gets a list of Freshdesk Accounts",
11528     "examples": [
11529       {
11530         "title": "Example usage:",
11531         "content": "curl https://{domain}/api/integrations/freshdesk/accounts -v -u {name}:{password}",
11532         "type": "json"
11533       }
11534     ],
11535     "name": "GetFreshdesk_Accounts",
11536     "group": "Freshdesk_Accounts",
11537     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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/{id}",
11545     "title": "Gets a single Freshdesk Account",
11546     "examples": [
11547       {
11548         "title": "Example usage:",
11549         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password}",
11550         "type": "json"
11551       }
11552     ],
11553     "name": "ShowFreshdesk_Accounts",
11554     "group": "Freshdesk_Accounts",
11555     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11556     "version": "0.0.0",
11557     "filename": "server/api/intFreshdeskAccount/index.js",
11558     "groupTitle": "Freshdesk_Accounts"
11559   },
11560   {
11561     "type": "post",
11562     "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
11563     "title": "Creates new configuration",
11564     "examples": [
11565       {
11566         "title": "Example usage:",
11567         "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",
11568         "type": "json"
11569       }
11570     ],
11571     "name": "addConfiguration",
11572     "group": "Freshdesk_Accounts",
11573     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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": "get",
11580     "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
11581     "title": "Gets account configurations",
11582     "examples": [
11583       {
11584         "title": "Example usage:",
11585         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
11586         "type": "json"
11587       }
11588     ],
11589     "name": "getConfigurations",
11590     "group": "Freshdesk_Accounts",
11591     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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}/fields",
11599     "title": "Gets account fields",
11600     "examples": [
11601       {
11602         "title": "Example usage:",
11603         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
11604         "type": "json"
11605       }
11606     ],
11607     "name": "getFields",
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": "put",
11616     "url": "/api/integrations/freshdesk/accounts/{id}",
11617     "title": "Update an existing Freshdesk Account",
11618     "examples": [
11619       {
11620         "title": "Example usage:",
11621         "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",
11622         "type": "json"
11623       }
11624     ],
11625     "name": "updateFreshdesk_Accounts",
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": "post",
11634     "url": "/api/integrations/freshdesk/configurations",
11635     "title": "Creates a new Freshdesk Configuration",
11636     "examples": [
11637       {
11638         "title": "Example usage:",
11639         "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",
11640         "type": "json"
11641       }
11642     ],
11643     "name": "CreateFreshdesk_Configurations",
11644     "group": "Freshdesk_Configurations",
11645     "parameter": {
11646       "fields": {
11647         "Body": [
11648           {
11649             "group": "Body",
11650             "type": "String",
11651             "optional": true,
11652             "field": "name",
11653             "description": ""
11654           },
11655           {
11656             "group": "Body",
11657             "type": "String",
11658             "optional": true,
11659             "field": "description",
11660             "description": ""
11661           }
11662         ]
11663       }
11664     },
11665     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11666     "version": "0.0.0",
11667     "filename": "server/api/intFreshdeskConfiguration/index.js",
11668     "groupTitle": "Freshdesk_Configurations"
11669   },
11670   {
11671     "type": "delete",
11672     "url": "/api/integrations/freshdesk/configurations/{id}",
11673     "title": "Deletes a Freshdesk Configuration",
11674     "examples": [
11675       {
11676         "title": "Example usage:",
11677         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password} -X DELETE",
11678         "type": "json"
11679       }
11680     ],
11681     "name": "DeleteFreshdesk_Configurations",
11682     "group": "Freshdesk_Configurations",
11683     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "get",
11690     "url": "/api/integrations/freshdesk/configurations",
11691     "title": "Gets a list of Freshdesk Configurations",
11692     "examples": [
11693       {
11694         "title": "Example usage:",
11695         "content": "curl https://{domain}/api/integrations/freshdesk/configurations -v -u {name}:{password}",
11696         "type": "json"
11697       }
11698     ],
11699     "name": "GetFreshdesk_Configurations",
11700     "group": "Freshdesk_Configurations",
11701     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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/{id}",
11709     "title": "Gets a single Freshdesk Configuration",
11710     "examples": [
11711       {
11712         "title": "Example usage:",
11713         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password}",
11714         "type": "json"
11715       }
11716     ],
11717     "name": "ShowFreshdesk_Configurations",
11718     "group": "Freshdesk_Configurations",
11719     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</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}/descriptions",
11727     "title": "Gets configurations descriptions",
11728     "examples": [
11729       {
11730         "title": "Example usage:",
11731         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
11732         "type": "json"
11733       }
11734     ],
11735     "name": "getDescriptions",
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}/fields",
11745     "title": "Gets configurations fields",
11746     "examples": [
11747       {
11748         "title": "Example usage:",
11749         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
11750         "type": "json"
11751       }
11752     ],
11753     "name": "getFields",
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}/subjects",
11763     "title": "Gets configurations subjects",
11764     "examples": [
11765       {
11766         "title": "Example usage:",
11767         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
11768         "type": "json"
11769       }
11770     ],
11771     "name": "getSubjects",
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}/tags",
11781     "title": "Gets configurations tags",
11782     "examples": [
11783       {
11784         "title": "Example usage:",
11785         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
11786         "type": "json"
11787       }
11788     ],
11789     "name": "getTags",
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": "post",
11798     "url": "/api/integrations/freshdesk/configurations/{id}/tags",
11799     "title": "Sets new tags",
11800     "examples": [
11801       {
11802         "title": "Example usage:",
11803         "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",
11804         "type": "json"
11805       }
11806     ],
11807     "name": "setTags",
11808     "group": "Freshdesk_Configurations",
11809     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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": "put",
11816     "url": "/api/integrations/freshdesk/configurations/{id}",
11817     "title": "Update an existing Freshdesk Configuration",
11818     "examples": [
11819       {
11820         "title": "Example usage:",
11821         "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",
11822         "type": "json"
11823       }
11824     ],
11825     "name": "updateFreshdesk_Configurations",
11826     "group": "Freshdesk_Configurations",
11827     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "post",
11834     "url": "/api/integrations/freshdesk/fields",
11835     "title": "Creates a new Freshdesk Field",
11836     "examples": [
11837       {
11838         "title": "Example usage:",
11839         "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",
11840         "type": "json"
11841       }
11842     ],
11843     "name": "CreateFreshdesk_Fields",
11844     "group": "Freshdesk_Fields",
11845     "parameter": {
11846       "fields": {
11847         "Body": [
11848           {
11849             "group": "Body",
11850             "type": "String",
11851             "allowedValues": [
11852               "\"string\"",
11853               "\"variable\"",
11854               "\"customVariable\"",
11855               "\"keyValue\""
11856             ],
11857             "optional": true,
11858             "field": "type",
11859             "description": ""
11860           },
11861           {
11862             "group": "Body",
11863             "type": "String",
11864             "optional": true,
11865             "field": "content",
11866             "description": ""
11867           },
11868           {
11869             "group": "Body",
11870             "type": "String",
11871             "optional": true,
11872             "field": "key",
11873             "description": ""
11874           },
11875           {
11876             "group": "Body",
11877             "type": "String",
11878             "allowedValues": [
11879               "\"string\"",
11880               "\"variable\"",
11881               "\"customVariable\""
11882             ],
11883             "optional": true,
11884             "field": "keyType",
11885             "description": ""
11886           },
11887           {
11888             "group": "Body",
11889             "type": "String",
11890             "optional": true,
11891             "field": "keyContent",
11892             "description": ""
11893           },
11894           {
11895             "group": "Body",
11896             "type": "String",
11897             "optional": true,
11898             "field": "idField",
11899             "description": ""
11900           },
11901           {
11902             "group": "Body",
11903             "type": "String",
11904             "optional": true,
11905             "field": "nameField",
11906             "description": ""
11907           },
11908           {
11909             "group": "Body",
11910             "type": "Boolean",
11911             "optional": true,
11912             "field": "customField",
11913             "description": ""
11914           },
11915           {
11916             "group": "Body",
11917             "type": "String",
11918             "optional": true,
11919             "field": "variableName",
11920             "description": ""
11921           }
11922         ]
11923       }
11924     },
11925     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11926     "version": "0.0.0",
11927     "filename": "server/api/intFreshdeskField/index.js",
11928     "groupTitle": "Freshdesk_Fields"
11929   },
11930   {
11931     "type": "delete",
11932     "url": "/api/integrations/freshdesk/fields/{id}",
11933     "title": "Deletes a Freshdesk Field",
11934     "examples": [
11935       {
11936         "title": "Example usage:",
11937         "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password} -X DELETE",
11938         "type": "json"
11939       }
11940     ],
11941     "name": "DeleteFreshdesk_Fields",
11942     "group": "Freshdesk_Fields",
11943     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "get",
11950     "url": "/api/integrations/freshdesk/fields",
11951     "title": "Gets a list of Freshdesk Fields",
11952     "examples": [
11953       {
11954         "title": "Example usage:",
11955         "content": "curl https://{domain}/api/integrations/freshdesk/fields -v -u {name}:{password}",
11956         "type": "json"
11957       }
11958     ],
11959     "name": "GetFreshdesk_Fields",
11960     "group": "Freshdesk_Fields",
11961     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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/{id}",
11969     "title": "Gets a single Freshdesk Field",
11970     "examples": [
11971       {
11972         "title": "Example usage:",
11973         "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password}",
11974         "type": "json"
11975       }
11976     ],
11977     "name": "ShowFreshdesk_Fields",
11978     "group": "Freshdesk_Fields",
11979     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11980     "version": "0.0.0",
11981     "filename": "server/api/intFreshdeskField/index.js",
11982     "groupTitle": "Freshdesk_Fields"
11983   },
11984   {
11985     "type": "put",
11986     "url": "/api/integrations/freshdesk/fields/{id}",
11987     "title": "Update an existing Freshdesk Field",
11988     "examples": [
11989       {
11990         "title": "Example usage:",
11991         "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",
11992         "type": "json"
11993       }
11994     ],
11995     "name": "updateFreshdesk_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": "post",
12004     "url": "/api/integrations/freshsales/accounts",
12005     "title": "Creates a new Freshsales Account",
12006     "examples": [
12007       {
12008         "title": "Example usage:",
12009         "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",
12010         "type": "json"
12011       }
12012     ],
12013     "name": "CreateFreshsales_Accounts",
12014     "group": "Freshsales_Accounts",
12015     "parameter": {
12016       "fields": {
12017         "Body": [
12018           {
12019             "group": "Body",
12020             "type": "String",
12021             "optional": true,
12022             "field": "name",
12023             "description": ""
12024           },
12025           {
12026             "group": "Body",
12027             "type": "String",
12028             "optional": true,
12029             "field": "description",
12030             "description": ""
12031           },
12032           {
12033             "group": "Body",
12034             "type": "String",
12035             "optional": true,
12036             "field": "username",
12037             "description": ""
12038           },
12039           {
12040             "group": "Body",
12041             "type": "String",
12042             "optional": true,
12043             "field": "apiKey",
12044             "description": ""
12045           },
12046           {
12047             "group": "Body",
12048             "type": "String",
12049             "optional": true,
12050             "field": "remoteUri",
12051             "description": ""
12052           },
12053           {
12054             "group": "Body",
12055             "type": "String",
12056             "optional": true,
12057             "field": "serverUrl",
12058             "description": ""
12059           }
12060         ]
12061       }
12062     },
12063     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12064     "version": "0.0.0",
12065     "filename": "server/api/intFreshsalesAccount/index.js",
12066     "groupTitle": "Freshsales_Accounts"
12067   },
12068   {
12069     "type": "delete",
12070     "url": "/api/integrations/freshsales/accounts/{id}",
12071     "title": "Deletes a Freshsales Account",
12072     "examples": [
12073       {
12074         "title": "Example usage:",
12075         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password} -X DELETE",
12076         "type": "json"
12077       }
12078     ],
12079     "name": "DeleteFreshsales_Accounts",
12080     "group": "Freshsales_Accounts",
12081     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "get",
12088     "url": "/api/integrations/freshsales/accounts",
12089     "title": "Gets a list of Freshsales Accounts",
12090     "examples": [
12091       {
12092         "title": "Example usage:",
12093         "content": "curl https://{domain}/api/integrations/freshsales/accounts -v -u {name}:{password}",
12094         "type": "json"
12095       }
12096     ],
12097     "name": "GetFreshsales_Accounts",
12098     "group": "Freshsales_Accounts",
12099     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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/{id}",
12107     "title": "Gets a single Freshsales Account",
12108     "examples": [
12109       {
12110         "title": "Example usage:",
12111         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password}",
12112         "type": "json"
12113       }
12114     ],
12115     "name": "ShowFreshsales_Accounts",
12116     "group": "Freshsales_Accounts",
12117     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12118     "version": "0.0.0",
12119     "filename": "server/api/intFreshsalesAccount/index.js",
12120     "groupTitle": "Freshsales_Accounts"
12121   },
12122   {
12123     "type": "post",
12124     "url": "/api/integrations/freshsales/accounts/{id}/configurations",
12125     "title": "Creates new configuration",
12126     "examples": [
12127       {
12128         "title": "Example usage:",
12129         "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",
12130         "type": "json"
12131       }
12132     ],
12133     "name": "addConfiguration",
12134     "group": "Freshsales_Accounts",
12135     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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": "get",
12142     "url": "/api/integrations/freshsales/accounts/{id}/configurations",
12143     "title": "Gets account configurations",
12144     "examples": [
12145       {
12146         "title": "Example usage:",
12147         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/configurations -v -u {name}:{password} -X GET",
12148         "type": "json"
12149       }
12150     ],
12151     "name": "getConfigurations",
12152     "group": "Freshsales_Accounts",
12153     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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}/fields",
12161     "title": "Gets account fields",
12162     "examples": [
12163       {
12164         "title": "Example usage:",
12165         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/fields -v -u {name}:{password} -X GET",
12166         "type": "json"
12167       }
12168     ],
12169     "name": "getFields",
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": "put",
12178     "url": "/api/integrations/freshsales/accounts/{id}",
12179     "title": "Update an existing Freshsales Account",
12180     "examples": [
12181       {
12182         "title": "Example usage:",
12183         "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",
12184         "type": "json"
12185       }
12186     ],
12187     "name": "updateFreshsales_Accounts",
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": "post",
12196     "url": "/api/integrations/freshsales/configurations",
12197     "title": "Creates a new Freshsales Configuration",
12198     "examples": [
12199       {
12200         "title": "Example usage:",
12201         "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",
12202         "type": "json"
12203       }
12204     ],
12205     "name": "CreateFreshsales_Configurations",
12206     "group": "Freshsales_Configurations",
12207     "parameter": {
12208       "fields": {
12209         "Body": [
12210           {
12211             "group": "Body",
12212             "type": "String",
12213             "optional": true,
12214             "field": "name",
12215             "description": ""
12216           },
12217           {
12218             "group": "Body",
12219             "type": "String",
12220             "optional": true,
12221             "field": "description",
12222             "description": ""
12223           }
12224         ]
12225       }
12226     },
12227     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12228     "version": "0.0.0",
12229     "filename": "server/api/intFreshsalesConfiguration/index.js",
12230     "groupTitle": "Freshsales_Configurations"
12231   },
12232   {
12233     "type": "delete",
12234     "url": "/api/integrations/freshsales/configurations/{id}",
12235     "title": "Deletes a Freshsales Configuration",
12236     "examples": [
12237       {
12238         "title": "Example usage:",
12239         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password} -X DELETE",
12240         "type": "json"
12241       }
12242     ],
12243     "name": "DeleteFreshsales_Configurations",
12244     "group": "Freshsales_Configurations",
12245     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "get",
12252     "url": "/api/integrations/freshsales/configurations",
12253     "title": "Gets a list of Freshsales Configurations",
12254     "examples": [
12255       {
12256         "title": "Example usage:",
12257         "content": "curl https://{domain}/api/integrations/freshsales/configurations -v -u {name}:{password}",
12258         "type": "json"
12259       }
12260     ],
12261     "name": "GetFreshsales_Configurations",
12262     "group": "Freshsales_Configurations",
12263     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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/{id}",
12271     "title": "Gets a single Freshsales Configuration",
12272     "examples": [
12273       {
12274         "title": "Example usage:",
12275         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password}",
12276         "type": "json"
12277       }
12278     ],
12279     "name": "ShowFreshsales_Configurations",
12280     "group": "Freshsales_Configurations",
12281     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</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}/descriptions",
12289     "title": "Gets configurations descriptions",
12290     "examples": [
12291       {
12292         "title": "Example usage:",
12293         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
12294         "type": "json"
12295       }
12296     ],
12297     "name": "getDescriptions",
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}/fields",
12307     "title": "Gets configurations fields",
12308     "examples": [
12309       {
12310         "title": "Example usage:",
12311         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/fields -v -u {name}:{password} -X GET",
12312         "type": "json"
12313       }
12314     ],
12315     "name": "getFields",
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}/subjects",
12325     "title": "Gets configurations subjects",
12326     "examples": [
12327       {
12328         "title": "Example usage:",
12329         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/subjects -v -u {name}:{password} -X GET",
12330         "type": "json"
12331       }
12332     ],
12333     "name": "getSubjects",
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": "put",
12342     "url": "/api/integrations/freshsales/configurations/{id}",
12343     "title": "Update an existing Freshsales Configuration",
12344     "examples": [
12345       {
12346         "title": "Example usage:",
12347         "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",
12348         "type": "json"
12349       }
12350     ],
12351     "name": "updateFreshsales_Configurations",
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": "post",
12360     "url": "/api/integrations/freshsales/fields",
12361     "title": "Creates a new Freshsales Field",
12362     "examples": [
12363       {
12364         "title": "Example usage:",
12365         "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",
12366         "type": "json"
12367       }
12368     ],
12369     "name": "CreateFreshsales_Fields",
12370     "group": "Freshsales_Fields",
12371     "parameter": {
12372       "fields": {
12373         "Body": [
12374           {
12375             "group": "Body",
12376             "type": "String",
12377             "allowedValues": [
12378               "\"string\"",
12379               "\"variable\"",
12380               "\"customVariable\"",
12381               "\"keyValue\""
12382             ],
12383             "optional": true,
12384             "field": "type",
12385             "description": ""
12386           },
12387           {
12388             "group": "Body",
12389             "type": "String",
12390             "optional": true,
12391             "field": "content",
12392             "description": ""
12393           },
12394           {
12395             "group": "Body",
12396             "type": "String",
12397             "optional": true,
12398             "field": "key",
12399             "description": ""
12400           },
12401           {
12402             "group": "Body",
12403             "type": "String",
12404             "allowedValues": [
12405               "\"string\"",
12406               "\"variable\"",
12407               "\"customVariable\""
12408             ],
12409             "optional": true,
12410             "field": "keyType",
12411             "description": ""
12412           },
12413           {
12414             "group": "Body",
12415             "type": "String",
12416             "optional": true,
12417             "field": "keyContent",
12418             "description": ""
12419           },
12420           {
12421             "group": "Body",
12422             "type": "String",
12423             "optional": true,
12424             "field": "idField",
12425             "description": ""
12426           },
12427           {
12428             "group": "Body",
12429             "type": "String",
12430             "optional": true,
12431             "field": "nameField",
12432             "description": ""
12433           },
12434           {
12435             "group": "Body",
12436             "type": "Boolean",
12437             "optional": true,
12438             "field": "customField",
12439             "description": ""
12440           },
12441           {
12442             "group": "Body",
12443             "type": "String",
12444             "optional": true,
12445             "field": "variableName",
12446             "description": ""
12447           }
12448         ]
12449       }
12450     },
12451     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12452     "version": "0.0.0",
12453     "filename": "server/api/intFreshsalesField/index.js",
12454     "groupTitle": "Freshsales_Fields"
12455   },
12456   {
12457     "type": "delete",
12458     "url": "/api/integrations/freshsales/fields/{id}",
12459     "title": "Deletes a Freshsales Field",
12460     "examples": [
12461       {
12462         "title": "Example usage:",
12463         "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password} -X DELETE",
12464         "type": "json"
12465       }
12466     ],
12467     "name": "DeleteFreshsales_Fields",
12468     "group": "Freshsales_Fields",
12469     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "get",
12476     "url": "/api/integrations/freshsales/fields",
12477     "title": "Gets a list of Freshsales Fields",
12478     "examples": [
12479       {
12480         "title": "Example usage:",
12481         "content": "curl https://{domain}/api/integrations/freshsales/fields -v -u {name}:{password}",
12482         "type": "json"
12483       }
12484     ],
12485     "name": "GetFreshsales_Fields",
12486     "group": "Freshsales_Fields",
12487     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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/{id}",
12495     "title": "Gets a single Freshsales Field",
12496     "examples": [
12497       {
12498         "title": "Example usage:",
12499         "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password}",
12500         "type": "json"
12501       }
12502     ],
12503     "name": "ShowFreshsales_Fields",
12504     "group": "Freshsales_Fields",
12505     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12506     "version": "0.0.0",
12507     "filename": "server/api/intFreshsalesField/index.js",
12508     "groupTitle": "Freshsales_Fields"
12509   },
12510   {
12511     "type": "put",
12512     "url": "/api/integrations/freshsales/fields/{id}",
12513     "title": "Update an existing Freshsales Field",
12514     "examples": [
12515       {
12516         "title": "Example usage:",
12517         "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",
12518         "type": "json"
12519       }
12520     ],
12521     "name": "updateFreshsales_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": "post",
12530     "url": "/api/campaigns/{id}/blacklists",
12531     "title": "Add blacklists to an IVR campaign",
12532     "examples": [
12533       {
12534         "title": "Example usage:",
12535         "content": "curl https://{domain}/api/campaigns/{id}/blacklists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
12536         "type": "json"
12537       }
12538     ],
12539     "name": "AddBlackLists",
12540     "group": "IVR_Campaigns",
12541     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12542     "version": "0.0.0",
12543     "filename": "server/api/campaign/index.js",
12544     "groupTitle": "IVR_Campaigns"
12545   },
12546   {
12547     "type": "post",
12548     "url": "/api/campaigns/{id}/lists",
12549     "title": "Add lists to an IVR campaign",
12550     "examples": [
12551       {
12552         "title": "Example usage:",
12553         "content": "curl https://{domain}/api/campaigns/{id}/lists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
12554         "type": "json"
12555       }
12556     ],
12557     "name": "AddLists",
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/clone",
12567     "title": "Clone an existing IVR Campaign",
12568     "examples": [
12569       {
12570         "title": "Example usage:",
12571         "content": "curl https://{domain}/api/campaigns/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12572         "type": "json"
12573       }
12574     ],
12575     "name": "CloneIVR_Campaigns",
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",
12585     "title": "Creates a new IVR Campaign",
12586     "examples": [
12587       {
12588         "title": "Example usage:",
12589         "content": "curl https://{domain}/api/campaigns -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12590         "type": "json"
12591       }
12592     ],
12593     "name": "CreateIVR_Campaigns",
12594     "group": "IVR_Campaigns",
12595     "parameter": {
12596       "fields": {
12597         "Body": [
12598           {
12599             "group": "Body",
12600             "type": "String",
12601             "optional": false,
12602             "field": "name",
12603             "description": ""
12604           },
12605           {
12606             "group": "Body",
12607             "type": "String",
12608             "allowedValues": [
12609               "\"ivr\""
12610             ],
12611             "optional": false,
12612             "field": "type",
12613             "description": ""
12614           },
12615           {
12616             "group": "Body",
12617             "type": "String",
12618             "optional": true,
12619             "field": "description",
12620             "description": ""
12621           },
12622           {
12623             "group": "Body",
12624             "type": "Boolean",
12625             "optional": true,
12626             "field": "active",
12627             "description": "<p>Active/Disactive Campaign</p>"
12628           },
12629           {
12630             "group": "Body",
12631             "type": "Integer",
12632             "optional": true,
12633             "field": "limitCalls",
12634             "description": "<p>Max 200 calls.</p>"
12635           },
12636           {
12637             "group": "Body",
12638             "type": "String",
12639             "optional": true,
12640             "field": "dialOriginateCallerIdName",
12641             "description": ""
12642           },
12643           {
12644             "group": "Body",
12645             "type": "String",
12646             "optional": true,
12647             "field": "dialOriginateCallerIdNumber",
12648             "description": ""
12649           },
12650           {
12651             "group": "Body",
12652             "type": "Integer",
12653             "optional": true,
12654             "field": "dialOriginateTimeout",
12655             "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
12656           },
12657           {
12658             "group": "Body",
12659             "type": "Integer",
12660             "optional": true,
12661             "field": "dialCongestionMaxRetry",
12662             "description": "<p>#Congestion Retry (min:1, max:999)</p>"
12663           },
12664           {
12665             "group": "Body",
12666             "type": "Integer",
12667             "optional": true,
12668             "field": "dialCongestionRetryFrequency",
12669             "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
12670           },
12671           {
12672             "group": "Body",
12673             "type": "Integer",
12674             "optional": true,
12675             "field": "dialBusyMaxRetry",
12676             "description": "<p>#Busy Retry (min:1, max:999)</p>"
12677           },
12678           {
12679             "group": "Body",
12680             "type": "Integer",
12681             "optional": true,
12682             "field": "dialBusyRetryFrequency",
12683             "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
12684           },
12685           {
12686             "group": "Body",
12687             "type": "Integer",
12688             "optional": true,
12689             "field": "dialNoAnswerMaxRetry",
12690             "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
12691           },
12692           {
12693             "group": "Body",
12694             "type": "Integer",
12695             "optional": true,
12696             "field": "dialNoAnswerRetryFrequency",
12697             "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
12698           },
12699           {
12700             "group": "Body",
12701             "type": "Integer",
12702             "optional": true,
12703             "field": "dialGlobalMaxRetry",
12704             "description": "<p>#Global Max Retry (min:1, max:999)</p>"
12705           },
12706           {
12707             "group": "Body",
12708             "type": "String",
12709             "optional": true,
12710             "field": "dialTimezone",
12711             "description": ""
12712           },
12713           {
12714             "group": "Body",
12715             "type": "String",
12716             "optional": true,
12717             "field": "dialGlobalInterval",
12718             "description": ""
12719           },
12720           {
12721             "group": "Body",
12722             "type": "String",
12723             "allowedValues": [
12724               "\"always\"",
12725               "\"never\"",
12726               "\"onlyIfOpen\""
12727             ],
12728             "optional": true,
12729             "field": "dialCheckDuplicateType",
12730             "description": ""
12731           },
12732           {
12733             "group": "Body",
12734             "type": "Boolean",
12735             "optional": true,
12736             "field": "dialAMDActive",
12737             "description": "<p>Active/Disactive AMD</p>"
12738           },
12739           {
12740             "group": "Body",
12741             "type": "Integer",
12742             "optional": true,
12743             "field": "dialAMDInitialSilence",
12744             "description": "<p>#AMD Initial Silence</p>"
12745           },
12746           {
12747             "group": "Body",
12748             "type": "Integer",
12749             "optional": true,
12750             "field": "dialAMDGreeting",
12751             "description": "<p>#AMD Greeting</p>"
12752           },
12753           {
12754             "group": "Body",
12755             "type": "Integer",
12756             "optional": true,
12757             "field": "dialAMDAfterGreetingSilence",
12758             "description": "<p>#AMD After Greeting Silence</p>"
12759           },
12760           {
12761             "group": "Body",
12762             "type": "Integer",
12763             "optional": true,
12764             "field": "dialAMDTotalAnalysisTime",
12765             "description": "<p>#AMD Total Analysis Time</p>"
12766           },
12767           {
12768             "group": "Body",
12769             "type": "Integer",
12770             "optional": true,
12771             "field": "dialAMDMinWordLength",
12772             "description": "<p>#AMD Min Word Length</p>"
12773           },
12774           {
12775             "group": "Body",
12776             "type": "Integer",
12777             "optional": true,
12778             "field": "dialAMDBetweenWordsSilence",
12779             "description": "<p>#AMD Between Words Silence</p>"
12780           },
12781           {
12782             "group": "Body",
12783             "type": "Integer",
12784             "optional": true,
12785             "field": "dialAMDMaximumNumberOfWords",
12786             "description": "<p>#AMD Maximum Number Of Words</p>"
12787           },
12788           {
12789             "group": "Body",
12790             "type": "Integer",
12791             "optional": true,
12792             "field": "dialAMDSilenceThreshold",
12793             "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
12794           },
12795           {
12796             "group": "Body",
12797             "type": "Integer",
12798             "optional": true,
12799             "field": "dialAMDMaximumWordLength",
12800             "description": "<p>#AMD Maximum Word Length</p>"
12801           },
12802           {
12803             "group": "Body",
12804             "type": "String",
12805             "allowedValues": [
12806               "\"DESC\"",
12807               "\"ASC\""
12808             ],
12809             "optional": true,
12810             "field": "dialOrderByScheduledAt",
12811             "description": ""
12812           },
12813           {
12814             "group": "Body",
12815             "type": "String",
12816             "optional": true,
12817             "field": "dialPrefix",
12818             "description": ""
12819           },
12820           {
12821             "group": "Body",
12822             "type": "Integer",
12823             "optional": true,
12824             "field": "dialRandomLastDigitCallerIdNumber",
12825             "description": "<p>Random Last Digit (min:1, max:15)</p>"
12826           },
12827           {
12828             "group": "Body",
12829             "type": "Integer",
12830             "optional": true,
12831             "field": "dialCutDigit",
12832             "description": "<p>Cut Digit (min:1, max:15)</p>"
12833           },
12834           {
12835             "group": "Body",
12836             "type": "Integer",
12837             "optional": true,
12838             "field": "dialNoSuchNumberMaxRetry",
12839             "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
12840           },
12841           {
12842             "group": "Body",
12843             "type": "Integer",
12844             "optional": true,
12845             "field": "dialNoSuchNumberRetryFrequency",
12846             "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
12847           },
12848           {
12849             "group": "Body",
12850             "type": "Integer",
12851             "optional": true,
12852             "field": "dialDropMaxRetry",
12853             "description": "<p>#Drop Retry (min:1, max:999)</p>"
12854           },
12855           {
12856             "group": "Body",
12857             "type": "Integer",
12858             "optional": true,
12859             "field": "dialDropRetryFrequency",
12860             "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
12861           },
12862           {
12863             "group": "Body",
12864             "type": "Integer",
12865             "optional": true,
12866             "field": "dialAbandonedMaxRetry",
12867             "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
12868           },
12869           {
12870             "group": "Body",
12871             "type": "Integer",
12872             "optional": true,
12873             "field": "dialAbandonedRetryFrequency",
12874             "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
12875           },
12876           {
12877             "group": "Body",
12878             "type": "Integer",
12879             "optional": true,
12880             "field": "dialMachineMaxRetry",
12881             "description": "<p>#Machine Retry (min:1, max:999)</p>"
12882           },
12883           {
12884             "group": "Body",
12885             "type": "Integer",
12886             "optional": true,
12887             "field": "dialMachineRetryFrequency",
12888             "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
12889           },
12890           {
12891             "group": "Body",
12892             "type": "Integer",
12893             "optional": true,
12894             "field": "dialAgentRejectMaxRetry",
12895             "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
12896           },
12897           {
12898             "group": "Body",
12899             "type": "Integer",
12900             "optional": true,
12901             "field": "dialAgentRejectRetryFrequency",
12902             "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
12903           }
12904         ]
12905       }
12906     },
12907     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12908     "version": "0.0.0",
12909     "filename": "server/api/campaign/index.js",
12910     "groupTitle": "IVR_Campaigns"
12911   },
12912   {
12913     "type": "delete",
12914     "url": "/api/campaigns/{id}",
12915     "title": "Deletes a IVR Campaign",
12916     "examples": [
12917       {
12918         "title": "Example usage:",
12919         "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password} -X DELETE",
12920         "type": "json"
12921       }
12922     ],
12923     "name": "DeleteIVR_Campaigns",
12924     "group": "IVR_Campaigns",
12925     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "get",
12932     "url": "/api/campaigns/{id}/blacklists",
12933     "title": "Get IVR campaign blacklists",
12934     "examples": [
12935       {
12936         "title": "Example usage:",
12937         "content": "curl https://{domain}/api/campaigns/{id}/blacklists -v -u {name}:{password} -X GET",
12938         "type": "json"
12939       }
12940     ],
12941     "name": "GetBlackLists",
12942     "group": "IVR_Campaigns",
12943     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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}/finals",
12951     "title": "Gets IVR campaign hopper finals",
12952     "examples": [
12953       {
12954         "title": "Example usage:",
12955         "content": "curl https://{domain}/api/campaigns/{id}/hopper_finals -v -u {name}:{password}  -X GET",
12956         "type": "json"
12957       }
12958     ],
12959     "name": "GetHopperFinals",
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}/hopper_histories",
12969     "title": "Gets IVR campaign hopper histories",
12970     "examples": [
12971       {
12972         "title": "Example usage:",
12973         "content": "curl https://{domain}/api/campaigns/{id}/hopper_histories -v -u {name}:{password} -X GET",
12974         "type": "json"
12975       }
12976     ],
12977     "name": "GetHopperHistories",
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}/hoppers",
12987     "title": "Gets IVR campaign hoppers",
12988     "examples": [
12989       {
12990         "title": "Example usage:",
12991         "content": "curl https://{domain}/api/campaigns/{id}/hoppers -v -u {name}:{password} -X GET",
12992         "type": "json"
12993       }
12994     ],
12995     "name": "GetHoppers",
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",
13005     "title": "Gets a list of IVR Campaigns",
13006     "examples": [
13007       {
13008         "title": "Example usage:",
13009         "content": "curl https://{domain}/api/campaigns -v -u {name}:{password}",
13010         "type": "json"
13011       }
13012     ],
13013     "name": "GetIVR_Campaigns",
13014     "group": "IVR_Campaigns",
13015     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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/{id}/lists",
13023     "title": "Get IVR campaign lists",
13024     "examples": [
13025       {
13026         "title": "Example usage:",
13027         "content": "curl https://{domain}/api/campaigns/{id}/lists -v -u {name}:{password} -X GET",
13028         "type": "json"
13029       }
13030     ],
13031     "name": "GetLists",
13032     "group": "IVR_Campaigns",
13033     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13034     "version": "0.0.0",
13035     "filename": "server/api/campaign/index.js",
13036     "groupTitle": "IVR_Campaigns"
13037   },
13038   {
13039     "type": "delete",
13040     "url": "/api/campaigns/{id}/blacklists",
13041     "title": "Remove blacklists from an IVR Campaign",
13042     "examples": [
13043       {
13044         "title": "Example usage:",
13045         "content": "curl https://{domain}/api/campaigns/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
13046         "type": "json"
13047       }
13048     ],
13049     "name": "RemoveBlackLists",
13050     "group": "IVR_Campaigns",
13051     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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}/lists",
13059     "title": "Remove lists from an IVR Campaign",
13060     "examples": [
13061       {
13062         "title": "Example usage:",
13063         "content": "curl https://{domain}/api/campaigns/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
13064         "type": "json"
13065       }
13066     ],
13067     "name": "RemoveLists",
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": "get",
13076     "url": "/api/campaigns/{id}",
13077     "title": "Gets a single IVR Campaign",
13078     "examples": [
13079       {
13080         "title": "Example usage:",
13081         "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password}",
13082         "type": "json"
13083       }
13084     ],
13085     "name": "ShowIVR_Campaigns",
13086     "group": "IVR_Campaigns",
13087     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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}/blacks",
13095     "title": "Gets IVR campaign hopper blacks",
13096     "examples": [
13097       {
13098         "title": "Example usage:",
13099         "content": "curl https://{domain}/api/campaigns/{id}/hopper_black -v -u {name}:{password}  -X GET",
13100         "type": "json"
13101       }
13102     ],
13103     "name": "getHopperBlacks",
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": "put",
13112     "url": "/api/campaigns/{id}",
13113     "title": "Update an existing IVR Campaign",
13114     "examples": [
13115       {
13116         "title": "Example usage:",
13117         "content": "curl https://{domain}/api/campaigns/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
13118         "type": "json"
13119       }
13120     ],
13121     "name": "updateIVR_Campaigns",
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": "post",
13130     "url": "/api/integrations/reports",
13131     "title": "Creates a new Integration Report",
13132     "examples": [
13133       {
13134         "title": "Example usage:",
13135         "content": "curl https://{domain}/api/integrations/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13136         "type": "json"
13137       }
13138     ],
13139     "name": "CreateIntegration_Reports",
13140     "group": "Integration_Reports",
13141     "parameter": {
13142       "fields": {
13143         "Body": [
13144           {
13145             "group": "Body",
13146             "type": "String",
13147             "optional": true,
13148             "field": "integration",
13149             "description": ""
13150           },
13151           {
13152             "group": "Body",
13153             "type": "String",
13154             "optional": true,
13155             "field": "eventChannel",
13156             "description": ""
13157           },
13158           {
13159             "group": "Body",
13160             "type": "String",
13161             "optional": true,
13162             "field": "exitStatus",
13163             "description": ""
13164           },
13165           {
13166             "group": "Body",
13167             "type": "String",
13168             "optional": true,
13169             "field": "ticketId",
13170             "description": ""
13171           },
13172           {
13173             "group": "Body",
13174             "type": "Integer",
13175             "optional": true,
13176             "field": "integrationId",
13177             "description": ""
13178           },
13179           {
13180             "group": "Body",
13181             "type": "String",
13182             "optional": true,
13183             "field": "contacts",
13184             "description": ""
13185           },
13186           {
13187             "group": "Body",
13188             "type": "String",
13189             "optional": true,
13190             "field": "uniqueid",
13191             "description": ""
13192           },
13193           {
13194             "group": "Body",
13195             "type": "String",
13196             "optional": true,
13197             "field": "calleridnum",
13198             "description": ""
13199           },
13200           {
13201             "group": "Body",
13202             "type": "String",
13203             "optional": true,
13204             "field": "calleridname",
13205             "description": ""
13206           },
13207           {
13208             "group": "Body",
13209             "type": "String",
13210             "optional": true,
13211             "field": "queue",
13212             "description": ""
13213           },
13214           {
13215             "group": "Body",
13216             "type": "String",
13217             "optional": true,
13218             "field": "interface",
13219             "description": ""
13220           },
13221           {
13222             "group": "Body",
13223             "type": "String",
13224             "optional": true,
13225             "field": "membername",
13226             "description": ""
13227           },
13228           {
13229             "group": "Body",
13230             "type": "String",
13231             "optional": true,
13232             "field": "agentcalledAt",
13233             "description": ""
13234           },
13235           {
13236             "group": "Body",
13237             "type": "String",
13238             "optional": true,
13239             "field": "agentconnectAt",
13240             "description": ""
13241           },
13242           {
13243             "group": "Body",
13244             "type": "Integer",
13245             "optional": true,
13246             "field": "holdtime",
13247             "description": ""
13248           },
13249           {
13250             "group": "Body",
13251             "type": "Boolean",
13252             "optional": true,
13253             "field": "agentcomplete",
13254             "description": ""
13255           },
13256           {
13257             "group": "Body",
13258             "type": "String",
13259             "optional": true,
13260             "field": "agentcompleteAt",
13261             "description": ""
13262           },
13263           {
13264             "group": "Body",
13265             "type": "Integer",
13266             "optional": true,
13267             "field": "talktime",
13268             "description": ""
13269           },
13270           {
13271             "group": "Body",
13272             "type": "Boolean",
13273             "optional": true,
13274             "field": "agentacw",
13275             "description": ""
13276           },
13277           {
13278             "group": "Body",
13279             "type": "Integer",
13280             "optional": true,
13281             "field": "acwtime",
13282             "description": ""
13283           },
13284           {
13285             "group": "Body",
13286             "type": "String",
13287             "optional": true,
13288             "field": "reason",
13289             "description": ""
13290           },
13291           {
13292             "group": "Body",
13293             "type": "Boolean",
13294             "optional": true,
13295             "field": "agentringnoanswer",
13296             "description": ""
13297           },
13298           {
13299             "group": "Body",
13300             "type": "String",
13301             "optional": true,
13302             "field": "agentringnoanswerAt",
13303             "description": ""
13304           },
13305           {
13306             "group": "Body",
13307             "type": "Boolean",
13308             "optional": true,
13309             "field": "agentdump",
13310             "description": ""
13311           },
13312           {
13313             "group": "Body",
13314             "type": "String",
13315             "optional": true,
13316             "field": "agentdumpAt",
13317             "description": ""
13318           },
13319           {
13320             "group": "Body",
13321             "type": "String",
13322             "optional": true,
13323             "field": "lastevent",
13324             "description": ""
13325           },
13326           {
13327             "group": "Body",
13328             "type": "String",
13329             "optional": true,
13330             "field": "channel",
13331             "description": ""
13332           },
13333           {
13334             "group": "Body",
13335             "type": "Integer",
13336             "optional": true,
13337             "field": "channelstate",
13338             "description": ""
13339           },
13340           {
13341             "group": "Body",
13342             "type": "String",
13343             "optional": true,
13344             "field": "channelstatedesc",
13345             "description": ""
13346           },
13347           {
13348             "group": "Body",
13349             "type": "String",
13350             "optional": true,
13351             "field": "connectedlinenum",
13352             "description": ""
13353           },
13354           {
13355             "group": "Body",
13356             "type": "String",
13357             "optional": true,
13358             "field": "connectedlinename",
13359             "description": ""
13360           },
13361           {
13362             "group": "Body",
13363             "type": "String",
13364             "optional": true,
13365             "field": "language",
13366             "description": ""
13367           },
13368           {
13369             "group": "Body",
13370             "type": "String",
13371             "optional": true,
13372             "field": "accountcode",
13373             "description": ""
13374           },
13375           {
13376             "group": "Body",
13377             "type": "String",
13378             "optional": true,
13379             "field": "context",
13380             "description": ""
13381           },
13382           {
13383             "group": "Body",
13384             "type": "String",
13385             "optional": true,
13386             "field": "exten",
13387             "description": ""
13388           },
13389           {
13390             "group": "Body",
13391             "type": "String",
13392             "optional": true,
13393             "field": "priority",
13394             "description": ""
13395           },
13396           {
13397             "group": "Body",
13398             "type": "String",
13399             "optional": true,
13400             "field": "destchannel",
13401             "description": ""
13402           },
13403           {
13404             "group": "Body",
13405             "type": "Integer",
13406             "optional": true,
13407             "field": "destchannelstate",
13408             "description": ""
13409           },
13410           {
13411             "group": "Body",
13412             "type": "String",
13413             "optional": true,
13414             "field": "destchannelstatedesc",
13415             "description": ""
13416           },
13417           {
13418             "group": "Body",
13419             "type": "String",
13420             "optional": true,
13421             "field": "destcalleridnum",
13422             "description": ""
13423           },
13424           {
13425             "group": "Body",
13426             "type": "String",
13427             "optional": true,
13428             "field": "destcalleridname",
13429             "description": ""
13430           },
13431           {
13432             "group": "Body",
13433             "type": "String",
13434             "optional": true,
13435             "field": "destconnectedlinenum",
13436             "description": ""
13437           },
13438           {
13439             "group": "Body",
13440             "type": "String",
13441             "optional": true,
13442             "field": "destconnectedlinename",
13443             "description": ""
13444           },
13445           {
13446             "group": "Body",
13447             "type": "String",
13448             "optional": true,
13449             "field": "destlanguage",
13450             "description": ""
13451           },
13452           {
13453             "group": "Body",
13454             "type": "String",
13455             "optional": true,
13456             "field": "destaccountcode",
13457             "description": ""
13458           },
13459           {
13460             "group": "Body",
13461             "type": "String",
13462             "optional": true,
13463             "field": "destcontext",
13464             "description": ""
13465           },
13466           {
13467             "group": "Body",
13468             "type": "String",
13469             "optional": true,
13470             "field": "destexten",
13471             "description": ""
13472           },
13473           {
13474             "group": "Body",
13475             "type": "String",
13476             "optional": true,
13477             "field": "destpriority",
13478             "description": ""
13479           },
13480           {
13481             "group": "Body",
13482             "type": "String",
13483             "optional": true,
13484             "field": "destuniqueid",
13485             "description": ""
13486           },
13487           {
13488             "group": "Body",
13489             "type": "String",
13490             "optional": true,
13491             "field": "messageId",
13492             "description": ""
13493           },
13494           {
13495             "group": "Body",
13496             "type": "String",
13497             "optional": true,
13498             "field": "inReplyTo",
13499             "description": ""
13500           },
13501           {
13502             "group": "Body",
13503             "type": "String",
13504             "optional": true,
13505             "field": "subject",
13506             "description": ""
13507           },
13508           {
13509             "group": "Body",
13510             "type": "String",
13511             "optional": true,
13512             "field": "from",
13513             "description": ""
13514           },
13515           {
13516             "group": "Body",
13517             "type": "String",
13518             "optional": true,
13519             "field": "to",
13520             "description": ""
13521           },
13522           {
13523             "group": "Body",
13524             "type": "String",
13525             "optional": true,
13526             "field": "cc",
13527             "description": ""
13528           },
13529           {
13530             "group": "Body",
13531             "type": "Text",
13532             "optional": true,
13533             "field": "attachment",
13534             "description": ""
13535           },
13536           {
13537             "group": "Body",
13538             "type": "Text",
13539             "optional": true,
13540             "field": "html",
13541             "description": ""
13542           },
13543           {
13544             "group": "Body",
13545             "type": "Text",
13546             "optional": true,
13547             "field": "text",
13548             "description": ""
13549           },
13550           {
13551             "group": "Body",
13552             "type": "String",
13553             "allowedValues": [
13554               "\"SENT\"",
13555               "\"SENDING\"",
13556               "\"RECEIVED\"",
13557               "\"FAILED\""
13558             ],
13559             "optional": true,
13560             "field": "status",
13561             "description": ""
13562           },
13563           {
13564             "group": "Body",
13565             "type": "String",
13566             "optional": true,
13567             "field": "url",
13568             "description": ""
13569           },
13570           {
13571             "group": "Body",
13572             "type": "String",
13573             "optional": true,
13574             "field": "app",
13575             "description": ""
13576           },
13577           {
13578             "group": "Body",
13579             "type": "String",
13580             "optional": true,
13581             "field": "appdata",
13582             "description": ""
13583           },
13584           {
13585             "group": "Body",
13586             "type": "Integer",
13587             "optional": true,
13588             "field": "projectId",
13589             "description": ""
13590           }
13591         ]
13592       }
13593     },
13594     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13595     "version": "0.0.0",
13596     "filename": "server/api/integrationReport/index.js",
13597     "groupTitle": "Integration_Reports"
13598   },
13599   {
13600     "type": "delete",
13601     "url": "/api/integrations/reports/{id}",
13602     "title": "Deletes a Integration Report",
13603     "examples": [
13604       {
13605         "title": "Example usage:",
13606         "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password} -X DELETE",
13607         "type": "json"
13608       }
13609     ],
13610     "name": "DeleteIntegration_Reports",
13611     "group": "Integration_Reports",
13612     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "get",
13619     "url": "/api/integrations/reports/describe",
13620     "title": "Gets table info about Integration Reports",
13621     "examples": [
13622       {
13623         "title": "Example usage:",
13624         "content": "curl https://{domain}/api/integrations/reports/describe -v -u {name}:{password}",
13625         "type": "json"
13626       }
13627     ],
13628     "name": "DescribeIntegration_Reports",
13629     "group": "Integration_Reports",
13630     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</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",
13638     "title": "Gets a list of Integration Reports",
13639     "examples": [
13640       {
13641         "title": "Example usage:",
13642         "content": "curl https://{domain}/api/integrations/reports -v -u {name}:{password}",
13643         "type": "json"
13644       }
13645     ],
13646     "name": "GetIntegration_Reports",
13647     "group": "Integration_Reports",
13648     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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/{id}",
13656     "title": "Gets a single Integration Report",
13657     "examples": [
13658       {
13659         "title": "Example usage:",
13660         "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password}",
13661         "type": "json"
13662       }
13663     ],
13664     "name": "ShowIntegration_Reports",
13665     "group": "Integration_Reports",
13666     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13667     "version": "0.0.0",
13668     "filename": "server/api/integrationReport/index.js",
13669     "groupTitle": "Integration_Reports"
13670   },
13671   {
13672     "type": "put",
13673     "url": "/api/integrations/reports/{id}",
13674     "title": "Update an existing Integration Report",
13675     "examples": [
13676       {
13677         "title": "Example usage:",
13678         "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",
13679         "type": "json"
13680       }
13681     ],
13682     "name": "updateIntegration_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": "post",
13691     "url": "/api/intervals",
13692     "title": "Creates a new Interval",
13693     "examples": [
13694       {
13695         "title": "Example usage:",
13696         "content": "curl https://{domain}/api/intervals -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13697         "type": "json"
13698       }
13699     ],
13700     "name": "CreateIntervals",
13701     "group": "Intervals",
13702     "parameter": {
13703       "fields": {
13704         "Body": [
13705           {
13706             "group": "Body",
13707             "type": "String",
13708             "optional": true,
13709             "field": "name",
13710             "description": ""
13711           },
13712           {
13713             "group": "Body",
13714             "type": "String",
13715             "optional": true,
13716             "field": "description",
13717             "description": ""
13718           },
13719           {
13720             "group": "Body",
13721             "type": "String",
13722             "optional": true,
13723             "field": "interval",
13724             "description": ""
13725           }
13726         ]
13727       }
13728     },
13729     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13730     "version": "0.0.0",
13731     "filename": "server/api/interval/index.js",
13732     "groupTitle": "Intervals"
13733   },
13734   {
13735     "type": "delete",
13736     "url": "/api/intervals/{id}",
13737     "title": "Deletes a Interval",
13738     "examples": [
13739       {
13740         "title": "Example usage:",
13741         "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password} -X DELETE",
13742         "type": "json"
13743       }
13744     ],
13745     "name": "DeleteIntervals",
13746     "group": "Intervals",
13747     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "get",
13754     "url": "/api/intervals",
13755     "title": "Gets a list of Intervals",
13756     "examples": [
13757       {
13758         "title": "Example usage:",
13759         "content": "curl https://{domain}/api/intervals -v -u {name}:{password}",
13760         "type": "json"
13761       }
13762     ],
13763     "name": "GetIntervals",
13764     "group": "Intervals",
13765     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13766     "version": "0.0.0",
13767     "filename": "server/api/interval/index.js",
13768     "groupTitle": "Intervals"
13769   },
13770   {
13771     "type": "get",
13772     "url": "/api/intervals/{id}",
13773     "title": "Gets a single Interval",
13774     "examples": [
13775       {
13776         "title": "Example usage:",
13777         "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password}",
13778         "type": "json"
13779       }
13780     ],
13781     "name": "ShowIntervals",
13782     "group": "Intervals",
13783     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13784     "version": "0.0.0",
13785     "filename": "server/api/interval/index.js",
13786     "groupTitle": "Intervals"
13787   },
13788   {
13789     "type": "post",
13790     "url": "/api/intervals/{id}/sub_intervals",
13791     "title": "Creates a new sub interval",
13792     "examples": [
13793       {
13794         "title": "Example usage:",
13795         "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",
13796         "type": "json"
13797       }
13798     ],
13799     "name": "addInterval",
13800     "group": "Intervals",
13801     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/create_many",
13809     "title": "Create new sub intervals set",
13810     "examples": [
13811       {
13812         "title": "Example usage:",
13813         "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
13814         "type": "json"
13815       }
13816     ],
13817     "name": "addIntervals",
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": "get",
13826     "url": "/api/intervals/{id}/sub_intervals",
13827     "title": "Get sub intervals set",
13828     "examples": [
13829       {
13830         "title": "Example usage:",
13831         "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -v -u {name}:{password} -X GET",
13832         "type": "json"
13833       }
13834     ],
13835     "name": "getIntervals",
13836     "group": "Intervals",
13837     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "put",
13844     "url": "/api/intervals/{id}",
13845     "title": "Update an existing Interval",
13846     "examples": [
13847       {
13848         "title": "Example usage:",
13849         "content": "curl https://{domain}/api/intervals/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
13850         "type": "json"
13851       }
13852     ],
13853     "name": "updateIntervals",
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": "post",
13862     "url": "/api/jira",
13863     "title": "Creates a new issue",
13864     "examples": [
13865       {
13866         "title": "Example usage:",
13867         "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}",
13868         "type": "json"
13869       }
13870     ],
13871     "name": "Creates_Issue",
13872     "group": "Issue",
13873     "parameter": {
13874       "fields": {
13875         "Body": [
13876           {
13877             "group": "Body",
13878             "type": "String",
13879             "allowedValues": [
13880               "\"Bug\""
13881             ],
13882             "optional": true,
13883             "field": "issuetype",
13884             "description": ""
13885           },
13886           {
13887             "group": "Body",
13888             "type": "String",
13889             "optional": false,
13890             "field": "summary",
13891             "description": ""
13892           },
13893           {
13894             "group": "Body",
13895             "type": "String",
13896             "optional": false,
13897             "field": "description",
13898             "description": ""
13899           }
13900         ]
13901       }
13902     },
13903     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13904     "version": "0.0.0",
13905     "filename": "server/api/jira/index.js",
13906     "groupTitle": "Issue"
13907   },
13908   {
13909     "type": "post",
13910     "url": "/api/jscripty/answers/reports",
13911     "title": "Creates a new Report",
13912     "examples": [
13913       {
13914         "title": "Example usage:",
13915         "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",
13916         "type": "json"
13917       }
13918     ],
13919     "name": "CreateReports",
13920     "group": "JscriptyAnswerReport",
13921     "parameter": {
13922       "fields": {
13923         "Body": [
13924           {
13925             "group": "Body",
13926             "type": "String",
13927             "optional": true,
13928             "field": "question",
13929             "description": ""
13930           },
13931           {
13932             "group": "Body",
13933             "type": "Text",
13934             "optional": true,
13935             "field": "answer",
13936             "description": ""
13937           },
13938           {
13939             "group": "Body",
13940             "type": "String",
13941             "optional": true,
13942             "field": "membername",
13943             "description": ""
13944           },
13945           {
13946             "group": "Body",
13947             "type": "String",
13948             "optional": true,
13949             "field": "projectname",
13950             "description": ""
13951           },
13952           {
13953             "group": "Body",
13954             "type": "String",
13955             "optional": true,
13956             "field": "queue",
13957             "description": ""
13958           },
13959           {
13960             "group": "Body",
13961             "type": "String",
13962             "optional": true,
13963             "field": "uniqueid",
13964             "description": ""
13965           },
13966           {
13967             "group": "Body",
13968             "type": "String",
13969             "optional": true,
13970             "field": "calleridname",
13971             "description": ""
13972           },
13973           {
13974             "group": "Body",
13975             "type": "String",
13976             "optional": true,
13977             "field": "calleridnum",
13978             "description": ""
13979           },
13980           {
13981             "group": "Body",
13982             "type": "String",
13983             "optional": true,
13984             "field": "questionId",
13985             "description": ""
13986           }
13987         ]
13988       }
13989     },
13990     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13991     "version": "0.0.0",
13992     "filename": "server/api/jscriptyAnswerReport/index.js",
13993     "groupTitle": "JscriptyAnswerReport"
13994   },
13995   {
13996     "type": "delete",
13997     "url": "/api/jscripty/answers/reports/{id}",
13998     "title": "Deletes a Report",
13999     "examples": [
14000       {
14001         "title": "Example usage:",
14002         "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password} -X DELETE",
14003         "type": "json"
14004       }
14005     ],
14006     "name": "DeleteReports",
14007     "group": "JscriptyAnswerReport",
14008     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "get",
14015     "url": "/api/jscripty/answers/reports/describe",
14016     "title": "Gets table info about Reports",
14017     "examples": [
14018       {
14019         "title": "Example usage:",
14020         "content": "curl https://{domain}/api/jscripty/answers/reports/describe -v -u {name}:{password}",
14021         "type": "json"
14022       }
14023     ],
14024     "name": "DescribeReports",
14025     "group": "JscriptyAnswerReport",
14026     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</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",
14034     "title": "Gets a list of Reports",
14035     "examples": [
14036       {
14037         "title": "Example usage:",
14038         "content": "curl https://{domain}/api/jscripty/answers/reports -v -u {name}:{password}",
14039         "type": "json"
14040       }
14041     ],
14042     "name": "GetReports",
14043     "group": "JscriptyAnswerReport",
14044     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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/{id}",
14052     "title": "Gets a single Report",
14053     "examples": [
14054       {
14055         "title": "Example usage:",
14056         "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password}",
14057         "type": "json"
14058       }
14059     ],
14060     "name": "ShowReports",
14061     "group": "JscriptyAnswerReport",
14062     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14063     "version": "0.0.0",
14064     "filename": "server/api/jscriptyAnswerReport/index.js",
14065     "groupTitle": "JscriptyAnswerReport"
14066   },
14067   {
14068     "type": "put",
14069     "url": "/api/jscripty/answers/reports/{id}",
14070     "title": "Update an existing Report",
14071     "examples": [
14072       {
14073         "title": "Example usage:",
14074         "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",
14075         "type": "json"
14076       }
14077     ],
14078     "name": "updateReports",
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": "post",
14087     "url": "/api/jscripty/questions/reports",
14088     "title": "Creates a new Report",
14089     "examples": [
14090       {
14091         "title": "Example usage:",
14092         "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",
14093         "type": "json"
14094       }
14095     ],
14096     "name": "CreateReports",
14097     "group": "JscriptyQuestionReport",
14098     "parameter": {
14099       "fields": {
14100         "Body": [
14101           {
14102             "group": "Body",
14103             "type": "String",
14104             "optional": true,
14105             "field": "question",
14106             "description": ""
14107           },
14108           {
14109             "group": "Body",
14110             "type": "Text",
14111             "optional": true,
14112             "field": "answer",
14113             "description": ""
14114           },
14115           {
14116             "group": "Body",
14117             "type": "String",
14118             "optional": true,
14119             "field": "membername",
14120             "description": ""
14121           },
14122           {
14123             "group": "Body",
14124             "type": "String",
14125             "optional": true,
14126             "field": "projectname",
14127             "description": ""
14128           },
14129           {
14130             "group": "Body",
14131             "type": "String",
14132             "optional": true,
14133             "field": "queue",
14134             "description": ""
14135           },
14136           {
14137             "group": "Body",
14138             "type": "String",
14139             "optional": true,
14140             "field": "uniqueid",
14141             "description": ""
14142           },
14143           {
14144             "group": "Body",
14145             "type": "String",
14146             "optional": true,
14147             "field": "calleridname",
14148             "description": ""
14149           },
14150           {
14151             "group": "Body",
14152             "type": "String",
14153             "optional": true,
14154             "field": "calleridnum",
14155             "description": ""
14156           },
14157           {
14158             "group": "Body",
14159             "type": "String",
14160             "optional": true,
14161             "field": "questionId",
14162             "description": ""
14163           }
14164         ]
14165       }
14166     },
14167     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14168     "version": "0.0.0",
14169     "filename": "server/api/jscriptyQuestionReport/index.js",
14170     "groupTitle": "JscriptyQuestionReport"
14171   },
14172   {
14173     "type": "delete",
14174     "url": "/api/jscripty/questions/reports/{id}",
14175     "title": "Deletes a Report",
14176     "examples": [
14177       {
14178         "title": "Example usage:",
14179         "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password} -X DELETE",
14180         "type": "json"
14181       }
14182     ],
14183     "name": "DeleteReports",
14184     "group": "JscriptyQuestionReport",
14185     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "get",
14192     "url": "/api/jscripty/questions/reports/describe",
14193     "title": "Gets table info about Reports",
14194     "examples": [
14195       {
14196         "title": "Example usage:",
14197         "content": "curl https://{domain}/api/jscripty/questions/reports/describe -v -u {name}:{password}",
14198         "type": "json"
14199       }
14200     ],
14201     "name": "DescribeReports",
14202     "group": "JscriptyQuestionReport",
14203     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</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",
14211     "title": "Gets a list of Reports",
14212     "examples": [
14213       {
14214         "title": "Example usage:",
14215         "content": "curl https://{domain}/api/jscripty/questions/reports -v -u {name}:{password}",
14216         "type": "json"
14217       }
14218     ],
14219     "name": "GetReports",
14220     "group": "JscriptyQuestionReport",
14221     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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/{id}",
14229     "title": "Gets a single Report",
14230     "examples": [
14231       {
14232         "title": "Example usage:",
14233         "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password}",
14234         "type": "json"
14235       }
14236     ],
14237     "name": "ShowReports",
14238     "group": "JscriptyQuestionReport",
14239     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14240     "version": "0.0.0",
14241     "filename": "server/api/jscriptyQuestionReport/index.js",
14242     "groupTitle": "JscriptyQuestionReport"
14243   },
14244   {
14245     "type": "put",
14246     "url": "/api/jscripty/questions/reports/{id}",
14247     "title": "Update an existing Report",
14248     "examples": [
14249       {
14250         "title": "Example usage:",
14251         "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",
14252         "type": "json"
14253       }
14254     ],
14255     "name": "updateReports",
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": "post",
14264     "url": "/api/jscripty/sessions/reports",
14265     "title": "Creates a new Report",
14266     "examples": [
14267       {
14268         "title": "Example usage:",
14269         "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",
14270         "type": "json"
14271       }
14272     ],
14273     "name": "CreateReports",
14274     "group": "JscriptySessionReport",
14275     "parameter": {
14276       "fields": {
14277         "Body": [
14278           {
14279             "group": "Body",
14280             "type": "String",
14281             "optional": true,
14282             "field": "starttime",
14283             "description": ""
14284           },
14285           {
14286             "group": "Body",
14287             "type": "String",
14288             "optional": true,
14289             "field": "endtime",
14290             "description": ""
14291           },
14292           {
14293             "group": "Body",
14294             "type": "String",
14295             "optional": true,
14296             "field": "membername",
14297             "description": ""
14298           },
14299           {
14300             "group": "Body",
14301             "type": "String",
14302             "optional": true,
14303             "field": "projectname",
14304             "description": ""
14305           },
14306           {
14307             "group": "Body",
14308             "type": "String",
14309             "optional": true,
14310             "field": "queue",
14311             "description": ""
14312           },
14313           {
14314             "group": "Body",
14315             "type": "String",
14316             "optional": true,
14317             "field": "uniqueid",
14318             "description": ""
14319           },
14320           {
14321             "group": "Body",
14322             "type": "String",
14323             "optional": true,
14324             "field": "calleridname",
14325             "description": ""
14326           },
14327           {
14328             "group": "Body",
14329             "type": "String",
14330             "optional": true,
14331             "field": "calleridnum",
14332             "description": ""
14333           },
14334           {
14335             "group": "Body",
14336             "type": "Boolean",
14337             "optional": true,
14338             "field": "completed",
14339             "description": ""
14340           }
14341         ]
14342       }
14343     },
14344     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14345     "version": "0.0.0",
14346     "filename": "server/api/jscriptySessionReport/index.js",
14347     "groupTitle": "JscriptySessionReport"
14348   },
14349   {
14350     "type": "delete",
14351     "url": "/api/jscripty/sessions/reports/{id}",
14352     "title": "Deletes a Report",
14353     "examples": [
14354       {
14355         "title": "Example usage:",
14356         "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password} -X DELETE",
14357         "type": "json"
14358       }
14359     ],
14360     "name": "DeleteReports",
14361     "group": "JscriptySessionReport",
14362     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "get",
14369     "url": "/api/jscripty/sessions/reports/describe",
14370     "title": "Gets table info about Reports",
14371     "examples": [
14372       {
14373         "title": "Example usage:",
14374         "content": "curl https://{domain}/api/jscripty/sessions/reports/describe -v -u {name}:{password}",
14375         "type": "json"
14376       }
14377     ],
14378     "name": "DescribeReports",
14379     "group": "JscriptySessionReport",
14380     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</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",
14388     "title": "Gets a list of Reports",
14389     "examples": [
14390       {
14391         "title": "Example usage:",
14392         "content": "curl https://{domain}/api/jscripty/sessions/reports -v -u {name}:{password}",
14393         "type": "json"
14394       }
14395     ],
14396     "name": "GetReports",
14397     "group": "JscriptySessionReport",
14398     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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/{id}",
14406     "title": "Gets a single Report",
14407     "examples": [
14408       {
14409         "title": "Example usage:",
14410         "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password}",
14411         "type": "json"
14412       }
14413     ],
14414     "name": "ShowReports",
14415     "group": "JscriptySessionReport",
14416     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</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}/questions",
14424     "title": "Gets Jscripty Session questions",
14425     "examples": [
14426       {
14427         "title": "Example usage:",
14428         "content": "curl https://{domain}/api/jscripty/sessions/reports/{id}/questions -v -u {name}:{password}  -X GET",
14429         "type": "json"
14430       }
14431     ],
14432     "name": "getQuestions",
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": "put",
14441     "url": "/api/jscripty/sessions/reports/{id}",
14442     "title": "Update an existing Report",
14443     "examples": [
14444       {
14445         "title": "Example usage:",
14446         "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",
14447         "type": "json"
14448       }
14449     ],
14450     "name": "updateReports",
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": "post",
14459     "url": "/api/jscripty/projects/clone",
14460     "title": "Clone an existing Project",
14461     "examples": [
14462       {
14463         "title": "Example usage:",
14464         "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",
14465         "type": "json"
14466       }
14467     ],
14468     "name": "CloneProjects",
14469     "group": "Jscripty_Projects",
14470     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14471     "version": "0.0.0",
14472     "filename": "server/api/jscriptyProject/index.js",
14473     "groupTitle": "Jscripty_Projects"
14474   },
14475   {
14476     "type": "post",
14477     "url": "/api/jscripty/projects",
14478     "title": "Creates a new Project",
14479     "examples": [
14480       {
14481         "title": "Example usage:",
14482         "content": "curl https://{domain}/api/jscripty/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
14483         "type": "json"
14484       }
14485     ],
14486     "name": "CreateProjects",
14487     "group": "Jscripty_Projects",
14488     "parameter": {
14489       "fields": {
14490         "Body": [
14491           {
14492             "group": "Body",
14493             "type": "String",
14494             "optional": true,
14495             "field": "name",
14496             "description": ""
14497           },
14498           {
14499             "group": "Body",
14500             "type": "String",
14501             "optional": true,
14502             "field": "description",
14503             "description": ""
14504           },
14505           {
14506             "group": "Body",
14507             "type": "Text",
14508             "optional": true,
14509             "field": "formData",
14510             "description": ""
14511           },
14512           {
14513             "group": "Body",
14514             "type": "Boolean",
14515             "optional": true,
14516             "field": "enableUncompleteSave",
14517             "description": ""
14518           },
14519           {
14520             "group": "Body",
14521             "type": "Boolean",
14522             "optional": true,
14523             "field": "sendUnpauseOnSubmit",
14524             "description": ""
14525           }
14526         ]
14527       }
14528     },
14529     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14530     "version": "0.0.0",
14531     "filename": "server/api/jscriptyProject/index.js",
14532     "groupTitle": "Jscripty_Projects"
14533   },
14534   {
14535     "type": "delete",
14536     "url": "/api/jscripty/projects/{id}",
14537     "title": "Deletes a Project",
14538     "examples": [
14539       {
14540         "title": "Example usage:",
14541         "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password} -X DELETE",
14542         "type": "json"
14543       }
14544     ],
14545     "name": "DeleteProjects",
14546     "group": "Jscripty_Projects",
14547     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "get",
14554     "url": "/api/jscripty/projects",
14555     "title": "Gets a list of Projects",
14556     "examples": [
14557       {
14558         "title": "Example usage:",
14559         "content": "curl https://{domain}/api/jscripty/projects -v -u {name}:{password}",
14560         "type": "json"
14561       }
14562     ],
14563     "name": "GetProjects",
14564     "group": "Jscripty_Projects",
14565     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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/{id}",
14573     "title": "Gets a single Project",
14574     "examples": [
14575       {
14576         "title": "Example usage:",
14577         "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password}",
14578         "type": "json"
14579       }
14580     ],
14581     "name": "ShowProjects",
14582     "group": "Jscripty_Projects",
14583     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</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}/answers",
14591     "title": "Gets jscripty project answers",
14592     "examples": [
14593       {
14594         "title": "Example usage:",
14595         "content": "curl https://{domain}/api/jscripty/projects/{id}/answers -v -u {name}:{password}  -X GET",
14596         "type": "json"
14597       }
14598     ],
14599     "name": "getAnswers",
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}/sessions",
14609     "title": "Gets jscripty project sessions",
14610     "examples": [
14611       {
14612         "title": "Example usage:",
14613         "content": "curl https://{domain}/api/jscripty/projects/{id}/sessions -v -u {name}:{password}  -X GET",
14614         "type": "json"
14615       }
14616     ],
14617     "name": "getSessions",
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}/summary",
14627     "title": "Gets jscripty project summary",
14628     "examples": [
14629       {
14630         "title": "Example usage:",
14631         "content": "curl https://{domain}/api/jscripty/projects/{id}/summary -v -u {name}:{password}  -X GET",
14632         "type": "json"
14633       }
14634     ],
14635     "name": "getSummary",
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": "put",
14644     "url": "/api/jscripty/projects/{id}",
14645     "title": "Update an existing Project",
14646     "examples": [
14647       {
14648         "title": "Example usage:",
14649         "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",
14650         "type": "json"
14651       }
14652     ],
14653     "name": "updateProjects",
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": "get",
14662     "url": "/api/license",
14663     "title": "Gets License Info",
14664     "examples": [
14665       {
14666         "title": "Example usage:",
14667         "content": "curl https://{domain}/api/license -v -u {name}:{password} -X GET",
14668         "type": "json"
14669       }
14670     ],
14671     "name": "index",
14672     "group": "License",
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/license/index.js",
14676     "groupTitle": "License"
14677   },
14678   {
14679     "type": "put",
14680     "url": "/api/license/{id}",
14681     "title": "Update License Info",
14682     "examples": [
14683       {
14684         "title": "Example usage:",
14685         "content": "curl https://{domain}/api/license/{id} -v -u {name}:{password} -X PUT",
14686         "type": "json"
14687       }
14688     ],
14689     "name": "update",
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": "post",
14698     "url": "/api/mail/accounts/{id}/users",
14699     "title": "Add agents to a mail account",
14700     "examples": [
14701       {
14702         "title": "Example usage:",
14703         "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",
14704         "type": "json"
14705       }
14706     ],
14707     "name": "AddAgents",
14708     "group": "Mail_Accounts",
14709     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14710     "version": "0.0.0",
14711     "filename": "server/api/mailAccount/index.js",
14712     "groupTitle": "Mail_Accounts"
14713   },
14714   {
14715     "type": "post",
14716     "url": "/api/mail/accounts/{id}/in_servers",
14717     "title": "Creates a new IMAP server",
14718     "examples": [
14719       {
14720         "title": "Example usage:",
14721         "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",
14722         "type": "json"
14723       }
14724     ],
14725     "name": "AddImap",
14726     "group": "Mail_Accounts",
14727     "parameter": {
14728       "fields": {
14729         "Body": [
14730           {
14731             "group": "Body",
14732             "type": "String",
14733             "optional": true,
14734             "field": "description",
14735             "description": ""
14736           },
14737           {
14738             "group": "Body",
14739             "type": "String",
14740             "optional": true,
14741             "field": "host",
14742             "description": ""
14743           },
14744           {
14745             "group": "Body",
14746             "type": "Boolean",
14747             "optional": true,
14748             "field": "authentication",
14749             "description": ""
14750           },
14751           {
14752             "group": "Body",
14753             "type": "String",
14754             "optional": true,
14755             "field": "user",
14756             "description": ""
14757           },
14758           {
14759             "group": "Body",
14760             "type": "String",
14761             "optional": true,
14762             "field": "password",
14763             "description": ""
14764           },
14765           {
14766             "group": "Body",
14767             "type": "Integer",
14768             "optional": true,
14769             "field": "port",
14770             "description": ""
14771           },
14772           {
14773             "group": "Body",
14774             "type": "Boolean",
14775             "optional": true,
14776             "field": "tls",
14777             "description": ""
14778           },
14779           {
14780             "group": "Body",
14781             "type": "String",
14782             "optional": true,
14783             "field": "mailbox",
14784             "description": ""
14785           },
14786           {
14787             "group": "Body",
14788             "type": "Integer",
14789             "optional": true,
14790             "field": "connTimeout",
14791             "description": ""
14792           },
14793           {
14794             "group": "Body",
14795             "type": "Integer",
14796             "optional": true,
14797             "field": "authTimeout",
14798             "description": ""
14799           },
14800           {
14801             "group": "Body",
14802             "type": "String",
14803             "optional": true,
14804             "field": "service",
14805             "description": ""
14806           }
14807         ]
14808       }
14809     },
14810     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14811     "version": "0.0.0",
14812     "filename": "server/api/mailAccount/index.js",
14813     "groupTitle": "Mail_Accounts"
14814   },
14815   {
14816     "type": "post",
14817     "url": "/api/mail/accounts/{id}/out_servers",
14818     "title": "Creates a new SMTP server",
14819     "examples": [
14820       {
14821         "title": "Example usage:",
14822         "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",
14823         "type": "json"
14824       }
14825     ],
14826     "name": "AddSmtp",
14827     "group": "Mail_Accounts",
14828     "parameter": {
14829       "fields": {
14830         "Body": [
14831           {
14832             "group": "Body",
14833             "type": "String",
14834             "optional": true,
14835             "field": "description",
14836             "description": ""
14837           },
14838           {
14839             "group": "Body",
14840             "type": "String",
14841             "optional": true,
14842             "field": "host",
14843             "description": ""
14844           },
14845           {
14846             "group": "Body",
14847             "type": "String",
14848             "optional": true,
14849             "field": "user",
14850             "description": ""
14851           },
14852           {
14853             "group": "Body",
14854             "type": "String",
14855             "optional": true,
14856             "field": "pass",
14857             "description": ""
14858           },
14859           {
14860             "group": "Body",
14861             "type": "Integer",
14862             "optional": true,
14863             "field": "port",
14864             "description": ""
14865           },
14866           {
14867             "group": "Body",
14868             "type": "Boolean",
14869             "optional": true,
14870             "field": "secure",
14871             "description": ""
14872           },
14873           {
14874             "group": "Body",
14875             "type": "String",
14876             "optional": true,
14877             "field": "service",
14878             "description": ""
14879           },
14880           {
14881             "group": "Body",
14882             "type": "Boolean",
14883             "optional": true,
14884             "field": "authentication",
14885             "description": ""
14886           }
14887         ]
14888       }
14889     },
14890     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14891     "version": "0.0.0",
14892     "filename": "server/api/mailAccount/index.js",
14893     "groupTitle": "Mail_Accounts"
14894   },
14895   {
14896     "type": "delete",
14897     "url": "/api/mail/accounts/{id}",
14898     "title": "Deletes a mail account",
14899     "examples": [
14900       {
14901         "title": "Example usage:",
14902         "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password} -X DELETE",
14903         "type": "json"
14904       }
14905     ],
14906     "name": "DeleteMailAccounts",
14907     "group": "Mail_Accounts",
14908     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "get",
14915     "url": "/api/mail/accounts/describe",
14916     "title": "Gets table info about Accounts",
14917     "examples": [
14918       {
14919         "title": "Example usage:",
14920         "content": "curl https://{domain}/api/mail/accounts/describe -v -u {name}:{password}",
14921         "type": "json"
14922       }
14923     ],
14924     "name": "DescribeAccounts",
14925     "group": "Mail_Accounts",
14926     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</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",
14934     "title": "Gets a list of Accounts",
14935     "examples": [
14936       {
14937         "title": "Example usage:",
14938         "content": "curl https://{domain}/api/mail/accounts -v -u {name}:{password}",
14939         "type": "json"
14940       }
14941     ],
14942     "name": "GetAccounts",
14943     "group": "Mail_Accounts",
14944     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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/{id}/users",
14952     "title": "Gets agents from mail account",
14953     "examples": [
14954       {
14955         "title": "Example usage:",
14956         "content": "curl https://{domain}/api/mail/accounts/{id}/users -v -u {name}:{password} -X GET",
14957         "type": "json"
14958       }
14959     ],
14960     "name": "GetAgents",
14961     "group": "Mail_Accounts",
14962     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</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}/in_servers",
14970     "title": "Gets account IMAP server",
14971     "examples": [
14972       {
14973         "title": "Example usage:",
14974         "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X GET",
14975         "type": "json"
14976       }
14977     ],
14978     "name": "GetImap",
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}/out_servers",
14988     "title": "Gets account SMTP server",
14989     "examples": [
14990       {
14991         "title": "Example usage:",
14992         "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X GET",
14993         "type": "json"
14994       }
14995     ],
14996     "name": "GetSmtp",
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": "delete",
15005     "url": "/api/mail/accounts/{id}/users",
15006     "title": "Removes agents from a mail account",
15007     "examples": [
15008       {
15009         "title": "Example usage:",
15010         "content": "curl https://{domain}/api/mail/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15011         "type": "json"
15012       }
15013     ],
15014     "name": "RemoveAgents",
15015     "group": "Mail_Accounts",
15016     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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}/canned_answers",
15024     "title": "Removes canned answers from account",
15025     "examples": [
15026       {
15027         "title": "Example usage:",
15028         "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15029         "type": "json"
15030       }
15031     ],
15032     "name": "RemoveAnswers",
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}/dispositions",
15042     "title": "Removes dispositions from account",
15043     "examples": [
15044       {
15045         "title": "Example usage:",
15046         "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15047         "type": "json"
15048       }
15049     ],
15050     "name": "RemoveDispositions",
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}/in_servers",
15060     "title": "Removes IMAP server from an account",
15061     "examples": [
15062       {
15063         "title": "Example usage:",
15064         "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X DELETE",
15065         "type": "json"
15066       }
15067     ],
15068     "name": "RemoveImmap",
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}/out_servers",
15078     "title": "Removes SMTP server from an account",
15079     "examples": [
15080       {
15081         "title": "Example usage:",
15082         "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X DELETE",
15083         "type": "json"
15084       }
15085     ],
15086     "name": "RemoveSmtp",
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": "get",
15095     "url": "/api/mail/accounts/{id}",
15096     "title": "Gets a single Account",
15097     "examples": [
15098       {
15099         "title": "Example usage:",
15100         "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password}",
15101         "type": "json"
15102       }
15103     ],
15104     "name": "ShowAccounts",
15105     "group": "Mail_Accounts",
15106     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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": "post",
15113     "url": "/api/mail/accounts/{id}/canned_answers",
15114     "title": "Creates new canned answer",
15115     "examples": [
15116       {
15117         "title": "Example usage:",
15118         "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",
15119         "type": "json"
15120       }
15121     ],
15122     "name": "addAnswer",
15123     "group": "Mail_Accounts",
15124     "parameter": {
15125       "fields": {
15126         "Body": [
15127           {
15128             "group": "Body",
15129             "type": "String",
15130             "optional": false,
15131             "field": "key",
15132             "description": ""
15133           },
15134           {
15135             "group": "Body",
15136             "type": "Text",
15137             "optional": false,
15138             "field": "value",
15139             "description": ""
15140           },
15141           {
15142             "group": "Body",
15143             "type": "String",
15144             "optional": true,
15145             "field": "description",
15146             "description": ""
15147           },
15148           {
15149             "group": "Body",
15150             "type": "Virtual",
15151             "optional": true,
15152             "field": "name",
15153             "description": ""
15154           }
15155         ]
15156       }
15157     },
15158     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15159     "version": "0.0.0",
15160     "filename": "server/api/mailAccount/index.js",
15161     "groupTitle": "Mail_Accounts"
15162   },
15163   {
15164     "type": "post",
15165     "url": "/api/mail/accounts/{id}/applications",
15166     "title": "Creates new applications",
15167     "examples": [
15168       {
15169         "title": "Example usage:",
15170         "content": "curl https://{domain}/api/mail/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15171         "type": "json"
15172       }
15173     ],
15174     "name": "addApplications",
15175     "group": "Mail_Accounts",
15176     "parameter": {
15177       "fields": {
15178         "Body": [
15179           {
15180             "group": "Body",
15181             "type": "Integer",
15182             "optional": false,
15183             "field": "priority",
15184             "description": ""
15185           },
15186           {
15187             "group": "Body",
15188             "type": "String",
15189             "optional": false,
15190             "field": "app",
15191             "description": ""
15192           },
15193           {
15194             "group": "Body",
15195             "type": "Text",
15196             "optional": true,
15197             "field": "appdata",
15198             "description": ""
15199           },
15200           {
15201             "group": "Body",
15202             "type": "String",
15203             "optional": true,
15204             "field": "description",
15205             "description": ""
15206           },
15207           {
15208             "group": "Body",
15209             "type": "String",
15210             "optional": true,
15211             "field": "interval",
15212             "description": ""
15213           }
15214         ]
15215       }
15216     },
15217     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15218     "version": "0.0.0",
15219     "filename": "server/api/mailAccount/index.js",
15220     "groupTitle": "Mail_Accounts"
15221   },
15222   {
15223     "type": "post",
15224     "url": "/api/mail/accounts/{id}/dispositions",
15225     "title": "Creates new disposition",
15226     "examples": [
15227       {
15228         "title": "Example usage:",
15229         "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15230         "type": "json"
15231       }
15232     ],
15233     "name": "addDisposition",
15234     "group": "Mail_Accounts",
15235     "parameter": {
15236       "fields": {
15237         "Body": [
15238           {
15239             "group": "Body",
15240             "type": "String",
15241             "optional": false,
15242             "field": "name",
15243             "description": ""
15244           },
15245           {
15246             "group": "Body",
15247             "type": "String",
15248             "allowedValues": [
15249               "\"first\"",
15250               "\"second\"",
15251               "\"third\""
15252             ],
15253             "optional": false,
15254             "field": "level",
15255             "description": ""
15256           },
15257           {
15258             "group": "Body",
15259             "type": "String",
15260             "optional": true,
15261             "field": "description",
15262             "description": ""
15263           }
15264         ]
15265       }
15266     },
15267     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15268     "version": "0.0.0",
15269     "filename": "server/api/mailAccount/index.js",
15270     "groupTitle": "Mail_Accounts"
15271   },
15272   {
15273     "type": "post",
15274     "url": "/api/mail/accounts/{id}/interactions",
15275     "title": "Creates new interactions",
15276     "examples": [
15277       {
15278         "title": "Example usage:",
15279         "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",
15280         "type": "json"
15281       }
15282     ],
15283     "name": "addInteraction",
15284     "group": "Mail_Accounts",
15285     "parameter": {
15286       "fields": {
15287         "Body": [
15288           {
15289             "group": "Body",
15290             "type": "Boolean",
15291             "optional": true,
15292             "field": "closed",
15293             "description": ""
15294           },
15295           {
15296             "group": "Body",
15297             "type": "String",
15298             "optional": true,
15299             "field": "closedAt",
15300             "description": ""
15301           },
15302           {
15303             "group": "Body",
15304             "type": "String",
15305             "optional": true,
15306             "field": "disposition",
15307             "description": ""
15308           },
15309           {
15310             "group": "Body",
15311             "type": "String",
15312             "optional": true,
15313             "field": "secondDisposition",
15314             "description": ""
15315           },
15316           {
15317             "group": "Body",
15318             "type": "String",
15319             "optional": true,
15320             "field": "thirdDisposition",
15321             "description": ""
15322           },
15323           {
15324             "group": "Body",
15325             "type": "String",
15326             "optional": true,
15327             "field": "note",
15328             "description": ""
15329           },
15330           {
15331             "group": "Body",
15332             "type": "String",
15333             "optional": true,
15334             "field": "inReplyTo",
15335             "description": ""
15336           },
15337           {
15338             "group": "Body",
15339             "type": "String",
15340             "optional": true,
15341             "field": "to",
15342             "description": ""
15343           },
15344           {
15345             "group": "Body",
15346             "type": "Text",
15347             "optional": true,
15348             "field": "cc",
15349             "description": ""
15350           },
15351           {
15352             "group": "Body",
15353             "type": "Text",
15354             "optional": true,
15355             "field": "subject",
15356             "description": ""
15357           },
15358           {
15359             "group": "Body",
15360             "type": "Boolean",
15361             "optional": true,
15362             "field": "attach",
15363             "description": ""
15364           },
15365           {
15366             "group": "Body",
15367             "type": "String",
15368             "optional": true,
15369             "field": "read1stAt",
15370             "description": ""
15371           },
15372           {
15373             "group": "Body",
15374             "type": "String",
15375             "optional": true,
15376             "field": "substatus",
15377             "description": ""
15378           },
15379           {
15380             "group": "Body",
15381             "type": "String",
15382             "optional": true,
15383             "field": "substatusAt",
15384             "description": ""
15385           },
15386           {
15387             "group": "Body",
15388             "type": "String",
15389             "allowedValues": [
15390               "\"in\"",
15391               "\"out\""
15392             ],
15393             "optional": false,
15394             "field": "firstMsgDirection",
15395             "description": ""
15396           },
15397           {
15398             "group": "Body",
15399             "type": "String",
15400             "optional": true,
15401             "field": "lastMsgAt",
15402             "description": ""
15403           },
15404           {
15405             "group": "Body",
15406             "type": "String",
15407             "allowedValues": [
15408               "\"in\"",
15409               "\"out\""
15410             ],
15411             "optional": false,
15412             "field": "lastMsgDirection",
15413             "description": ""
15414           },
15415           {
15416             "group": "Body",
15417             "type": "Text",
15418             "optional": true,
15419             "field": "lastMsgBody",
15420             "description": ""
15421           },
15422           {
15423             "group": "Body",
15424             "type": "Text",
15425             "optional": true,
15426             "field": "lastMsgText",
15427             "description": ""
15428           }
15429         ]
15430       }
15431     },
15432     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15433     "version": "0.0.0",
15434     "filename": "server/api/mailAccount/index.js",
15435     "groupTitle": "Mail_Accounts"
15436   },
15437   {
15438     "type": "post",
15439     "url": "/api/mail/accounts",
15440     "title": "Create a mail account",
15441     "examples": [
15442       {
15443         "title": "Example usage:",
15444         "content": "curl https://{domain}/api/mail/accounts \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15445         "type": "json"
15446       }
15447     ],
15448     "name": "create",
15449     "group": "Mail_Accounts",
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": "get",
15457     "url": "/api/mail/accounts/{id}/canned_answers",
15458     "title": "Gets account canned answers",
15459     "examples": [
15460       {
15461         "title": "Example usage:",
15462         "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
15463         "type": "json"
15464       }
15465     ],
15466     "name": "getAnswers",
15467     "group": "Mail_Accounts",
15468     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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}/applications",
15476     "title": "Gets account applications",
15477     "examples": [
15478       {
15479         "title": "Example usage:",
15480         "content": "curl https://{domain}/api/mail/accounts/{id}/applications -v -u {name}:{password} -X GET",
15481         "type": "json"
15482       }
15483     ],
15484     "name": "getApplications",
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}/dispositions",
15494     "title": "Gets account dispositions",
15495     "examples": [
15496       {
15497         "title": "Example usage:",
15498         "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
15499         "type": "json"
15500       }
15501     ],
15502     "name": "getDispositions",
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}/interactions",
15512     "title": "Gets account interactions",
15513     "examples": [
15514       {
15515         "title": "Example usage:",
15516         "content": "curl https://{domain}/api/mail/accounts/{id}/interactions -v -u {name}:{password} -X GET",
15517         "type": "json"
15518       }
15519     ],
15520     "name": "getInteraction",
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}/messages",
15530     "title": "Gets account messages",
15531     "examples": [
15532       {
15533         "title": "Example usage:",
15534         "content": "curl https://{domain}/api/mail/accounts/{id}/messages -v -u {name}:{password} -X GET",
15535         "type": "json"
15536       }
15537     ],
15538     "name": "getMessages",
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": "post",
15547     "url": "/api/mail/accounts/{id}/send",
15548     "title": "Send new mail",
15549     "examples": [
15550       {
15551         "title": "Example usage:",
15552         "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",
15553         "type": "json"
15554       }
15555     ],
15556     "name": "sendMail",
15557     "group": "Mail_Accounts",
15558     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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": "put",
15565     "url": "/api/mail/accounts/{id}",
15566     "title": "Update an existing Account",
15567     "examples": [
15568       {
15569         "title": "Example usage:",
15570         "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",
15571         "type": "json"
15572       }
15573     ],
15574     "name": "updateAccounts",
15575     "group": "Mail_Accounts",
15576     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "get",
15583     "url": "/api/mail/accounts/{id}/verify",
15584     "title": "Verify mail account",
15585     "examples": [
15586       {
15587         "title": "Example usage:",
15588         "content": "curl https://{domain}/api/mail/accounts/{id}/verify -v -u {name}:{password} -X GET",
15589         "type": "json"
15590       }
15591     ],
15592     "name": "verifySmtp",
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": "delete",
15601     "url": "/api/mail/applications/{id}",
15602     "title": "Deletes a Application",
15603     "examples": [
15604       {
15605         "title": "Example usage:",
15606         "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password} -X DELETE",
15607         "type": "json"
15608       }
15609     ],
15610     "name": "DeleteApplications",
15611     "group": "Mail_Applications",
15612     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/mailApplication/index.js",
15615     "groupTitle": "Mail_Applications"
15616   },
15617   {
15618     "type": "get",
15619     "url": "/api/mail/applications/{id}",
15620     "title": "Gets a single Application",
15621     "examples": [
15622       {
15623         "title": "Example usage:",
15624         "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password}",
15625         "type": "json"
15626       }
15627     ],
15628     "name": "ShowApplications",
15629     "group": "Mail_Applications",
15630     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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": "put",
15637     "url": "/api/mail/applications/{id}",
15638     "title": "Update an existing Application",
15639     "examples": [
15640       {
15641         "title": "Example usage:",
15642         "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",
15643         "type": "json"
15644       }
15645     ],
15646     "name": "updateApplications",
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": "post",
15655     "url": "/api/mail/interactions/{id}/tags",
15656     "title": "Add tags to the interaction",
15657     "examples": [
15658       {
15659         "title": "Example usage:",
15660         "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",
15661         "type": "json"
15662       }
15663     ],
15664     "name": "AddTags",
15665     "group": "Mail_Interactions",
15666     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15667     "version": "0.0.0",
15668     "filename": "server/api/mailInteraction/index.js",
15669     "groupTitle": "Mail_Interactions"
15670   },
15671   {
15672     "type": "post",
15673     "url": "/api/mail/interactions",
15674     "title": "Creates a new Interaction",
15675     "examples": [
15676       {
15677         "title": "Example usage:",
15678         "content": "curl https://{domain}/api/mail/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
15679         "type": "json"
15680       }
15681     ],
15682     "name": "CreateInteractions",
15683     "group": "Mail_Interactions",
15684     "parameter": {
15685       "fields": {
15686         "Body": [
15687           {
15688             "group": "Body",
15689             "type": "Boolean",
15690             "optional": true,
15691             "field": "closed",
15692             "description": ""
15693           },
15694           {
15695             "group": "Body",
15696             "type": "String",
15697             "optional": true,
15698             "field": "closedAt",
15699             "description": ""
15700           },
15701           {
15702             "group": "Body",
15703             "type": "String",
15704             "optional": true,
15705             "field": "disposition",
15706             "description": ""
15707           },
15708           {
15709             "group": "Body",
15710             "type": "String",
15711             "optional": true,
15712             "field": "secondDisposition",
15713             "description": ""
15714           },
15715           {
15716             "group": "Body",
15717             "type": "String",
15718             "optional": true,
15719             "field": "thirdDisposition",
15720             "description": ""
15721           },
15722           {
15723             "group": "Body",
15724             "type": "String",
15725             "optional": true,
15726             "field": "note",
15727             "description": ""
15728           },
15729           {
15730             "group": "Body",
15731             "type": "String",
15732             "optional": true,
15733             "field": "inReplyTo",
15734             "description": ""
15735           },
15736           {
15737             "group": "Body",
15738             "type": "String",
15739             "optional": true,
15740             "field": "to",
15741             "description": ""
15742           },
15743           {
15744             "group": "Body",
15745             "type": "Text",
15746             "optional": true,
15747             "field": "cc",
15748             "description": ""
15749           },
15750           {
15751             "group": "Body",
15752             "type": "Text",
15753             "optional": true,
15754             "field": "subject",
15755             "description": ""
15756           },
15757           {
15758             "group": "Body",
15759             "type": "Boolean",
15760             "optional": true,
15761             "field": "attach",
15762             "description": ""
15763           },
15764           {
15765             "group": "Body",
15766             "type": "String",
15767             "optional": true,
15768             "field": "read1stAt",
15769             "description": ""
15770           },
15771           {
15772             "group": "Body",
15773             "type": "String",
15774             "optional": true,
15775             "field": "substatus",
15776             "description": ""
15777           },
15778           {
15779             "group": "Body",
15780             "type": "String",
15781             "optional": true,
15782             "field": "substatusAt",
15783             "description": ""
15784           },
15785           {
15786             "group": "Body",
15787             "type": "String",
15788             "allowedValues": [
15789               "\"in\"",
15790               "\"out\""
15791             ],
15792             "optional": false,
15793             "field": "firstMsgDirection",
15794             "description": ""
15795           },
15796           {
15797             "group": "Body",
15798             "type": "String",
15799             "optional": true,
15800             "field": "lastMsgAt",
15801             "description": ""
15802           },
15803           {
15804             "group": "Body",
15805             "type": "String",
15806             "allowedValues": [
15807               "\"in\"",
15808               "\"out\""
15809             ],
15810             "optional": false,
15811             "field": "lastMsgDirection",
15812             "description": ""
15813           },
15814           {
15815             "group": "Body",
15816             "type": "Text",
15817             "optional": true,
15818             "field": "lastMsgBody",
15819             "description": ""
15820           },
15821           {
15822             "group": "Body",
15823             "type": "Text",
15824             "optional": true,
15825             "field": "lastMsgText",
15826             "description": ""
15827           }
15828         ]
15829       }
15830     },
15831     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15832     "version": "0.0.0",
15833     "filename": "server/api/mailInteraction/index.js",
15834     "groupTitle": "Mail_Interactions"
15835   },
15836   {
15837     "type": "delete",
15838     "url": "/api/mail/interactions/{id}",
15839     "title": "Deletes a Interaction",
15840     "examples": [
15841       {
15842         "title": "Example usage:",
15843         "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password} -X DELETE",
15844         "type": "json"
15845       }
15846     ],
15847     "name": "DeleteInteractions",
15848     "group": "Mail_Interactions",
15849     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "get",
15856     "url": "/api/mail/interactions/describe",
15857     "title": "Gets table info about Interactions",
15858     "examples": [
15859       {
15860         "title": "Example usage:",
15861         "content": "curl https://{domain}/api/mail/interactions/describe -v -u {name}:{password}",
15862         "type": "json"
15863       }
15864     ],
15865     "name": "DescribeInteractions",
15866     "group": "Mail_Interactions",
15867     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</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",
15875     "title": "Gets a list of Interactions",
15876     "examples": [
15877       {
15878         "title": "Example usage:",
15879         "content": "curl https://{domain}/api/mail/interactions -v -u {name}:{password}",
15880         "type": "json"
15881       }
15882     ],
15883     "name": "GetInteractions",
15884     "group": "Mail_Interactions",
15885     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
15886     "version": "0.0.0",
15887     "filename": "server/api/mailInteraction/index.js",
15888     "groupTitle": "Mail_Interactions"
15889   },
15890   {
15891     "type": "delete",
15892     "url": "/api/mail/interactions/{id}/tags",
15893     "title": "Removes tags from interaction",
15894     "examples": [
15895       {
15896         "title": "Example usage:",
15897         "content": "curl https://{domain}/api/mail/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15898         "type": "json"
15899       }
15900     ],
15901     "name": "RemoveTags",
15902     "group": "Mail_Interactions",
15903     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15904     "version": "0.0.0",
15905     "filename": "server/api/mailInteraction/index.js",
15906     "groupTitle": "Mail_Interactions"
15907   },
15908   {
15909     "type": "get",
15910     "url": "/api/mail/interactions/{id}",
15911     "title": "Gets a single Interaction",
15912     "examples": [
15913       {
15914         "title": "Example usage:",
15915         "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password}",
15916         "type": "json"
15917       }
15918     ],
15919     "name": "ShowInteractions",
15920     "group": "Mail_Interactions",
15921     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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": "post",
15928     "url": "/api/mail/interactions/{id}/messages",
15929     "title": "Creates new message",
15930     "examples": [
15931       {
15932         "title": "Example usage:",
15933         "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",
15934         "type": "json"
15935       }
15936     ],
15937     "name": "addMessage",
15938     "group": "Mail_Interactions",
15939     "parameter": {
15940       "fields": {
15941         "Body": [
15942           {
15943             "group": "Body",
15944             "type": "Text",
15945             "optional": false,
15946             "field": "body",
15947             "description": ""
15948           },
15949           {
15950             "group": "Body",
15951             "type": "Text",
15952             "optional": true,
15953             "field": "plainBody",
15954             "description": ""
15955           },
15956           {
15957             "group": "Body",
15958             "type": "Boolean",
15959             "optional": true,
15960             "field": "read",
15961             "description": ""
15962           },
15963           {
15964             "group": "Body",
15965             "type": "String",
15966             "allowedValues": [
15967               "\"in\"",
15968               "\"out\""
15969             ],
15970             "optional": false,
15971             "field": "direction",
15972             "description": ""
15973           },
15974           {
15975             "group": "Body",
15976             "type": "String",
15977             "optional": true,
15978             "field": "messageId",
15979             "description": ""
15980           },
15981           {
15982             "group": "Body",
15983             "type": "String",
15984             "optional": true,
15985             "field": "from",
15986             "description": ""
15987           },
15988           {
15989             "group": "Body",
15990             "type": "Text",
15991             "optional": true,
15992             "field": "to",
15993             "description": ""
15994           },
15995           {
15996             "group": "Body",
15997             "type": "Text",
15998             "optional": true,
15999             "field": "cc",
16000             "description": ""
16001           },
16002           {
16003             "group": "Body",
16004             "type": "Text",
16005             "optional": true,
16006             "field": "bcc",
16007             "description": ""
16008           },
16009           {
16010             "group": "Body",
16011             "type": "Text",
16012             "optional": true,
16013             "field": "subject",
16014             "description": ""
16015           },
16016           {
16017             "group": "Body",
16018             "type": "String",
16019             "optional": true,
16020             "field": "sentAt",
16021             "description": ""
16022           },
16023           {
16024             "group": "Body",
16025             "type": "Integer",
16026             "optional": true,
16027             "field": "attach",
16028             "description": ""
16029           },
16030           {
16031             "group": "Body",
16032             "type": "Boolean",
16033             "optional": true,
16034             "field": "secret",
16035             "description": ""
16036           },
16037           {
16038             "group": "Body",
16039             "type": "String",
16040             "optional": true,
16041             "field": "readAt",
16042             "description": ""
16043           },
16044           {
16045             "group": "Body",
16046             "type": "Text",
16047             "optional": true,
16048             "field": "originTo",
16049             "description": ""
16050           },
16051           {
16052             "group": "Body",
16053             "type": "Text",
16054             "optional": true,
16055             "field": "originCc",
16056             "description": ""
16057           }
16058         ]
16059       }
16060     },
16061     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16062     "version": "0.0.0",
16063     "filename": "server/api/mailInteraction/index.js",
16064     "groupTitle": "Mail_Interactions"
16065   },
16066   {
16067     "type": "get",
16068     "url": "/api/mail/interactions/{id}/download",
16069     "title": "Gets interaction",
16070     "examples": [
16071       {
16072         "title": "Example usage:",
16073         "content": "curl https://{domain}/api/mail/interactions/{id}/download -v -u {name}:{password} -X GET",
16074         "type": "json"
16075       }
16076     ],
16077     "name": "download",
16078     "group": "Mail_Interactions",
16079     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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}/messages",
16087     "title": "Gets interaction messages",
16088     "examples": [
16089       {
16090         "title": "Example usage:",
16091         "content": "curl https://{domain}/api/mail/interactions/{id}/messages -v -u {name}:{password} -X GET",
16092         "type": "json"
16093       }
16094     ],
16095     "name": "getMessages",
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": "put",
16104     "url": "/api/mail/interactions/{id}",
16105     "title": "Update an existing Interaction",
16106     "examples": [
16107       {
16108         "title": "Example usage:",
16109         "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",
16110         "type": "json"
16111       }
16112     ],
16113     "name": "updateInteractions",
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": "delete",
16122     "url": "/api/mail/messages/{id}",
16123     "title": "Deletes a Message",
16124     "examples": [
16125       {
16126         "title": "Example usage:",
16127         "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password} -X DELETE",
16128         "type": "json"
16129       }
16130     ],
16131     "name": "DeleteMessages",
16132     "group": "Mail_Messages",
16133     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/mailMessage/index.js",
16136     "groupTitle": "Mail_Messages"
16137   },
16138   {
16139     "type": "get",
16140     "url": "/api/mail/messages/describe",
16141     "title": "Gets table info about Messages",
16142     "examples": [
16143       {
16144         "title": "Example usage:",
16145         "content": "curl https://{domain}/api/mail/messages/describe -v -u {name}:{password}",
16146         "type": "json"
16147       }
16148     ],
16149     "name": "DescribeMessages",
16150     "group": "Mail_Messages",
16151     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</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",
16159     "title": "Gets a list of Messages",
16160     "examples": [
16161       {
16162         "title": "Example usage:",
16163         "content": "curl https://{domain}/api/mail/messages -v -u {name}:{password}",
16164         "type": "json"
16165       }
16166     ],
16167     "name": "GetMessages",
16168     "group": "Mail_Messages",
16169     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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/{id}",
16177     "title": "Gets a single Message",
16178     "examples": [
16179       {
16180         "title": "Example usage:",
16181         "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password}",
16182         "type": "json"
16183       }
16184     ],
16185     "name": "ShowMessages",
16186     "group": "Mail_Messages",
16187     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16188     "version": "0.0.0",
16189     "filename": "server/api/mailMessage/index.js",
16190     "groupTitle": "Mail_Messages"
16191   },
16192   {
16193     "type": "put",
16194     "url": "/api/mail/messages/{id}/accept",
16195     "title": "Accepts message",
16196     "examples": [
16197       {
16198         "title": "Example usage:",
16199         "content": "curl https://{domain}/api/mail/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
16200         "type": "json"
16201       }
16202     ],
16203     "name": "acceptMessage",
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": "post",
16212     "url": "/api/mail/messages",
16213     "title": "Create a message",
16214     "examples": [
16215       {
16216         "title": "Example usage:",
16217         "content": "curl https://{domain}/api/mail/messages \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
16218         "type": "json"
16219       }
16220     ],
16221     "name": "createMessage",
16222     "group": "Mail_Messages",
16223     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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": "get",
16230     "url": "/api/mail/messages/{id}/download",
16231     "title": "Gets message",
16232     "examples": [
16233       {
16234         "title": "Example usage:",
16235         "content": "curl https://{domain}/api/mail/messages/{id}/download -v -u {name}:{password} -X GET",
16236         "type": "json"
16237       }
16238     ],
16239     "name": "download",
16240     "group": "Mail_Messages",
16241     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "put",
16248     "url": "/api/mail/messages/{id}/reject",
16249     "title": "Rejects message",
16250     "examples": [
16251       {
16252         "title": "Example usage:",
16253         "content": "curl https://{domain}/api/mail/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
16254         "type": "json"
16255       }
16256     ],
16257     "name": "rejectMessage",
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}",
16267     "title": "Update an existing Message",
16268     "examples": [
16269       {
16270         "title": "Example usage:",
16271         "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",
16272         "type": "json"
16273       }
16274     ],
16275     "name": "updateMessages",
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": "post",
16284     "url": "/api/mail/reports/queue",
16285     "title": "Creates a new Mail Queue Report",
16286     "examples": [
16287       {
16288         "title": "Example usage:",
16289         "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",
16290         "type": "json"
16291       }
16292     ],
16293     "name": "CreateMail_Queue_Reports",
16294     "group": "Mail_Queue_Reports",
16295     "parameter": {
16296       "fields": {
16297         "Body": [
16298           {
16299             "group": "Body",
16300             "type": "String",
16301             "optional": false,
16302             "field": "uniqueid",
16303             "description": ""
16304           },
16305           {
16306             "group": "Body",
16307             "type": "String",
16308             "optional": true,
16309             "field": "from",
16310             "description": ""
16311           },
16312           {
16313             "group": "Body",
16314             "type": "String",
16315             "optional": true,
16316             "field": "joinAt",
16317             "description": ""
16318           },
16319           {
16320             "group": "Body",
16321             "type": "String",
16322             "optional": true,
16323             "field": "leaveAt",
16324             "description": ""
16325           },
16326           {
16327             "group": "Body",
16328             "type": "String",
16329             "optional": true,
16330             "field": "acceptAt",
16331             "description": ""
16332           },
16333           {
16334             "group": "Body",
16335             "type": "String",
16336             "optional": true,
16337             "field": "exitAt",
16338             "description": ""
16339           },
16340           {
16341             "group": "Body",
16342             "type": "String",
16343             "optional": true,
16344             "field": "reason",
16345             "description": ""
16346           }
16347         ]
16348       }
16349     },
16350     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16351     "version": "0.0.0",
16352     "filename": "server/api/mailQueueReport/index.js",
16353     "groupTitle": "Mail_Queue_Reports"
16354   },
16355   {
16356     "type": "delete",
16357     "url": "/api/mail/reports/queue/{id}",
16358     "title": "Deletes a Mail Queue Report",
16359     "examples": [
16360       {
16361         "title": "Example usage:",
16362         "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password} -X DELETE",
16363         "type": "json"
16364       }
16365     ],
16366     "name": "DeleteMail_Queue_Reports",
16367     "group": "Mail_Queue_Reports",
16368     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "get",
16375     "url": "/api/mail/reports/queue/describe",
16376     "title": "Gets table info about Mail Queue Reports",
16377     "examples": [
16378       {
16379         "title": "Example usage:",
16380         "content": "curl https://{domain}/api/mail/reports/queue/describe -v -u {name}:{password}",
16381         "type": "json"
16382       }
16383     ],
16384     "name": "DescribeMail_Queue_Reports",
16385     "group": "Mail_Queue_Reports",
16386     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</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",
16394     "title": "Gets a list of Mail Queue Reports",
16395     "examples": [
16396       {
16397         "title": "Example usage:",
16398         "content": "curl https://{domain}/api/mail/reports/queue -v -u {name}:{password}",
16399         "type": "json"
16400       }
16401     ],
16402     "name": "GetMail_Queue_Reports",
16403     "group": "Mail_Queue_Reports",
16404     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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/{id}",
16412     "title": "Gets a single Mail Queue Report",
16413     "examples": [
16414       {
16415         "title": "Example usage:",
16416         "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password}",
16417         "type": "json"
16418       }
16419     ],
16420     "name": "ShowMail_Queue_Reports",
16421     "group": "Mail_Queue_Reports",
16422     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16423     "version": "0.0.0",
16424     "filename": "server/api/mailQueueReport/index.js",
16425     "groupTitle": "Mail_Queue_Reports"
16426   },
16427   {
16428     "type": "put",
16429     "url": "/api/mail/reports/queue/{id}",
16430     "title": "Update an existing Mail Queue Report",
16431     "examples": [
16432       {
16433         "title": "Example usage:",
16434         "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",
16435         "type": "json"
16436       }
16437     ],
16438     "name": "updateMail_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": "post",
16447     "url": "/api/mail/queues/{id}/users",
16448     "title": "Add agents to a queue",
16449     "examples": [
16450       {
16451         "title": "Example usage:",
16452         "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",
16453         "type": "json"
16454       }
16455     ],
16456     "name": "AddAgents",
16457     "group": "Mail_Queues",
16458     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16459     "version": "0.0.0",
16460     "filename": "server/api/mailQueue/index.js",
16461     "groupTitle": "Mail_Queues"
16462   },
16463   {
16464     "type": "post",
16465     "url": "/api/mail/queues/{id}/teams",
16466     "title": "Add teams to a queue",
16467     "examples": [
16468       {
16469         "title": "Example usage:",
16470         "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",
16471         "type": "json"
16472       }
16473     ],
16474     "name": "AddTeams",
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",
16484     "title": "Creates a new Queue",
16485     "examples": [
16486       {
16487         "title": "Example usage:",
16488         "content": "curl https://{domain}/api/mail/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
16489         "type": "json"
16490       }
16491     ],
16492     "name": "CreateQueues",
16493     "group": "Mail_Queues",
16494     "parameter": {
16495       "fields": {
16496         "Body": [
16497           {
16498             "group": "Body",
16499             "type": "String",
16500             "optional": true,
16501             "field": "name",
16502             "description": ""
16503           },
16504           {
16505             "group": "Body",
16506             "type": "String",
16507             "optional": true,
16508             "field": "description",
16509             "description": ""
16510           },
16511           {
16512             "group": "Body",
16513             "type": "Integer",
16514             "optional": true,
16515             "field": "timeout",
16516             "description": ""
16517           },
16518           {
16519             "group": "Body",
16520             "type": "String",
16521             "allowedValues": [
16522               "\"rrmemory\"",
16523               "\"beepall\"",
16524               "\"roundrobin\""
16525             ],
16526             "optional": true,
16527             "field": "strategy",
16528             "description": ""
16529           }
16530         ]
16531       }
16532     },
16533     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16534     "version": "0.0.0",
16535     "filename": "server/api/mailQueue/index.js",
16536     "groupTitle": "Mail_Queues"
16537   },
16538   {
16539     "type": "delete",
16540     "url": "/api/mail/queues/{id}",
16541     "title": "Deletes a Queue",
16542     "examples": [
16543       {
16544         "title": "Example usage:",
16545         "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password} -X DELETE",
16546         "type": "json"
16547       }
16548     ],
16549     "name": "DeleteQueues",
16550     "group": "Mail_Queues",
16551     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "get",
16558     "url": "/api/mail/queues/describe",
16559     "title": "Gets table info about Queues",
16560     "examples": [
16561       {
16562         "title": "Example usage:",
16563         "content": "curl https://{domain}/api/mail/queues/describe -v -u {name}:{password}",
16564         "type": "json"
16565       }
16566     ],
16567     "name": "DescribeQueues",
16568     "group": "Mail_Queues",
16569     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</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/{id}/users",
16577     "title": "Gets queue agents",
16578     "examples": [
16579       {
16580         "title": "Example usage:",
16581         "content": "curl https://{domain}/api/mail/queues/{id}/users -v -u {name}:{password} -X POST",
16582         "type": "json"
16583       }
16584     ],
16585     "name": "GetAgents",
16586     "group": "Mail_Queues",
16587     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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}/members",
16595     "title": "GetMembers",
16596     "examples": [
16597       {
16598         "title": "Example usage:",
16599         "content": "curl https://{domain}/api/mail/queues/{id}/members  -v -u {name}:{password}",
16600         "type": "json"
16601       }
16602     ],
16603     "name": "GetMembers",
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",
16613     "title": "Gets a list of Queues",
16614     "examples": [
16615       {
16616         "title": "Example usage:",
16617         "content": "curl https://{domain}/api/mail/queues -v -u {name}:{password}",
16618         "type": "json"
16619       }
16620     ],
16621     "name": "GetQueues",
16622     "group": "Mail_Queues",
16623     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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/{id}/teams",
16631     "title": "Gets queues list",
16632     "examples": [
16633       {
16634         "title": "Example usage:",
16635         "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password}",
16636         "type": "json"
16637       }
16638     ],
16639     "name": "GetTeams",
16640     "group": "Mail_Queues",
16641     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16642     "version": "0.0.0",
16643     "filename": "server/api/mailQueue/index.js",
16644     "groupTitle": "Mail_Queues"
16645   },
16646   {
16647     "type": "delete",
16648     "url": "/api/mail/queues/{id}/users",
16649     "title": "Removes agents from a queue",
16650     "examples": [
16651       {
16652         "title": "Example usage:",
16653         "content": "curl https://{domain}/api/mail/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
16654         "type": "json"
16655       }
16656     ],
16657     "name": "RemoveAgents",
16658     "group": "Mail_Queues",
16659     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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": "get",
16666     "url": "/api/mail/queues/{id}",
16667     "title": "Gets a single Queue",
16668     "examples": [
16669       {
16670         "title": "Example usage:",
16671         "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password}",
16672         "type": "json"
16673       }
16674     ],
16675     "name": "ShowQueues",
16676     "group": "Mail_Queues",
16677     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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": "put",
16684     "url": "/api/mail/queues/{id}",
16685     "title": "Update an existing Queue",
16686     "examples": [
16687       {
16688         "title": "Example usage:",
16689         "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",
16690         "type": "json"
16691       }
16692     ],
16693     "name": "updateQueues",
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": "post",
16702     "url": "/api/mail/out_servers",
16703     "title": "Creates a new SMTP",
16704     "examples": [
16705       {
16706         "title": "Example usage:",
16707         "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",
16708         "type": "json"
16709       }
16710     ],
16711     "name": "CreateSMTPs",
16712     "group": "Mail_SMTP",
16713     "parameter": {
16714       "fields": {
16715         "Body": [
16716           {
16717             "group": "Body",
16718             "type": "String",
16719             "optional": true,
16720             "field": "description",
16721             "description": ""
16722           },
16723           {
16724             "group": "Body",
16725             "type": "String",
16726             "optional": true,
16727             "field": "host",
16728             "description": ""
16729           },
16730           {
16731             "group": "Body",
16732             "type": "String",
16733             "optional": true,
16734             "field": "user",
16735             "description": ""
16736           },
16737           {
16738             "group": "Body",
16739             "type": "String",
16740             "optional": true,
16741             "field": "pass",
16742             "description": ""
16743           },
16744           {
16745             "group": "Body",
16746             "type": "Integer",
16747             "optional": true,
16748             "field": "port",
16749             "description": ""
16750           },
16751           {
16752             "group": "Body",
16753             "type": "Boolean",
16754             "optional": true,
16755             "field": "secure",
16756             "description": ""
16757           },
16758           {
16759             "group": "Body",
16760             "type": "String",
16761             "optional": true,
16762             "field": "service",
16763             "description": ""
16764           },
16765           {
16766             "group": "Body",
16767             "type": "Boolean",
16768             "optional": true,
16769             "field": "authentication",
16770             "description": ""
16771           }
16772         ]
16773       }
16774     },
16775     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16776     "version": "0.0.0",
16777     "filename": "server/api/mailServerOut/index.js",
16778     "groupTitle": "Mail_SMTP"
16779   },
16780   {
16781     "type": "delete",
16782     "url": "/api/mail/out_servers/{id}",
16783     "title": "Deletes a SMTP",
16784     "examples": [
16785       {
16786         "title": "Example usage:",
16787         "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password} -X DELETE",
16788         "type": "json"
16789       }
16790     ],
16791     "name": "DeleteSMTPs",
16792     "group": "Mail_SMTP",
16793     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "get",
16800     "url": "/api/mail/out_servers",
16801     "title": "Gets a list of SMTPs",
16802     "examples": [
16803       {
16804         "title": "Example usage:",
16805         "content": "curl https://{domain}/api/mail/out_servers -v -u {name}:{password}",
16806         "type": "json"
16807       }
16808     ],
16809     "name": "GetSMTPs",
16810     "group": "Mail_SMTP",
16811     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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/{id}",
16819     "title": "Gets a single SMTP",
16820     "examples": [
16821       {
16822         "title": "Example usage:",
16823         "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password}",
16824         "type": "json"
16825       }
16826     ],
16827     "name": "ShowSMTPs",
16828     "group": "Mail_SMTP",
16829     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16830     "version": "0.0.0",
16831     "filename": "server/api/mailServerOut/index.js",
16832     "groupTitle": "Mail_SMTP"
16833   },
16834   {
16835     "type": "put",
16836     "url": "/api/mail/out_servers/{id}",
16837     "title": "Update an existing SMTP",
16838     "examples": [
16839       {
16840         "title": "Example usage:",
16841         "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",
16842         "type": "json"
16843       }
16844     ],
16845     "name": "updateSMTPs",
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": "post",
16854     "url": "/api/mail/substatuses",
16855     "title": "Creates a new Queue",
16856     "examples": [
16857       {
16858         "title": "Example usage:",
16859         "content": "curl https://{domain}/api/mail/substatuses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
16860         "type": "json"
16861       }
16862     ],
16863     "name": "CreateSubstatuses",
16864     "group": "Mail_Substatuses",
16865     "parameter": {
16866       "fields": {
16867         "Body": [
16868           {
16869             "group": "Body",
16870             "type": "String",
16871             "optional": false,
16872             "field": "name",
16873             "description": ""
16874           },
16875           {
16876             "group": "Body",
16877             "type": "String",
16878             "optional": true,
16879             "field": "description",
16880             "description": ""
16881           }
16882         ]
16883       }
16884     },
16885     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16886     "version": "0.0.0",
16887     "filename": "server/api/mailSubstatus/index.js",
16888     "groupTitle": "Mail_Substatuses"
16889   },
16890   {
16891     "type": "delete",
16892     "url": "/api/mail/substatuses/{id}",
16893     "title": "Deletes a Queue",
16894     "examples": [
16895       {
16896         "title": "Example usage:",
16897         "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password} -X DELETE",
16898         "type": "json"
16899       }
16900     ],
16901     "name": "DeleteSubstatuses",
16902     "group": "Mail_Substatuses",
16903     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "get",
16910     "url": "/api/mail/substatuses/describe",
16911     "title": "Gets table info about Substatuses",
16912     "examples": [
16913       {
16914         "title": "Example usage:",
16915         "content": "curl https://{domain}/api/mail/substatuses/describe -v -u {name}:{password}",
16916         "type": "json"
16917       }
16918     ],
16919     "name": "DescribeSubstatuses",
16920     "group": "Mail_Substatuses",
16921     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</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",
16929     "title": "Gets a list of Substatuses",
16930     "examples": [
16931       {
16932         "title": "Example usage:",
16933         "content": "curl https://{domain}/api/mail/substatuses -v -u {name}:{password}",
16934         "type": "json"
16935       }
16936     ],
16937     "name": "GetSubstatuses",
16938     "group": "Mail_Substatuses",
16939     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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/{id}",
16947     "title": "Gets a single Queue",
16948     "examples": [
16949       {
16950         "title": "Example usage:",
16951         "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password}",
16952         "type": "json"
16953       }
16954     ],
16955     "name": "ShowSubstatuses",
16956     "group": "Mail_Substatuses",
16957     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16958     "version": "0.0.0",
16959     "filename": "server/api/mailSubstatus/index.js",
16960     "groupTitle": "Mail_Substatuses"
16961   },
16962   {
16963     "type": "put",
16964     "url": "/api/mail/substatuses/{id}",
16965     "title": "Update an existing Queue",
16966     "examples": [
16967       {
16968         "title": "Example usage:",
16969         "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",
16970         "type": "json"
16971       }
16972     ],
16973     "name": "updateSubstatuses",
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": "post",
16982     "url": "/api/mail/reports/transfer",
16983     "title": "Creates a new Mail Transfer Report",
16984     "examples": [
16985       {
16986         "title": "Example usage:",
16987         "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",
16988         "type": "json"
16989       }
16990     ],
16991     "name": "CreateMail_Transfer_Reports",
16992     "group": "Mail_Transfer_Reports",
16993     "parameter": {
16994       "fields": {
16995         "Body": [
16996           {
16997             "group": "Body",
16998             "type": "String",
16999             "optional": false,
17000             "field": "uniqueid",
17001             "description": ""
17002           },
17003           {
17004             "group": "Body",
17005             "type": "String",
17006             "allowedValues": [
17007               "\"account\"",
17008               "\"agent\"",
17009               "\"queue\""
17010             ],
17011             "optional": false,
17012             "field": "type",
17013             "description": ""
17014           },
17015           {
17016             "group": "Body",
17017             "type": "String",
17018             "optional": false,
17019             "field": "transferredAt",
17020             "description": ""
17021           }
17022         ]
17023       }
17024     },
17025     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17026     "version": "0.0.0",
17027     "filename": "server/api/mailTransferReport/index.js",
17028     "groupTitle": "Mail_Transfer_Reports"
17029   },
17030   {
17031     "type": "delete",
17032     "url": "/api/mail/reports/transfer/{id}",
17033     "title": "Deletes a Mail Transfer Report",
17034     "examples": [
17035       {
17036         "title": "Example usage:",
17037         "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
17038         "type": "json"
17039       }
17040     ],
17041     "name": "DeleteMail_Transfer_Reports",
17042     "group": "Mail_Transfer_Reports",
17043     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "get",
17050     "url": "/api/mail/reports/transfer/describe",
17051     "title": "Gets table info about Mail Transfer Reports",
17052     "examples": [
17053       {
17054         "title": "Example usage:",
17055         "content": "curl https://{domain}/api/mail/reports/transfer/describe -v -u {name}:{password}",
17056         "type": "json"
17057       }
17058     ],
17059     "name": "DescribeMail_Transfer_Reports",
17060     "group": "Mail_Transfer_Reports",
17061     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17062     "version": "0.0.0",
17063     "filename": "server/api/mailTransferReport/index.js",
17064     "groupTitle": "Mail_Transfer_Reports"
17065   },
17066   {
17067     "type": "get",
17068     "url": "/api/mail/reports/transfer",
17069     "title": "Gets a list of Mail Transfer Reports",
17070     "examples": [
17071       {
17072         "title": "Example usage:",
17073         "content": "curl https://{domain}/api/mail/reports/transfer -v -u {name}:{password}",
17074         "type": "json"
17075       }
17076     ],
17077     "name": "GetMail_Transfer_Reports",
17078     "group": "Mail_Transfer_Reports",
17079     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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/{id}",
17087     "title": "Gets a single Mail Transfer Report",
17088     "examples": [
17089       {
17090         "title": "Example usage:",
17091         "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password}",
17092         "type": "json"
17093       }
17094     ],
17095     "name": "ShowMail_Transfer_Reports",
17096     "group": "Mail_Transfer_Reports",
17097     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17098     "version": "0.0.0",
17099     "filename": "server/api/mailTransferReport/index.js",
17100     "groupTitle": "Mail_Transfer_Reports"
17101   },
17102   {
17103     "type": "put",
17104     "url": "/api/mail/reports/transfer/{id}",
17105     "title": "Update an existing Mail Transfer Report",
17106     "examples": [
17107       {
17108         "title": "Example usage:",
17109         "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",
17110         "type": "json"
17111       }
17112     ],
17113     "name": "updateMail_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": "get",
17122     "url": "/api/members/reports/describe",
17123     "title": "Gets table info about Member Reports",
17124     "examples": [
17125       {
17126         "title": "Example usage:",
17127         "content": "curl https://{domain}/api/members/reports/describe -v -u {name}:{password}",
17128         "type": "json"
17129       }
17130     ],
17131     "name": "DescribeMember_Reports",
17132     "group": "Member_Reports",
17133     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17134     "version": "0.0.0",
17135     "filename": "server/api/memberReport/index.js",
17136     "groupTitle": "Member_Reports"
17137   },
17138   {
17139     "type": "get",
17140     "url": "/api/members/reports",
17141     "title": "Gets a list of Member Reports",
17142     "examples": [
17143       {
17144         "title": "Example usage:",
17145         "content": "curl https://{domain}/api/members/reports -v -u {name}:{password}",
17146         "type": "json"
17147       }
17148     ],
17149     "name": "GetMember_Reports",
17150     "group": "Member_Reports",
17151     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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/{id}",
17159     "title": "Gets a single Member Report",
17160     "examples": [
17161       {
17162         "title": "Example usage:",
17163         "content": "curl https://{domain}/api/members/reports/{id} -v -u {name}:{password}",
17164         "type": "json"
17165       }
17166     ],
17167     "name": "ShowMember_Reports",
17168     "group": "Member_Reports",
17169     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</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/migrations",
17177     "title": "Gets a list of Migrations",
17178     "examples": [
17179       {
17180         "title": "Example usage:",
17181         "content": "curl https://{domain}/api/migrations -v -u {name}:{password}",
17182         "type": "json"
17183       }
17184     ],
17185     "name": "GetMigrations",
17186     "group": "Migrations",
17187     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17188     "version": "0.0.0",
17189     "filename": "server/api/migration/index.js",
17190     "groupTitle": "Migrations"
17191   },
17192   {
17193     "type": "post",
17194     "url": "/api/voice/networks",
17195     "title": "Create a new network",
17196     "examples": [
17197       {
17198         "title": "Example usage:",
17199         "content": "curl https://{domain}/api/voice/networks -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17200         "type": "json"
17201       }
17202     ],
17203     "name": "Create",
17204     "group": "Networks",
17205     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17206     "version": "0.0.0",
17207     "filename": "server/api/network/index.js",
17208     "groupTitle": "Networks"
17209   },
17210   {
17211     "type": "delete",
17212     "url": "/api/voice/networks/{id}",
17213     "title": "Deletes a network",
17214     "examples": [
17215       {
17216         "title": "Example usage:",
17217         "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X DELETE",
17218         "type": "json"
17219       }
17220     ],
17221     "name": "Delete",
17222     "group": "Networks",
17223     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "get",
17230     "url": "/api/networks",
17231     "title": "Gets a list of Networks",
17232     "examples": [
17233       {
17234         "title": "Example usage:",
17235         "content": "curl https://{domain}/api/networks -v -u {name}:{password}",
17236         "type": "json"
17237       }
17238     ],
17239     "name": "GetNetworks",
17240     "group": "Networks",
17241     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17242     "version": "0.0.0",
17243     "filename": "server/api/network/index.js",
17244     "groupTitle": "Networks"
17245   },
17246   {
17247     "type": "get",
17248     "url": "/api/networks/{id}",
17249     "title": "Gets a single Network",
17250     "examples": [
17251       {
17252         "title": "Example usage:",
17253         "content": "curl https://{domain}/api/networks/{id} -v -u {name}:{password}",
17254         "type": "json"
17255       }
17256     ],
17257     "name": "ShowNetworks",
17258     "group": "Networks",
17259     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17260     "version": "0.0.0",
17261     "filename": "server/api/network/index.js",
17262     "groupTitle": "Networks"
17263   },
17264   {
17265     "type": "put",
17266     "url": "/api/voice/networks/{id}",
17267     "title": "Update an existing network",
17268     "examples": [
17269       {
17270         "title": "Example usage:",
17271         "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X PUT",
17272         "type": "json"
17273       }
17274     ],
17275     "name": "Update",
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": "post",
17284     "url": "/api/notifications",
17285     "title": "Send notification to user",
17286     "examples": [
17287       {
17288         "title": "Example usage:",
17289         "content": "curl https://{domain}/api/notifications -d '{\"text\": \"Hello!\", \"TemplateId\": 1}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17290         "type": "json"
17291       }
17292     ],
17293     "name": "Send",
17294     "group": "Notifications",
17295     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17296     "version": "0.0.0",
17297     "filename": "server/api/notification/index.js",
17298     "groupTitle": "Notifications"
17299   },
17300   {
17301     "type": "post",
17302     "url": "/api/openchannel/accounts/{id}/users",
17303     "title": "Add agents to a openchannel account",
17304     "examples": [
17305       {
17306         "title": "Example usage:",
17307         "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",
17308         "type": "json"
17309       }
17310     ],
17311     "name": "AddAgents",
17312     "group": "Openchannel_Accounts",
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/openchannelAccount/index.js",
17316     "groupTitle": "Openchannel_Accounts"
17317   },
17318   {
17319     "type": "post",
17320     "url": "/api/openchannel/accounts",
17321     "title": "Creates a new Account",
17322     "examples": [
17323       {
17324         "title": "Example usage:",
17325         "content": "curl https://{domain}/api/openchannel/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17326         "type": "json"
17327       }
17328     ],
17329     "name": "CreateAccounts",
17330     "group": "Openchannel_Accounts",
17331     "parameter": {
17332       "fields": {
17333         "Body": [
17334           {
17335             "group": "Body",
17336             "type": "String",
17337             "optional": false,
17338             "field": "name",
17339             "description": ""
17340           },
17341           {
17342             "group": "Body",
17343             "type": "String",
17344             "optional": true,
17345             "field": "description",
17346             "description": ""
17347           },
17348           {
17349             "group": "Body",
17350             "type": "String",
17351             "optional": true,
17352             "field": "token",
17353             "description": ""
17354           },
17355           {
17356             "group": "Body",
17357             "type": "String",
17358             "optional": true,
17359             "field": "replyUri",
17360             "description": ""
17361           },
17362           {
17363             "group": "Body",
17364             "type": "String",
17365             "optional": false,
17366             "field": "key",
17367             "description": ""
17368           },
17369           {
17370             "group": "Body",
17371             "type": "Text",
17372             "optional": true,
17373             "field": "notificationTemplate",
17374             "description": ""
17375           },
17376           {
17377             "group": "Body",
17378             "type": "Boolean",
17379             "optional": true,
17380             "field": "notificationSound",
17381             "description": ""
17382           },
17383           {
17384             "group": "Body",
17385             "type": "Boolean",
17386             "optional": true,
17387             "field": "notificationShake",
17388             "description": ""
17389           },
17390           {
17391             "group": "Body",
17392             "type": "Integer",
17393             "optional": true,
17394             "field": "waitForTheAssignedAgent",
17395             "description": ""
17396           },
17397           {
17398             "group": "Body",
17399             "type": "String",
17400             "optional": true,
17401             "field": "mapKey",
17402             "description": ""
17403           },
17404           {
17405             "group": "Body",
17406             "type": "Boolean",
17407             "optional": true,
17408             "field": "queueTransfer",
17409             "description": ""
17410           },
17411           {
17412             "group": "Body",
17413             "type": "Integer",
17414             "optional": true,
17415             "field": "queueTransferTimeout",
17416             "description": ""
17417           },
17418           {
17419             "group": "Body",
17420             "type": "Boolean",
17421             "optional": true,
17422             "field": "agentTransfer",
17423             "description": ""
17424           },
17425           {
17426             "group": "Body",
17427             "type": "Integer",
17428             "optional": true,
17429             "field": "agentTransferTimeout",
17430             "description": ""
17431           },
17432           {
17433             "group": "Body",
17434             "type": "Integer",
17435             "optional": true,
17436             "field": "mandatoryDispositionPauseId",
17437             "description": "<p>Status to put when mandatory disposition is enabled</p>"
17438           },
17439           {
17440             "group": "Body",
17441             "type": "Boolean",
17442             "optional": true,
17443             "field": "mandatoryDisposition",
17444             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
17445           }
17446         ]
17447       }
17448     },
17449     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17450     "version": "0.0.0",
17451     "filename": "server/api/openchannelAccount/index.js",
17452     "groupTitle": "Openchannel_Accounts"
17453   },
17454   {
17455     "type": "delete",
17456     "url": "/api/openchannel/accounts/{id}",
17457     "title": "Deletes a Account",
17458     "examples": [
17459       {
17460         "title": "Example usage:",
17461         "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password} -X DELETE",
17462         "type": "json"
17463       }
17464     ],
17465     "name": "DeleteAccounts",
17466     "group": "Openchannel_Accounts",
17467     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "get",
17474     "url": "/api/openchannel/accounts/describe",
17475     "title": "Gets table info about Accounts",
17476     "examples": [
17477       {
17478         "title": "Example usage:",
17479         "content": "curl https://{domain}/api/openchannel/accounts/describe -v -u {name}:{password}",
17480         "type": "json"
17481       }
17482     ],
17483     "name": "DescribeAccounts",
17484     "group": "Openchannel_Accounts",
17485     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</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",
17493     "title": "Gets a list of Accounts",
17494     "examples": [
17495       {
17496         "title": "Example usage:",
17497         "content": "curl https://{domain}/api/openchannel/accounts -v -u {name}:{password}",
17498         "type": "json"
17499       }
17500     ],
17501     "name": "GetAccounts",
17502     "group": "Openchannel_Accounts",
17503     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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/{id}/users",
17511     "title": "Gets agents from openchannel account",
17512     "examples": [
17513       {
17514         "title": "Example usage:",
17515         "content": "curl https://{domain}/api/openchannel/accounts/{id}/users -v -u {name}:{password} -X GET",
17516         "type": "json"
17517       }
17518     ],
17519     "name": "GetAgents",
17520     "group": "Openchannel_Accounts",
17521     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17522     "version": "0.0.0",
17523     "filename": "server/api/openchannelAccount/index.js",
17524     "groupTitle": "Openchannel_Accounts"
17525   },
17526   {
17527     "type": "delete",
17528     "url": "/api/openchannel/accounts/{id}/users",
17529     "title": "Removes agents from a openchannel account",
17530     "examples": [
17531       {
17532         "title": "Example usage:",
17533         "content": "curl https://{domain}/api/openchannel/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17534         "type": "json"
17535       }
17536     ],
17537     "name": "RemoveAgents",
17538     "group": "Openchannel_Accounts",
17539     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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}/canned_answers",
17547     "title": "Removes canned answers from account",
17548     "examples": [
17549       {
17550         "title": "Example usage:",
17551         "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17552         "type": "json"
17553       }
17554     ],
17555     "name": "RemoveAnswers",
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}/dispositions",
17565     "title": "Removes dispositions from account",
17566     "examples": [
17567       {
17568         "title": "Example usage:",
17569         "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17570         "type": "json"
17571       }
17572     ],
17573     "name": "RemoveDispositions",
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": "get",
17582     "url": "/api/openchannel/accounts/{id}",
17583     "title": "Gets a single Account",
17584     "examples": [
17585       {
17586         "title": "Example usage:",
17587         "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password}",
17588         "type": "json"
17589       }
17590     ],
17591     "name": "ShowAccounts",
17592     "group": "Openchannel_Accounts",
17593     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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": "post",
17600     "url": "/api/openchannel/accounts/{id}/canned_answers",
17601     "title": "Creates new canned answer",
17602     "examples": [
17603       {
17604         "title": "Example usage:",
17605         "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",
17606         "type": "json"
17607       }
17608     ],
17609     "name": "addAnswer",
17610     "group": "Openchannel_Accounts",
17611     "parameter": {
17612       "fields": {
17613         "Body": [
17614           {
17615             "group": "Body",
17616             "type": "String",
17617             "optional": false,
17618             "field": "key",
17619             "description": ""
17620           },
17621           {
17622             "group": "Body",
17623             "type": "Text",
17624             "optional": false,
17625             "field": "value",
17626             "description": ""
17627           },
17628           {
17629             "group": "Body",
17630             "type": "String",
17631             "optional": true,
17632             "field": "description",
17633             "description": ""
17634           },
17635           {
17636             "group": "Body",
17637             "type": "Virtual",
17638             "optional": true,
17639             "field": "name",
17640             "description": ""
17641           }
17642         ]
17643       }
17644     },
17645     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17646     "version": "0.0.0",
17647     "filename": "server/api/openchannelAccount/index.js",
17648     "groupTitle": "Openchannel_Accounts"
17649   },
17650   {
17651     "type": "post",
17652     "url": "/api/openchannel/accounts/{id}/applications",
17653     "title": "Creates new applications",
17654     "examples": [
17655       {
17656         "title": "Example usage:",
17657         "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17658         "type": "json"
17659       }
17660     ],
17661     "name": "addApplications",
17662     "group": "Openchannel_Accounts",
17663     "parameter": {
17664       "fields": {
17665         "Body": [
17666           {
17667             "group": "Body",
17668             "type": "Integer",
17669             "optional": false,
17670             "field": "priority",
17671             "description": ""
17672           },
17673           {
17674             "group": "Body",
17675             "type": "String",
17676             "optional": false,
17677             "field": "app",
17678             "description": ""
17679           },
17680           {
17681             "group": "Body",
17682             "type": "Text",
17683             "optional": true,
17684             "field": "appdata",
17685             "description": ""
17686           },
17687           {
17688             "group": "Body",
17689             "type": "String",
17690             "optional": true,
17691             "field": "description",
17692             "description": ""
17693           },
17694           {
17695             "group": "Body",
17696             "type": "String",
17697             "optional": true,
17698             "field": "interval",
17699             "description": ""
17700           }
17701         ]
17702       }
17703     },
17704     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17705     "version": "0.0.0",
17706     "filename": "server/api/openchannelAccount/index.js",
17707     "groupTitle": "Openchannel_Accounts"
17708   },
17709   {
17710     "type": "post",
17711     "url": "/api/openchannel/accounts/{id}/dispositions",
17712     "title": "Creates new disposition",
17713     "examples": [
17714       {
17715         "title": "Example usage:",
17716         "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17717         "type": "json"
17718       }
17719     ],
17720     "name": "addDisposition",
17721     "group": "Openchannel_Accounts",
17722     "parameter": {
17723       "fields": {
17724         "Body": [
17725           {
17726             "group": "Body",
17727             "type": "String",
17728             "optional": false,
17729             "field": "name",
17730             "description": ""
17731           },
17732           {
17733             "group": "Body",
17734             "type": "String",
17735             "allowedValues": [
17736               "\"first\"",
17737               "\"second\"",
17738               "\"third\""
17739             ],
17740             "optional": false,
17741             "field": "level",
17742             "description": ""
17743           },
17744           {
17745             "group": "Body",
17746             "type": "String",
17747             "optional": true,
17748             "field": "description",
17749             "description": ""
17750           }
17751         ]
17752       }
17753     },
17754     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17755     "version": "0.0.0",
17756     "filename": "server/api/openchannelAccount/index.js",
17757     "groupTitle": "Openchannel_Accounts"
17758   },
17759   {
17760     "type": "get",
17761     "url": "/api/openchannel/accounts/{id}/canned_answers",
17762     "title": "Gets account canned answers",
17763     "examples": [
17764       {
17765         "title": "Example usage:",
17766         "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
17767         "type": "json"
17768       }
17769     ],
17770     "name": "getAnswers",
17771     "group": "Openchannel_Accounts",
17772     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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}/applications",
17780     "title": "Gets account applications",
17781     "examples": [
17782       {
17783         "title": "Example usage:",
17784         "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -v -u {name}:{password} -X GET",
17785         "type": "json"
17786       }
17787     ],
17788     "name": "getApplications",
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}/dispositions",
17798     "title": "Gets account dispositions",
17799     "examples": [
17800       {
17801         "title": "Example usage:",
17802         "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
17803         "type": "json"
17804       }
17805     ],
17806     "name": "getDispositions",
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}/interactions",
17816     "title": "Gets Openchannel Account Interactions",
17817     "examples": [
17818       {
17819         "title": "Example usage:",
17820         "content": "curl https://{domain}/api/openchannel/accounts/{id}/interactions -v -u {name}:{password} -X GET",
17821         "type": "json"
17822       }
17823     ],
17824     "name": "getInteractions",
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": "post",
17833     "url": "/api/openchannel/accounts/{id}/notify",
17834     "title": "Notify new message",
17835     "examples": [
17836       {
17837         "title": "Example usage:",
17838         "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",
17839         "type": "json"
17840       }
17841     ],
17842     "name": "notify",
17843     "group": "Openchannel_Accounts",
17844     "description": "<p>Motion 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>",
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}/send",
17852     "title": "Send new openchannel message",
17853     "examples": [
17854       {
17855         "title": "Example usage:",
17856         "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",
17857         "type": "json"
17858       }
17859     ],
17860     "name": "sendOpenchannel",
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>",
17863     "version": "0.0.0",
17864     "filename": "server/api/openchannelAccount/index.js",
17865     "groupTitle": "Openchannel_Accounts"
17866   },
17867   {
17868     "type": "put",
17869     "url": "/api/openchannel/accounts/{id}",
17870     "title": "Update an existing Account",
17871     "examples": [
17872       {
17873         "title": "Example usage:",
17874         "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",
17875         "type": "json"
17876       }
17877     ],
17878     "name": "updateAccounts",
17879     "group": "Openchannel_Accounts",
17880     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17881     "version": "0.0.0",
17882     "filename": "server/api/openchannelAccount/index.js",
17883     "groupTitle": "Openchannel_Accounts"
17884   },
17885   {
17886     "type": "post",
17887     "url": "/api/openchannel/applications",
17888     "title": "Creates a new Application",
17889     "examples": [
17890       {
17891         "title": "Example usage:",
17892         "content": "curl https://{domain}/api/openchannel/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17893         "type": "json"
17894       }
17895     ],
17896     "name": "CreateApplications",
17897     "group": "Openchannel_Applications",
17898     "parameter": {
17899       "fields": {
17900         "Body": [
17901           {
17902             "group": "Body",
17903             "type": "Integer",
17904             "optional": false,
17905             "field": "priority",
17906             "description": ""
17907           },
17908           {
17909             "group": "Body",
17910             "type": "String",
17911             "optional": false,
17912             "field": "app",
17913             "description": ""
17914           },
17915           {
17916             "group": "Body",
17917             "type": "Text",
17918             "optional": true,
17919             "field": "appdata",
17920             "description": ""
17921           },
17922           {
17923             "group": "Body",
17924             "type": "String",
17925             "optional": true,
17926             "field": "description",
17927             "description": ""
17928           },
17929           {
17930             "group": "Body",
17931             "type": "String",
17932             "optional": true,
17933             "field": "interval",
17934             "description": ""
17935           }
17936         ]
17937       }
17938     },
17939     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17940     "version": "0.0.0",
17941     "filename": "server/api/openchannelApplication/index.js",
17942     "groupTitle": "Openchannel_Applications"
17943   },
17944   {
17945     "type": "delete",
17946     "url": "/api/openchannel/applications/{id}",
17947     "title": "Deletes a Application",
17948     "examples": [
17949       {
17950         "title": "Example usage:",
17951         "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password} -X DELETE",
17952         "type": "json"
17953       }
17954     ],
17955     "name": "DeleteApplications",
17956     "group": "Openchannel_Applications",
17957     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "get",
17964     "url": "/api/openchannel/applications",
17965     "title": "Gets a list of Applications",
17966     "examples": [
17967       {
17968         "title": "Example usage:",
17969         "content": "curl https://{domain}/api/openchannel/applications -v -u {name}:{password}",
17970         "type": "json"
17971       }
17972     ],
17973     "name": "GetApplications",
17974     "group": "Openchannel_Applications",
17975     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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/{id}",
17983     "title": "Gets a single Application",
17984     "examples": [
17985       {
17986         "title": "Example usage:",
17987         "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password}",
17988         "type": "json"
17989       }
17990     ],
17991     "name": "ShowApplications",
17992     "group": "Openchannel_Applications",
17993     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17994     "version": "0.0.0",
17995     "filename": "server/api/openchannelApplication/index.js",
17996     "groupTitle": "Openchannel_Applications"
17997   },
17998   {
17999     "type": "put",
18000     "url": "/api/openchannel/applications/{id}",
18001     "title": "Update an existing Application",
18002     "examples": [
18003       {
18004         "title": "Example usage:",
18005         "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",
18006         "type": "json"
18007       }
18008     ],
18009     "name": "updateApplications",
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": "post",
18018     "url": "/api/openchannel/interactions/{id}/tags",
18019     "title": "Add tags to the interaction",
18020     "examples": [
18021       {
18022         "title": "Example usage:",
18023         "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",
18024         "type": "json"
18025       }
18026     ],
18027     "name": "AddTags",
18028     "group": "Openchannel_Interactions",
18029     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18030     "version": "0.0.0",
18031     "filename": "server/api/openchannelInteraction/index.js",
18032     "groupTitle": "Openchannel_Interactions"
18033   },
18034   {
18035     "type": "post",
18036     "url": "/api/openchannel/interactions",
18037     "title": "Creates a new Interaction",
18038     "examples": [
18039       {
18040         "title": "Example usage:",
18041         "content": "curl https://{domain}/api/openchannel/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18042         "type": "json"
18043       }
18044     ],
18045     "name": "CreateInteractions",
18046     "group": "Openchannel_Interactions",
18047     "parameter": {
18048       "fields": {
18049         "Body": [
18050           {
18051             "group": "Body",
18052             "type": "Boolean",
18053             "optional": true,
18054             "field": "closed",
18055             "description": ""
18056           },
18057           {
18058             "group": "Body",
18059             "type": "String",
18060             "optional": true,
18061             "field": "closedAt",
18062             "description": ""
18063           },
18064           {
18065             "group": "Body",
18066             "type": "String",
18067             "optional": true,
18068             "field": "disposition",
18069             "description": ""
18070           },
18071           {
18072             "group": "Body",
18073             "type": "String",
18074             "optional": true,
18075             "field": "secondDisposition",
18076             "description": ""
18077           },
18078           {
18079             "group": "Body",
18080             "type": "String",
18081             "optional": true,
18082             "field": "thirdDisposition",
18083             "description": ""
18084           },
18085           {
18086             "group": "Body",
18087             "type": "String",
18088             "optional": true,
18089             "field": "note",
18090             "description": ""
18091           },
18092           {
18093             "group": "Body",
18094             "type": "String",
18095             "optional": true,
18096             "field": "read1stAt",
18097             "description": ""
18098           },
18099           {
18100             "group": "Body",
18101             "type": "String",
18102             "optional": true,
18103             "field": "threadId",
18104             "description": ""
18105           },
18106           {
18107             "group": "Body",
18108             "type": "String",
18109             "optional": true,
18110             "field": "externalUrl",
18111             "description": ""
18112           },
18113           {
18114             "group": "Body",
18115             "type": "String",
18116             "optional": true,
18117             "field": "lastMsgAt",
18118             "description": ""
18119           },
18120           {
18121             "group": "Body",
18122             "type": "String",
18123             "allowedValues": [
18124               "\"in\"",
18125               "\"out\""
18126             ],
18127             "optional": false,
18128             "field": "lastMsgDirection",
18129             "description": ""
18130           },
18131           {
18132             "group": "Body",
18133             "type": "String",
18134             "optional": true,
18135             "field": "from",
18136             "description": ""
18137           }
18138         ]
18139       }
18140     },
18141     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18142     "version": "0.0.0",
18143     "filename": "server/api/openchannelInteraction/index.js",
18144     "groupTitle": "Openchannel_Interactions"
18145   },
18146   {
18147     "type": "delete",
18148     "url": "/api/openchannel/interactions/{id}",
18149     "title": "Deletes a Interaction",
18150     "examples": [
18151       {
18152         "title": "Example usage:",
18153         "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password} -X DELETE",
18154         "type": "json"
18155       }
18156     ],
18157     "name": "DeleteInteractions",
18158     "group": "Openchannel_Interactions",
18159     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "get",
18166     "url": "/api/openchannel/interactions/describe",
18167     "title": "Gets table info about Interactions",
18168     "examples": [
18169       {
18170         "title": "Example usage:",
18171         "content": "curl https://{domain}/api/openchannel/interactions/describe -v -u {name}:{password}",
18172         "type": "json"
18173       }
18174     ],
18175     "name": "DescribeInteractions",
18176     "group": "Openchannel_Interactions",
18177     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</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",
18185     "title": "Gets a list of Interactions",
18186     "examples": [
18187       {
18188         "title": "Example usage:",
18189         "content": "curl https://{domain}/api/openchannel/interactions -v -u {name}:{password}",
18190         "type": "json"
18191       }
18192     ],
18193     "name": "GetInteractions",
18194     "group": "Openchannel_Interactions",
18195     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18196     "version": "0.0.0",
18197     "filename": "server/api/openchannelInteraction/index.js",
18198     "groupTitle": "Openchannel_Interactions"
18199   },
18200   {
18201     "type": "delete",
18202     "url": "/api/openchannel/interactions/{id}/tags",
18203     "title": "Removes tags from interaction",
18204     "examples": [
18205       {
18206         "title": "Example usage:",
18207         "content": "curl https://{domain}/api/openchannel/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
18208         "type": "json"
18209       }
18210     ],
18211     "name": "RemoveTags",
18212     "group": "Openchannel_Interactions",
18213     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18214     "version": "0.0.0",
18215     "filename": "server/api/openchannelInteraction/index.js",
18216     "groupTitle": "Openchannel_Interactions"
18217   },
18218   {
18219     "type": "get",
18220     "url": "/api/openchannel/interactions/{id}",
18221     "title": "Gets a single Interaction",
18222     "examples": [
18223       {
18224         "title": "Example usage:",
18225         "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password}",
18226         "type": "json"
18227       }
18228     ],
18229     "name": "ShowInteractions",
18230     "group": "Openchannel_Interactions",
18231     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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": "post",
18238     "url": "/api/openchannel/interactions/{id}/messages",
18239     "title": "Creates new messages",
18240     "examples": [
18241       {
18242         "title": "Example usage:",
18243         "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
18244         "type": "json"
18245       }
18246     ],
18247     "name": "addMessage",
18248     "group": "Openchannel_Interactions",
18249     "parameter": {
18250       "fields": {
18251         "Body": [
18252           {
18253             "group": "Body",
18254             "type": "Text",
18255             "optional": false,
18256             "field": "body",
18257             "description": ""
18258           },
18259           {
18260             "group": "Body",
18261             "type": "Boolean",
18262             "optional": true,
18263             "field": "read",
18264             "description": ""
18265           },
18266           {
18267             "group": "Body",
18268             "type": "Boolean",
18269             "optional": true,
18270             "field": "secret",
18271             "description": ""
18272           },
18273           {
18274             "group": "Body",
18275             "type": "String",
18276             "allowedValues": [
18277               "\"in\"",
18278               "\"out\""
18279             ],
18280             "optional": false,
18281             "field": "direction",
18282             "description": ""
18283           },
18284           {
18285             "group": "Body",
18286             "type": "String",
18287             "optional": true,
18288             "field": "readAt",
18289             "description": ""
18290           },
18291           {
18292             "group": "Body",
18293             "type": "String",
18294             "optional": true,
18295             "field": "providerName",
18296             "description": ""
18297           },
18298           {
18299             "group": "Body",
18300             "type": "Text",
18301             "optional": true,
18302             "field": "providerResponse",
18303             "description": ""
18304           }
18305         ]
18306       }
18307     },
18308     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18309     "version": "0.0.0",
18310     "filename": "server/api/openchannelInteraction/index.js",
18311     "groupTitle": "Openchannel_Interactions"
18312   },
18313   {
18314     "type": "get",
18315     "url": "/api/openchannel/interactions/{id}/download",
18316     "title": "Gets interaction",
18317     "examples": [
18318       {
18319         "title": "Example usage:",
18320         "content": "curl https://{domain}/api/openchannel/interactions/{id}/download -v -u {name}:{password} -X GET",
18321         "type": "json"
18322       }
18323     ],
18324     "name": "download",
18325     "group": "Openchannel_Interactions",
18326     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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}/messages",
18334     "title": "Gets interaction messages",
18335     "examples": [
18336       {
18337         "title": "Example usage:",
18338         "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -v -u {name}:{password} -X GET",
18339         "type": "json"
18340       }
18341     ],
18342     "name": "getMessages",
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": "put",
18351     "url": "/api/openchannel/interactions/{id}",
18352     "title": "Update an existing Interaction",
18353     "examples": [
18354       {
18355         "title": "Example usage:",
18356         "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",
18357         "type": "json"
18358       }
18359     ],
18360     "name": "updateInteractions",
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": "post",
18369     "url": "/api/openchannel/messages",
18370     "title": "Creates a new Message",
18371     "examples": [
18372       {
18373         "title": "Example usage:",
18374         "content": "curl https://{domain}/api/openchannel/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18375         "type": "json"
18376       }
18377     ],
18378     "name": "CreateMessages",
18379     "group": "Openchannel_Messages",
18380     "parameter": {
18381       "fields": {
18382         "Body": [
18383           {
18384             "group": "Body",
18385             "type": "Text",
18386             "optional": false,
18387             "field": "body",
18388             "description": ""
18389           },
18390           {
18391             "group": "Body",
18392             "type": "Boolean",
18393             "optional": true,
18394             "field": "read",
18395             "description": ""
18396           },
18397           {
18398             "group": "Body",
18399             "type": "Boolean",
18400             "optional": true,
18401             "field": "secret",
18402             "description": ""
18403           },
18404           {
18405             "group": "Body",
18406             "type": "String",
18407             "allowedValues": [
18408               "\"in\"",
18409               "\"out\""
18410             ],
18411             "optional": false,
18412             "field": "direction",
18413             "description": ""
18414           },
18415           {
18416             "group": "Body",
18417             "type": "String",
18418             "optional": true,
18419             "field": "readAt",
18420             "description": ""
18421           },
18422           {
18423             "group": "Body",
18424             "type": "String",
18425             "optional": true,
18426             "field": "providerName",
18427             "description": ""
18428           },
18429           {
18430             "group": "Body",
18431             "type": "Text",
18432             "optional": true,
18433             "field": "providerResponse",
18434             "description": ""
18435           }
18436         ]
18437       }
18438     },
18439     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18440     "version": "0.0.0",
18441     "filename": "server/api/openchannelMessage/index.js",
18442     "groupTitle": "Openchannel_Messages"
18443   },
18444   {
18445     "type": "delete",
18446     "url": "/api/openchannel/messages/{id}",
18447     "title": "Deletes a Message",
18448     "examples": [
18449       {
18450         "title": "Example usage:",
18451         "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password} -X DELETE",
18452         "type": "json"
18453       }
18454     ],
18455     "name": "DeleteMessages",
18456     "group": "Openchannel_Messages",
18457     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "get",
18464     "url": "/api/openchannel/messages/describe",
18465     "title": "Gets table info about Messages",
18466     "examples": [
18467       {
18468         "title": "Example usage:",
18469         "content": "curl https://{domain}/api/openchannel/messages/describe -v -u {name}:{password}",
18470         "type": "json"
18471       }
18472     ],
18473     "name": "DescribeMessages",
18474     "group": "Openchannel_Messages",
18475     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</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",
18483     "title": "Gets a list of Messages",
18484     "examples": [
18485       {
18486         "title": "Example usage:",
18487         "content": "curl https://{domain}/api/openchannel/messages -v -u {name}:{password}",
18488         "type": "json"
18489       }
18490     ],
18491     "name": "GetMessages",
18492     "group": "Openchannel_Messages",
18493     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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/{id}",
18501     "title": "Gets a single Message",
18502     "examples": [
18503       {
18504         "title": "Example usage:",
18505         "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password}",
18506         "type": "json"
18507       }
18508     ],
18509     "name": "ShowMessages",
18510     "group": "Openchannel_Messages",
18511     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18512     "version": "0.0.0",
18513     "filename": "server/api/openchannelMessage/index.js",
18514     "groupTitle": "Openchannel_Messages"
18515   },
18516   {
18517     "type": "put",
18518     "url": "/api/openchannel/messages/{id}/accept",
18519     "title": "Accepts message",
18520     "examples": [
18521       {
18522         "title": "Example usage:",
18523         "content": "curl https://{domain}/api/openchannel/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
18524         "type": "json"
18525       }
18526     ],
18527     "name": "acceptMessage",
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}/reject",
18537     "title": "Rejects message",
18538     "examples": [
18539       {
18540         "title": "Example usage:",
18541         "content": "curl https://{domain}/api/openchannel/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
18542         "type": "json"
18543       }
18544     ],
18545     "name": "rejectMessage",
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}",
18555     "title": "Update an existing Message",
18556     "examples": [
18557       {
18558         "title": "Example usage:",
18559         "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",
18560         "type": "json"
18561       }
18562     ],
18563     "name": "updateMessages",
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": "post",
18572     "url": "/api/openchannel/reports/queue",
18573     "title": "Creates a new Openchannel Queue Report",
18574     "examples": [
18575       {
18576         "title": "Example usage:",
18577         "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",
18578         "type": "json"
18579       }
18580     ],
18581     "name": "CreateOpenchannel_Queue_Reports",
18582     "group": "Openchannel_Queue_Reports",
18583     "parameter": {
18584       "fields": {
18585         "Body": [
18586           {
18587             "group": "Body",
18588             "type": "String",
18589             "optional": false,
18590             "field": "uniqueid",
18591             "description": ""
18592           },
18593           {
18594             "group": "Body",
18595             "type": "String",
18596             "optional": true,
18597             "field": "from",
18598             "description": ""
18599           },
18600           {
18601             "group": "Body",
18602             "type": "String",
18603             "optional": true,
18604             "field": "joinAt",
18605             "description": ""
18606           },
18607           {
18608             "group": "Body",
18609             "type": "String",
18610             "optional": true,
18611             "field": "leaveAt",
18612             "description": ""
18613           },
18614           {
18615             "group": "Body",
18616             "type": "String",
18617             "optional": true,
18618             "field": "acceptAt",
18619             "description": ""
18620           },
18621           {
18622             "group": "Body",
18623             "type": "String",
18624             "optional": true,
18625             "field": "exitAt",
18626             "description": ""
18627           },
18628           {
18629             "group": "Body",
18630             "type": "String",
18631             "optional": true,
18632             "field": "reason",
18633             "description": ""
18634           }
18635         ]
18636       }
18637     },
18638     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18639     "version": "0.0.0",
18640     "filename": "server/api/openchannelQueueReport/index.js",
18641     "groupTitle": "Openchannel_Queue_Reports"
18642   },
18643   {
18644     "type": "delete",
18645     "url": "/api/openchannel/reports/queue/{id}",
18646     "title": "Deletes a Openchannel Queue Report",
18647     "examples": [
18648       {
18649         "title": "Example usage:",
18650         "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password} -X DELETE",
18651         "type": "json"
18652       }
18653     ],
18654     "name": "DeleteOpenchannel_Queue_Reports",
18655     "group": "Openchannel_Queue_Reports",
18656     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "get",
18663     "url": "/api/openchannel/reports/queue/describe",
18664     "title": "Gets table info about Openchannel Queue Reports",
18665     "examples": [
18666       {
18667         "title": "Example usage:",
18668         "content": "curl https://{domain}/api/openchannel/reports/queue/describe -v -u {name}:{password}",
18669         "type": "json"
18670       }
18671     ],
18672     "name": "DescribeOpenchannel_Queue_Reports",
18673     "group": "Openchannel_Queue_Reports",
18674     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</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",
18682     "title": "Gets a list of Openchannel Queue Reports",
18683     "examples": [
18684       {
18685         "title": "Example usage:",
18686         "content": "curl https://{domain}/api/openchannel/reports/queue -v -u {name}:{password}",
18687         "type": "json"
18688       }
18689     ],
18690     "name": "GetOpenchannel_Queue_Reports",
18691     "group": "Openchannel_Queue_Reports",
18692     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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/{id}",
18700     "title": "Gets a single Openchannel Queue Report",
18701     "examples": [
18702       {
18703         "title": "Example usage:",
18704         "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password}",
18705         "type": "json"
18706       }
18707     ],
18708     "name": "ShowOpenchannel_Queue_Reports",
18709     "group": "Openchannel_Queue_Reports",
18710     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18711     "version": "0.0.0",
18712     "filename": "server/api/openchannelQueueReport/index.js",
18713     "groupTitle": "Openchannel_Queue_Reports"
18714   },
18715   {
18716     "type": "put",
18717     "url": "/api/openchannel/reports/queue/{id}",
18718     "title": "Update an existing Openchannel Queue Report",
18719     "examples": [
18720       {
18721         "title": "Example usage:",
18722         "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",
18723         "type": "json"
18724       }
18725     ],
18726     "name": "updateOpenchannel_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": "post",
18735     "url": "/api/openchannel/queues/{id}/users",
18736     "title": "Add agents to a queue",
18737     "examples": [
18738       {
18739         "title": "Example usage:",
18740         "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",
18741         "type": "json"
18742       }
18743     ],
18744     "name": "AddAgents",
18745     "group": "Openchannel_Queues",
18746     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18747     "version": "0.0.0",
18748     "filename": "server/api/openchannelQueue/index.js",
18749     "groupTitle": "Openchannel_Queues"
18750   },
18751   {
18752     "type": "post",
18753     "url": "/api/openchannel/queues/{id}/teams",
18754     "title": "Add teams to a queue",
18755     "examples": [
18756       {
18757         "title": "Example usage:",
18758         "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",
18759         "type": "json"
18760       }
18761     ],
18762     "name": "AddTeams",
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",
18772     "title": "Creates a new Queue",
18773     "examples": [
18774       {
18775         "title": "Example usage:",
18776         "content": "curl https://{domain}/api/openchannel/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18777         "type": "json"
18778       }
18779     ],
18780     "name": "CreateQueues",
18781     "group": "Openchannel_Queues",
18782     "parameter": {
18783       "fields": {
18784         "Body": [
18785           {
18786             "group": "Body",
18787             "type": "String",
18788             "optional": true,
18789             "field": "name",
18790             "description": ""
18791           },
18792           {
18793             "group": "Body",
18794             "type": "String",
18795             "optional": true,
18796             "field": "description",
18797             "description": ""
18798           },
18799           {
18800             "group": "Body",
18801             "type": "Integer",
18802             "optional": true,
18803             "field": "timeout",
18804             "description": ""
18805           },
18806           {
18807             "group": "Body",
18808             "type": "String",
18809             "allowedValues": [
18810               "\"rrmemory\"",
18811               "\"beepall\"",
18812               "\"roundrobin\""
18813             ],
18814             "optional": true,
18815             "field": "strategy",
18816             "description": ""
18817           }
18818         ]
18819       }
18820     },
18821     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18822     "version": "0.0.0",
18823     "filename": "server/api/openchannelQueue/index.js",
18824     "groupTitle": "Openchannel_Queues"
18825   },
18826   {
18827     "type": "delete",
18828     "url": "/api/openchannel/queues/{id}",
18829     "title": "Deletes a Queue",
18830     "examples": [
18831       {
18832         "title": "Example usage:",
18833         "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password} -X DELETE",
18834         "type": "json"
18835       }
18836     ],
18837     "name": "DeleteQueues",
18838     "group": "Openchannel_Queues",
18839     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "get",
18846     "url": "/api/openchannel/queues/describe",
18847     "title": "Gets table info about Queues",
18848     "examples": [
18849       {
18850         "title": "Example usage:",
18851         "content": "curl https://{domain}/api/openchannel/queues/describe -v -u {name}:{password}",
18852         "type": "json"
18853       }
18854     ],
18855     "name": "DescribeQueues",
18856     "group": "Openchannel_Queues",
18857     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</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/{id}/users",
18865     "title": "Gets queue agents",
18866     "examples": [
18867       {
18868         "title": "Example usage:",
18869         "content": "curl https://{domain}/api/openchannel/queues/{id}/users -v -u {name}:{password} -X POST",
18870         "type": "json"
18871       }
18872     ],
18873     "name": "GetAgents",
18874     "group": "Openchannel_Queues",
18875     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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}/members",
18883     "title": "GetMembers",
18884     "examples": [
18885       {
18886         "title": "Example usage:",
18887         "content": "curl https://{domain}/api/openchannel/queues/{id}/members  -v -u {name}:{password}",
18888         "type": "json"
18889       }
18890     ],
18891     "name": "GetMembers",
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",
18901     "title": "Gets a list of Queues",
18902     "examples": [
18903       {
18904         "title": "Example usage:",
18905         "content": "curl https://{domain}/api/openchannel/queues -v -u {name}:{password}",
18906         "type": "json"
18907       }
18908     ],
18909     "name": "GetQueues",
18910     "group": "Openchannel_Queues",
18911     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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/{id}/teams",
18919     "title": "Gets queues list",
18920     "examples": [
18921       {
18922         "title": "Example usage:",
18923         "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password}",
18924         "type": "json"
18925       }
18926     ],
18927     "name": "GetTeams",
18928     "group": "Openchannel_Queues",
18929     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18930     "version": "0.0.0",
18931     "filename": "server/api/openchannelQueue/index.js",
18932     "groupTitle": "Openchannel_Queues"
18933   },
18934   {
18935     "type": "delete",
18936     "url": "/api/openchannel/queues/{id}/users",
18937     "title": "Removes agents from a queue",
18938     "examples": [
18939       {
18940         "title": "Example usage:",
18941         "content": "curl https://{domain}/api/openchannel/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
18942         "type": "json"
18943       }
18944     ],
18945     "name": "RemoveAgents",
18946     "group": "Openchannel_Queues",
18947     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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": "get",
18954     "url": "/api/openchannel/queues/{id}",
18955     "title": "Gets a single Queue",
18956     "examples": [
18957       {
18958         "title": "Example usage:",
18959         "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password}",
18960         "type": "json"
18961       }
18962     ],
18963     "name": "ShowQueues",
18964     "group": "Openchannel_Queues",
18965     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18966     "version": "0.0.0",
18967     "filename": "server/api/openchannelQueue/index.js",
18968     "groupTitle": "Openchannel_Queues"
18969   },
18970   {
18971     "type": "put",
18972     "url": "/api/openchannel/queues/{id}",
18973     "title": "Update an existing Queue",
18974     "examples": [
18975       {
18976         "title": "Example usage:",
18977         "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",
18978         "type": "json"
18979       }
18980     ],
18981     "name": "updateQueues",
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": "post",
18990     "url": "/api/openchannel/reports/transfer",
18991     "title": "Creates a new Openchannel Transfer Report",
18992     "examples": [
18993       {
18994         "title": "Example usage:",
18995         "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",
18996         "type": "json"
18997       }
18998     ],
18999     "name": "CreateOpenchannel_Transfer_Reports",
19000     "group": "Openchannel_Transfer_Reports",
19001     "parameter": {
19002       "fields": {
19003         "Body": [
19004           {
19005             "group": "Body",
19006             "type": "String",
19007             "optional": false,
19008             "field": "uniqueid",
19009             "description": ""
19010           },
19011           {
19012             "group": "Body",
19013             "type": "String",
19014             "allowedValues": [
19015               "\"account\"",
19016               "\"agent\"",
19017               "\"queue\""
19018             ],
19019             "optional": false,
19020             "field": "type",
19021             "description": ""
19022           },
19023           {
19024             "group": "Body",
19025             "type": "String",
19026             "optional": false,
19027             "field": "transferredAt",
19028             "description": ""
19029           }
19030         ]
19031       }
19032     },
19033     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19034     "version": "0.0.0",
19035     "filename": "server/api/openchannelTransferReport/index.js",
19036     "groupTitle": "Openchannel_Transfer_Reports"
19037   },
19038   {
19039     "type": "delete",
19040     "url": "/api/openchannel/reports/transfer/{id}",
19041     "title": "Deletes a Openchannel Transfer Report",
19042     "examples": [
19043       {
19044         "title": "Example usage:",
19045         "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
19046         "type": "json"
19047       }
19048     ],
19049     "name": "DeleteOpenchannel_Transfer_Reports",
19050     "group": "Openchannel_Transfer_Reports",
19051     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "get",
19058     "url": "/api/openchannel/reports/transfer/describe",
19059     "title": "Gets table info about Openchannel Transfer Reports",
19060     "examples": [
19061       {
19062         "title": "Example usage:",
19063         "content": "curl https://{domain}/api/openchannel/reports/transfer/describe -v -u {name}:{password}",
19064         "type": "json"
19065       }
19066     ],
19067     "name": "DescribeOpenchannel_Transfer_Reports",
19068     "group": "Openchannel_Transfer_Reports",
19069     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</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",
19077     "title": "Gets a list of Openchannel Transfer Reports",
19078     "examples": [
19079       {
19080         "title": "Example usage:",
19081         "content": "curl https://{domain}/api/openchannel/reports/transfer -v -u {name}:{password}",
19082         "type": "json"
19083       }
19084     ],
19085     "name": "GetOpenchannel_Transfer_Reports",
19086     "group": "Openchannel_Transfer_Reports",
19087     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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/{id}",
19095     "title": "Gets a single Openchannel Transfer Report",
19096     "examples": [
19097       {
19098         "title": "Example usage:",
19099         "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password}",
19100         "type": "json"
19101       }
19102     ],
19103     "name": "ShowOpenchannel_Transfer_Reports",
19104     "group": "Openchannel_Transfer_Reports",
19105     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19106     "version": "0.0.0",
19107     "filename": "server/api/openchannelTransferReport/index.js",
19108     "groupTitle": "Openchannel_Transfer_Reports"
19109   },
19110   {
19111     "type": "put",
19112     "url": "/api/openchannel/reports/transfer/{id}",
19113     "title": "Update an existing Openchannel Transfer Report",
19114     "examples": [
19115       {
19116         "title": "Example usage:",
19117         "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",
19118         "type": "json"
19119       }
19120     ],
19121     "name": "updateOpenchannel_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": "post",
19130     "url": "/api/pauses",
19131     "title": "Creates a new Pause",
19132     "examples": [
19133       {
19134         "title": "Example usage:",
19135         "content": "curl https://{domain}/api/pauses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
19136         "type": "json"
19137       }
19138     ],
19139     "name": "CreatePauses",
19140     "group": "Pauses",
19141     "parameter": {
19142       "fields": {
19143         "Body": [
19144           {
19145             "group": "Body",
19146             "type": "String",
19147             "optional": false,
19148             "field": "name",
19149             "description": ""
19150           },
19151           {
19152             "group": "Body",
19153             "type": "String",
19154             "optional": true,
19155             "field": "description",
19156             "description": ""
19157           }
19158         ]
19159       }
19160     },
19161     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19162     "version": "0.0.0",
19163     "filename": "server/api/pause/index.js",
19164     "groupTitle": "Pauses"
19165   },
19166   {
19167     "type": "delete",
19168     "url": "/api/pauses/{id}",
19169     "title": "Deletes a Pause",
19170     "examples": [
19171       {
19172         "title": "Example usage:",
19173         "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password} -X DELETE",
19174         "type": "json"
19175       }
19176     ],
19177     "name": "DeletePauses",
19178     "group": "Pauses",
19179     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "get",
19186     "url": "/api/pauses",
19187     "title": "Gets a list of Pauses",
19188     "examples": [
19189       {
19190         "title": "Example usage:",
19191         "content": "curl https://{domain}/api/pauses -v -u {name}:{password}",
19192         "type": "json"
19193       }
19194     ],
19195     "name": "GetPauses",
19196     "group": "Pauses",
19197     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19198     "version": "0.0.0",
19199     "filename": "server/api/pause/index.js",
19200     "groupTitle": "Pauses"
19201   },
19202   {
19203     "type": "get",
19204     "url": "/api/pauses/{id}",
19205     "title": "Gets a single Pause",
19206     "examples": [
19207       {
19208         "title": "Example usage:",
19209         "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password}",
19210         "type": "json"
19211       }
19212     ],
19213     "name": "ShowPauses",
19214     "group": "Pauses",
19215     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19216     "version": "0.0.0",
19217     "filename": "server/api/pause/index.js",
19218     "groupTitle": "Pauses"
19219   },
19220   {
19221     "type": "put",
19222     "url": "/api/pauses/{id}",
19223     "title": "Update an existing Pause",
19224     "examples": [
19225       {
19226         "title": "Example usage:",
19227         "content": "curl https://{domain}/api/pauses/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
19228         "type": "json"
19229       }
19230     ],
19231     "name": "updatePauses",
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": "get",
19240     "url": "/api/plugins",
19241     "title": "Gets a list of Plugins",
19242     "examples": [
19243       {
19244         "title": "Example usage:",
19245         "content": "curl https://{domain}/api/plugins -v -u {name}:{password}",
19246         "type": "json"
19247       }
19248     ],
19249     "name": "GetPlugins",
19250     "group": "Plugins",
19251     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19252     "version": "0.0.0",
19253     "filename": "server/api/plugin/index.js",
19254     "groupTitle": "Plugins"
19255   },
19256   {
19257     "type": "get",
19258     "url": "/api/plugins/{id}",
19259     "title": "Gets a single Plugin",
19260     "examples": [
19261       {
19262         "title": "Example usage:",
19263         "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password}",
19264         "type": "json"
19265       }
19266     ],
19267     "name": "ShowPlugins",
19268     "group": "Plugins",
19269     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19270     "version": "0.0.0",
19271     "filename": "server/api/plugin/index.js",
19272     "groupTitle": "Plugins"
19273   },
19274   {
19275     "type": "delete",
19276     "url": "/api/plugins/{id}",
19277     "title": "Delete a plugin",
19278     "examples": [
19279       {
19280         "title": "Example usage:",
19281         "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X DELETE",
19282         "type": "json"
19283       }
19284     ],
19285     "name": "destroyPlugin",
19286     "group": "Plugins",
19287     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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": "get",
19294     "url": "/api/plugins/{id}/download",
19295     "title": "Download plugin source code",
19296     "examples": [
19297       {
19298         "title": "Example usage:",
19299         "content": "curl https://{domain}/api/plugins/{id}/download -v -u {name}:{password} -X GET",
19300         "type": "json"
19301       }
19302     ],
19303     "name": "download",
19304     "group": "Plugins",
19305     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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": "put",
19312     "url": "/api/plugins/{id}",
19313     "title": "Update an existing plugin",
19314     "examples": [
19315       {
19316         "title": "Example usage:",
19317         "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X PUT",
19318         "type": "json"
19319       }
19320     ],
19321     "name": "updatePlugin",
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": "post",
19330     "url": "/api/plugins",
19331     "title": "Upload new plugin",
19332     "examples": [
19333       {
19334         "title": "Example usage:",
19335         "content": "curl https://{domain}/api/plugins -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
19336         "type": "json"
19337       }
19338     ],
19339     "name": "uploadPlugin",
19340     "group": "Plugins",
19341     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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": "get",
19348     "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
19349     "title": "Redirect a plugin request to the specified path",
19350     "examples": [
19351       {
19352         "title": "Example usage:",
19353         "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -v -u {name}:{password} -X GET",
19354         "type": "json"
19355       }
19356     ],
19357     "name": "webhookPlugin",
19358     "group": "Plugins",
19359     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "post",
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} -H 'Content-Type: application/json' -X POST",
19372         "type": "json"
19373       }
19374     ],
19375     "name": "webhookPlugin",
19376     "group": "Plugins",
19377     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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": "delete",
19384     "url": "/api/pm2/{id}",
19385     "title": "Deletes an existing process",
19386     "examples": [
19387       {
19388         "title": "Example usage:",
19389         "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password} -X DELETE",
19390         "type": "json"
19391       }
19392     ],
19393     "name": "DeletePm2Process",
19394     "group": "Pm2",
19395     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19396     "version": "0.0.0",
19397     "filename": "server/api/pm2/index.js",
19398     "groupTitle": "Pm2"
19399   },
19400   {
19401     "type": "get",
19402     "url": "/api/pm2/{id}",
19403     "title": "Gets a single pm2 process",
19404     "examples": [
19405       {
19406         "title": "Example usage:",
19407         "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password}",
19408         "type": "json"
19409       }
19410     ],
19411     "name": "GetPm2Process",
19412     "group": "Pm2",
19413     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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",
19421     "title": "Gets pm2 processes",
19422     "examples": [
19423       {
19424         "title": "Example usage:",
19425         "content": "curl https://{domain}/api/pm2 -v -u {name}:{password}",
19426         "type": "json"
19427       }
19428     ],
19429     "name": "GetPm2Processes",
19430     "group": "Pm2",
19431     "description": "<p>Motion returns the pm2 processes list.</p>",
19432     "version": "0.0.0",
19433     "filename": "server/api/pm2/index.js",
19434     "groupTitle": "Pm2"
19435   },
19436   {
19437     "type": "post",
19438     "url": "/api/pm2",
19439     "title": "Start a single pm2 process",
19440     "examples": [
19441       {
19442         "title": "Example usage:",
19443         "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",
19444         "type": "json"
19445       }
19446     ],
19447     "name": "StartPm2Process",
19448     "group": "Pm2",
19449     "parameter": {
19450       "fields": {
19451         "Body": [
19452           {
19453             "group": "Body",
19454             "type": "String",
19455             "optional": false,
19456             "field": "name",
19457             "description": ""
19458           },
19459           {
19460             "group": "Body",
19461             "type": "String",
19462             "optional": false,
19463             "field": "script",
19464             "description": ""
19465           }
19466         ]
19467       }
19468     },
19469     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19470     "version": "0.0.0",
19471     "filename": "server/api/pm2/index.js",
19472     "groupTitle": "Pm2"
19473   },
19474   {
19475     "type": "put",
19476     "url": "/api/pm2/{id}",
19477     "title": "Update an existing process",
19478     "examples": [
19479       {
19480         "title": "Example usage:",
19481         "content": "curl https://{domain}/api/pm2/{id} -d '{\"status\": \"online\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
19482         "type": "json"
19483       }
19484     ],
19485     "name": "UpdatePm2Process",
19486     "group": "Pm2",
19487     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "get",
19494     "url": "/api/rpc/campaigns/",
19495     "title": "Gets a list of campaigns",
19496     "examples": [
19497       {
19498         "title": "Example usage:",
19499         "content": "curl https://{domain}/api/rpc/campaigns -v -u {name}:{password}",
19500         "type": "json"
19501       }
19502     ],
19503     "name": "Campaigns",
19504     "group": "RPC_Realtime",
19505     "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>",
19506     "version": "0.0.0",
19507     "filename": "server/api/rpc/index.js",
19508     "groupTitle": "RPC_Realtime"
19509   },
19510   {
19511     "type": "get",
19512     "url": "/api/rpc/fax/accounts",
19513     "title": "Gets a list of FaxAccounts",
19514     "examples": [
19515       {
19516         "title": "Example usage:",
19517         "content": "curl https://{domain}/api/rpc/fax/accounts -v -u {name}:{password}",
19518         "type": "json"
19519       }
19520     ],
19521     "name": "FaxAccounts",
19522     "group": "RPC_Realtime",
19523     "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>",
19524     "version": "0.0.0",
19525     "filename": "server/api/rpc/index.js",
19526     "groupTitle": "RPC_Realtime"
19527   },
19528   {
19529     "type": "put",
19530     "url": "/api/rpc/agents/:id/capacity",
19531     "title": "Sets agent capacity",
19532     "examples": [
19533       {
19534         "title": "Example usage:",
19535         "content": "curl https://{domain}/api/rpc/agents/:id/capacity -v -u {name}:{password}",
19536         "type": "json"
19537       }
19538     ],
19539     "name": "RTAgentCapacity",
19540     "group": "RPC_Realtime",
19541     "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>",
19542     "version": "0.0.0",
19543     "filename": "server/api/rpc/index.js",
19544     "groupTitle": "RPC_Realtime"
19545   },
19546   {
19547     "type": "get",
19548     "url": "/api/rpc/agents",
19549     "title": "Gets a list of RTAgents",
19550     "examples": [
19551       {
19552         "title": "Example usage:",
19553         "content": "curl https://{domain}/api/rpc/agents -v -u {name}:{password}",
19554         "type": "json"
19555       }
19556     ],
19557     "name": "RTAgents",
19558     "group": "RPC_Realtime",
19559     "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>",
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/chat/queues",
19567     "title": "Gets a list of RTChatQueues",
19568     "examples": [
19569       {
19570         "title": "Example usage:",
19571         "content": "curl https://{domain}/api/rpc/chat/queues -v -u {name}:{password}",
19572         "type": "json"
19573       }
19574     ],
19575     "name": "RTChatQueues",
19576     "group": "RPC_Realtime",
19577     "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>",
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/fax/queues",
19585     "title": "Gets a list of RTFaxQueues",
19586     "examples": [
19587       {
19588         "title": "Example usage:",
19589         "content": "curl https://{domain}/api/rpc/fax/queues -v -u {name}:{password}",
19590         "type": "json"
19591       }
19592     ],
19593     "name": "RTFaxQueues",
19594     "group": "RPC_Realtime",
19595     "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>",
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/mail/accounts",
19603     "title": "Gets a list of RTMailAccounts",
19604     "examples": [
19605       {
19606         "title": "Example usage:",
19607         "content": "curl https://{domain}/api/rpc/mail/accounts -v -u {name}:{password}",
19608         "type": "json"
19609       }
19610     ],
19611     "name": "RTMailAccounts",
19612     "group": "RPC_Realtime",
19613     "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>",
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/queues",
19621     "title": "Gets a list of RTMailQueues",
19622     "examples": [
19623       {
19624         "title": "Example usage:",
19625         "content": "curl https://{domain}/api/rpc/mail/queues -v -u {name}:{password}",
19626         "type": "json"
19627       }
19628     ],
19629     "name": "RTMailQueues",
19630     "group": "RPC_Realtime",
19631     "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>",
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/openchannel/queues",
19639     "title": "Gets a list of RTOpenchannelQueues",
19640     "examples": [
19641       {
19642         "title": "Example usage:",
19643         "content": "curl https://{domain}/api/rpc/openchannel/queues -v -u {name}:{password}",
19644         "type": "json"
19645       }
19646     ],
19647     "name": "RTOpenchannelQueues",
19648     "group": "RPC_Realtime",
19649     "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>",
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/outbound/channels",
19657     "title": "Gets a list of RTOutboundChannels",
19658     "examples": [
19659       {
19660         "title": "Example usage:",
19661         "content": "curl https://{domain}/api/rpc/outbound/channels -v -u {name}:{password}",
19662         "type": "json"
19663       }
19664     ],
19665     "name": "RTOutboundChannels",
19666     "group": "RPC_Realtime",
19667     "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>",
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/sms/queues",
19675     "title": "Gets a list of RTSmsQueues",
19676     "examples": [
19677       {
19678         "title": "Example usage:",
19679         "content": "curl https://{domain}/api/rpc/sms/queues -v -u {name}:{password}",
19680         "type": "json"
19681       }
19682     ],
19683     "name": "RTSmsQueues",
19684     "group": "RPC_Realtime",
19685     "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>",
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/telephones",
19693     "title": "Gets a list of RTTelephones",
19694     "examples": [
19695       {
19696         "title": "Example usage:",
19697         "content": "curl https://{domain}/api/rpc/telephones -v -u {name}:{password}",
19698         "type": "json"
19699       }
19700     ],
19701     "name": "RTTelephones",
19702     "group": "RPC_Realtime",
19703     "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>",
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/trunks",
19711     "title": "Gets a list of RTTrunks",
19712     "examples": [
19713       {
19714         "title": "Example usage:",
19715         "content": "curl https://{domain}/api/rpc/trunks -v -u {name}:{password}",
19716         "type": "json"
19717       }
19718     ],
19719     "name": "RTTrunks",
19720     "group": "RPC_Realtime",
19721     "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>",
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/voice/channels",
19729     "title": "Gets a list of RTVoiceChannelMixMonitor",
19730     "examples": [
19731       {
19732         "title": "Example usage:",
19733         "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/mixmonitor -v -u {name}:{password}",
19734         "type": "json"
19735       }
19736     ],
19737     "name": "RTVoiceChannelMixMonitor",
19738     "group": "RPC_Realtime",
19739     "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>",
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 RTVoiceChannelStopMixMonitor",
19748     "examples": [
19749       {
19750         "title": "Example usage:",
19751         "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/stopmixmonitor -v -u {name}:{password}",
19752         "type": "json"
19753       }
19754     ],
19755     "name": "RTVoiceChannelStopMixMonitor",
19756     "group": "RPC_Realtime",
19757     "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>",
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 RTVoiceChannels",
19766     "examples": [
19767       {
19768         "title": "Example usage:",
19769         "content": "curl https://{domain}/api/rpc/voice/channels -v -u {name}:{password}",
19770         "type": "json"
19771       }
19772     ],
19773     "name": "RTVoiceChannels",
19774     "group": "RPC_Realtime",
19775     "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>",
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/queues/channels/{uniqueid}",
19783     "title": "Gets a single RTVoiceQueueChannel",
19784     "examples": [
19785       {
19786         "title": "Example usage:",
19787         "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid} -v -u {name}:{password}",
19788         "type": "json"
19789       }
19790     ],
19791     "name": "RTVoiceQueueChannel",
19792     "group": "RPC_Realtime",
19793     "description": "<p>Motion will return a specific realtime voice queue channel.</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}/hangup",
19801     "title": "Hangup a single RTVoiceQueueChannel",
19802     "examples": [
19803       {
19804         "title": "Example usage:",
19805         "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/hangup -v -u {name}:{password}",
19806         "type": "json"
19807       }
19808     ],
19809     "name": "RTVoiceQueueChannelHangup",
19810     "group": "RPC_Realtime",
19811     "description": "<p>Motion will hangup 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}/redirect/{exten}",
19819     "title": "Hangup a single RTVoiceQueueChannel",
19820     "examples": [
19821       {
19822         "title": "Example usage:",
19823         "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten} -v -u {name}:{password}",
19824         "type": "json"
19825       }
19826     ],
19827     "name": "RTVoiceQueueChannelRedirect",
19828     "group": "RPC_Realtime",
19829     "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>",
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/preview/{id}",
19837     "title": "Gets a single preview contact",
19838     "examples": [
19839       {
19840         "title": "Example usage:",
19841         "content": "curl https://{domain}/api/rpc/voice/queues/preview/{id} -v -u {name}:{password}",
19842         "type": "json"
19843       }
19844     ],
19845     "name": "RTVoiceQueuePreview",
19846     "group": "RPC_Realtime",
19847     "description": "<p>Motion will return a specific preview contact.</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/outbound",
19855     "title": "Gets a list of RTOutbound",
19856     "examples": [
19857       {
19858         "title": "Example usage:",
19859         "content": "curl https://{domain}/api/rpc/outbound -v -u {name}:{password}",
19860         "type": "json"
19861       }
19862     ],
19863     "name": "RTVoiceQueues",
19864     "group": "RPC_Realtime",
19865     "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>",
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/voice/queues/channels",
19891     "title": "Gets a list of RTVoiceQueuesChannels",
19892     "examples": [
19893       {
19894         "title": "Example usage:",
19895         "content": "curl https://{domain}/api/rpc/voice/queues/channels -v -u {name}:{password}",
19896         "type": "json"
19897       }
19898     ],
19899     "name": "RTVoiceQueuesChannels",
19900     "group": "RPC_Realtime",
19901     "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>",
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/chat/queues/{id}",
19909     "title": "Gets a single RTChatQueue",
19910     "examples": [
19911       {
19912         "title": "Example usage:",
19913         "content": "curl https://{domain}/api/rpc/chat/queues/{id} -v -u {name}:{password}",
19914         "type": "json"
19915       }
19916     ],
19917     "name": "ShowRTChatQueues",
19918     "group": "RPC_Realtime",
19919     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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/fax/queues/{id}",
19927     "title": "Gets a single RTFaxQueue",
19928     "examples": [
19929       {
19930         "title": "Example usage:",
19931         "content": "curl https://{domain}/api/rpc/fax/queues/{id} -v -u {name}:{password}",
19932         "type": "json"
19933       }
19934     ],
19935     "name": "ShowRTFaxQueues",
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/mail/queues/{id}",
19945     "title": "Gets a single RTMailQueue",
19946     "examples": [
19947       {
19948         "title": "Example usage:",
19949         "content": "curl https://{domain}/api/rpc/mail/queues/{id} -v -u {name}:{password}",
19950         "type": "json"
19951       }
19952     ],
19953     "name": "ShowRTMailQueues",
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/openchannel/queues/{id}",
19963     "title": "Gets a single RTOpenchannelQueue",
19964     "examples": [
19965       {
19966         "title": "Example usage:",
19967         "content": "curl https://{domain}/api/rpc/openchannel/queues/{id} -v -u {name}:{password}",
19968         "type": "json"
19969       }
19970     ],
19971     "name": "ShowRTOpenchannelQueues",
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/sms/queues/{id}",
19981     "title": "Gets a single RTSmsQueue",
19982     "examples": [
19983       {
19984         "title": "Example usage:",
19985         "content": "curl https://{domain}/api/rpc/sms/queues/{id} -v -u {name}:{password}",
19986         "type": "json"
19987       }
19988     ],
19989     "name": "ShowRTSmsQueues",
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/voice/queues/{id}",
19999     "title": "Gets a single RTVoiceQueue",
20000     "examples": [
20001       {
20002         "title": "Example usage:",
20003         "content": "curl https://{domain}/api/rpc/voice/queues/{id} -v -u {name}:{password}",
20004         "type": "json"
20005       }
20006     ],
20007     "name": "ShowRTVoiceQueues",
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": "post",
20016     "url": "/api/rpc/agents/:id/notify",
20017     "title": "Notify message to a specific agent",
20018     "examples": [
20019       {
20020         "title": "Example usage:",
20021         "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",
20022         "type": "json"
20023       }
20024     ],
20025     "name": "agentNotify",
20026     "group": "RPC_Realtime",
20027     "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>",
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/chat/queues/:id/notify",
20035     "title": "Notify message to a specific queue",
20036     "examples": [
20037       {
20038         "title": "Example usage:",
20039         "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",
20040         "type": "json"
20041       }
20042     ],
20043     "name": "chatQueueNotify",
20044     "group": "RPC_Realtime",
20045     "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>",
20046     "version": "0.0.0",
20047     "filename": "server/api/rpc/index.js",
20048     "groupTitle": "RPC_Realtime"
20049   },
20050   {
20051     "type": "get",
20052     "url": "/api/rpc/chat/queues/waitinginteractions",
20053     "title": "Gets a list of chatQueuesWaitingInteractions",
20054     "examples": [
20055       {
20056         "title": "Example usage:",
20057         "content": "curl https://{domain}/api/rpc/chat/queues/waitinginteractions -v -u {name}:{password}",
20058         "type": "json"
20059       }
20060     ],
20061     "name": "chatQueuesWaitingInteractions",
20062     "group": "RPC_Realtime",
20063     "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>",
20064     "version": "0.0.0",
20065     "filename": "server/api/rpc/index.js",
20066     "groupTitle": "RPC_Realtime"
20067   },
20068   {
20069     "type": "post",
20070     "url": "/api/rpc/fax/queues/:id/notify",
20071     "title": "Notify message to a specific queue",
20072     "examples": [
20073       {
20074         "title": "Example usage:",
20075         "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",
20076         "type": "json"
20077       }
20078     ],
20079     "name": "faxQueueNotify",
20080     "group": "RPC_Realtime",
20081     "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>",
20082     "version": "0.0.0",
20083     "filename": "server/api/rpc/index.js",
20084     "groupTitle": "RPC_Realtime"
20085   },
20086   {
20087     "type": "get",
20088     "url": "/api/rpc/fax/queues/waitinginteractions",
20089     "title": "Gets a list of faxQueuesWaitingInteractions",
20090     "examples": [
20091       {
20092         "title": "Example usage:",
20093         "content": "curl https://{domain}/api/rpc/fax/queues/waitinginteractions -v -u {name}:{password}",
20094         "type": "json"
20095       }
20096     ],
20097     "name": "faxQueuesWaitingInteractions",
20098     "group": "RPC_Realtime",
20099     "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>",
20100     "version": "0.0.0",
20101     "filename": "server/api/rpc/index.js",
20102     "groupTitle": "RPC_Realtime"
20103   },
20104   {
20105     "type": "post",
20106     "url": "/api/rpc/mail/queues/:id/notify",
20107     "title": "Notify message to a specific queue",
20108     "examples": [
20109       {
20110         "title": "Example usage:",
20111         "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",
20112         "type": "json"
20113       }
20114     ],
20115     "name": "mailQueueNotify",
20116     "group": "RPC_Realtime",
20117     "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>",
20118     "version": "0.0.0",
20119     "filename": "server/api/rpc/index.js",
20120     "groupTitle": "RPC_Realtime"
20121   },
20122   {
20123     "type": "get",
20124     "url": "/api/rpc/mail/queues/waitinginteractions",
20125     "title": "Gets a list of mailQueuesWaitingInteractions",
20126     "examples": [
20127       {
20128         "title": "Example usage:",
20129         "content": "curl https://{domain}/api/rpc/mail/queues/waitinginteractions -v -u {name}:{password}",
20130         "type": "json"
20131       }
20132     ],
20133     "name": "mailQueuesWaitingInteractions",
20134     "group": "RPC_Realtime",
20135     "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>",
20136     "version": "0.0.0",
20137     "filename": "server/api/rpc/index.js",
20138     "groupTitle": "RPC_Realtime"
20139   },
20140   {
20141     "type": "post",
20142     "url": "/api/rpc/openchannel/queues/:id/notify",
20143     "title": "Notify message to a specific queue",
20144     "examples": [
20145       {
20146         "title": "Example usage:",
20147         "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",
20148         "type": "json"
20149       }
20150     ],
20151     "name": "openchannelQueueNotify",
20152     "group": "RPC_Realtime",
20153     "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>",
20154     "version": "0.0.0",
20155     "filename": "server/api/rpc/index.js",
20156     "groupTitle": "RPC_Realtime"
20157   },
20158   {
20159     "type": "get",
20160     "url": "/api/rpc/openchannel/queues/:id/waitinginteractions",
20161     "title": "Gets a list of openchannelQueuesIdWaitingInteractions",
20162     "examples": [
20163       {
20164         "title": "Example usage:",
20165         "content": "curl https://{domain}/api/rpc/openchannel/queues/:id/waitinginteractions -v -u {name}:{password}",
20166         "type": "json"
20167       }
20168     ],
20169     "name": "openchannelQueuesIdWaitingInteractions",
20170     "group": "RPC_Realtime",
20171     "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>",
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/waitinginteractions",
20179     "title": "Gets a list of openchannelQueuesWaitingInteractions",
20180     "examples": [
20181       {
20182         "title": "Example usage:",
20183         "content": "curl https://{domain}/api/rpc/openchannel/queues/waitinginteractions -v -u {name}:{password}",
20184         "type": "json"
20185       }
20186     ],
20187     "name": "openchannelQueuesWaitingInteractions",
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": "post",
20196     "url": "/api/rpc/sms/queues/:id/notify",
20197     "title": "Notify message to a specific queue",
20198     "examples": [
20199       {
20200         "title": "Example usage:",
20201         "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",
20202         "type": "json"
20203       }
20204     ],
20205     "name": "smsQueueNotify",
20206     "group": "RPC_Realtime",
20207     "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>",
20208     "version": "0.0.0",
20209     "filename": "server/api/rpc/index.js",
20210     "groupTitle": "RPC_Realtime"
20211   },
20212   {
20213     "type": "get",
20214     "url": "/api/rpc/sms/queues/waitinginteractions",
20215     "title": "Gets a list of smsQueuesWaitingInteractions",
20216     "examples": [
20217       {
20218         "title": "Example usage:",
20219         "content": "curl https://{domain}/api/rpc/sms/queues/waitinginteractions -v -u {name}:{password}",
20220         "type": "json"
20221       }
20222     ],
20223     "name": "smsQueuesWaitingInteractions",
20224     "group": "RPC_Realtime",
20225     "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>",
20226     "version": "0.0.0",
20227     "filename": "server/api/rpc/index.js",
20228     "groupTitle": "RPC_Realtime"
20229   },
20230   {
20231     "type": "post",
20232     "url": "/api/integrations/salesforce/accounts",
20233     "title": "Creates a new Salesforce Account",
20234     "examples": [
20235       {
20236         "title": "Example usage:",
20237         "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",
20238         "type": "json"
20239       }
20240     ],
20241     "name": "CreateSalesforce_Accounts",
20242     "group": "Salesforce_Accounts",
20243     "parameter": {
20244       "fields": {
20245         "Body": [
20246           {
20247             "group": "Body",
20248             "type": "String",
20249             "optional": true,
20250             "field": "name",
20251             "description": ""
20252           },
20253           {
20254             "group": "Body",
20255             "type": "String",
20256             "optional": true,
20257             "field": "description",
20258             "description": ""
20259           },
20260           {
20261             "group": "Body",
20262             "type": "String",
20263             "optional": true,
20264             "field": "username",
20265             "description": ""
20266           },
20267           {
20268             "group": "Body",
20269             "type": "String",
20270             "optional": true,
20271             "field": "remoteUri",
20272             "description": ""
20273           },
20274           {
20275             "group": "Body",
20276             "type": "String",
20277             "optional": true,
20278             "field": "password",
20279             "description": ""
20280           },
20281           {
20282             "group": "Body",
20283             "type": "String",
20284             "optional": true,
20285             "field": "clientId",
20286             "description": ""
20287           },
20288           {
20289             "group": "Body",
20290             "type": "String",
20291             "optional": true,
20292             "field": "clientSecret",
20293             "description": ""
20294           },
20295           {
20296             "group": "Body",
20297             "type": "String",
20298             "optional": true,
20299             "field": "securityToken",
20300             "description": ""
20301           },
20302           {
20303             "group": "Body",
20304             "type": "String",
20305             "optional": true,
20306             "field": "serverUrl",
20307             "description": ""
20308           },
20309           {
20310             "group": "Body",
20311             "type": "String",
20312             "allowedValues": [
20313               "\"integrationTab\"",
20314               "\"newTab\""
20315             ],
20316             "optional": true,
20317             "field": "type",
20318             "description": ""
20319           }
20320         ]
20321       }
20322     },
20323     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20324     "version": "0.0.0",
20325     "filename": "server/api/intSalesforceAccount/index.js",
20326     "groupTitle": "Salesforce_Accounts"
20327   },
20328   {
20329     "type": "delete",
20330     "url": "/api/integrations/salesforce/accounts/{id}",
20331     "title": "Deletes a Salesforce Account",
20332     "examples": [
20333       {
20334         "title": "Example usage:",
20335         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password} -X DELETE",
20336         "type": "json"
20337       }
20338     ],
20339     "name": "DeleteSalesforce_Accounts",
20340     "group": "Salesforce_Accounts",
20341     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "get",
20348     "url": "/api/integrations/salesforce/accounts",
20349     "title": "Gets a list of Salesforce Accounts",
20350     "examples": [
20351       {
20352         "title": "Example usage:",
20353         "content": "curl https://{domain}/api/integrations/salesforce/accounts -v -u {name}:{password}",
20354         "type": "json"
20355       }
20356     ],
20357     "name": "GetSalesforce_Accounts",
20358     "group": "Salesforce_Accounts",
20359     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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/{id}",
20367     "title": "Gets a single Salesforce Account",
20368     "examples": [
20369       {
20370         "title": "Example usage:",
20371         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password}",
20372         "type": "json"
20373       }
20374     ],
20375     "name": "ShowSalesforce_Accounts",
20376     "group": "Salesforce_Accounts",
20377     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20378     "version": "0.0.0",
20379     "filename": "server/api/intSalesforceAccount/index.js",
20380     "groupTitle": "Salesforce_Accounts"
20381   },
20382   {
20383     "type": "post",
20384     "url": "/api/integrations/salesforce/accounts/{id}/configurations",
20385     "title": "Creates new configuration",
20386     "examples": [
20387       {
20388         "title": "Example usage:",
20389         "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",
20390         "type": "json"
20391       }
20392     ],
20393     "name": "addConfiguration",
20394     "group": "Salesforce_Accounts",
20395     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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": "get",
20402     "url": "/api/integrations/salesforce/accounts/{id}/configurations",
20403     "title": "Gets account configurations",
20404     "examples": [
20405       {
20406         "title": "Example usage:",
20407         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/configurations -v -u {name}:{password} -X GET",
20408         "type": "json"
20409       }
20410     ],
20411     "name": "getConfigurations",
20412     "group": "Salesforce_Accounts",
20413     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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}/fields",
20421     "title": "Gets account fields",
20422     "examples": [
20423       {
20424         "title": "Example usage:",
20425         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/fields -v -u {name}:{password} -X GET",
20426         "type": "json"
20427       }
20428     ],
20429     "name": "getFields",
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": "put",
20438     "url": "/api/integrations/salesforce/accounts/{id}",
20439     "title": "Update an existing Salesforce Account",
20440     "examples": [
20441       {
20442         "title": "Example usage:",
20443         "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",
20444         "type": "json"
20445       }
20446     ],
20447     "name": "updateSalesforce_Accounts",
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": "post",
20456     "url": "/api/integrations/salesforce/configurations",
20457     "title": "Creates a new Salesforce Configuration",
20458     "examples": [
20459       {
20460         "title": "Example usage:",
20461         "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",
20462         "type": "json"
20463       }
20464     ],
20465     "name": "CreateSalesforce_Configurations",
20466     "group": "Salesforce_Configurations",
20467     "parameter": {
20468       "fields": {
20469         "Body": [
20470           {
20471             "group": "Body",
20472             "type": "String",
20473             "optional": true,
20474             "field": "name",
20475             "description": ""
20476           },
20477           {
20478             "group": "Body",
20479             "type": "String",
20480             "optional": true,
20481             "field": "description",
20482             "description": ""
20483           },
20484           {
20485             "group": "Body",
20486             "type": "String",
20487             "allowedValues": [
20488               "\"Task\"",
20489               "\"Case\""
20490             ],
20491             "optional": true,
20492             "field": "ticketType",
20493             "description": ""
20494           },
20495           {
20496             "group": "Body",
20497             "type": "String",
20498             "allowedValues": [
20499               "\"contact_lead\"",
20500               "\"contact\"",
20501               "\"lead\""
20502             ],
20503             "optional": true,
20504             "field": "moduleSearch",
20505             "description": ""
20506           },
20507           {
20508             "group": "Body",
20509             "type": "String",
20510             "allowedValues": [
20511               "\"nothing\"",
20512               "\"contact\"",
20513               "\"lead\""
20514             ],
20515             "optional": true,
20516             "field": "moduleCreate",
20517             "description": ""
20518           }
20519         ]
20520       }
20521     },
20522     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20523     "version": "0.0.0",
20524     "filename": "server/api/intSalesforceConfiguration/index.js",
20525     "groupTitle": "Salesforce_Configurations"
20526   },
20527   {
20528     "type": "delete",
20529     "url": "/api/integrations/salesforce/configurations/{id}",
20530     "title": "Deletes a Salesforce Configuration",
20531     "examples": [
20532       {
20533         "title": "Example usage:",
20534         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password} -X DELETE",
20535         "type": "json"
20536       }
20537     ],
20538     "name": "DeleteSalesforce_Configurations",
20539     "group": "Salesforce_Configurations",
20540     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20541     "version": "0.0.0",
20542     "filename": "server/api/intSalesforceConfiguration/index.js",
20543     "groupTitle": "Salesforce_Configurations"
20544   },
20545   {
20546     "type": "get",
20547     "url": "/api/integrations/salesforce/configurations",
20548     "title": "Gets a list of Salesforce Configurations",
20549     "examples": [
20550       {
20551         "title": "Example usage:",
20552         "content": "curl https://{domain}/api/integrations/salesforce/configurations -v -u {name}:{password}",
20553         "type": "json"
20554       }
20555     ],
20556     "name": "GetSalesforce_Configurations",
20557     "group": "Salesforce_Configurations",
20558     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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/{id}",
20566     "title": "Gets a single Salesforce Configuration",
20567     "examples": [
20568       {
20569         "title": "Example usage:",
20570         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password}",
20571         "type": "json"
20572       }
20573     ],
20574     "name": "ShowSalesforce_Configurations",
20575     "group": "Salesforce_Configurations",
20576     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20577     "version": "0.0.0",
20578     "filename": "server/api/intSalesforceConfiguration/index.js",
20579     "groupTitle": "Salesforce_Configurations"
20580   },
20581   {
20582     "type": "get",
20583     "url": "/api/integrations/salesforce/configurations/{id}/descriptions",
20584     "title": "Gets configurations descriptions",
20585     "examples": [
20586       {
20587         "title": "Example usage:",
20588         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
20589         "type": "json"
20590       }
20591     ],
20592     "name": "getDescriptions",
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}/fields",
20602     "title": "Gets configurations fields",
20603     "examples": [
20604       {
20605         "title": "Example usage:",
20606         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/fields -v -u {name}:{password} -X GET",
20607         "type": "json"
20608       }
20609     ],
20610     "name": "getFields",
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}/subjects",
20620     "title": "Gets configurations subjects",
20621     "examples": [
20622       {
20623         "title": "Example usage:",
20624         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/subjects -v -u {name}:{password} -X GET",
20625         "type": "json"
20626       }
20627     ],
20628     "name": "getSubjects",
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": "put",
20637     "url": "/api/integrations/salesforce/configurations/{id}",
20638     "title": "Update an existing Salesforce Configuration",
20639     "examples": [
20640       {
20641         "title": "Example usage:",
20642         "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",
20643         "type": "json"
20644       }
20645     ],
20646     "name": "updateSalesforce_Configurations",
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": "post",
20655     "url": "/api/integrations/salesforce/fields",
20656     "title": "Creates a new Salesforce Field",
20657     "examples": [
20658       {
20659         "title": "Example usage:",
20660         "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",
20661         "type": "json"
20662       }
20663     ],
20664     "name": "CreateSalesforce_Fields",
20665     "group": "Salesforce_Fields",
20666     "parameter": {
20667       "fields": {
20668         "Body": [
20669           {
20670             "group": "Body",
20671             "type": "String",
20672             "allowedValues": [
20673               "\"string\"",
20674               "\"variable\"",
20675               "\"customVariable\"",
20676               "\"keyValue\""
20677             ],
20678             "optional": true,
20679             "field": "type",
20680             "description": ""
20681           },
20682           {
20683             "group": "Body",
20684             "type": "String",
20685             "optional": true,
20686             "field": "content",
20687             "description": ""
20688           },
20689           {
20690             "group": "Body",
20691             "type": "String",
20692             "optional": true,
20693             "field": "key",
20694             "description": ""
20695           },
20696           {
20697             "group": "Body",
20698             "type": "String",
20699             "allowedValues": [
20700               "\"string\"",
20701               "\"variable\"",
20702               "\"customVariable\""
20703             ],
20704             "optional": true,
20705             "field": "keyType",
20706             "description": ""
20707           },
20708           {
20709             "group": "Body",
20710             "type": "String",
20711             "optional": true,
20712             "field": "keyContent",
20713             "description": ""
20714           },
20715           {
20716             "group": "Body",
20717             "type": "String",
20718             "optional": true,
20719             "field": "idField",
20720             "description": ""
20721           },
20722           {
20723             "group": "Body",
20724             "type": "String",
20725             "optional": true,
20726             "field": "variableName",
20727             "description": ""
20728           }
20729         ]
20730       }
20731     },
20732     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20733     "version": "0.0.0",
20734     "filename": "server/api/intSalesforceField/index.js",
20735     "groupTitle": "Salesforce_Fields"
20736   },
20737   {
20738     "type": "delete",
20739     "url": "/api/integrations/salesforce/fields/{id}",
20740     "title": "Deletes a Salesforce Field",
20741     "examples": [
20742       {
20743         "title": "Example usage:",
20744         "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password} -X DELETE",
20745         "type": "json"
20746       }
20747     ],
20748     "name": "DeleteSalesforce_Fields",
20749     "group": "Salesforce_Fields",
20750     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "get",
20757     "url": "/api/integrations/salesforce/fields",
20758     "title": "Gets a list of Salesforce Fields",
20759     "examples": [
20760       {
20761         "title": "Example usage:",
20762         "content": "curl https://{domain}/api/integrations/salesforce/fields -v -u {name}:{password}",
20763         "type": "json"
20764       }
20765     ],
20766     "name": "GetSalesforce_Fields",
20767     "group": "Salesforce_Fields",
20768     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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/{id}",
20776     "title": "Gets a single Salesforce Field",
20777     "examples": [
20778       {
20779         "title": "Example usage:",
20780         "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password}",
20781         "type": "json"
20782       }
20783     ],
20784     "name": "ShowSalesforce_Fields",
20785     "group": "Salesforce_Fields",
20786     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20787     "version": "0.0.0",
20788     "filename": "server/api/intSalesforceField/index.js",
20789     "groupTitle": "Salesforce_Fields"
20790   },
20791   {
20792     "type": "put",
20793     "url": "/api/integrations/salesforce/fields/{id}",
20794     "title": "Update an existing Salesforce Field",
20795     "examples": [
20796       {
20797         "title": "Example usage:",
20798         "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",
20799         "type": "json"
20800       }
20801     ],
20802     "name": "updateSalesforce_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": "post",
20811     "url": "/api/schedules",
20812     "title": "Creates a new Schedule",
20813     "examples": [
20814       {
20815         "title": "Example usage:",
20816         "content": "curl https://{domain}/api/schedules -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
20817         "type": "json"
20818       }
20819     ],
20820     "name": "CreateSchedules",
20821     "group": "Schedules",
20822     "parameter": {
20823       "fields": {
20824         "Body": [
20825           {
20826             "group": "Body",
20827             "type": "String",
20828             "optional": false,
20829             "field": "name",
20830             "description": ""
20831           },
20832           {
20833             "group": "Body",
20834             "type": "String",
20835             "optional": true,
20836             "field": "description",
20837             "description": ""
20838           },
20839           {
20840             "group": "Body",
20841             "type": "Boolean",
20842             "optional": false,
20843             "field": "active",
20844             "description": ""
20845           },
20846           {
20847             "group": "Body",
20848             "type": "String",
20849             "optional": false,
20850             "field": "cron",
20851             "description": ""
20852           },
20853           {
20854             "group": "Body",
20855             "type": "String",
20856             "optional": false,
20857             "field": "startAt",
20858             "description": ""
20859           },
20860           {
20861             "group": "Body",
20862             "type": "String",
20863             "optional": false,
20864             "field": "endAt",
20865             "description": ""
20866           },
20867           {
20868             "group": "Body",
20869             "type": "Integer",
20870             "optional": false,
20871             "field": "subtractNumber",
20872             "description": ""
20873           },
20874           {
20875             "group": "Body",
20876             "type": "String",
20877             "allowedValues": [
20878               "\"years\"",
20879               "\"quarters\"",
20880               "\"months\"",
20881               "\"weeks\"",
20882               "\"days\"",
20883               "\"hours\"",
20884               "\"minutes\""
20885             ],
20886             "optional": false,
20887             "field": "subtractUnit",
20888             "description": ""
20889           },
20890           {
20891             "group": "Body",
20892             "type": "String",
20893             "allowedValues": [
20894               "\"csv\"",
20895               "\"pdf\"",
20896               "\"xlsx\""
20897             ],
20898             "optional": false,
20899             "field": "output",
20900             "description": ""
20901           },
20902           {
20903             "group": "Body",
20904             "type": "String",
20905             "allowedValues": [
20906               "\"custom\"",
20907               "\"default\""
20908             ],
20909             "optional": false,
20910             "field": "type",
20911             "description": ""
20912           },
20913           {
20914             "group": "Body",
20915             "type": "Boolean",
20916             "optional": true,
20917             "field": "sendMail",
20918             "description": ""
20919           },
20920           {
20921             "group": "Body",
20922             "type": "String",
20923             "optional": true,
20924             "field": "email",
20925             "description": ""
20926           },
20927           {
20928             "group": "Body",
20929             "type": "Text",
20930             "optional": true,
20931             "field": "cc",
20932             "description": ""
20933           },
20934           {
20935             "group": "Body",
20936             "type": "Text",
20937             "optional": true,
20938             "field": "bcc",
20939             "description": ""
20940           },
20941           {
20942             "group": "Body",
20943             "type": "Boolean",
20944             "optional": true,
20945             "field": "sendIfEmpty",
20946             "description": ""
20947           }
20948         ]
20949       }
20950     },
20951     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20952     "version": "0.0.0",
20953     "filename": "server/api/schedule/index.js",
20954     "groupTitle": "Schedules"
20955   },
20956   {
20957     "type": "delete",
20958     "url": "/api/schedules/{id}",
20959     "title": "Deletes a Schedule",
20960     "examples": [
20961       {
20962         "title": "Example usage:",
20963         "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password} -X DELETE",
20964         "type": "json"
20965       }
20966     ],
20967     "name": "DeleteSchedules",
20968     "group": "Schedules",
20969     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "get",
20976     "url": "/api/schedules",
20977     "title": "Gets a list of Schedules",
20978     "examples": [
20979       {
20980         "title": "Example usage:",
20981         "content": "curl https://{domain}/api/schedules -v -u {name}:{password}",
20982         "type": "json"
20983       }
20984     ],
20985     "name": "GetSchedules",
20986     "group": "Schedules",
20987     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20988     "version": "0.0.0",
20989     "filename": "server/api/schedule/index.js",
20990     "groupTitle": "Schedules"
20991   },
20992   {
20993     "type": "get",
20994     "url": "/api/schedules/{id}",
20995     "title": "Gets a single Schedule",
20996     "examples": [
20997       {
20998         "title": "Example usage:",
20999         "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password}",
21000         "type": "json"
21001       }
21002     ],
21003     "name": "ShowSchedules",
21004     "group": "Schedules",
21005     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</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}/run",
21013     "title": "Run Scheduler",
21014     "examples": [
21015       {
21016         "title": "Example usage:",
21017         "content": "curl https://{domain}/api/schedules/{id}/run -v -u {name}:{password} -X GET",
21018         "type": "json"
21019       }
21020     ],
21021     "name": "run",
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": "put",
21030     "url": "/api/schedules/{id}",
21031     "title": "Update an existing Schedule",
21032     "examples": [
21033       {
21034         "title": "Example usage:",
21035         "content": "curl https://{domain}/api/schedules/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
21036         "type": "json"
21037       }
21038     ],
21039     "name": "updateSchedules",
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": "post",
21048     "url": "/api/screen/recordings",
21049     "title": "Creates a new Recording",
21050     "examples": [
21051       {
21052         "title": "Example usage:",
21053         "content": "curl https://{domain}/api/screen/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
21054         "type": "json"
21055       }
21056     ],
21057     "name": "CreateRecordings",
21058     "group": "Screen_Recordings",
21059     "parameter": {
21060       "fields": {
21061         "Body": [
21062           {
21063             "group": "Body",
21064             "type": "Virtual",
21065             "optional": true,
21066             "field": "format",
21067             "description": ""
21068           },
21069           {
21070             "group": "Body",
21071             "type": "String",
21072             "optional": true,
21073             "field": "interactionid",
21074             "description": ""
21075           },
21076           {
21077             "group": "Body",
21078             "type": "String",
21079             "optional": true,
21080             "field": "channel",
21081             "description": ""
21082           },
21083           {
21084             "group": "Body",
21085             "type": "String",
21086             "optional": true,
21087             "field": "value",
21088             "description": ""
21089           },
21090           {
21091             "group": "Body",
21092             "type": "Integer",
21093             "optional": true,
21094             "field": "rating",
21095             "description": ""
21096           },
21097           {
21098             "group": "Body",
21099             "type": "Integer",
21100             "optional": true,
21101             "field": "duration",
21102             "description": ""
21103           },
21104           {
21105             "group": "Body",
21106             "type": "String",
21107             "optional": true,
21108             "field": "startedAt",
21109             "description": ""
21110           },
21111           {
21112             "group": "Body",
21113             "type": "String",
21114             "optional": true,
21115             "field": "closedAt",
21116             "description": ""
21117           },
21118           {
21119             "group": "Body",
21120             "type": "String",
21121             "optional": true,
21122             "field": "createdAt",
21123             "description": ""
21124           },
21125           {
21126             "group": "Body",
21127             "type": "String",
21128             "optional": true,
21129             "field": "updatedAt",
21130             "description": ""
21131           }
21132         ]
21133       }
21134     },
21135     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21136     "version": "0.0.0",
21137     "filename": "server/api/screenRecording/index.js",
21138     "groupTitle": "Screen_Recordings"
21139   },
21140   {
21141     "type": "get",
21142     "url": "/api/screen/recordings/describe",
21143     "title": "Gets table info about Recordings",
21144     "examples": [
21145       {
21146         "title": "Example usage:",
21147         "content": "curl https://{domain}/api/screen/recordings/describe -v -u {name}:{password}",
21148         "type": "json"
21149       }
21150     ],
21151     "name": "DescribeRecordings",
21152     "group": "Screen_Recordings",
21153     "description": "<p>Motion will return a HTTP status code <code>200</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",
21161     "title": "Gets a list of Recordings",
21162     "examples": [
21163       {
21164         "title": "Example usage:",
21165         "content": "curl https://{domain}/api/screen/recordings -v -u {name}:{password}",
21166         "type": "json"
21167       }
21168     ],
21169     "name": "GetRecordings",
21170     "group": "Screen_Recordings",
21171     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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/{id}",
21179     "title": "Gets a single Recording",
21180     "examples": [
21181       {
21182         "title": "Example usage:",
21183         "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password}",
21184         "type": "json"
21185       }
21186     ],
21187     "name": "ShowRecordings",
21188     "group": "Screen_Recordings",
21189     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21190     "version": "0.0.0",
21191     "filename": "server/api/screenRecording/index.js",
21192     "groupTitle": "Screen_Recordings"
21193   },
21194   {
21195     "type": "delete",
21196     "url": "/api/screen/recordings/{id}",
21197     "title": "Delete screen recording",
21198     "examples": [
21199       {
21200         "title": "Example usage:",
21201         "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password} -X DELETE",
21202         "type": "json"
21203       }
21204     ],
21205     "name": "destroy",
21206     "group": "Screen_Recordings",
21207     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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": "get",
21214     "url": "/api/screen/recordings/{id}/download",
21215     "title": "Download Recording",
21216     "examples": [
21217       {
21218         "title": "Example usage:",
21219         "content": "curl https://{domain}/api/screen/recordings/{id}/download -v -u {name}:{password} -X GET",
21220         "type": "json"
21221       }
21222     ],
21223     "name": "download",
21224     "group": "Screen_Recordings",
21225     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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": "put",
21232     "url": "/api/screen/recordings/{id}",
21233     "title": "Update an existing Recording",
21234     "examples": [
21235       {
21236         "title": "Example usage:",
21237         "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",
21238         "type": "json"
21239       }
21240     ],
21241     "name": "updateRecordings",
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": "post",
21250     "url": "/api/integrations/servicenow/accounts",
21251     "title": "Creates a new Servicenow Account",
21252     "examples": [
21253       {
21254         "title": "Example usage:",
21255         "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",
21256         "type": "json"
21257       }
21258     ],
21259     "name": "CreateServicenow_Accounts",
21260     "group": "Servicenow_Accounts",
21261     "parameter": {
21262       "fields": {
21263         "Body": [
21264           {
21265             "group": "Body",
21266             "type": "String",
21267             "optional": true,
21268             "field": "name",
21269             "description": ""
21270           },
21271           {
21272             "group": "Body",
21273             "type": "String",
21274             "optional": true,
21275             "field": "description",
21276             "description": ""
21277           },
21278           {
21279             "group": "Body",
21280             "type": "String",
21281             "optional": true,
21282             "field": "username",
21283             "description": ""
21284           },
21285           {
21286             "group": "Body",
21287             "type": "String",
21288             "optional": true,
21289             "field": "password",
21290             "description": ""
21291           },
21292           {
21293             "group": "Body",
21294             "type": "String",
21295             "optional": true,
21296             "field": "email",
21297             "description": ""
21298           },
21299           {
21300             "group": "Body",
21301             "type": "String",
21302             "optional": true,
21303             "field": "remoteUri",
21304             "description": ""
21305           },
21306           {
21307             "group": "Body",
21308             "type": "String",
21309             "optional": true,
21310             "field": "serverUrl",
21311             "description": ""
21312           }
21313         ]
21314       }
21315     },
21316     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21317     "version": "0.0.0",
21318     "filename": "server/api/intServicenowAccount/index.js",
21319     "groupTitle": "Servicenow_Accounts"
21320   },
21321   {
21322     "type": "delete",
21323     "url": "/api/integrations/servicenow/accounts/{id}",
21324     "title": "Deletes a Servicenow Account",
21325     "examples": [
21326       {
21327         "title": "Example usage:",
21328         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password} -X DELETE",
21329         "type": "json"
21330       }
21331     ],
21332     "name": "DeleteServicenow_Accounts",
21333     "group": "Servicenow_Accounts",
21334     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "get",
21341     "url": "/api/integrations/servicenow/accounts",
21342     "title": "Gets a list of Servicenow Accounts",
21343     "examples": [
21344       {
21345         "title": "Example usage:",
21346         "content": "curl https://{domain}/api/integrations/servicenow/accounts -v -u {name}:{password}",
21347         "type": "json"
21348       }
21349     ],
21350     "name": "GetServicenow_Accounts",
21351     "group": "Servicenow_Accounts",
21352     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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/{id}",
21360     "title": "Gets a single Servicenow Account",
21361     "examples": [
21362       {
21363         "title": "Example usage:",
21364         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password}",
21365         "type": "json"
21366       }
21367     ],
21368     "name": "ShowServicenow_Accounts",
21369     "group": "Servicenow_Accounts",
21370     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21371     "version": "0.0.0",
21372     "filename": "server/api/intServicenowAccount/index.js",
21373     "groupTitle": "Servicenow_Accounts"
21374   },
21375   {
21376     "type": "post",
21377     "url": "/api/integrations/servicenow/accounts/{id}/configurations",
21378     "title": "Creates new configuration",
21379     "examples": [
21380       {
21381         "title": "Example usage:",
21382         "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",
21383         "type": "json"
21384       }
21385     ],
21386     "name": "addConfiguration",
21387     "group": "Servicenow_Accounts",
21388     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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": "get",
21395     "url": "/api/integrations/servicenow/accounts/{id}/configurations",
21396     "title": "Gets account configurations",
21397     "examples": [
21398       {
21399         "title": "Example usage:",
21400         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/configurations -v -u {name}:{password} -X GET",
21401         "type": "json"
21402       }
21403     ],
21404     "name": "getConfigurations",
21405     "group": "Servicenow_Accounts",
21406     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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}/fields",
21414     "title": "Gets account fields",
21415     "examples": [
21416       {
21417         "title": "Example usage:",
21418         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/fields -v -u {name}:{password} -X GET",
21419         "type": "json"
21420       }
21421     ],
21422     "name": "getFields",
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": "put",
21431     "url": "/api/integrations/servicenow/accounts/{id}",
21432     "title": "Update an existing Servicenow Account",
21433     "examples": [
21434       {
21435         "title": "Example usage:",
21436         "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",
21437         "type": "json"
21438       }
21439     ],
21440     "name": "updateServicenow_Accounts",
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": "post",
21449     "url": "/api/integrations/servicenow/configurations",
21450     "title": "Creates a new Servicenow Configuration",
21451     "examples": [
21452       {
21453         "title": "Example usage:",
21454         "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",
21455         "type": "json"
21456       }
21457     ],
21458     "name": "CreateServicenow_Configurations",
21459     "group": "Servicenow_Configurations",
21460     "parameter": {
21461       "fields": {
21462         "Body": [
21463           {
21464             "group": "Body",
21465             "type": "String",
21466             "optional": true,
21467             "field": "name",
21468             "description": ""
21469           },
21470           {
21471             "group": "Body",
21472             "type": "String",
21473             "optional": true,
21474             "field": "description",
21475             "description": ""
21476           }
21477         ]
21478       }
21479     },
21480     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21481     "version": "0.0.0",
21482     "filename": "server/api/intServicenowConfiguration/index.js",
21483     "groupTitle": "Servicenow_Configurations"
21484   },
21485   {
21486     "type": "delete",
21487     "url": "/api/integrations/servicenow/configurations/{id}",
21488     "title": "Deletes a Servicenow Configuration",
21489     "examples": [
21490       {
21491         "title": "Example usage:",
21492         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password} -X DELETE",
21493         "type": "json"
21494       }
21495     ],
21496     "name": "DeleteServicenow_Configurations",
21497     "group": "Servicenow_Configurations",
21498     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "get",
21505     "url": "/api/integrations/servicenow/configurations",
21506     "title": "Gets a list of Servicenow Configurations",
21507     "examples": [
21508       {
21509         "title": "Example usage:",
21510         "content": "curl https://{domain}/api/integrations/servicenow/configurations -v -u {name}:{password}",
21511         "type": "json"
21512       }
21513     ],
21514     "name": "GetServicenow_Configurations",
21515     "group": "Servicenow_Configurations",
21516     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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/{id}",
21524     "title": "Gets a single Servicenow Configuration",
21525     "examples": [
21526       {
21527         "title": "Example usage:",
21528         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password}",
21529         "type": "json"
21530       }
21531     ],
21532     "name": "ShowServicenow_Configurations",
21533     "group": "Servicenow_Configurations",
21534     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</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}/descriptions",
21542     "title": "Gets configurations descriptions",
21543     "examples": [
21544       {
21545         "title": "Example usage:",
21546         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
21547         "type": "json"
21548       }
21549     ],
21550     "name": "getDescriptions",
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}/fields",
21560     "title": "Gets configurations fields",
21561     "examples": [
21562       {
21563         "title": "Example usage:",
21564         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/fields -v -u {name}:{password} -X GET",
21565         "type": "json"
21566       }
21567     ],
21568     "name": "getFields",
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}/subjects",
21578     "title": "Gets configurations subjects",
21579     "examples": [
21580       {
21581         "title": "Example usage:",
21582         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/subjects -v -u {name}:{password} -X GET",
21583         "type": "json"
21584       }
21585     ],
21586     "name": "getSubjects",
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": "put",
21595     "url": "/api/integrations/servicenow/configurations/{id}",
21596     "title": "Update an existing Servicenow Configuration",
21597     "examples": [
21598       {
21599         "title": "Example usage:",
21600         "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",
21601         "type": "json"
21602       }
21603     ],
21604     "name": "updateServicenow_Configurations",
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": "post",
21613     "url": "/api/integrations/servicenow/fields",
21614     "title": "Creates a new Servicenow Field",
21615     "examples": [
21616       {
21617         "title": "Example usage:",
21618         "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",
21619         "type": "json"
21620       }
21621     ],
21622     "name": "CreateServicenow_Fields",
21623     "group": "Servicenow_Fields",
21624     "parameter": {
21625       "fields": {
21626         "Body": [
21627           {
21628             "group": "Body",
21629             "type": "String",
21630             "allowedValues": [
21631               "\"string\"",
21632               "\"variable\"",
21633               "\"customVariable\"",
21634               "\"keyValue\""
21635             ],
21636             "optional": true,
21637             "field": "type",
21638             "description": ""
21639           },
21640           {
21641             "group": "Body",
21642             "type": "String",
21643             "optional": true,
21644             "field": "content",
21645             "description": ""
21646           },
21647           {
21648             "group": "Body",
21649             "type": "String",
21650             "optional": true,
21651             "field": "key",
21652             "description": ""
21653           },
21654           {
21655             "group": "Body",
21656             "type": "String",
21657             "allowedValues": [
21658               "\"string\"",
21659               "\"variable\"",
21660               "\"customVariable\""
21661             ],
21662             "optional": true,
21663             "field": "keyType",
21664             "description": ""
21665           },
21666           {
21667             "group": "Body",
21668             "type": "String",
21669             "optional": true,
21670             "field": "keyContent",
21671             "description": ""
21672           },
21673           {
21674             "group": "Body",
21675             "type": "String",
21676             "optional": true,
21677             "field": "idField",
21678             "description": ""
21679           },
21680           {
21681             "group": "Body",
21682             "type": "String",
21683             "optional": true,
21684             "field": "nameField",
21685             "description": ""
21686           },
21687           {
21688             "group": "Body",
21689             "type": "Boolean",
21690             "optional": true,
21691             "field": "customField",
21692             "description": ""
21693           },
21694           {
21695             "group": "Body",
21696             "type": "String",
21697             "optional": true,
21698             "field": "variableName",
21699             "description": ""
21700           }
21701         ]
21702       }
21703     },
21704     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21705     "version": "0.0.0",
21706     "filename": "server/api/intServicenowField/index.js",
21707     "groupTitle": "Servicenow_Fields"
21708   },
21709   {
21710     "type": "delete",
21711     "url": "/api/integrations/servicenow/fields/{id}",
21712     "title": "Deletes a Servicenow Field",
21713     "examples": [
21714       {
21715         "title": "Example usage:",
21716         "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password} -X DELETE",
21717         "type": "json"
21718       }
21719     ],
21720     "name": "DeleteServicenow_Fields",
21721     "group": "Servicenow_Fields",
21722     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "get",
21729     "url": "/api/integrations/servicenow/fields",
21730     "title": "Gets a list of Servicenow Fields",
21731     "examples": [
21732       {
21733         "title": "Example usage:",
21734         "content": "curl https://{domain}/api/integrations/servicenow/fields -v -u {name}:{password}",
21735         "type": "json"
21736       }
21737     ],
21738     "name": "GetServicenow_Fields",
21739     "group": "Servicenow_Fields",
21740     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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/{id}",
21748     "title": "Gets a single Servicenow Field",
21749     "examples": [
21750       {
21751         "title": "Example usage:",
21752         "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password}",
21753         "type": "json"
21754       }
21755     ],
21756     "name": "ShowServicenow_Fields",
21757     "group": "Servicenow_Fields",
21758     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21759     "version": "0.0.0",
21760     "filename": "server/api/intServicenowField/index.js",
21761     "groupTitle": "Servicenow_Fields"
21762   },
21763   {
21764     "type": "put",
21765     "url": "/api/integrations/servicenow/fields/{id}",
21766     "title": "Update an existing Servicenow Field",
21767     "examples": [
21768       {
21769         "title": "Example usage:",
21770         "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",
21771         "type": "json"
21772       }
21773     ],
21774     "name": "updateServicenow_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": "get",
21783     "url": "/api/settings",
21784     "title": "Gets a list of Settings",
21785     "examples": [
21786       {
21787         "title": "Example usage:",
21788         "content": "curl https://{domain}/api/settings -v -u {name}:{password}",
21789         "type": "json"
21790       }
21791     ],
21792     "name": "GetSettings",
21793     "group": "Settings",
21794     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21795     "version": "0.0.0",
21796     "filename": "server/api/setting/index.js",
21797     "groupTitle": "Settings"
21798   },
21799   {
21800     "type": "get",
21801     "url": "/api/settings/{id}",
21802     "title": "Gets a single Setting",
21803     "examples": [
21804       {
21805         "title": "Example usage:",
21806         "content": "curl https://{domain}/api/settings/{id} -v -u {name}:{password}",
21807         "type": "json"
21808       }
21809     ],
21810     "name": "ShowSettings",
21811     "group": "Settings",
21812     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21813     "version": "0.0.0",
21814     "filename": "server/api/setting/index.js",
21815     "groupTitle": "Settings"
21816   },
21817   {
21818     "type": "post",
21819     "url": "/api/settings/{id}/favicon",
21820     "title": "Add Favicon",
21821     "examples": [
21822       {
21823         "title": "Example usage:",
21824         "content": "curl https://{domain}/api/settings/{id}/favicon -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21825         "type": "json"
21826       }
21827     ],
21828     "name": "addFavicon",
21829     "group": "Settings",
21830     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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}/logo",
21838     "title": "Add logo",
21839     "examples": [
21840       {
21841         "title": "Example usage:",
21842         "content": "curl https://{domain}/api/settings/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21843         "type": "json"
21844       }
21845     ],
21846     "name": "addLogo",
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_login",
21856     "title": "Add logo login",
21857     "examples": [
21858       {
21859         "title": "Example usage:",
21860         "content": "curl https://{domain}/api/settings/{id}/logo_login -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21861         "type": "json"
21862       }
21863     ],
21864     "name": "addLogoLogin",
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}/preferred",
21874     "title": "Add Preferred",
21875     "examples": [
21876       {
21877         "title": "Example usage:",
21878         "content": "curl https://{domain}/api/settings/{id}/preferred -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21879         "type": "json"
21880       }
21881     ],
21882     "name": "addPreferred",
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": "get",
21891     "url": "/api/settings/now",
21892     "title": "Get Server Current Date",
21893     "examples": [
21894       {
21895         "title": "Example usage:",
21896         "content": "curl https://{domain}/api/settings/now -v -X GET",
21897         "type": "json"
21898       }
21899     ],
21900     "name": "getDate",
21901     "group": "Settings",
21902     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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/{id}/favicon",
21910     "title": "Get Favicon",
21911     "examples": [
21912       {
21913         "title": "Example usage:",
21914         "content": "curl https://{domain}/api/settings/{id}/favicon -v -X GET",
21915         "type": "json"
21916       }
21917     ],
21918     "name": "getFavicon",
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}/gdpr",
21928     "title": "Get gdpr settings",
21929     "examples": [
21930       {
21931         "title": "Example usage:",
21932         "content": "curl https://{domain}/api/settings/{id}/gdpr -v -u {name}:{password} -X GET",
21933         "type": "json"
21934       }
21935     ],
21936     "name": "getGdpr",
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}/logo",
21946     "title": "Get logo",
21947     "examples": [
21948       {
21949         "title": "Example usage:",
21950         "content": "curl https://{domain}/api/settings/{id}/logo -v -X GET",
21951         "type": "json"
21952       }
21953     ],
21954     "name": "getLogo",
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_login",
21964     "title": "Get logo login",
21965     "examples": [
21966       {
21967         "title": "Example usage:",
21968         "content": "curl https://{domain}/api/settings/{id}/logo_login -v -X GET",
21969         "type": "json"
21970       }
21971     ],
21972     "name": "getLogoLogin",
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}/preferred",
21982     "title": "Get Preferred",
21983     "examples": [
21984       {
21985         "title": "Example usage:",
21986         "content": "curl https://{domain}/api/settings/{id}/preferred -v -X GET",
21987         "type": "json"
21988       }
21989     ],
21990     "name": "getPreferred",
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": "put",
21999     "url": "/api/settings/{id}",
22000     "title": "Update an existing Setting",
22001     "examples": [
22002       {
22003         "title": "Example usage:",
22004         "content": "curl https://{domain}/api/settings/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
22005         "type": "json"
22006       }
22007     ],
22008     "name": "updateSettings",
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": "post",
22017     "url": "/api/sms/accounts/{id}/users",
22018     "title": "Add agents to a sms account",
22019     "examples": [
22020       {
22021         "title": "Example usage:",
22022         "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",
22023         "type": "json"
22024       }
22025     ],
22026     "name": "AddAgents",
22027     "group": "Sms_Accounts",
22028     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22029     "version": "0.0.0",
22030     "filename": "server/api/smsAccount/index.js",
22031     "groupTitle": "Sms_Accounts"
22032   },
22033   {
22034     "type": "post",
22035     "url": "/api/sms/accounts",
22036     "title": "Creates a new Account",
22037     "examples": [
22038       {
22039         "title": "Example usage:",
22040         "content": "curl https://{domain}/api/sms/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22041         "type": "json"
22042       }
22043     ],
22044     "name": "CreateAccounts",
22045     "group": "Sms_Accounts",
22046     "parameter": {
22047       "fields": {
22048         "Body": [
22049           {
22050             "group": "Body",
22051             "type": "String",
22052             "optional": false,
22053             "field": "name",
22054             "description": ""
22055           },
22056           {
22057             "group": "Body",
22058             "type": "String",
22059             "optional": false,
22060             "field": "key",
22061             "description": ""
22062           },
22063           {
22064             "group": "Body",
22065             "type": "String",
22066             "optional": false,
22067             "field": "remote",
22068             "description": ""
22069           },
22070           {
22071             "group": "Body",
22072             "type": "String",
22073             "optional": true,
22074             "field": "token",
22075             "description": ""
22076           },
22077           {
22078             "group": "Body",
22079             "type": "String",
22080             "optional": true,
22081             "field": "phone",
22082             "description": ""
22083           },
22084           {
22085             "group": "Body",
22086             "type": "String",
22087             "allowedValues": [
22088               "\"twilio\"",
22089               "\"skebby\"",
22090               "\"connectel\"",
22091               "\"clicksend\"",
22092               "\"plivo\"",
22093               "\"clickatell\"",
22094               "\"csc\"",
22095               "\"infobip\"",
22096               "\"intelepeer\""
22097             ],
22098             "optional": true,
22099             "field": "type",
22100             "description": ""
22101           },
22102           {
22103             "group": "Body",
22104             "type": "String",
22105             "optional": true,
22106             "field": "accountSid",
22107             "description": ""
22108           },
22109           {
22110             "group": "Body",
22111             "type": "String",
22112             "optional": true,
22113             "field": "authId",
22114             "description": ""
22115           },
22116           {
22117             "group": "Body",
22118             "type": "String",
22119             "optional": true,
22120             "field": "authToken",
22121             "description": ""
22122           },
22123           {
22124             "group": "Body",
22125             "type": "String",
22126             "allowedValues": [
22127               "\"SI\"",
22128               "\"TI\"",
22129               "\"GP\""
22130             ],
22131             "optional": true,
22132             "field": "smsMethod",
22133             "description": ""
22134           },
22135           {
22136             "group": "Body",
22137             "type": "String",
22138             "optional": true,
22139             "field": "username",
22140             "description": ""
22141           },
22142           {
22143             "group": "Body",
22144             "type": "String",
22145             "optional": true,
22146             "field": "password",
22147             "description": ""
22148           },
22149           {
22150             "group": "Body",
22151             "type": "String",
22152             "optional": true,
22153             "field": "apiKey",
22154             "description": ""
22155           },
22156           {
22157             "group": "Body",
22158             "type": "String",
22159             "optional": true,
22160             "field": "senderString",
22161             "description": ""
22162           },
22163           {
22164             "group": "Body",
22165             "type": "Boolean",
22166             "optional": true,
22167             "field": "deliveryReport",
22168             "description": ""
22169           },
22170           {
22171             "group": "Body",
22172             "type": "String",
22173             "optional": true,
22174             "field": "description",
22175             "description": ""
22176           },
22177           {
22178             "group": "Body",
22179             "type": "Text",
22180             "optional": true,
22181             "field": "notificationTemplate",
22182             "description": ""
22183           },
22184           {
22185             "group": "Body",
22186             "type": "Boolean",
22187             "optional": true,
22188             "field": "notificationSound",
22189             "description": ""
22190           },
22191           {
22192             "group": "Body",
22193             "type": "Boolean",
22194             "optional": true,
22195             "field": "notificationShake",
22196             "description": ""
22197           },
22198           {
22199             "group": "Body",
22200             "type": "Integer",
22201             "optional": true,
22202             "field": "waitForTheAssignedAgent",
22203             "description": ""
22204           },
22205           {
22206             "group": "Body",
22207             "type": "Boolean",
22208             "optional": true,
22209             "field": "queueTransfer",
22210             "description": ""
22211           },
22212           {
22213             "group": "Body",
22214             "type": "Integer",
22215             "optional": true,
22216             "field": "queueTransferTimeout",
22217             "description": ""
22218           },
22219           {
22220             "group": "Body",
22221             "type": "Boolean",
22222             "optional": true,
22223             "field": "agentTransfer",
22224             "description": ""
22225           },
22226           {
22227             "group": "Body",
22228             "type": "Integer",
22229             "optional": true,
22230             "field": "agentTransferTimeout",
22231             "description": ""
22232           },
22233           {
22234             "group": "Body",
22235             "type": "String",
22236             "optional": true,
22237             "field": "baseUrl",
22238             "description": ""
22239           },
22240           {
22241             "group": "Body",
22242             "type": "Integer",
22243             "optional": true,
22244             "field": "mandatoryDispositionPauseId",
22245             "description": "<p>Status to put when mandatory disposition is enabled</p>"
22246           },
22247           {
22248             "group": "Body",
22249             "type": "Boolean",
22250             "optional": true,
22251             "field": "mandatoryDisposition",
22252             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
22253           }
22254         ]
22255       }
22256     },
22257     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22258     "version": "0.0.0",
22259     "filename": "server/api/smsAccount/index.js",
22260     "groupTitle": "Sms_Accounts"
22261   },
22262   {
22263     "type": "delete",
22264     "url": "/api/sms/accounts/{id}",
22265     "title": "Deletes a Account",
22266     "examples": [
22267       {
22268         "title": "Example usage:",
22269         "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password} -X DELETE",
22270         "type": "json"
22271       }
22272     ],
22273     "name": "DeleteAccounts",
22274     "group": "Sms_Accounts",
22275     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22276     "version": "0.0.0",
22277     "filename": "server/api/smsAccount/index.js",
22278     "groupTitle": "Sms_Accounts"
22279   },
22280   {
22281     "type": "get",
22282     "url": "/api/sms/accounts/describe",
22283     "title": "Gets table info about Accounts",
22284     "examples": [
22285       {
22286         "title": "Example usage:",
22287         "content": "curl https://{domain}/api/sms/accounts/describe -v -u {name}:{password}",
22288         "type": "json"
22289       }
22290     ],
22291     "name": "DescribeAccounts",
22292     "group": "Sms_Accounts",
22293     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22294     "version": "0.0.0",
22295     "filename": "server/api/smsAccount/index.js",
22296     "groupTitle": "Sms_Accounts"
22297   },
22298   {
22299     "type": "get",
22300     "url": "/api/sms/accounts",
22301     "title": "Gets a list of Accounts",
22302     "examples": [
22303       {
22304         "title": "Example usage:",
22305         "content": "curl https://{domain}/api/sms/accounts -v -u {name}:{password}",
22306         "type": "json"
22307       }
22308     ],
22309     "name": "GetAccounts",
22310     "group": "Sms_Accounts",
22311     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22312     "version": "0.0.0",
22313     "filename": "server/api/smsAccount/index.js",
22314     "groupTitle": "Sms_Accounts"
22315   },
22316   {
22317     "type": "get",
22318     "url": "/api/sms/accounts/{id}/users",
22319     "title": "Gets agents from sms account",
22320     "examples": [
22321       {
22322         "title": "Example usage:",
22323         "content": "curl https://{domain}/api/sms/accounts/{id}/users -v -u {name}:{password} -X GET",
22324         "type": "json"
22325       }
22326     ],
22327     "name": "GetAgents",
22328     "group": "Sms_Accounts",
22329     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22330     "version": "0.0.0",
22331     "filename": "server/api/smsAccount/index.js",
22332     "groupTitle": "Sms_Accounts"
22333   },
22334   {
22335     "type": "delete",
22336     "url": "/api/sms/accounts/{id}/users",
22337     "title": "Removes agents from a sms account",
22338     "examples": [
22339       {
22340         "title": "Example usage:",
22341         "content": "curl https://{domain}/api/sms/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22342         "type": "json"
22343       }
22344     ],
22345     "name": "RemoveAgents",
22346     "group": "Sms_Accounts",
22347     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22348     "version": "0.0.0",
22349     "filename": "server/api/smsAccount/index.js",
22350     "groupTitle": "Sms_Accounts"
22351   },
22352   {
22353     "type": "delete",
22354     "url": "/api/sms/accounts/{id}/canned_answers",
22355     "title": "Removes canned answers from account",
22356     "examples": [
22357       {
22358         "title": "Example usage:",
22359         "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22360         "type": "json"
22361       }
22362     ],
22363     "name": "RemoveAnswers",
22364     "group": "Sms_Accounts",
22365     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22366     "version": "0.0.0",
22367     "filename": "server/api/smsAccount/index.js",
22368     "groupTitle": "Sms_Accounts"
22369   },
22370   {
22371     "type": "delete",
22372     "url": "/api/sms/accounts/{id}/dispositions",
22373     "title": "Removes dispositions from account",
22374     "examples": [
22375       {
22376         "title": "Example usage:",
22377         "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22378         "type": "json"
22379       }
22380     ],
22381     "name": "RemoveDispositions",
22382     "group": "Sms_Accounts",
22383     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22384     "version": "0.0.0",
22385     "filename": "server/api/smsAccount/index.js",
22386     "groupTitle": "Sms_Accounts"
22387   },
22388   {
22389     "type": "get",
22390     "url": "/api/sms/accounts/{id}",
22391     "title": "Gets a single Account",
22392     "examples": [
22393       {
22394         "title": "Example usage:",
22395         "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password}",
22396         "type": "json"
22397       }
22398     ],
22399     "name": "ShowAccounts",
22400     "group": "Sms_Accounts",
22401     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22402     "version": "0.0.0",
22403     "filename": "server/api/smsAccount/index.js",
22404     "groupTitle": "Sms_Accounts"
22405   },
22406   {
22407     "type": "put",
22408     "url": "/api/sms/messages/{id}/accept",
22409     "title": "Accepts message",
22410     "examples": [
22411       {
22412         "title": "Example usage:",
22413         "content": "curl https://{domain}/api/sms/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
22414         "type": "json"
22415       }
22416     ],
22417     "name": "acceptMessage",
22418     "group": "Sms_Accounts",
22419     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22420     "version": "0.0.0",
22421     "filename": "server/api/smsMessage/index.js",
22422     "groupTitle": "Sms_Accounts"
22423   },
22424   {
22425     "type": "post",
22426     "url": "/api/sms/accounts/{id}/canned_answers",
22427     "title": "Creates new canned answer",
22428     "examples": [
22429       {
22430         "title": "Example usage:",
22431         "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",
22432         "type": "json"
22433       }
22434     ],
22435     "name": "addAnswer",
22436     "group": "Sms_Accounts",
22437     "parameter": {
22438       "fields": {
22439         "Body": [
22440           {
22441             "group": "Body",
22442             "type": "String",
22443             "optional": false,
22444             "field": "key",
22445             "description": ""
22446           },
22447           {
22448             "group": "Body",
22449             "type": "Text",
22450             "optional": false,
22451             "field": "value",
22452             "description": ""
22453           },
22454           {
22455             "group": "Body",
22456             "type": "String",
22457             "optional": true,
22458             "field": "description",
22459             "description": ""
22460           },
22461           {
22462             "group": "Body",
22463             "type": "Virtual",
22464             "optional": true,
22465             "field": "name",
22466             "description": ""
22467           }
22468         ]
22469       }
22470     },
22471     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22472     "version": "0.0.0",
22473     "filename": "server/api/smsAccount/index.js",
22474     "groupTitle": "Sms_Accounts"
22475   },
22476   {
22477     "type": "post",
22478     "url": "/api/sms/accounts/{id}/applications",
22479     "title": "Creates new applications",
22480     "examples": [
22481       {
22482         "title": "Example usage:",
22483         "content": "curl https://{domain}/api/sms/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
22484         "type": "json"
22485       }
22486     ],
22487     "name": "addApplications",
22488     "group": "Sms_Accounts",
22489     "parameter": {
22490       "fields": {
22491         "Body": [
22492           {
22493             "group": "Body",
22494             "type": "Integer",
22495             "optional": false,
22496             "field": "priority",
22497             "description": ""
22498           },
22499           {
22500             "group": "Body",
22501             "type": "String",
22502             "optional": false,
22503             "field": "app",
22504             "description": ""
22505           },
22506           {
22507             "group": "Body",
22508             "type": "Text",
22509             "optional": true,
22510             "field": "appdata",
22511             "description": ""
22512           },
22513           {
22514             "group": "Body",
22515             "type": "String",
22516             "optional": true,
22517             "field": "description",
22518             "description": ""
22519           },
22520           {
22521             "group": "Body",
22522             "type": "String",
22523             "optional": true,
22524             "field": "interval",
22525             "description": ""
22526           }
22527         ]
22528       }
22529     },
22530     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22531     "version": "0.0.0",
22532     "filename": "server/api/smsAccount/index.js",
22533     "groupTitle": "Sms_Accounts"
22534   },
22535   {
22536     "type": "post",
22537     "url": "/api/sms/accounts/{id}/dispositions",
22538     "title": "Creates new disposition",
22539     "examples": [
22540       {
22541         "title": "Example usage:",
22542         "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
22543         "type": "json"
22544       }
22545     ],
22546     "name": "addDisposition",
22547     "group": "Sms_Accounts",
22548     "parameter": {
22549       "fields": {
22550         "Body": [
22551           {
22552             "group": "Body",
22553             "type": "String",
22554             "optional": false,
22555             "field": "name",
22556             "description": ""
22557           },
22558           {
22559             "group": "Body",
22560             "type": "String",
22561             "allowedValues": [
22562               "\"first\"",
22563               "\"second\"",
22564               "\"third\""
22565             ],
22566             "optional": false,
22567             "field": "level",
22568             "description": ""
22569           },
22570           {
22571             "group": "Body",
22572             "type": "String",
22573             "optional": true,
22574             "field": "description",
22575             "description": ""
22576           }
22577         ]
22578       }
22579     },
22580     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22581     "version": "0.0.0",
22582     "filename": "server/api/smsAccount/index.js",
22583     "groupTitle": "Sms_Accounts"
22584   },
22585   {
22586     "type": "get",
22587     "url": "/api/sms/accounts/{id}/canned_answers",
22588     "title": "Gets account canned answers",
22589     "examples": [
22590       {
22591         "title": "Example usage:",
22592         "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
22593         "type": "json"
22594       }
22595     ],
22596     "name": "getAnswers",
22597     "group": "Sms_Accounts",
22598     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22599     "version": "0.0.0",
22600     "filename": "server/api/smsAccount/index.js",
22601     "groupTitle": "Sms_Accounts"
22602   },
22603   {
22604     "type": "get",
22605     "url": "/api/sms/accounts/{id}/applications",
22606     "title": "Gets account applications",
22607     "examples": [
22608       {
22609         "title": "Example usage:",
22610         "content": "curl https://{domain}/api/sms/accounts/{id}/applications -v -u {name}:{password} -X GET",
22611         "type": "json"
22612       }
22613     ],
22614     "name": "getApplications",
22615     "group": "Sms_Accounts",
22616     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22617     "version": "0.0.0",
22618     "filename": "server/api/smsAccount/index.js",
22619     "groupTitle": "Sms_Accounts"
22620   },
22621   {
22622     "type": "get",
22623     "url": "/api/sms/accounts/{id}/dispositions",
22624     "title": "Gets account dispositions",
22625     "examples": [
22626       {
22627         "title": "Example usage:",
22628         "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
22629         "type": "json"
22630       }
22631     ],
22632     "name": "getDispositions",
22633     "group": "Sms_Accounts",
22634     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22635     "version": "0.0.0",
22636     "filename": "server/api/smsAccount/index.js",
22637     "groupTitle": "Sms_Accounts"
22638   },
22639   {
22640     "type": "get",
22641     "url": "/api/sms/accounts/{id}/interactions",
22642     "title": "Gets Sms Account interactions",
22643     "examples": [
22644       {
22645         "title": "Example usage:",
22646         "content": "curl https://{domain}/api/sms/accounts/{id}/interactions -v -u {name}:{password} -X GET",
22647         "type": "json"
22648       }
22649     ],
22650     "name": "getInteractions",
22651     "group": "Sms_Accounts",
22652     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22653     "version": "0.0.0",
22654     "filename": "server/api/smsAccount/index.js",
22655     "groupTitle": "Sms_Accounts"
22656   },
22657   {
22658     "type": "post",
22659     "url": "/api/sms/accounts/{id}/notify",
22660     "title": "Notify new message",
22661     "examples": [
22662       {
22663         "title": "Example usage:",
22664         "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",
22665         "type": "json"
22666       }
22667     ],
22668     "name": "notify",
22669     "group": "Sms_Accounts",
22670     "description": "<p>Motion 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>",
22671     "version": "0.0.0",
22672     "filename": "server/api/smsAccount/index.js",
22673     "groupTitle": "Sms_Accounts"
22674   },
22675   {
22676     "type": "put",
22677     "url": "/api/sms/messages/{id}/reject",
22678     "title": "Rejects message",
22679     "examples": [
22680       {
22681         "title": "Example usage:",
22682         "content": "curl https://{domain}/api/sms/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
22683         "type": "json"
22684       }
22685     ],
22686     "name": "rejectMessage",
22687     "group": "Sms_Accounts",
22688     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22689     "version": "0.0.0",
22690     "filename": "server/api/smsMessage/index.js",
22691     "groupTitle": "Sms_Accounts"
22692   },
22693   {
22694     "type": "post",
22695     "url": "/api/sms/accounts/{id}/send",
22696     "title": "Send new sms message",
22697     "examples": [
22698       {
22699         "title": "Example usage:",
22700         "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",
22701         "type": "json"
22702       }
22703     ],
22704     "name": "sendSms",
22705     "group": "Sms_Accounts",
22706     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22707     "version": "0.0.0",
22708     "filename": "server/api/smsAccount/index.js",
22709     "groupTitle": "Sms_Accounts"
22710   },
22711   {
22712     "type": "get",
22713     "url": "/api/sms/accounts/{id}/status",
22714     "title": "Receive message status as get request",
22715     "examples": [
22716       {
22717         "title": "Example usage:",
22718         "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X GET",
22719         "type": "json"
22720       }
22721     ],
22722     "name": "statusMessage",
22723     "group": "Sms_Accounts",
22724     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22725     "version": "0.0.0",
22726     "filename": "server/api/smsAccount/index.js",
22727     "groupTitle": "Sms_Accounts"
22728   },
22729   {
22730     "type": "post",
22731     "url": "/api/sms/messages/{id}/status",
22732     "title": "Receive message status",
22733     "examples": [
22734       {
22735         "title": "Example usage:",
22736         "content": "curl https://{domain}/api/sms/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
22737         "type": "json"
22738       }
22739     ],
22740     "name": "statusMessage",
22741     "group": "Sms_Accounts",
22742     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22743     "version": "0.0.0",
22744     "filename": "server/api/smsMessage/index.js",
22745     "groupTitle": "Sms_Accounts"
22746   },
22747   {
22748     "type": "post",
22749     "url": "/api/sms/accounts/{id}/status",
22750     "title": "Receive message status",
22751     "examples": [
22752       {
22753         "title": "Example usage:",
22754         "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X POST",
22755         "type": "json"
22756       }
22757     ],
22758     "name": "statusMessage",
22759     "group": "Sms_Accounts",
22760     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22761     "version": "0.0.0",
22762     "filename": "server/api/smsAccount/index.js",
22763     "groupTitle": "Sms_Accounts"
22764   },
22765   {
22766     "type": "put",
22767     "url": "/api/sms/accounts/{id}",
22768     "title": "Update an existing Account",
22769     "examples": [
22770       {
22771         "title": "Example usage:",
22772         "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",
22773         "type": "json"
22774       }
22775     ],
22776     "name": "updateAccounts",
22777     "group": "Sms_Accounts",
22778     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22779     "version": "0.0.0",
22780     "filename": "server/api/smsAccount/index.js",
22781     "groupTitle": "Sms_Accounts"
22782   },
22783   {
22784     "type": "post",
22785     "url": "/api/sms/applications",
22786     "title": "Creates a new Application",
22787     "examples": [
22788       {
22789         "title": "Example usage:",
22790         "content": "curl https://{domain}/api/sms/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22791         "type": "json"
22792       }
22793     ],
22794     "name": "CreateApplications",
22795     "group": "Sms_Applications",
22796     "parameter": {
22797       "fields": {
22798         "Body": [
22799           {
22800             "group": "Body",
22801             "type": "Integer",
22802             "optional": false,
22803             "field": "priority",
22804             "description": ""
22805           },
22806           {
22807             "group": "Body",
22808             "type": "String",
22809             "optional": false,
22810             "field": "app",
22811             "description": ""
22812           },
22813           {
22814             "group": "Body",
22815             "type": "Text",
22816             "optional": true,
22817             "field": "appdata",
22818             "description": ""
22819           },
22820           {
22821             "group": "Body",
22822             "type": "String",
22823             "optional": true,
22824             "field": "description",
22825             "description": ""
22826           },
22827           {
22828             "group": "Body",
22829             "type": "String",
22830             "optional": true,
22831             "field": "interval",
22832             "description": ""
22833           }
22834         ]
22835       }
22836     },
22837     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22838     "version": "0.0.0",
22839     "filename": "server/api/smsApplication/index.js",
22840     "groupTitle": "Sms_Applications"
22841   },
22842   {
22843     "type": "delete",
22844     "url": "/api/sms/applications/{id}",
22845     "title": "Deletes a Application",
22846     "examples": [
22847       {
22848         "title": "Example usage:",
22849         "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password} -X DELETE",
22850         "type": "json"
22851       }
22852     ],
22853     "name": "DeleteApplications",
22854     "group": "Sms_Applications",
22855     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22856     "version": "0.0.0",
22857     "filename": "server/api/smsApplication/index.js",
22858     "groupTitle": "Sms_Applications"
22859   },
22860   {
22861     "type": "get",
22862     "url": "/api/sms/applications",
22863     "title": "Gets a list of Applications",
22864     "examples": [
22865       {
22866         "title": "Example usage:",
22867         "content": "curl https://{domain}/api/sms/applications -v -u {name}:{password}",
22868         "type": "json"
22869       }
22870     ],
22871     "name": "GetApplications",
22872     "group": "Sms_Applications",
22873     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22874     "version": "0.0.0",
22875     "filename": "server/api/smsApplication/index.js",
22876     "groupTitle": "Sms_Applications"
22877   },
22878   {
22879     "type": "get",
22880     "url": "/api/sms/applications/{id}",
22881     "title": "Gets a single Application",
22882     "examples": [
22883       {
22884         "title": "Example usage:",
22885         "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password}",
22886         "type": "json"
22887       }
22888     ],
22889     "name": "ShowApplications",
22890     "group": "Sms_Applications",
22891     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22892     "version": "0.0.0",
22893     "filename": "server/api/smsApplication/index.js",
22894     "groupTitle": "Sms_Applications"
22895   },
22896   {
22897     "type": "put",
22898     "url": "/api/sms/applications/{id}",
22899     "title": "Update an existing Application",
22900     "examples": [
22901       {
22902         "title": "Example usage:",
22903         "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",
22904         "type": "json"
22905       }
22906     ],
22907     "name": "updateApplications",
22908     "group": "Sms_Applications",
22909     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22910     "version": "0.0.0",
22911     "filename": "server/api/smsApplication/index.js",
22912     "groupTitle": "Sms_Applications"
22913   },
22914   {
22915     "type": "post",
22916     "url": "/api/sms/interactions/{id}/tags",
22917     "title": "Add tags to the interaction",
22918     "examples": [
22919       {
22920         "title": "Example usage:",
22921         "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",
22922         "type": "json"
22923       }
22924     ],
22925     "name": "AddTags",
22926     "group": "Sms_Interactions",
22927     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22928     "version": "0.0.0",
22929     "filename": "server/api/smsInteraction/index.js",
22930     "groupTitle": "Sms_Interactions"
22931   },
22932   {
22933     "type": "post",
22934     "url": "/api/sms/interactions",
22935     "title": "Creates a new Interaction",
22936     "examples": [
22937       {
22938         "title": "Example usage:",
22939         "content": "curl https://{domain}/api/sms/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22940         "type": "json"
22941       }
22942     ],
22943     "name": "CreateInteractions",
22944     "group": "Sms_Interactions",
22945     "parameter": {
22946       "fields": {
22947         "Body": [
22948           {
22949             "group": "Body",
22950             "type": "Boolean",
22951             "optional": true,
22952             "field": "closed",
22953             "description": ""
22954           },
22955           {
22956             "group": "Body",
22957             "type": "String",
22958             "optional": true,
22959             "field": "closedAt",
22960             "description": ""
22961           },
22962           {
22963             "group": "Body",
22964             "type": "String",
22965             "optional": true,
22966             "field": "disposition",
22967             "description": ""
22968           },
22969           {
22970             "group": "Body",
22971             "type": "String",
22972             "optional": true,
22973             "field": "secondDisposition",
22974             "description": ""
22975           },
22976           {
22977             "group": "Body",
22978             "type": "String",
22979             "optional": true,
22980             "field": "thirdDisposition",
22981             "description": ""
22982           },
22983           {
22984             "group": "Body",
22985             "type": "String",
22986             "optional": true,
22987             "field": "note",
22988             "description": ""
22989           },
22990           {
22991             "group": "Body",
22992             "type": "String",
22993             "optional": true,
22994             "field": "phone",
22995             "description": ""
22996           },
22997           {
22998             "group": "Body",
22999             "type": "String",
23000             "optional": true,
23001             "field": "read1stAt",
23002             "description": ""
23003           },
23004           {
23005             "group": "Body",
23006             "type": "String",
23007             "allowedValues": [
23008               "\"in\"",
23009               "\"out\""
23010             ],
23011             "optional": false,
23012             "field": "firstMsgDirection",
23013             "description": ""
23014           },
23015           {
23016             "group": "Body",
23017             "type": "String",
23018             "optional": true,
23019             "field": "lastMsgAt",
23020             "description": ""
23021           },
23022           {
23023             "group": "Body",
23024             "type": "String",
23025             "allowedValues": [
23026               "\"in\"",
23027               "\"out\""
23028             ],
23029             "optional": false,
23030             "field": "lastMsgDirection",
23031             "description": ""
23032           }
23033         ]
23034       }
23035     },
23036     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23037     "version": "0.0.0",
23038     "filename": "server/api/smsInteraction/index.js",
23039     "groupTitle": "Sms_Interactions"
23040   },
23041   {
23042     "type": "delete",
23043     "url": "/api/sms/interactions/{id}",
23044     "title": "Deletes a Interaction",
23045     "examples": [
23046       {
23047         "title": "Example usage:",
23048         "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password} -X DELETE",
23049         "type": "json"
23050       }
23051     ],
23052     "name": "DeleteInteractions",
23053     "group": "Sms_Interactions",
23054     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23055     "version": "0.0.0",
23056     "filename": "server/api/smsInteraction/index.js",
23057     "groupTitle": "Sms_Interactions"
23058   },
23059   {
23060     "type": "get",
23061     "url": "/api/sms/interactions/describe",
23062     "title": "Gets table info about Interactions",
23063     "examples": [
23064       {
23065         "title": "Example usage:",
23066         "content": "curl https://{domain}/api/sms/interactions/describe -v -u {name}:{password}",
23067         "type": "json"
23068       }
23069     ],
23070     "name": "DescribeInteractions",
23071     "group": "Sms_Interactions",
23072     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23073     "version": "0.0.0",
23074     "filename": "server/api/smsInteraction/index.js",
23075     "groupTitle": "Sms_Interactions"
23076   },
23077   {
23078     "type": "get",
23079     "url": "/api/sms/interactions",
23080     "title": "Gets a list of Interactions",
23081     "examples": [
23082       {
23083         "title": "Example usage:",
23084         "content": "curl https://{domain}/api/sms/interactions -v -u {name}:{password}",
23085         "type": "json"
23086       }
23087     ],
23088     "name": "GetInteractions",
23089     "group": "Sms_Interactions",
23090     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23091     "version": "0.0.0",
23092     "filename": "server/api/smsInteraction/index.js",
23093     "groupTitle": "Sms_Interactions"
23094   },
23095   {
23096     "type": "delete",
23097     "url": "/api/sms/interactions/{id}/tags",
23098     "title": "Removes tags from interaction",
23099     "examples": [
23100       {
23101         "title": "Example usage:",
23102         "content": "curl https://{domain}/api/sms/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
23103         "type": "json"
23104       }
23105     ],
23106     "name": "RemoveTags",
23107     "group": "Sms_Interactions",
23108     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23109     "version": "0.0.0",
23110     "filename": "server/api/smsInteraction/index.js",
23111     "groupTitle": "Sms_Interactions"
23112   },
23113   {
23114     "type": "get",
23115     "url": "/api/sms/interactions/{id}",
23116     "title": "Gets a single Interaction",
23117     "examples": [
23118       {
23119         "title": "Example usage:",
23120         "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password}",
23121         "type": "json"
23122       }
23123     ],
23124     "name": "ShowInteractions",
23125     "group": "Sms_Interactions",
23126     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23127     "version": "0.0.0",
23128     "filename": "server/api/smsInteraction/index.js",
23129     "groupTitle": "Sms_Interactions"
23130   },
23131   {
23132     "type": "post",
23133     "url": "/api/sms/interactions/{id}/messages",
23134     "title": "Creates new messages",
23135     "examples": [
23136       {
23137         "title": "Example usage:",
23138         "content": "curl https://{domain}/api/sms/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
23139         "type": "json"
23140       }
23141     ],
23142     "name": "addMessage",
23143     "group": "Sms_Interactions",
23144     "parameter": {
23145       "fields": {
23146         "Body": [
23147           {
23148             "group": "Body",
23149             "type": "Text",
23150             "optional": false,
23151             "field": "body",
23152             "description": ""
23153           },
23154           {
23155             "group": "Body",
23156             "type": "Boolean",
23157             "optional": true,
23158             "field": "read",
23159             "description": ""
23160           },
23161           {
23162             "group": "Body",
23163             "type": "String",
23164             "allowedValues": [
23165               "\"in\"",
23166               "\"out\""
23167             ],
23168             "optional": false,
23169             "field": "direction",
23170             "description": ""
23171           },
23172           {
23173             "group": "Body",
23174             "type": "String",
23175             "optional": true,
23176             "field": "messageId",
23177             "description": ""
23178           },
23179           {
23180             "group": "Body",
23181             "type": "String",
23182             "optional": true,
23183             "field": "phone",
23184             "description": ""
23185           },
23186           {
23187             "group": "Body",
23188             "type": "String",
23189             "optional": true,
23190             "field": "readAt",
23191             "description": ""
23192           },
23193           {
23194             "group": "Body",
23195             "type": "Boolean",
23196             "optional": true,
23197             "field": "secret",
23198             "description": ""
23199           },
23200           {
23201             "group": "Body",
23202             "type": "String",
23203             "optional": true,
23204             "field": "providerName",
23205             "description": ""
23206           },
23207           {
23208             "group": "Body",
23209             "type": "Text",
23210             "optional": true,
23211             "field": "providerResponse",
23212             "description": ""
23213           }
23214         ]
23215       }
23216     },
23217     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23218     "version": "0.0.0",
23219     "filename": "server/api/smsInteraction/index.js",
23220     "groupTitle": "Sms_Interactions"
23221   },
23222   {
23223     "type": "get",
23224     "url": "/api/sms/interactions/{id}/download",
23225     "title": "Gets interaction",
23226     "examples": [
23227       {
23228         "title": "Example usage:",
23229         "content": "curl https://{domain}/api/sms/interactions/{id}/download -v -u {name}:{password} -X GET",
23230         "type": "json"
23231       }
23232     ],
23233     "name": "download",
23234     "group": "Sms_Interactions",
23235     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23236     "version": "0.0.0",
23237     "filename": "server/api/smsInteraction/index.js",
23238     "groupTitle": "Sms_Interactions"
23239   },
23240   {
23241     "type": "get",
23242     "url": "/api/sms/interactions/{id}/messages",
23243     "title": "Gets interaction messages",
23244     "examples": [
23245       {
23246         "title": "Example usage:",
23247         "content": "curl https://{domain}/api/sms/interactions/{id}/messages -v -u {name}:{password} -X GET",
23248         "type": "json"
23249       }
23250     ],
23251     "name": "getMessages",
23252     "group": "Sms_Interactions",
23253     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23254     "version": "0.0.0",
23255     "filename": "server/api/smsInteraction/index.js",
23256     "groupTitle": "Sms_Interactions"
23257   },
23258   {
23259     "type": "put",
23260     "url": "/api/sms/interactions/{id}",
23261     "title": "Update an existing Interaction",
23262     "examples": [
23263       {
23264         "title": "Example usage:",
23265         "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",
23266         "type": "json"
23267       }
23268     ],
23269     "name": "updateInteractions",
23270     "group": "Sms_Interactions",
23271     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23272     "version": "0.0.0",
23273     "filename": "server/api/smsInteraction/index.js",
23274     "groupTitle": "Sms_Interactions"
23275   },
23276   {
23277     "type": "post",
23278     "url": "/api/sms/messages",
23279     "title": "Creates a new Message",
23280     "examples": [
23281       {
23282         "title": "Example usage:",
23283         "content": "curl https://{domain}/api/sms/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23284         "type": "json"
23285       }
23286     ],
23287     "name": "CreateMessages",
23288     "group": "Sms_Messages",
23289     "parameter": {
23290       "fields": {
23291         "Body": [
23292           {
23293             "group": "Body",
23294             "type": "Text",
23295             "optional": false,
23296             "field": "body",
23297             "description": ""
23298           },
23299           {
23300             "group": "Body",
23301             "type": "Boolean",
23302             "optional": true,
23303             "field": "read",
23304             "description": ""
23305           },
23306           {
23307             "group": "Body",
23308             "type": "String",
23309             "allowedValues": [
23310               "\"in\"",
23311               "\"out\""
23312             ],
23313             "optional": false,
23314             "field": "direction",
23315             "description": ""
23316           },
23317           {
23318             "group": "Body",
23319             "type": "String",
23320             "optional": true,
23321             "field": "messageId",
23322             "description": ""
23323           },
23324           {
23325             "group": "Body",
23326             "type": "String",
23327             "optional": true,
23328             "field": "phone",
23329             "description": ""
23330           },
23331           {
23332             "group": "Body",
23333             "type": "String",
23334             "optional": true,
23335             "field": "readAt",
23336             "description": ""
23337           },
23338           {
23339             "group": "Body",
23340             "type": "Boolean",
23341             "optional": true,
23342             "field": "secret",
23343             "description": ""
23344           },
23345           {
23346             "group": "Body",
23347             "type": "String",
23348             "optional": true,
23349             "field": "providerName",
23350             "description": ""
23351           },
23352           {
23353             "group": "Body",
23354             "type": "Text",
23355             "optional": true,
23356             "field": "providerResponse",
23357             "description": ""
23358           }
23359         ]
23360       }
23361     },
23362     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23363     "version": "0.0.0",
23364     "filename": "server/api/smsMessage/index.js",
23365     "groupTitle": "Sms_Messages"
23366   },
23367   {
23368     "type": "delete",
23369     "url": "/api/sms/messages/{id}",
23370     "title": "Deletes a Message",
23371     "examples": [
23372       {
23373         "title": "Example usage:",
23374         "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password} -X DELETE",
23375         "type": "json"
23376       }
23377     ],
23378     "name": "DeleteMessages",
23379     "group": "Sms_Messages",
23380     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23381     "version": "0.0.0",
23382     "filename": "server/api/smsMessage/index.js",
23383     "groupTitle": "Sms_Messages"
23384   },
23385   {
23386     "type": "get",
23387     "url": "/api/sms/messages/describe",
23388     "title": "Gets table info about Messages",
23389     "examples": [
23390       {
23391         "title": "Example usage:",
23392         "content": "curl https://{domain}/api/sms/messages/describe -v -u {name}:{password}",
23393         "type": "json"
23394       }
23395     ],
23396     "name": "DescribeMessages",
23397     "group": "Sms_Messages",
23398     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23399     "version": "0.0.0",
23400     "filename": "server/api/smsMessage/index.js",
23401     "groupTitle": "Sms_Messages"
23402   },
23403   {
23404     "type": "get",
23405     "url": "/api/sms/messages",
23406     "title": "Gets a list of Messages",
23407     "examples": [
23408       {
23409         "title": "Example usage:",
23410         "content": "curl https://{domain}/api/sms/messages -v -u {name}:{password}",
23411         "type": "json"
23412       }
23413     ],
23414     "name": "GetMessages",
23415     "group": "Sms_Messages",
23416     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23417     "version": "0.0.0",
23418     "filename": "server/api/smsMessage/index.js",
23419     "groupTitle": "Sms_Messages"
23420   },
23421   {
23422     "type": "get",
23423     "url": "/api/sms/messages/{id}",
23424     "title": "Gets a single Message",
23425     "examples": [
23426       {
23427         "title": "Example usage:",
23428         "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password}",
23429         "type": "json"
23430       }
23431     ],
23432     "name": "ShowMessages",
23433     "group": "Sms_Messages",
23434     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23435     "version": "0.0.0",
23436     "filename": "server/api/smsMessage/index.js",
23437     "groupTitle": "Sms_Messages"
23438   },
23439   {
23440     "type": "put",
23441     "url": "/api/sms/messages/{id}",
23442     "title": "Update an existing Message",
23443     "examples": [
23444       {
23445         "title": "Example usage:",
23446         "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",
23447         "type": "json"
23448       }
23449     ],
23450     "name": "updateMessages",
23451     "group": "Sms_Messages",
23452     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23453     "version": "0.0.0",
23454     "filename": "server/api/smsMessage/index.js",
23455     "groupTitle": "Sms_Messages"
23456   },
23457   {
23458     "type": "post",
23459     "url": "/api/sms/reports/queue",
23460     "title": "Creates a new Sms Queue Report",
23461     "examples": [
23462       {
23463         "title": "Example usage:",
23464         "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",
23465         "type": "json"
23466       }
23467     ],
23468     "name": "CreateSms_Queue_Reports",
23469     "group": "Sms_Queue_Reports",
23470     "parameter": {
23471       "fields": {
23472         "Body": [
23473           {
23474             "group": "Body",
23475             "type": "String",
23476             "optional": false,
23477             "field": "uniqueid",
23478             "description": ""
23479           },
23480           {
23481             "group": "Body",
23482             "type": "String",
23483             "optional": true,
23484             "field": "from",
23485             "description": ""
23486           },
23487           {
23488             "group": "Body",
23489             "type": "String",
23490             "optional": true,
23491             "field": "joinAt",
23492             "description": ""
23493           },
23494           {
23495             "group": "Body",
23496             "type": "String",
23497             "optional": true,
23498             "field": "leaveAt",
23499             "description": ""
23500           },
23501           {
23502             "group": "Body",
23503             "type": "String",
23504             "optional": true,
23505             "field": "acceptAt",
23506             "description": ""
23507           },
23508           {
23509             "group": "Body",
23510             "type": "String",
23511             "optional": true,
23512             "field": "exitAt",
23513             "description": ""
23514           },
23515           {
23516             "group": "Body",
23517             "type": "String",
23518             "optional": true,
23519             "field": "reason",
23520             "description": ""
23521           }
23522         ]
23523       }
23524     },
23525     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23526     "version": "0.0.0",
23527     "filename": "server/api/smsQueueReport/index.js",
23528     "groupTitle": "Sms_Queue_Reports"
23529   },
23530   {
23531     "type": "delete",
23532     "url": "/api/sms/reports/queue/{id}",
23533     "title": "Deletes a Sms Queue Report",
23534     "examples": [
23535       {
23536         "title": "Example usage:",
23537         "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password} -X DELETE",
23538         "type": "json"
23539       }
23540     ],
23541     "name": "DeleteSms_Queue_Reports",
23542     "group": "Sms_Queue_Reports",
23543     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23544     "version": "0.0.0",
23545     "filename": "server/api/smsQueueReport/index.js",
23546     "groupTitle": "Sms_Queue_Reports"
23547   },
23548   {
23549     "type": "get",
23550     "url": "/api/sms/reports/queue/describe",
23551     "title": "Gets table info about Sms Queue Reports",
23552     "examples": [
23553       {
23554         "title": "Example usage:",
23555         "content": "curl https://{domain}/api/sms/reports/queue/describe -v -u {name}:{password}",
23556         "type": "json"
23557       }
23558     ],
23559     "name": "DescribeSms_Queue_Reports",
23560     "group": "Sms_Queue_Reports",
23561     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23562     "version": "0.0.0",
23563     "filename": "server/api/smsQueueReport/index.js",
23564     "groupTitle": "Sms_Queue_Reports"
23565   },
23566   {
23567     "type": "get",
23568     "url": "/api/sms/reports/queue",
23569     "title": "Gets a list of Sms Queue Reports",
23570     "examples": [
23571       {
23572         "title": "Example usage:",
23573         "content": "curl https://{domain}/api/sms/reports/queue -v -u {name}:{password}",
23574         "type": "json"
23575       }
23576     ],
23577     "name": "GetSms_Queue_Reports",
23578     "group": "Sms_Queue_Reports",
23579     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23580     "version": "0.0.0",
23581     "filename": "server/api/smsQueueReport/index.js",
23582     "groupTitle": "Sms_Queue_Reports"
23583   },
23584   {
23585     "type": "get",
23586     "url": "/api/sms/reports/queue/{id}",
23587     "title": "Gets a single Sms Queue Report",
23588     "examples": [
23589       {
23590         "title": "Example usage:",
23591         "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password}",
23592         "type": "json"
23593       }
23594     ],
23595     "name": "ShowSms_Queue_Reports",
23596     "group": "Sms_Queue_Reports",
23597     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23598     "version": "0.0.0",
23599     "filename": "server/api/smsQueueReport/index.js",
23600     "groupTitle": "Sms_Queue_Reports"
23601   },
23602   {
23603     "type": "put",
23604     "url": "/api/sms/reports/queue/{id}",
23605     "title": "Update an existing Sms Queue Report",
23606     "examples": [
23607       {
23608         "title": "Example usage:",
23609         "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",
23610         "type": "json"
23611       }
23612     ],
23613     "name": "updateSms_Queue_Reports",
23614     "group": "Sms_Queue_Reports",
23615     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23616     "version": "0.0.0",
23617     "filename": "server/api/smsQueueReport/index.js",
23618     "groupTitle": "Sms_Queue_Reports"
23619   },
23620   {
23621     "type": "post",
23622     "url": "/api/sms/queues/{id}/users",
23623     "title": "Add agents to a queue",
23624     "examples": [
23625       {
23626         "title": "Example usage:",
23627         "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",
23628         "type": "json"
23629       }
23630     ],
23631     "name": "AddAgents",
23632     "group": "Sms_Queues",
23633     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23634     "version": "0.0.0",
23635     "filename": "server/api/smsQueue/index.js",
23636     "groupTitle": "Sms_Queues"
23637   },
23638   {
23639     "type": "post",
23640     "url": "/api/sms/queues/{id}/teams",
23641     "title": "Add teams to a queue",
23642     "examples": [
23643       {
23644         "title": "Example usage:",
23645         "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",
23646         "type": "json"
23647       }
23648     ],
23649     "name": "AddTeams",
23650     "group": "Sms_Queues",
23651     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23652     "version": "0.0.0",
23653     "filename": "server/api/smsQueue/index.js",
23654     "groupTitle": "Sms_Queues"
23655   },
23656   {
23657     "type": "post",
23658     "url": "/api/sms/queues",
23659     "title": "Creates a new Queue",
23660     "examples": [
23661       {
23662         "title": "Example usage:",
23663         "content": "curl https://{domain}/api/sms/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23664         "type": "json"
23665       }
23666     ],
23667     "name": "CreateQueues",
23668     "group": "Sms_Queues",
23669     "parameter": {
23670       "fields": {
23671         "Body": [
23672           {
23673             "group": "Body",
23674             "type": "String",
23675             "optional": true,
23676             "field": "name",
23677             "description": ""
23678           },
23679           {
23680             "group": "Body",
23681             "type": "String",
23682             "optional": true,
23683             "field": "description",
23684             "description": ""
23685           },
23686           {
23687             "group": "Body",
23688             "type": "Integer",
23689             "optional": true,
23690             "field": "timeout",
23691             "description": ""
23692           },
23693           {
23694             "group": "Body",
23695             "type": "String",
23696             "allowedValues": [
23697               "\"rrmemory\"",
23698               "\"beepall\"",
23699               "\"roundrobin\""
23700             ],
23701             "optional": true,
23702             "field": "strategy",
23703             "description": ""
23704           }
23705         ]
23706       }
23707     },
23708     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23709     "version": "0.0.0",
23710     "filename": "server/api/smsQueue/index.js",
23711     "groupTitle": "Sms_Queues"
23712   },
23713   {
23714     "type": "delete",
23715     "url": "/api/sms/queues/{id}",
23716     "title": "Deletes a Queue",
23717     "examples": [
23718       {
23719         "title": "Example usage:",
23720         "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password} -X DELETE",
23721         "type": "json"
23722       }
23723     ],
23724     "name": "DeleteQueues",
23725     "group": "Sms_Queues",
23726     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23727     "version": "0.0.0",
23728     "filename": "server/api/smsQueue/index.js",
23729     "groupTitle": "Sms_Queues"
23730   },
23731   {
23732     "type": "get",
23733     "url": "/api/sms/queues/describe",
23734     "title": "Gets table info about Queues",
23735     "examples": [
23736       {
23737         "title": "Example usage:",
23738         "content": "curl https://{domain}/api/sms/queues/describe -v -u {name}:{password}",
23739         "type": "json"
23740       }
23741     ],
23742     "name": "DescribeQueues",
23743     "group": "Sms_Queues",
23744     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23745     "version": "0.0.0",
23746     "filename": "server/api/smsQueue/index.js",
23747     "groupTitle": "Sms_Queues"
23748   },
23749   {
23750     "type": "get",
23751     "url": "/api/sms/queues/{id}/users",
23752     "title": "Gets queue agents",
23753     "examples": [
23754       {
23755         "title": "Example usage:",
23756         "content": "curl https://{domain}/api/sms/queues/{id}/users -v -u {name}:{password} -X POST",
23757         "type": "json"
23758       }
23759     ],
23760     "name": "GetAgents",
23761     "group": "Sms_Queues",
23762     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23763     "version": "0.0.0",
23764     "filename": "server/api/smsQueue/index.js",
23765     "groupTitle": "Sms_Queues"
23766   },
23767   {
23768     "type": "get",
23769     "url": "/api/sms/queues/{id}/members",
23770     "title": "GetMembers",
23771     "examples": [
23772       {
23773         "title": "Example usage:",
23774         "content": "curl https://{domain}/api/sms/queues/{id}/members  -v -u {name}:{password}",
23775         "type": "json"
23776       }
23777     ],
23778     "name": "GetMembers",
23779     "group": "Sms_Queues",
23780     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23781     "version": "0.0.0",
23782     "filename": "server/api/smsQueue/index.js",
23783     "groupTitle": "Sms_Queues"
23784   },
23785   {
23786     "type": "get",
23787     "url": "/api/sms/queues",
23788     "title": "Gets a list of Queues",
23789     "examples": [
23790       {
23791         "title": "Example usage:",
23792         "content": "curl https://{domain}/api/sms/queues -v -u {name}:{password}",
23793         "type": "json"
23794       }
23795     ],
23796     "name": "GetQueues",
23797     "group": "Sms_Queues",
23798     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23799     "version": "0.0.0",
23800     "filename": "server/api/smsQueue/index.js",
23801     "groupTitle": "Sms_Queues"
23802   },
23803   {
23804     "type": "get",
23805     "url": "/api/sms/queues/{id}/teams",
23806     "title": "Gets queues list",
23807     "examples": [
23808       {
23809         "title": "Example usage:",
23810         "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password}",
23811         "type": "json"
23812       }
23813     ],
23814     "name": "GetTeams",
23815     "group": "Sms_Queues",
23816     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23817     "version": "0.0.0",
23818     "filename": "server/api/smsQueue/index.js",
23819     "groupTitle": "Sms_Queues"
23820   },
23821   {
23822     "type": "delete",
23823     "url": "/api/sms/queues/{id}/users",
23824     "title": "Removes agents from a queue",
23825     "examples": [
23826       {
23827         "title": "Example usage:",
23828         "content": "curl https://{domain}/api/sms/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
23829         "type": "json"
23830       }
23831     ],
23832     "name": "RemoveAgents",
23833     "group": "Sms_Queues",
23834     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23835     "version": "0.0.0",
23836     "filename": "server/api/smsQueue/index.js",
23837     "groupTitle": "Sms_Queues"
23838   },
23839   {
23840     "type": "get",
23841     "url": "/api/sms/queues/{id}",
23842     "title": "Gets a single Queue",
23843     "examples": [
23844       {
23845         "title": "Example usage:",
23846         "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password}",
23847         "type": "json"
23848       }
23849     ],
23850     "name": "ShowQueues",
23851     "group": "Sms_Queues",
23852     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23853     "version": "0.0.0",
23854     "filename": "server/api/smsQueue/index.js",
23855     "groupTitle": "Sms_Queues"
23856   },
23857   {
23858     "type": "put",
23859     "url": "/api/sms/queues/{id}",
23860     "title": "Update an existing Queue",
23861     "examples": [
23862       {
23863         "title": "Example usage:",
23864         "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",
23865         "type": "json"
23866       }
23867     ],
23868     "name": "updateQueues",
23869     "group": "Sms_Queues",
23870     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23871     "version": "0.0.0",
23872     "filename": "server/api/smsQueue/index.js",
23873     "groupTitle": "Sms_Queues"
23874   },
23875   {
23876     "type": "post",
23877     "url": "/api/sms/reports/transfer",
23878     "title": "Creates a new Sms Transfer Report",
23879     "examples": [
23880       {
23881         "title": "Example usage:",
23882         "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",
23883         "type": "json"
23884       }
23885     ],
23886     "name": "CreateSms_Transfer_Reports",
23887     "group": "Sms_Transfer_Reports",
23888     "parameter": {
23889       "fields": {
23890         "Body": [
23891           {
23892             "group": "Body",
23893             "type": "String",
23894             "optional": false,
23895             "field": "uniqueid",
23896             "description": ""
23897           },
23898           {
23899             "group": "Body",
23900             "type": "String",
23901             "allowedValues": [
23902               "\"account\"",
23903               "\"agent\"",
23904               "\"queue\""
23905             ],
23906             "optional": false,
23907             "field": "type",
23908             "description": ""
23909           },
23910           {
23911             "group": "Body",
23912             "type": "String",
23913             "optional": false,
23914             "field": "transferredAt",
23915             "description": ""
23916           }
23917         ]
23918       }
23919     },
23920     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23921     "version": "0.0.0",
23922     "filename": "server/api/smsTransferReport/index.js",
23923     "groupTitle": "Sms_Transfer_Reports"
23924   },
23925   {
23926     "type": "delete",
23927     "url": "/api/sms/reports/transfer/{id}",
23928     "title": "Deletes a Sms Transfer Report",
23929     "examples": [
23930       {
23931         "title": "Example usage:",
23932         "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
23933         "type": "json"
23934       }
23935     ],
23936     "name": "DeleteSms_Transfer_Reports",
23937     "group": "Sms_Transfer_Reports",
23938     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23939     "version": "0.0.0",
23940     "filename": "server/api/smsTransferReport/index.js",
23941     "groupTitle": "Sms_Transfer_Reports"
23942   },
23943   {
23944     "type": "get",
23945     "url": "/api/sms/reports/transfer/describe",
23946     "title": "Gets table info about Sms Transfer Reports",
23947     "examples": [
23948       {
23949         "title": "Example usage:",
23950         "content": "curl https://{domain}/api/sms/reports/transfer/describe -v -u {name}:{password}",
23951         "type": "json"
23952       }
23953     ],
23954     "name": "DescribeSms_Transfer_Reports",
23955     "group": "Sms_Transfer_Reports",
23956     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23957     "version": "0.0.0",
23958     "filename": "server/api/smsTransferReport/index.js",
23959     "groupTitle": "Sms_Transfer_Reports"
23960   },
23961   {
23962     "type": "get",
23963     "url": "/api/sms/reports/transfer",
23964     "title": "Gets a list of Sms Transfer Reports",
23965     "examples": [
23966       {
23967         "title": "Example usage:",
23968         "content": "curl https://{domain}/api/sms/reports/transfer -v -u {name}:{password}",
23969         "type": "json"
23970       }
23971     ],
23972     "name": "GetSms_Transfer_Reports",
23973     "group": "Sms_Transfer_Reports",
23974     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23975     "version": "0.0.0",
23976     "filename": "server/api/smsTransferReport/index.js",
23977     "groupTitle": "Sms_Transfer_Reports"
23978   },
23979   {
23980     "type": "get",
23981     "url": "/api/sms/reports/transfer/{id}",
23982     "title": "Gets a single Sms Transfer Report",
23983     "examples": [
23984       {
23985         "title": "Example usage:",
23986         "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password}",
23987         "type": "json"
23988       }
23989     ],
23990     "name": "ShowSms_Transfer_Reports",
23991     "group": "Sms_Transfer_Reports",
23992     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23993     "version": "0.0.0",
23994     "filename": "server/api/smsTransferReport/index.js",
23995     "groupTitle": "Sms_Transfer_Reports"
23996   },
23997   {
23998     "type": "put",
23999     "url": "/api/sms/reports/transfer/{id}",
24000     "title": "Update an existing Sms Transfer Report",
24001     "examples": [
24002       {
24003         "title": "Example usage:",
24004         "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",
24005         "type": "json"
24006       }
24007     ],
24008     "name": "updateSms_Transfer_Reports",
24009     "group": "Sms_Transfer_Reports",
24010     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24011     "version": "0.0.0",
24012     "filename": "server/api/smsTransferReport/index.js",
24013     "groupTitle": "Sms_Transfer_Reports"
24014   },
24015   {
24016     "type": "get",
24017     "url": "/api/sounds",
24018     "title": "Gets a list of Sounds",
24019     "examples": [
24020       {
24021         "title": "Example usage:",
24022         "content": "curl https://{domain}/api/sounds -v -u {name}:{password}",
24023         "type": "json"
24024       }
24025     ],
24026     "name": "GetSounds",
24027     "group": "Sounds",
24028     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24029     "version": "0.0.0",
24030     "filename": "server/api/sound/index.js",
24031     "groupTitle": "Sounds"
24032   },
24033   {
24034     "type": "get",
24035     "url": "/api/sounds/{id}",
24036     "title": "Gets a single Sound",
24037     "examples": [
24038       {
24039         "title": "Example usage:",
24040         "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password}",
24041         "type": "json"
24042       }
24043     ],
24044     "name": "ShowSounds",
24045     "group": "Sounds",
24046     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24047     "version": "0.0.0",
24048     "filename": "server/api/sound/index.js",
24049     "groupTitle": "Sounds"
24050   },
24051   {
24052     "type": "post",
24053     "url": "/api/sounds",
24054     "title": "Create a new sound",
24055     "examples": [
24056       {
24057         "title": "Example usage:",
24058         "content": "curl https://{domain}/api/sounds -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
24059         "type": "json"
24060       }
24061     ],
24062     "name": "addSound",
24063     "group": "Sounds",
24064     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24065     "version": "0.0.0",
24066     "filename": "server/api/sound/index.js",
24067     "groupTitle": "Sounds"
24068   },
24069   {
24070     "type": "delete",
24071     "url": "/api/sounds/{id}",
24072     "title": "Deletes a sound",
24073     "examples": [
24074       {
24075         "title": "Example usage:",
24076         "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password} -X DELETE",
24077         "type": "json"
24078       }
24079     ],
24080     "name": "destroySound",
24081     "group": "Sounds",
24082     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24083     "version": "0.0.0",
24084     "filename": "server/api/sound/index.js",
24085     "groupTitle": "Sounds"
24086   },
24087   {
24088     "type": "get",
24089     "url": "/api/sounds/{id}/download",
24090     "title": "Download Sound",
24091     "examples": [
24092       {
24093         "title": "Example usage:",
24094         "content": "curl https://{domain}/api/sounds/{id}/download -v -u {name}:{password} -X GET",
24095         "type": "json"
24096       }
24097     ],
24098     "name": "download",
24099     "group": "Sounds",
24100     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24101     "version": "0.0.0",
24102     "filename": "server/api/sound/index.js",
24103     "groupTitle": "Sounds"
24104   },
24105   {
24106     "type": "put",
24107     "url": "/api/sounds",
24108     "title": "Update an existing new sound",
24109     "examples": [
24110       {
24111         "title": "Example usage:",
24112         "content": "curl https://{domain}/api/sounds -d '[\"name\": \"sound_name\", \"description\": \"sound_desc\"]' -v -u {name}:{password} -X PUT",
24113         "type": "json"
24114       }
24115     ],
24116     "name": "updateSound",
24117     "group": "Sounds",
24118     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24119     "version": "0.0.0",
24120     "filename": "server/api/sound/index.js",
24121     "groupTitle": "Sounds"
24122   },
24123   {
24124     "type": "post",
24125     "url": "/api/square/details/reports",
24126     "title": "Creates a new Square Detail Report",
24127     "examples": [
24128       {
24129         "title": "Example usage:",
24130         "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",
24131         "type": "json"
24132       }
24133     ],
24134     "name": "CreateSquare_Detail_Reports",
24135     "group": "Square_Details_Reports",
24136     "parameter": {
24137       "fields": {
24138         "Body": [
24139           {
24140             "group": "Body",
24141             "type": "String",
24142             "optional": true,
24143             "field": "uniqueid",
24144             "description": ""
24145           },
24146           {
24147             "group": "Body",
24148             "type": "String",
24149             "optional": true,
24150             "field": "node",
24151             "description": ""
24152           },
24153           {
24154             "group": "Body",
24155             "type": "String",
24156             "optional": true,
24157             "field": "application",
24158             "description": ""
24159           },
24160           {
24161             "group": "Body",
24162             "type": "Text",
24163             "optional": true,
24164             "field": "data",
24165             "description": ""
24166           },
24167           {
24168             "group": "Body",
24169             "type": "String",
24170             "optional": true,
24171             "field": "project_name",
24172             "description": ""
24173           },
24174           {
24175             "group": "Body",
24176             "type": "String",
24177             "optional": true,
24178             "field": "callerid",
24179             "description": ""
24180           }
24181         ]
24182       }
24183     },
24184     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24185     "version": "0.0.0",
24186     "filename": "server/api/squareReportDetail/index.js",
24187     "groupTitle": "Square_Details_Reports"
24188   },
24189   {
24190     "type": "delete",
24191     "url": "/api/square/details/reports/{id}",
24192     "title": "Deletes a Square Detail Report",
24193     "examples": [
24194       {
24195         "title": "Example usage:",
24196         "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password} -X DELETE",
24197         "type": "json"
24198       }
24199     ],
24200     "name": "DeleteSquare_Detail_Reports",
24201     "group": "Square_Details_Reports",
24202     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24203     "version": "0.0.0",
24204     "filename": "server/api/squareReportDetail/index.js",
24205     "groupTitle": "Square_Details_Reports"
24206   },
24207   {
24208     "type": "get",
24209     "url": "/api/square/details/reports/describe",
24210     "title": "Gets table info about Square Detail Reports",
24211     "examples": [
24212       {
24213         "title": "Example usage:",
24214         "content": "curl https://{domain}/api/square/details/reports/describe -v -u {name}:{password}",
24215         "type": "json"
24216       }
24217     ],
24218     "name": "DescribeSquare_Detail_Reports",
24219     "group": "Square_Details_Reports",
24220     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24221     "version": "0.0.0",
24222     "filename": "server/api/squareReportDetail/index.js",
24223     "groupTitle": "Square_Details_Reports"
24224   },
24225   {
24226     "type": "get",
24227     "url": "/api/square/details/reports",
24228     "title": "Gets a list of Square Detail Reports",
24229     "examples": [
24230       {
24231         "title": "Example usage:",
24232         "content": "curl https://{domain}/api/square/details/reports -v -u {name}:{password}",
24233         "type": "json"
24234       }
24235     ],
24236     "name": "GetSquare_Detail_Reports",
24237     "group": "Square_Details_Reports",
24238     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24239     "version": "0.0.0",
24240     "filename": "server/api/squareReportDetail/index.js",
24241     "groupTitle": "Square_Details_Reports"
24242   },
24243   {
24244     "type": "get",
24245     "url": "/api/square/details/reports/{id}",
24246     "title": "Gets a single Square Detail Report",
24247     "examples": [
24248       {
24249         "title": "Example usage:",
24250         "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password}",
24251         "type": "json"
24252       }
24253     ],
24254     "name": "ShowSquare_Detail_Reports",
24255     "group": "Square_Details_Reports",
24256     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24257     "version": "0.0.0",
24258     "filename": "server/api/squareReportDetail/index.js",
24259     "groupTitle": "Square_Details_Reports"
24260   },
24261   {
24262     "type": "put",
24263     "url": "/api/square/details/reports/{id}",
24264     "title": "Update an existing Square Detail Report",
24265     "examples": [
24266       {
24267         "title": "Example usage:",
24268         "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",
24269         "type": "json"
24270       }
24271     ],
24272     "name": "updateSquare_Detail_Reports",
24273     "group": "Square_Details_Reports",
24274     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24275     "version": "0.0.0",
24276     "filename": "server/api/squareReportDetail/index.js",
24277     "groupTitle": "Square_Details_Reports"
24278   },
24279   {
24280     "type": "post",
24281     "url": "/api/square/messages",
24282     "title": "Creates a new Message",
24283     "examples": [
24284       {
24285         "title": "Example usage:",
24286         "content": "curl https://{domain}/api/square/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24287         "type": "json"
24288       }
24289     ],
24290     "name": "CreateMessages",
24291     "group": "Square_Messages",
24292     "parameter": {
24293       "fields": {
24294         "Body": [
24295           {
24296             "group": "Body",
24297             "type": "String",
24298             "optional": true,
24299             "field": "uniqueid",
24300             "description": ""
24301           },
24302           {
24303             "group": "Body",
24304             "type": "Text",
24305             "optional": false,
24306             "field": "body",
24307             "description": ""
24308           },
24309           {
24310             "group": "Body",
24311             "type": "String",
24312             "allowedValues": [
24313               "\"in\"",
24314               "\"out\""
24315             ],
24316             "optional": false,
24317             "field": "direction",
24318             "description": ""
24319           },
24320           {
24321             "group": "Body",
24322             "type": "String",
24323             "optional": true,
24324             "field": "providerName",
24325             "description": ""
24326           },
24327           {
24328             "group": "Body",
24329             "type": "Text",
24330             "optional": true,
24331             "field": "providerResponse",
24332             "description": ""
24333           }
24334         ]
24335       }
24336     },
24337     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24338     "version": "0.0.0",
24339     "filename": "server/api/squareMessage/index.js",
24340     "groupTitle": "Square_Messages"
24341   },
24342   {
24343     "type": "delete",
24344     "url": "/api/square/messages/{id}",
24345     "title": "Deletes a Message",
24346     "examples": [
24347       {
24348         "title": "Example usage:",
24349         "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password} -X DELETE",
24350         "type": "json"
24351       }
24352     ],
24353     "name": "DeleteMessages",
24354     "group": "Square_Messages",
24355     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24356     "version": "0.0.0",
24357     "filename": "server/api/squareMessage/index.js",
24358     "groupTitle": "Square_Messages"
24359   },
24360   {
24361     "type": "get",
24362     "url": "/api/square/messages",
24363     "title": "Gets a list of Messages",
24364     "examples": [
24365       {
24366         "title": "Example usage:",
24367         "content": "curl https://{domain}/api/square/messages -v -u {name}:{password}",
24368         "type": "json"
24369       }
24370     ],
24371     "name": "GetMessages",
24372     "group": "Square_Messages",
24373     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24374     "version": "0.0.0",
24375     "filename": "server/api/squareMessage/index.js",
24376     "groupTitle": "Square_Messages"
24377   },
24378   {
24379     "type": "get",
24380     "url": "/api/square/messages/{id}",
24381     "title": "Gets a single Message",
24382     "examples": [
24383       {
24384         "title": "Example usage:",
24385         "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password}",
24386         "type": "json"
24387       }
24388     ],
24389     "name": "ShowMessages",
24390     "group": "Square_Messages",
24391     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24392     "version": "0.0.0",
24393     "filename": "server/api/squareMessage/index.js",
24394     "groupTitle": "Square_Messages"
24395   },
24396   {
24397     "type": "put",
24398     "url": "/api/square/messages/{id}",
24399     "title": "Update an existing Message",
24400     "examples": [
24401       {
24402         "title": "Example usage:",
24403         "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",
24404         "type": "json"
24405       }
24406     ],
24407     "name": "updateMessages",
24408     "group": "Square_Messages",
24409     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24410     "version": "0.0.0",
24411     "filename": "server/api/squareMessage/index.js",
24412     "groupTitle": "Square_Messages"
24413   },
24414   {
24415     "type": "post",
24416     "url": "/api/square/odbc",
24417     "title": "Creates a new ODBC",
24418     "examples": [
24419       {
24420         "title": "Example usage:",
24421         "content": "curl https://{domain}/api/square/odbc -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24422         "type": "json"
24423       }
24424     ],
24425     "name": "CreateODBCs",
24426     "group": "Square_ODBC",
24427     "parameter": {
24428       "fields": {
24429         "Body": [
24430           {
24431             "group": "Body",
24432             "type": "String",
24433             "optional": false,
24434             "field": "name",
24435             "description": ""
24436           },
24437           {
24438             "group": "Body",
24439             "type": "String",
24440             "optional": true,
24441             "field": "dsn",
24442             "description": ""
24443           },
24444           {
24445             "group": "Body",
24446             "type": "String",
24447             "optional": true,
24448             "field": "description",
24449             "description": ""
24450           }
24451         ]
24452       }
24453     },
24454     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24455     "version": "0.0.0",
24456     "filename": "server/api/squareOdbc/index.js",
24457     "groupTitle": "Square_ODBC"
24458   },
24459   {
24460     "type": "delete",
24461     "url": "/api/square/odbc/{id}",
24462     "title": "Deletes a ODBC",
24463     "examples": [
24464       {
24465         "title": "Example usage:",
24466         "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password} -X DELETE",
24467         "type": "json"
24468       }
24469     ],
24470     "name": "DeleteODBCs",
24471     "group": "Square_ODBC",
24472     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24473     "version": "0.0.0",
24474     "filename": "server/api/squareOdbc/index.js",
24475     "groupTitle": "Square_ODBC"
24476   },
24477   {
24478     "type": "get",
24479     "url": "/api/square/odbc",
24480     "title": "Gets a list of ODBCs",
24481     "examples": [
24482       {
24483         "title": "Example usage:",
24484         "content": "curl https://{domain}/api/square/odbc -v -u {name}:{password}",
24485         "type": "json"
24486       }
24487     ],
24488     "name": "GetODBCs",
24489     "group": "Square_ODBC",
24490     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24491     "version": "0.0.0",
24492     "filename": "server/api/squareOdbc/index.js",
24493     "groupTitle": "Square_ODBC"
24494   },
24495   {
24496     "type": "get",
24497     "url": "/api/square/odbc/{id}",
24498     "title": "Gets a single ODBC",
24499     "examples": [
24500       {
24501         "title": "Example usage:",
24502         "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password}",
24503         "type": "json"
24504       }
24505     ],
24506     "name": "ShowODBCs",
24507     "group": "Square_ODBC",
24508     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24509     "version": "0.0.0",
24510     "filename": "server/api/squareOdbc/index.js",
24511     "groupTitle": "Square_ODBC"
24512   },
24513   {
24514     "type": "get",
24515     "url": "/api/square/odbc/{id}/test",
24516     "title": "Test Odbc",
24517     "examples": [
24518       {
24519         "title": "Example usage:",
24520         "content": "curl https://{domain}/api/square/odbc/{id}/test -v -u {name}:{password} -X GET",
24521         "type": "json"
24522       }
24523     ],
24524     "name": "test",
24525     "group": "Square_ODBC",
24526     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24527     "version": "0.0.0",
24528     "filename": "server/api/squareOdbc/index.js",
24529     "groupTitle": "Square_ODBC"
24530   },
24531   {
24532     "type": "put",
24533     "url": "/api/square/odbc/{id}",
24534     "title": "Update an existing ODBC",
24535     "examples": [
24536       {
24537         "title": "Example usage:",
24538         "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",
24539         "type": "json"
24540       }
24541     ],
24542     "name": "updateODBCs",
24543     "group": "Square_ODBC",
24544     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24545     "version": "0.0.0",
24546     "filename": "server/api/squareOdbc/index.js",
24547     "groupTitle": "Square_ODBC"
24548   },
24549   {
24550     "type": "post",
24551     "url": "/api/square/projects",
24552     "title": "Creates a new Project",
24553     "examples": [
24554       {
24555         "title": "Example usage:",
24556         "content": "curl https://{domain}/api/square/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24557         "type": "json"
24558       }
24559     ],
24560     "name": "CreateProjects",
24561     "group": "Square_Projects",
24562     "parameter": {
24563       "fields": {
24564         "Body": [
24565           {
24566             "group": "Body",
24567             "type": "String",
24568             "optional": false,
24569             "field": "name",
24570             "description": ""
24571           },
24572           {
24573             "group": "Body",
24574             "type": "String",
24575             "optional": true,
24576             "field": "description",
24577             "description": ""
24578           },
24579           {
24580             "group": "Body",
24581             "type": "Text",
24582             "optional": true,
24583             "field": "notes",
24584             "description": ""
24585           },
24586           {
24587             "group": "Body",
24588             "type": "Blob",
24589             "optional": true,
24590             "field": "preproduction",
24591             "description": ""
24592           },
24593           {
24594             "group": "Body",
24595             "type": "Blob",
24596             "optional": true,
24597             "field": "production",
24598             "description": ""
24599           }
24600         ]
24601       }
24602     },
24603     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24604     "version": "0.0.0",
24605     "filename": "server/api/squareProject/index.js",
24606     "groupTitle": "Square_Projects"
24607   },
24608   {
24609     "type": "delete",
24610     "url": "/api/square/projects/{id}",
24611     "title": "Deletes a Project",
24612     "examples": [
24613       {
24614         "title": "Example usage:",
24615         "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password} -X DELETE",
24616         "type": "json"
24617       }
24618     ],
24619     "name": "DeleteProjects",
24620     "group": "Square_Projects",
24621     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24622     "version": "0.0.0",
24623     "filename": "server/api/squareProject/index.js",
24624     "groupTitle": "Square_Projects"
24625   },
24626   {
24627     "type": "get",
24628     "url": "/api/square/projects",
24629     "title": "Gets a list of Projects",
24630     "examples": [
24631       {
24632         "title": "Example usage:",
24633         "content": "curl https://{domain}/api/square/projects -v -u {name}:{password}",
24634         "type": "json"
24635       }
24636     ],
24637     "name": "GetProjects",
24638     "group": "Square_Projects",
24639     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24640     "version": "0.0.0",
24641     "filename": "server/api/squareProject/index.js",
24642     "groupTitle": "Square_Projects"
24643   },
24644   {
24645     "type": "get",
24646     "url": "/api/square/projects/{id}",
24647     "title": "Gets a single Project",
24648     "examples": [
24649       {
24650         "title": "Example usage:",
24651         "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password}",
24652         "type": "json"
24653       }
24654     ],
24655     "name": "ShowProjects",
24656     "group": "Square_Projects",
24657     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24658     "version": "0.0.0",
24659     "filename": "server/api/squareProject/index.js",
24660     "groupTitle": "Square_Projects"
24661   },
24662   {
24663     "type": "post",
24664     "url": "/api/square/projects/{id}/users",
24665     "title": "Adds user permissions to a Project",
24666     "examples": [
24667       {
24668         "title": "Example usage:",
24669         "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",
24670         "type": "json"
24671       }
24672     ],
24673     "name": "addUsers",
24674     "group": "Square_Projects",
24675     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24676     "version": "0.0.0",
24677     "filename": "server/api/squareProject/index.js",
24678     "groupTitle": "Square_Projects"
24679   },
24680   {
24681     "type": "get",
24682     "url": "/api/square/projects/{id}/users",
24683     "title": "Gets users permissions from Project",
24684     "examples": [
24685       {
24686         "title": "Example usage:",
24687         "content": "curl https://{domain}/api/square/projects/{id}/users -v -u {name}:{password} -X GET",
24688         "type": "json"
24689       }
24690     ],
24691     "name": "getUsers",
24692     "group": "Square_Projects",
24693     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24694     "version": "0.0.0",
24695     "filename": "server/api/squareProject/index.js",
24696     "groupTitle": "Square_Projects"
24697   },
24698   {
24699     "type": "delete",
24700     "url": "/api/square/projects/{id}/users",
24701     "title": "Removes user permissions from a Project",
24702     "examples": [
24703       {
24704         "title": "Example usage:",
24705         "content": "curl https://{domain}/api/square/projects/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
24706         "type": "json"
24707       }
24708     ],
24709     "name": "removeUsers",
24710     "group": "Square_Projects",
24711     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24712     "version": "0.0.0",
24713     "filename": "server/api/squareProject/index.js",
24714     "groupTitle": "Square_Projects"
24715   },
24716   {
24717     "type": "put",
24718     "url": "/api/square/projects/{id}",
24719     "title": "Update an existing Project",
24720     "examples": [
24721       {
24722         "title": "Example usage:",
24723         "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",
24724         "type": "json"
24725       }
24726     ],
24727     "name": "updateProjects",
24728     "group": "Square_Projects",
24729     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24730     "version": "0.0.0",
24731     "filename": "server/api/squareProject/index.js",
24732     "groupTitle": "Square_Projects"
24733   },
24734   {
24735     "type": "post",
24736     "url": "/api/square/recordings",
24737     "title": "Creates a new Recording",
24738     "examples": [
24739       {
24740         "title": "Example usage:",
24741         "content": "curl https://{domain}/api/square/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24742         "type": "json"
24743       }
24744     ],
24745     "name": "CreateRecordings",
24746     "group": "Square_Recordings",
24747     "parameter": {
24748       "fields": {
24749         "Body": [
24750           {
24751             "group": "Body",
24752             "type": "String",
24753             "optional": true,
24754             "field": "uniqueid",
24755             "description": ""
24756           },
24757           {
24758             "group": "Body",
24759             "type": "String",
24760             "optional": true,
24761             "field": "callerid",
24762             "description": ""
24763           },
24764           {
24765             "group": "Body",
24766             "type": "String",
24767             "optional": true,
24768             "field": "calleridname",
24769             "description": ""
24770           },
24771           {
24772             "group": "Body",
24773             "type": "String",
24774             "optional": true,
24775             "field": "context",
24776             "description": ""
24777           },
24778           {
24779             "group": "Body",
24780             "type": "String",
24781             "optional": true,
24782             "field": "extension",
24783             "description": ""
24784           },
24785           {
24786             "group": "Body",
24787             "type": "String",
24788             "optional": true,
24789             "field": "priority",
24790             "description": ""
24791           },
24792           {
24793             "group": "Body",
24794             "type": "String",
24795             "optional": true,
24796             "field": "accountcode",
24797             "description": ""
24798           },
24799           {
24800             "group": "Body",
24801             "type": "String",
24802             "optional": true,
24803             "field": "dnid",
24804             "description": ""
24805           },
24806           {
24807             "group": "Body",
24808             "type": "String",
24809             "optional": true,
24810             "field": "projectName",
24811             "description": ""
24812           },
24813           {
24814             "group": "Body",
24815             "type": "String",
24816             "optional": true,
24817             "field": "saveName",
24818             "description": ""
24819           },
24820           {
24821             "group": "Body",
24822             "type": "String",
24823             "optional": true,
24824             "field": "filename",
24825             "description": ""
24826           },
24827           {
24828             "group": "Body",
24829             "type": "String",
24830             "optional": true,
24831             "field": "savePath",
24832             "description": ""
24833           },
24834           {
24835             "group": "Body",
24836             "type": "Virtual",
24837             "optional": true,
24838             "field": "format",
24839             "description": ""
24840           }
24841         ]
24842       }
24843     },
24844     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24845     "version": "0.0.0",
24846     "filename": "server/api/squareRecording/index.js",
24847     "groupTitle": "Square_Recordings"
24848   },
24849   {
24850     "type": "get",
24851     "url": "/api/square/recordings",
24852     "title": "Gets a list of Recordings",
24853     "examples": [
24854       {
24855         "title": "Example usage:",
24856         "content": "curl https://{domain}/api/square/recordings -v -u {name}:{password}",
24857         "type": "json"
24858       }
24859     ],
24860     "name": "GetRecordings",
24861     "group": "Square_Recordings",
24862     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24863     "version": "0.0.0",
24864     "filename": "server/api/squareRecording/index.js",
24865     "groupTitle": "Square_Recordings"
24866   },
24867   {
24868     "type": "get",
24869     "url": "/api/square/recordings/{id}",
24870     "title": "Gets a single Recording",
24871     "examples": [
24872       {
24873         "title": "Example usage:",
24874         "content": "curl https://{domain}/api/square/recordings/{id} -v -u {name}:{password}",
24875         "type": "json"
24876       }
24877     ],
24878     "name": "ShowRecordings",
24879     "group": "Square_Recordings",
24880     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24881     "version": "0.0.0",
24882     "filename": "server/api/squareRecording/index.js",
24883     "groupTitle": "Square_Recordings"
24884   },
24885   {
24886     "type": "delete",
24887     "url": "/api/square/recordings/{id}/delete",
24888     "title": "Delete recording",
24889     "examples": [
24890       {
24891         "title": "Example usage:",
24892         "content": "curl https://{domain}/api/square/recordings/{id}/delete -v -u {name}:{password} -X DELETE",
24893         "type": "json"
24894       }
24895     ],
24896     "name": "destroy",
24897     "group": "Square_Recordings",
24898     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24899     "version": "0.0.0",
24900     "filename": "server/api/squareRecording/index.js",
24901     "groupTitle": "Square_Recordings"
24902   },
24903   {
24904     "type": "get",
24905     "url": "/api/square/recordings/{id}/download",
24906     "title": "Download Recording",
24907     "examples": [
24908       {
24909         "title": "Example usage:",
24910         "content": "curl https://{domain}/api/square/recordings/{id}/download -v -u {name}:{password} -X GET",
24911         "type": "json"
24912       }
24913     ],
24914     "name": "download",
24915     "group": "Square_Recordings",
24916     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24917     "version": "0.0.0",
24918     "filename": "server/api/squareRecording/index.js",
24919     "groupTitle": "Square_Recordings"
24920   },
24921   {
24922     "type": "put",
24923     "url": "/api/square/recordings/{id}",
24924     "title": "Update an existing Recording",
24925     "examples": [
24926       {
24927         "title": "Example usage:",
24928         "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",
24929         "type": "json"
24930       }
24931     ],
24932     "name": "updateRecordings",
24933     "group": "Square_Recordings",
24934     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24935     "version": "0.0.0",
24936     "filename": "server/api/squareRecording/index.js",
24937     "groupTitle": "Square_Recordings"
24938   },
24939   {
24940     "type": "post",
24941     "url": "/api/square/reports",
24942     "title": "Creates a new Square Report",
24943     "examples": [
24944       {
24945         "title": "Example usage:",
24946         "content": "curl https://{domain}/api/square/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24947         "type": "json"
24948       }
24949     ],
24950     "name": "CreateSquare_Reports",
24951     "group": "Square_Reports",
24952     "parameter": {
24953       "fields": {
24954         "Body": [
24955           {
24956             "group": "Body",
24957             "type": "String",
24958             "optional": true,
24959             "field": "network",
24960             "description": ""
24961           },
24962           {
24963             "group": "Body",
24964             "type": "String",
24965             "optional": true,
24966             "field": "network_script",
24967             "description": ""
24968           },
24969           {
24970             "group": "Body",
24971             "type": "String",
24972             "optional": true,
24973             "field": "request",
24974             "description": ""
24975           },
24976           {
24977             "group": "Body",
24978             "type": "String",
24979             "optional": true,
24980             "field": "channel",
24981             "description": ""
24982           },
24983           {
24984             "group": "Body",
24985             "type": "String",
24986             "optional": true,
24987             "field": "language",
24988             "description": ""
24989           },
24990           {
24991             "group": "Body",
24992             "type": "String",
24993             "optional": true,
24994             "field": "type",
24995             "description": ""
24996           },
24997           {
24998             "group": "Body",
24999             "type": "String",
25000             "optional": true,
25001             "field": "uniqueid",
25002             "description": ""
25003           },
25004           {
25005             "group": "Body",
25006             "type": "String",
25007             "optional": true,
25008             "field": "version",
25009             "description": ""
25010           },
25011           {
25012             "group": "Body",
25013             "type": "String",
25014             "optional": true,
25015             "field": "callerid",
25016             "description": ""
25017           },
25018           {
25019             "group": "Body",
25020             "type": "String",
25021             "optional": true,
25022             "field": "calleridname",
25023             "description": ""
25024           },
25025           {
25026             "group": "Body",
25027             "type": "String",
25028             "optional": true,
25029             "field": "callingpres",
25030             "description": ""
25031           },
25032           {
25033             "group": "Body",
25034             "type": "String",
25035             "optional": true,
25036             "field": "callingani2",
25037             "description": ""
25038           },
25039           {
25040             "group": "Body",
25041             "type": "String",
25042             "optional": true,
25043             "field": "callington",
25044             "description": ""
25045           },
25046           {
25047             "group": "Body",
25048             "type": "String",
25049             "optional": true,
25050             "field": "callingtns",
25051             "description": ""
25052           },
25053           {
25054             "group": "Body",
25055             "type": "String",
25056             "optional": true,
25057             "field": "dnid",
25058             "description": ""
25059           },
25060           {
25061             "group": "Body",
25062             "type": "String",
25063             "optional": true,
25064             "field": "rdnis",
25065             "description": ""
25066           },
25067           {
25068             "group": "Body",
25069             "type": "String",
25070             "optional": true,
25071             "field": "context",
25072             "description": ""
25073           },
25074           {
25075             "group": "Body",
25076             "type": "String",
25077             "optional": true,
25078             "field": "extension",
25079             "description": ""
25080           },
25081           {
25082             "group": "Body",
25083             "type": "String",
25084             "optional": true,
25085             "field": "priority",
25086             "description": ""
25087           },
25088           {
25089             "group": "Body",
25090             "type": "String",
25091             "optional": true,
25092             "field": "enhanced",
25093             "description": ""
25094           },
25095           {
25096             "group": "Body",
25097             "type": "String",
25098             "optional": true,
25099             "field": "accountcode",
25100             "description": ""
25101           },
25102           {
25103             "group": "Body",
25104             "type": "String",
25105             "optional": true,
25106             "field": "threadid",
25107             "description": ""
25108           },
25109           {
25110             "group": "Body",
25111             "type": "String",
25112             "optional": true,
25113             "field": "project_name",
25114             "description": ""
25115           },
25116           {
25117             "group": "Body",
25118             "type": "String",
25119             "optional": true,
25120             "field": "joinAt",
25121             "description": ""
25122           },
25123           {
25124             "group": "Body",
25125             "type": "String",
25126             "optional": true,
25127             "field": "leaveAt",
25128             "description": ""
25129           },
25130           {
25131             "group": "Body",
25132             "type": "Boolean",
25133             "optional": true,
25134             "field": "bot",
25135             "description": ""
25136           }
25137         ]
25138       }
25139     },
25140     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25141     "version": "0.0.0",
25142     "filename": "server/api/squareReport/index.js",
25143     "groupTitle": "Square_Reports"
25144   },
25145   {
25146     "type": "delete",
25147     "url": "/api/square/reports/{id}",
25148     "title": "Deletes a Square Report",
25149     "examples": [
25150       {
25151         "title": "Example usage:",
25152         "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password} -X DELETE",
25153         "type": "json"
25154       }
25155     ],
25156     "name": "DeleteSquare_Reports",
25157     "group": "Square_Reports",
25158     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25159     "version": "0.0.0",
25160     "filename": "server/api/squareReport/index.js",
25161     "groupTitle": "Square_Reports"
25162   },
25163   {
25164     "type": "get",
25165     "url": "/api/square/reports/describe",
25166     "title": "Gets table info about Square Reports",
25167     "examples": [
25168       {
25169         "title": "Example usage:",
25170         "content": "curl https://{domain}/api/square/reports/describe -v -u {name}:{password}",
25171         "type": "json"
25172       }
25173     ],
25174     "name": "DescribeSquare_Reports",
25175     "group": "Square_Reports",
25176     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25177     "version": "0.0.0",
25178     "filename": "server/api/squareReport/index.js",
25179     "groupTitle": "Square_Reports"
25180   },
25181   {
25182     "type": "get",
25183     "url": "/api/square/reports",
25184     "title": "Gets a list of Square Reports",
25185     "examples": [
25186       {
25187         "title": "Example usage:",
25188         "content": "curl https://{domain}/api/square/reports -v -u {name}:{password}",
25189         "type": "json"
25190       }
25191     ],
25192     "name": "GetSquare_Reports",
25193     "group": "Square_Reports",
25194     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25195     "version": "0.0.0",
25196     "filename": "server/api/squareReport/index.js",
25197     "groupTitle": "Square_Reports"
25198   },
25199   {
25200     "type": "get",
25201     "url": "/api/square/reports/{id}",
25202     "title": "Gets a single Square Report",
25203     "examples": [
25204       {
25205         "title": "Example usage:",
25206         "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password}",
25207         "type": "json"
25208       }
25209     ],
25210     "name": "ShowSquare_Reports",
25211     "group": "Square_Reports",
25212     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25213     "version": "0.0.0",
25214     "filename": "server/api/squareReport/index.js",
25215     "groupTitle": "Square_Reports"
25216   },
25217   {
25218     "type": "put",
25219     "url": "/api/square/reports/{id}",
25220     "title": "Update an existing Square Report",
25221     "examples": [
25222       {
25223         "title": "Example usage:",
25224         "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",
25225         "type": "json"
25226       }
25227     ],
25228     "name": "updateSquare_Reports",
25229     "group": "Square_Reports",
25230     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25231     "version": "0.0.0",
25232     "filename": "server/api/squareReport/index.js",
25233     "groupTitle": "Square_Reports"
25234   },
25235   {
25236     "type": "post",
25237     "url": "/api/integrations/sugarcrm/configurations",
25238     "title": "Creates a new SugarCRM Configuration",
25239     "examples": [
25240       {
25241         "title": "Example usage:",
25242         "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",
25243         "type": "json"
25244       }
25245     ],
25246     "name": "CreateSugarCRM_Configurations",
25247     "group": "SugarCRM_Configurations",
25248     "parameter": {
25249       "fields": {
25250         "Body": [
25251           {
25252             "group": "Body",
25253             "type": "String",
25254             "optional": true,
25255             "field": "name",
25256             "description": ""
25257           },
25258           {
25259             "group": "Body",
25260             "type": "String",
25261             "optional": true,
25262             "field": "description",
25263             "description": ""
25264           }
25265         ]
25266       }
25267     },
25268     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25269     "version": "0.0.0",
25270     "filename": "server/api/intSugarcrmConfiguration/index.js",
25271     "groupTitle": "SugarCRM_Configurations"
25272   },
25273   {
25274     "type": "delete",
25275     "url": "/api/integrations/sugarcrm/configurations/{id}",
25276     "title": "Deletes a SugarCRM Configuration",
25277     "examples": [
25278       {
25279         "title": "Example usage:",
25280         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password} -X DELETE",
25281         "type": "json"
25282       }
25283     ],
25284     "name": "DeleteSugarCRM_Configurations",
25285     "group": "SugarCRM_Configurations",
25286     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25287     "version": "0.0.0",
25288     "filename": "server/api/intSugarcrmConfiguration/index.js",
25289     "groupTitle": "SugarCRM_Configurations"
25290   },
25291   {
25292     "type": "get",
25293     "url": "/api/integrations/sugarcrm/configurations",
25294     "title": "Gets a list of SugarCRM Configurations",
25295     "examples": [
25296       {
25297         "title": "Example usage:",
25298         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations -v -u {name}:{password}",
25299         "type": "json"
25300       }
25301     ],
25302     "name": "GetSugarCRM_Configurations",
25303     "group": "SugarCRM_Configurations",
25304     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25305     "version": "0.0.0",
25306     "filename": "server/api/intSugarcrmConfiguration/index.js",
25307     "groupTitle": "SugarCRM_Configurations"
25308   },
25309   {
25310     "type": "get",
25311     "url": "/api/integrations/sugarcrm/configurations/{id}",
25312     "title": "Gets a single SugarCRM Configuration",
25313     "examples": [
25314       {
25315         "title": "Example usage:",
25316         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password}",
25317         "type": "json"
25318       }
25319     ],
25320     "name": "ShowSugarCRM_Configurations",
25321     "group": "SugarCRM_Configurations",
25322     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25323     "version": "0.0.0",
25324     "filename": "server/api/intSugarcrmConfiguration/index.js",
25325     "groupTitle": "SugarCRM_Configurations"
25326   },
25327   {
25328     "type": "put",
25329     "url": "/api/integrations/sugarcrm/configurations/{id}",
25330     "title": "Update an existing SugarCRM Configuration",
25331     "examples": [
25332       {
25333         "title": "Example usage:",
25334         "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",
25335         "type": "json"
25336       }
25337     ],
25338     "name": "updateSugarCRM_Configurations",
25339     "group": "SugarCRM_Configurations",
25340     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25341     "version": "0.0.0",
25342     "filename": "server/api/intSugarcrmConfiguration/index.js",
25343     "groupTitle": "SugarCRM_Configurations"
25344   },
25345   {
25346     "type": "post",
25347     "url": "/api/integrations/sugarcrm/accounts",
25348     "title": "Creates a new Sugarcrm Account",
25349     "examples": [
25350       {
25351         "title": "Example usage:",
25352         "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",
25353         "type": "json"
25354       }
25355     ],
25356     "name": "CreateSugarcrm_Accounts",
25357     "group": "Sugarcrm_Accounts",
25358     "parameter": {
25359       "fields": {
25360         "Body": [
25361           {
25362             "group": "Body",
25363             "type": "String",
25364             "optional": true,
25365             "field": "name",
25366             "description": ""
25367           },
25368           {
25369             "group": "Body",
25370             "type": "String",
25371             "optional": true,
25372             "field": "description",
25373             "description": ""
25374           },
25375           {
25376             "group": "Body",
25377             "type": "String",
25378             "optional": true,
25379             "field": "username",
25380             "description": ""
25381           },
25382           {
25383             "group": "Body",
25384             "type": "String",
25385             "optional": true,
25386             "field": "password",
25387             "description": ""
25388           },
25389           {
25390             "group": "Body",
25391             "type": "String",
25392             "optional": true,
25393             "field": "remoteUri",
25394             "description": ""
25395           },
25396           {
25397             "group": "Body",
25398             "type": "String",
25399             "optional": true,
25400             "field": "serverUrl",
25401             "description": ""
25402           }
25403         ]
25404       }
25405     },
25406     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25407     "version": "0.0.0",
25408     "filename": "server/api/intSugarcrmAccount/index.js",
25409     "groupTitle": "Sugarcrm_Accounts"
25410   },
25411   {
25412     "type": "delete",
25413     "url": "/api/integrations/sugarcrm/accounts/{id}",
25414     "title": "Deletes a Sugarcrm Account",
25415     "examples": [
25416       {
25417         "title": "Example usage:",
25418         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password} -X DELETE",
25419         "type": "json"
25420       }
25421     ],
25422     "name": "DeleteSugarcrm_Accounts",
25423     "group": "Sugarcrm_Accounts",
25424     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25425     "version": "0.0.0",
25426     "filename": "server/api/intSugarcrmAccount/index.js",
25427     "groupTitle": "Sugarcrm_Accounts"
25428   },
25429   {
25430     "type": "get",
25431     "url": "/api/integrations/sugarcrm/accounts",
25432     "title": "Gets a list of Sugarcrm Accounts",
25433     "examples": [
25434       {
25435         "title": "Example usage:",
25436         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts -v -u {name}:{password}",
25437         "type": "json"
25438       }
25439     ],
25440     "name": "GetSugarcrm_Accounts",
25441     "group": "Sugarcrm_Accounts",
25442     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25443     "version": "0.0.0",
25444     "filename": "server/api/intSugarcrmAccount/index.js",
25445     "groupTitle": "Sugarcrm_Accounts"
25446   },
25447   {
25448     "type": "get",
25449     "url": "/api/integrations/sugarcrm/accounts/{id}",
25450     "title": "Gets a single Sugarcrm Account",
25451     "examples": [
25452       {
25453         "title": "Example usage:",
25454         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password}",
25455         "type": "json"
25456       }
25457     ],
25458     "name": "ShowSugarcrm_Accounts",
25459     "group": "Sugarcrm_Accounts",
25460     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25461     "version": "0.0.0",
25462     "filename": "server/api/intSugarcrmAccount/index.js",
25463     "groupTitle": "Sugarcrm_Accounts"
25464   },
25465   {
25466     "type": "post",
25467     "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
25468     "title": "Creates new configuration",
25469     "examples": [
25470       {
25471         "title": "Example usage:",
25472         "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",
25473         "type": "json"
25474       }
25475     ],
25476     "name": "addConfiguration",
25477     "group": "Sugarcrm_Accounts",
25478     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25479     "version": "0.0.0",
25480     "filename": "server/api/intSugarcrmAccount/index.js",
25481     "groupTitle": "Sugarcrm_Accounts"
25482   },
25483   {
25484     "type": "get",
25485     "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
25486     "title": "Gets account configurations",
25487     "examples": [
25488       {
25489         "title": "Example usage:",
25490         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/configurations -v -u {name}:{password} -X GET",
25491         "type": "json"
25492       }
25493     ],
25494     "name": "getConfigurations",
25495     "group": "Sugarcrm_Accounts",
25496     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25497     "version": "0.0.0",
25498     "filename": "server/api/intSugarcrmAccount/index.js",
25499     "groupTitle": "Sugarcrm_Accounts"
25500   },
25501   {
25502     "type": "get",
25503     "url": "/api/integrations/sugarcrm/accounts/{id}/fields",
25504     "title": "Gets account fields",
25505     "examples": [
25506       {
25507         "title": "Example usage:",
25508         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/fields -v -u {name}:{password} -X GET",
25509         "type": "json"
25510       }
25511     ],
25512     "name": "getFields",
25513     "group": "Sugarcrm_Accounts",
25514     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25515     "version": "0.0.0",
25516     "filename": "server/api/intSugarcrmAccount/index.js",
25517     "groupTitle": "Sugarcrm_Accounts"
25518   },
25519   {
25520     "type": "put",
25521     "url": "/api/integrations/sugarcrm/accounts/{id}",
25522     "title": "Update an existing Sugarcrm Account",
25523     "examples": [
25524       {
25525         "title": "Example usage:",
25526         "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",
25527         "type": "json"
25528       }
25529     ],
25530     "name": "updateSugarcrm_Accounts",
25531     "group": "Sugarcrm_Accounts",
25532     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25533     "version": "0.0.0",
25534     "filename": "server/api/intSugarcrmAccount/index.js",
25535     "groupTitle": "Sugarcrm_Accounts"
25536   },
25537   {
25538     "type": "get",
25539     "url": "/api/integrations/sugarcrm/configurations/{id}/descriptions",
25540     "title": "Gets configurations descriptions",
25541     "examples": [
25542       {
25543         "title": "Example usage:",
25544         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
25545         "type": "json"
25546       }
25547     ],
25548     "name": "getDescriptions",
25549     "group": "Sugarcrm_Configurations",
25550     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25551     "version": "0.0.0",
25552     "filename": "server/api/intSugarcrmConfiguration/index.js",
25553     "groupTitle": "Sugarcrm_Configurations"
25554   },
25555   {
25556     "type": "get",
25557     "url": "/api/integrations/sugarcrm/configurations/{id}/fields",
25558     "title": "Gets configurations fields",
25559     "examples": [
25560       {
25561         "title": "Example usage:",
25562         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/fields -v -u {name}:{password} -X GET",
25563         "type": "json"
25564       }
25565     ],
25566     "name": "getFields",
25567     "group": "Sugarcrm_Configurations",
25568     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25569     "version": "0.0.0",
25570     "filename": "server/api/intSugarcrmConfiguration/index.js",
25571     "groupTitle": "Sugarcrm_Configurations"
25572   },
25573   {
25574     "type": "get",
25575     "url": "/api/integrations/sugarcrm/configurations/{id}/subjects",
25576     "title": "Gets configurations subjects",
25577     "examples": [
25578       {
25579         "title": "Example usage:",
25580         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/subjects -v -u {name}:{password} -X GET",
25581         "type": "json"
25582       }
25583     ],
25584     "name": "getSubjects",
25585     "group": "Sugarcrm_Configurations",
25586     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25587     "version": "0.0.0",
25588     "filename": "server/api/intSugarcrmConfiguration/index.js",
25589     "groupTitle": "Sugarcrm_Configurations"
25590   },
25591   {
25592     "type": "post",
25593     "url": "/api/integrations/sugarcrm/fields",
25594     "title": "Creates a new Sugarcrm Field",
25595     "examples": [
25596       {
25597         "title": "Example usage:",
25598         "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",
25599         "type": "json"
25600       }
25601     ],
25602     "name": "CreateSugarcrm_Fields",
25603     "group": "Sugarcrm_Fields",
25604     "parameter": {
25605       "fields": {
25606         "Body": [
25607           {
25608             "group": "Body",
25609             "type": "String",
25610             "allowedValues": [
25611               "\"string\"",
25612               "\"variable\"",
25613               "\"customVariable\"",
25614               "\"keyValue\""
25615             ],
25616             "optional": true,
25617             "field": "type",
25618             "description": ""
25619           },
25620           {
25621             "group": "Body",
25622             "type": "String",
25623             "optional": true,
25624             "field": "content",
25625             "description": ""
25626           },
25627           {
25628             "group": "Body",
25629             "type": "String",
25630             "optional": true,
25631             "field": "key",
25632             "description": ""
25633           },
25634           {
25635             "group": "Body",
25636             "type": "String",
25637             "allowedValues": [
25638               "\"string\"",
25639               "\"variable\"",
25640               "\"customVariable\""
25641             ],
25642             "optional": true,
25643             "field": "keyType",
25644             "description": ""
25645           },
25646           {
25647             "group": "Body",
25648             "type": "String",
25649             "optional": true,
25650             "field": "keyContent",
25651             "description": ""
25652           },
25653           {
25654             "group": "Body",
25655             "type": "String",
25656             "optional": true,
25657             "field": "idField",
25658             "description": ""
25659           },
25660           {
25661             "group": "Body",
25662             "type": "String",
25663             "optional": true,
25664             "field": "nameField",
25665             "description": ""
25666           },
25667           {
25668             "group": "Body",
25669             "type": "Boolean",
25670             "optional": true,
25671             "field": "customField",
25672             "description": ""
25673           },
25674           {
25675             "group": "Body",
25676             "type": "String",
25677             "optional": true,
25678             "field": "variableName",
25679             "description": ""
25680           }
25681         ]
25682       }
25683     },
25684     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25685     "version": "0.0.0",
25686     "filename": "server/api/intSugarcrmField/index.js",
25687     "groupTitle": "Sugarcrm_Fields"
25688   },
25689   {
25690     "type": "delete",
25691     "url": "/api/integrations/sugarcrm/fields/{id}",
25692     "title": "Deletes a Sugarcrm Field",
25693     "examples": [
25694       {
25695         "title": "Example usage:",
25696         "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password} -X DELETE",
25697         "type": "json"
25698       }
25699     ],
25700     "name": "DeleteSugarcrm_Fields",
25701     "group": "Sugarcrm_Fields",
25702     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25703     "version": "0.0.0",
25704     "filename": "server/api/intSugarcrmField/index.js",
25705     "groupTitle": "Sugarcrm_Fields"
25706   },
25707   {
25708     "type": "get",
25709     "url": "/api/integrations/sugarcrm/fields",
25710     "title": "Gets a list of Sugarcrm Fields",
25711     "examples": [
25712       {
25713         "title": "Example usage:",
25714         "content": "curl https://{domain}/api/integrations/sugarcrm/fields -v -u {name}:{password}",
25715         "type": "json"
25716       }
25717     ],
25718     "name": "GetSugarcrm_Fields",
25719     "group": "Sugarcrm_Fields",
25720     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25721     "version": "0.0.0",
25722     "filename": "server/api/intSugarcrmField/index.js",
25723     "groupTitle": "Sugarcrm_Fields"
25724   },
25725   {
25726     "type": "get",
25727     "url": "/api/integrations/sugarcrm/fields/{id}",
25728     "title": "Gets a single Sugarcrm Field",
25729     "examples": [
25730       {
25731         "title": "Example usage:",
25732         "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password}",
25733         "type": "json"
25734       }
25735     ],
25736     "name": "ShowSugarcrm_Fields",
25737     "group": "Sugarcrm_Fields",
25738     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25739     "version": "0.0.0",
25740     "filename": "server/api/intSugarcrmField/index.js",
25741     "groupTitle": "Sugarcrm_Fields"
25742   },
25743   {
25744     "type": "put",
25745     "url": "/api/integrations/sugarcrm/fields/{id}",
25746     "title": "Update an existing Sugarcrm Field",
25747     "examples": [
25748       {
25749         "title": "Example usage:",
25750         "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",
25751         "type": "json"
25752       }
25753     ],
25754     "name": "updateSugarcrm_Fields",
25755     "group": "Sugarcrm_Fields",
25756     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25757     "version": "0.0.0",
25758     "filename": "server/api/intSugarcrmField/index.js",
25759     "groupTitle": "Sugarcrm_Fields"
25760   },
25761   {
25762     "type": "get",
25763     "url": "/api/system",
25764     "title": "Gets system information",
25765     "examples": [
25766       {
25767         "title": "Example usage:",
25768         "content": "curl https://{domain}/api/system -v -u {name}:{password}",
25769         "type": "json"
25770       }
25771     ],
25772     "name": "GetSystemInformation",
25773     "group": "System_Information",
25774     "description": "<p>Motion returns the system information.</p>",
25775     "version": "0.0.0",
25776     "filename": "server/api/system/index.js",
25777     "groupTitle": "System_Information"
25778   },
25779   {
25780     "type": "get",
25781     "url": "/api/system/process",
25782     "title": "Gets system information",
25783     "examples": [
25784       {
25785         "title": "Example usage:",
25786         "content": "curl https://{domain}/api/system -v -u {name}:{password}",
25787         "type": "json"
25788       }
25789     ],
25790     "name": "GetSystemInformation",
25791     "group": "System_Information",
25792     "description": "<p>Motion returns the system information.</p>",
25793     "version": "0.0.0",
25794     "filename": "server/api/system/index.js",
25795     "groupTitle": "System_Information"
25796   },
25797   {
25798     "type": "post",
25799     "url": "/api/tags",
25800     "title": "Creates a new Tag",
25801     "examples": [
25802       {
25803         "title": "Example usage:",
25804         "content": "curl https://{domain}/api/tags -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25805         "type": "json"
25806       }
25807     ],
25808     "name": "CreateTags",
25809     "group": "Tags",
25810     "parameter": {
25811       "fields": {
25812         "Body": [
25813           {
25814             "group": "Body",
25815             "type": "String",
25816             "optional": false,
25817             "field": "name",
25818             "description": ""
25819           },
25820           {
25821             "group": "Body",
25822             "type": "String",
25823             "optional": true,
25824             "field": "color",
25825             "description": ""
25826           },
25827           {
25828             "group": "Body",
25829             "type": "String",
25830             "optional": true,
25831             "field": "description",
25832             "description": ""
25833           }
25834         ]
25835       }
25836     },
25837     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25838     "version": "0.0.0",
25839     "filename": "server/api/tag/index.js",
25840     "groupTitle": "Tags"
25841   },
25842   {
25843     "type": "delete",
25844     "url": "/api/tags/{id}",
25845     "title": "Deletes a Tag",
25846     "examples": [
25847       {
25848         "title": "Example usage:",
25849         "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password} -X DELETE",
25850         "type": "json"
25851       }
25852     ],
25853     "name": "DeleteTags",
25854     "group": "Tags",
25855     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25856     "version": "0.0.0",
25857     "filename": "server/api/tag/index.js",
25858     "groupTitle": "Tags"
25859   },
25860   {
25861     "type": "get",
25862     "url": "/api/tags",
25863     "title": "Gets a list of Tags",
25864     "examples": [
25865       {
25866         "title": "Example usage:",
25867         "content": "curl https://{domain}/api/tags -v -u {name}:{password}",
25868         "type": "json"
25869       }
25870     ],
25871     "name": "GetTags",
25872     "group": "Tags",
25873     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25874     "version": "0.0.0",
25875     "filename": "server/api/tag/index.js",
25876     "groupTitle": "Tags"
25877   },
25878   {
25879     "type": "get",
25880     "url": "/api/tags/{id}",
25881     "title": "Gets a single Tag",
25882     "examples": [
25883       {
25884         "title": "Example usage:",
25885         "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password}",
25886         "type": "json"
25887       }
25888     ],
25889     "name": "ShowTags",
25890     "group": "Tags",
25891     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25892     "version": "0.0.0",
25893     "filename": "server/api/tag/index.js",
25894     "groupTitle": "Tags"
25895   },
25896   {
25897     "type": "put",
25898     "url": "/api/tags/{id}",
25899     "title": "Update an existing Tag",
25900     "examples": [
25901       {
25902         "title": "Example usage:",
25903         "content": "curl https://{domain}/api/tags/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
25904         "type": "json"
25905       }
25906     ],
25907     "name": "updateTags",
25908     "group": "Tags",
25909     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25910     "version": "0.0.0",
25911     "filename": "server/api/tag/index.js",
25912     "groupTitle": "Tags"
25913   },
25914   {
25915     "type": "post",
25916     "url": "/api/teams/{id}/queues",
25917     "title": "Add queues to a team",
25918     "examples": [
25919       {
25920         "title": "Example usage:",
25921         "content": "curl https://{domain}/api/teams/{id}/queues -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
25922         "type": "json"
25923       }
25924     ],
25925     "name": "AddQueues",
25926     "group": "Teams",
25927     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25928     "version": "0.0.0",
25929     "filename": "server/api/team/index.js",
25930     "groupTitle": "Teams"
25931   },
25932   {
25933     "type": "post",
25934     "url": "/api/teams",
25935     "title": "Creates a new Team",
25936     "examples": [
25937       {
25938         "title": "Example usage:",
25939         "content": "curl https://{domain}/api/teams -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25940         "type": "json"
25941       }
25942     ],
25943     "name": "CreateTeams",
25944     "group": "Teams",
25945     "parameter": {
25946       "fields": {
25947         "Body": [
25948           {
25949             "group": "Body",
25950             "type": "String",
25951             "optional": false,
25952             "field": "name",
25953             "description": ""
25954           },
25955           {
25956             "group": "Body",
25957             "type": "String",
25958             "optional": true,
25959             "field": "description",
25960             "description": ""
25961           }
25962         ]
25963       }
25964     },
25965     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25966     "version": "0.0.0",
25967     "filename": "server/api/team/index.js",
25968     "groupTitle": "Teams"
25969   },
25970   {
25971     "type": "delete",
25972     "url": "/api/teams/{id}",
25973     "title": "Deletes a Team",
25974     "examples": [
25975       {
25976         "title": "Example usage:",
25977         "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password} -X DELETE",
25978         "type": "json"
25979       }
25980     ],
25981     "name": "DeleteTeams",
25982     "group": "Teams",
25983     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25984     "version": "0.0.0",
25985     "filename": "server/api/team/index.js",
25986     "groupTitle": "Teams"
25987   },
25988   {
25989     "type": "get",
25990     "url": "/api/teams/{id}/users",
25991     "title": "Gets agents from team",
25992     "examples": [
25993       {
25994         "title": "Example usage:",
25995         "content": "curl https://{domain}/api/teams/{id}/users -v -u {name}:{password} -X GET",
25996         "type": "json"
25997       }
25998     ],
25999     "name": "GetAgents",
26000     "group": "Teams",
26001     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26002     "version": "0.0.0",
26003     "filename": "server/api/team/index.js",
26004     "groupTitle": "Teams"
26005   },
26006   {
26007     "type": "get",
26008     "url": "/api/teams/{id}/queues?channel={channel}",
26009     "title": "Gets Queues list",
26010     "examples": [
26011       {
26012         "title": "Example usage:",
26013         "content": "curl https://{domain}/api/teams/{id}/queues?channel={channel} -v -u {name}:{password}",
26014         "type": "json"
26015       }
26016     ],
26017     "name": "GetQueues",
26018     "group": "Teams",
26019     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26020     "version": "0.0.0",
26021     "filename": "server/api/team/index.js",
26022     "groupTitle": "Teams"
26023   },
26024   {
26025     "type": "get",
26026     "url": "/api/teams",
26027     "title": "Gets a list of Teams",
26028     "examples": [
26029       {
26030         "title": "Example usage:",
26031         "content": "curl https://{domain}/api/teams -v -u {name}:{password}",
26032         "type": "json"
26033       }
26034     ],
26035     "name": "GetTeams",
26036     "group": "Teams",
26037     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26038     "version": "0.0.0",
26039     "filename": "server/api/team/index.js",
26040     "groupTitle": "Teams"
26041   },
26042   {
26043     "type": "delete",
26044     "url": "/api/teams/{id}/users",
26045     "title": "Removes agents from a team",
26046     "examples": [
26047       {
26048         "title": "Example usage:",
26049         "content": "curl https://{domain}/api/teams/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
26050         "type": "json"
26051       }
26052     ],
26053     "name": "RemoveAgents",
26054     "group": "Teams",
26055     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26056     "version": "0.0.0",
26057     "filename": "server/api/team/index.js",
26058     "groupTitle": "Teams"
26059   },
26060   {
26061     "type": "delete",
26062     "url": "/api/teams/{id}/queues",
26063     "title": "Remove queues to a team",
26064     "examples": [
26065       {
26066         "title": "Example usage:",
26067         "content": "curl https://{domain}/api/teams/{id}/queues?channel=voice&ids=1&ids=2 -v -u {name}:{password} -X DELETE",
26068         "type": "json"
26069       }
26070     ],
26071     "name": "RemoveQueues",
26072     "group": "Teams",
26073     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26074     "version": "0.0.0",
26075     "filename": "server/api/team/index.js",
26076     "groupTitle": "Teams"
26077   },
26078   {
26079     "type": "delete",
26080     "url": "/api/whatsapp/queues/{id}/teams",
26081     "title": "Remove teams from a queue",
26082     "examples": [
26083       {
26084         "title": "Example usage:",
26085         "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26086         "type": "json"
26087       }
26088     ],
26089     "name": "RemoveTeams",
26090     "group": "Teams",
26091     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26092     "version": "0.0.0",
26093     "filename": "server/api/whatsappQueue/index.js",
26094     "groupTitle": "Teams"
26095   },
26096   {
26097     "type": "delete",
26098     "url": "/api/openchannel/queues/{id}/teams",
26099     "title": "Remove teams from a queue",
26100     "examples": [
26101       {
26102         "title": "Example usage:",
26103         "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26104         "type": "json"
26105       }
26106     ],
26107     "name": "RemoveTeams",
26108     "group": "Teams",
26109     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26110     "version": "0.0.0",
26111     "filename": "server/api/openchannelQueue/index.js",
26112     "groupTitle": "Teams"
26113   },
26114   {
26115     "type": "delete",
26116     "url": "/api/voice/queues/{id}/teams",
26117     "title": "Remove teams from a queue",
26118     "examples": [
26119       {
26120         "title": "Example usage:",
26121         "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26122         "type": "json"
26123       }
26124     ],
26125     "name": "RemoveTeams",
26126     "group": "Teams",
26127     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26128     "version": "0.0.0",
26129     "filename": "server/api/voiceQueue/index.js",
26130     "groupTitle": "Teams"
26131   },
26132   {
26133     "type": "delete",
26134     "url": "/api/sms/queues/{id}/teams",
26135     "title": "Remove teams from a queue",
26136     "examples": [
26137       {
26138         "title": "Example usage:",
26139         "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26140         "type": "json"
26141       }
26142     ],
26143     "name": "RemoveTeams",
26144     "group": "Teams",
26145     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26146     "version": "0.0.0",
26147     "filename": "server/api/smsQueue/index.js",
26148     "groupTitle": "Teams"
26149   },
26150   {
26151     "type": "delete",
26152     "url": "/api/chat/queues/{id}/teams",
26153     "title": "Remove teams from a queue",
26154     "examples": [
26155       {
26156         "title": "Example usage:",
26157         "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26158         "type": "json"
26159       }
26160     ],
26161     "name": "RemoveTeams",
26162     "group": "Teams",
26163     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26164     "version": "0.0.0",
26165     "filename": "server/api/chatQueue/index.js",
26166     "groupTitle": "Teams"
26167   },
26168   {
26169     "type": "delete",
26170     "url": "/api/mail/queues/{id}/teams",
26171     "title": "Remove teams from a queue",
26172     "examples": [
26173       {
26174         "title": "Example usage:",
26175         "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26176         "type": "json"
26177       }
26178     ],
26179     "name": "RemoveTeams",
26180     "group": "Teams",
26181     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26182     "version": "0.0.0",
26183     "filename": "server/api/mailQueue/index.js",
26184     "groupTitle": "Teams"
26185   },
26186   {
26187     "type": "delete",
26188     "url": "/api/fax/queues/{id}/teams",
26189     "title": "Remove teams from a queue",
26190     "examples": [
26191       {
26192         "title": "Example usage:",
26193         "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26194         "type": "json"
26195       }
26196     ],
26197     "name": "RemoveTeams",
26198     "group": "Teams",
26199     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26200     "version": "0.0.0",
26201     "filename": "server/api/faxQueue/index.js",
26202     "groupTitle": "Teams"
26203   },
26204   {
26205     "type": "get",
26206     "url": "/api/teams/{id}",
26207     "title": "Gets a single Team",
26208     "examples": [
26209       {
26210         "title": "Example usage:",
26211         "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password}",
26212         "type": "json"
26213       }
26214     ],
26215     "name": "ShowTeams",
26216     "group": "Teams",
26217     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26218     "version": "0.0.0",
26219     "filename": "server/api/team/index.js",
26220     "groupTitle": "Teams"
26221   },
26222   {
26223     "type": "post",
26224     "url": "/api/teams/{id}/users",
26225     "title": "Adds agents to a team",
26226     "examples": [
26227       {
26228         "title": "Example usage:",
26229         "content": "curl https://{domain}/api/teams/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26230         "type": "json"
26231       }
26232     ],
26233     "name": "addAgents",
26234     "group": "Teams",
26235     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26236     "version": "0.0.0",
26237     "filename": "server/api/team/index.js",
26238     "groupTitle": "Teams"
26239   },
26240   {
26241     "type": "put",
26242     "url": "/api/teams/{id}",
26243     "title": "Update an existing Team",
26244     "examples": [
26245       {
26246         "title": "Example usage:",
26247         "content": "curl https://{domain}/api/teams/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26248         "type": "json"
26249       }
26250     ],
26251     "name": "updateTeams",
26252     "group": "Teams",
26253     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26254     "version": "0.0.0",
26255     "filename": "server/api/team/index.js",
26256     "groupTitle": "Teams"
26257   },
26258   {
26259     "type": "post",
26260     "url": "/api/templates",
26261     "title": "Creates a new Template",
26262     "examples": [
26263       {
26264         "title": "Example usage:",
26265         "content": "curl https://{domain}/api/templates -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26266         "type": "json"
26267       }
26268     ],
26269     "name": "CreateTemplates",
26270     "group": "Templates",
26271     "parameter": {
26272       "fields": {
26273         "Body": [
26274           {
26275             "group": "Body",
26276             "type": "String",
26277             "optional": true,
26278             "field": "name",
26279             "description": ""
26280           },
26281           {
26282             "group": "Body",
26283             "type": "String",
26284             "optional": true,
26285             "field": "description",
26286             "description": ""
26287           },
26288           {
26289             "group": "Body",
26290             "type": "Text",
26291             "optional": true,
26292             "field": "html",
26293             "description": ""
26294           }
26295         ]
26296       }
26297     },
26298     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26299     "version": "0.0.0",
26300     "filename": "server/api/template/index.js",
26301     "groupTitle": "Templates"
26302   },
26303   {
26304     "type": "delete",
26305     "url": "/api/templates/{id}",
26306     "title": "Deletes a Template",
26307     "examples": [
26308       {
26309         "title": "Example usage:",
26310         "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password} -X DELETE",
26311         "type": "json"
26312       }
26313     ],
26314     "name": "DeleteTemplates",
26315     "group": "Templates",
26316     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26317     "version": "0.0.0",
26318     "filename": "server/api/template/index.js",
26319     "groupTitle": "Templates"
26320   },
26321   {
26322     "type": "get",
26323     "url": "/api/templates",
26324     "title": "Gets a list of Templates",
26325     "examples": [
26326       {
26327         "title": "Example usage:",
26328         "content": "curl https://{domain}/api/templates -v -u {name}:{password}",
26329         "type": "json"
26330       }
26331     ],
26332     "name": "GetTemplates",
26333     "group": "Templates",
26334     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26335     "version": "0.0.0",
26336     "filename": "server/api/template/index.js",
26337     "groupTitle": "Templates"
26338   },
26339   {
26340     "type": "get",
26341     "url": "/api/templates/{id}",
26342     "title": "Gets a single Template",
26343     "examples": [
26344       {
26345         "title": "Example usage:",
26346         "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password}",
26347         "type": "json"
26348       }
26349     ],
26350     "name": "ShowTemplates",
26351     "group": "Templates",
26352     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26353     "version": "0.0.0",
26354     "filename": "server/api/template/index.js",
26355     "groupTitle": "Templates"
26356   },
26357   {
26358     "type": "put",
26359     "url": "/api/templates/{id}",
26360     "title": "Update an existing Template",
26361     "examples": [
26362       {
26363         "title": "Example usage:",
26364         "content": "curl https://{domain}/api/templates/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26365         "type": "json"
26366       }
26367     ],
26368     "name": "updateTemplates",
26369     "group": "Templates",
26370     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26371     "version": "0.0.0",
26372     "filename": "server/api/template/index.js",
26373     "groupTitle": "Templates"
26374   },
26375   {
26376     "type": "post",
26377     "url": "/api/triggers",
26378     "title": "Creates a new Trigger",
26379     "examples": [
26380       {
26381         "title": "Example usage:",
26382         "content": "curl https://{domain}/api/triggers -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26383         "type": "json"
26384       }
26385     ],
26386     "name": "CreateTriggers",
26387     "group": "Triggers",
26388     "parameter": {
26389       "fields": {
26390         "Body": [
26391           {
26392             "group": "Body",
26393             "type": "String",
26394             "optional": true,
26395             "field": "name",
26396             "description": ""
26397           },
26398           {
26399             "group": "Body",
26400             "type": "String",
26401             "optional": true,
26402             "field": "channel",
26403             "description": ""
26404           },
26405           {
26406             "group": "Body",
26407             "type": "String",
26408             "optional": true,
26409             "field": "description",
26410             "description": ""
26411           },
26412           {
26413             "group": "Body",
26414             "type": "Boolean",
26415             "optional": true,
26416             "field": "status",
26417             "description": ""
26418           }
26419         ]
26420       }
26421     },
26422     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26423     "version": "0.0.0",
26424     "filename": "server/api/trigger/index.js",
26425     "groupTitle": "Triggers"
26426   },
26427   {
26428     "type": "delete",
26429     "url": "/api/triggers/{id}",
26430     "title": "Deletes a Trigger",
26431     "examples": [
26432       {
26433         "title": "Example usage:",
26434         "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password} -X DELETE",
26435         "type": "json"
26436       }
26437     ],
26438     "name": "DeleteTriggers",
26439     "group": "Triggers",
26440     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26441     "version": "0.0.0",
26442     "filename": "server/api/trigger/index.js",
26443     "groupTitle": "Triggers"
26444   },
26445   {
26446     "type": "get",
26447     "url": "/api/triggers",
26448     "title": "Gets a list of Triggers",
26449     "examples": [
26450       {
26451         "title": "Example usage:",
26452         "content": "curl https://{domain}/api/triggers -v -u {name}:{password}",
26453         "type": "json"
26454       }
26455     ],
26456     "name": "GetTriggers",
26457     "group": "Triggers",
26458     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26459     "version": "0.0.0",
26460     "filename": "server/api/trigger/index.js",
26461     "groupTitle": "Triggers"
26462   },
26463   {
26464     "type": "get",
26465     "url": "/api/triggers/{id}",
26466     "title": "Gets a single Trigger",
26467     "examples": [
26468       {
26469         "title": "Example usage:",
26470         "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password}",
26471         "type": "json"
26472       }
26473     ],
26474     "name": "ShowTriggers",
26475     "group": "Triggers",
26476     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26477     "version": "0.0.0",
26478     "filename": "server/api/trigger/index.js",
26479     "groupTitle": "Triggers"
26480   },
26481   {
26482     "type": "post",
26483     "url": "/api/triggers/{id}/actions",
26484     "title": "Creates new actions",
26485     "examples": [
26486       {
26487         "title": "Example usage:",
26488         "content": "curl https://{domain}/api/triggers/{id}/actions -d '{\"action\": \"contactManager\",\"data1\": \"1\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26489         "type": "json"
26490       }
26491     ],
26492     "name": "addAction",
26493     "group": "Triggers",
26494     "parameter": {
26495       "fields": {
26496         "Body": [
26497           {
26498             "group": "Body",
26499             "type": "Virtual",
26500             "optional": true,
26501             "field": "name",
26502             "description": ""
26503           },
26504           {
26505             "group": "Body",
26506             "type": "String",
26507             "optional": false,
26508             "field": "action",
26509             "description": "<p>Allowed values: contactManager, integration, motionbar, jscripty, urlForward, browser, bot, script</p>"
26510           },
26511           {
26512             "group": "Body",
26513             "type": "String",
26514             "optional": true,
26515             "field": "data1",
26516             "description": "<p>contactManager[ListId], integration[intName(zendesk)], motionbar[Popup(0),URL(1),WinApp(2)], urlForward[GET,POST], browser[TemplateId(0),URL(1)]</p>"
26517           },
26518           {
26519             "group": "Body",
26520             "type": "String",
26521             "optional": true,
26522             "field": "data2",
26523             "description": "<p>integration[AccountId], motionbar[TemplateId,URL,WinAppPath], urlForward[URL]</p>"
26524           },
26525           {
26526             "group": "Body",
26527             "type": "String",
26528             "optional": true,
26529             "field": "data3",
26530             "description": "<p>motionbar[NULL,NULL,WinAppArguments]</p>"
26531           },
26532           {
26533             "group": "Body",
26534             "type": "String",
26535             "optional": true,
26536             "field": "data4",
26537             "description": ""
26538           },
26539           {
26540             "group": "Body",
26541             "type": "String",
26542             "optional": true,
26543             "field": "data5",
26544             "description": ""
26545           },
26546           {
26547             "group": "Body",
26548             "type": "String",
26549             "optional": true,
26550             "field": "data6",
26551             "description": ""
26552           },
26553           {
26554             "group": "Body",
26555             "type": "Text",
26556             "optional": true,
26557             "field": "data7",
26558             "description": ""
26559           }
26560         ]
26561       }
26562     },
26563     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26564     "version": "0.0.0",
26565     "filename": "server/api/trigger/index.js",
26566     "groupTitle": "Triggers"
26567   },
26568   {
26569     "type": "post",
26570     "url": "/api/triggers/{id}/all_conditions",
26571     "title": "Creates a new \"AND\"condition",
26572     "examples": [
26573       {
26574         "title": "Example usage:",
26575         "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",
26576         "type": "json"
26577       }
26578     ],
26579     "name": "addAllCondition",
26580     "group": "Triggers",
26581     "parameter": {
26582       "fields": {
26583         "Body": [
26584           {
26585             "group": "Body",
26586             "type": "Virtual",
26587             "optional": true,
26588             "field": "name",
26589             "description": ""
26590           },
26591           {
26592             "group": "Body",
26593             "type": "String",
26594             "optional": false,
26595             "field": "field",
26596             "description": ""
26597           },
26598           {
26599             "group": "Body",
26600             "type": "String",
26601             "optional": false,
26602             "field": "operator",
26603             "description": ""
26604           },
26605           {
26606             "group": "Body",
26607             "type": "String",
26608             "optional": false,
26609             "field": "value",
26610             "description": ""
26611           }
26612         ]
26613       }
26614     },
26615     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26616     "version": "0.0.0",
26617     "filename": "server/api/trigger/index.js",
26618     "groupTitle": "Triggers"
26619   },
26620   {
26621     "type": "post",
26622     "url": "/api/triggers/{id}/any_conditions",
26623     "title": "Creates a new \"OR\"condition",
26624     "examples": [
26625       {
26626         "title": "Example usage:",
26627         "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",
26628         "type": "json"
26629       }
26630     ],
26631     "name": "addAnyCondition",
26632     "group": "Triggers",
26633     "parameter": {
26634       "fields": {
26635         "Body": [
26636           {
26637             "group": "Body",
26638             "type": "Virtual",
26639             "optional": true,
26640             "field": "name",
26641             "description": ""
26642           },
26643           {
26644             "group": "Body",
26645             "type": "String",
26646             "optional": false,
26647             "field": "field",
26648             "description": ""
26649           },
26650           {
26651             "group": "Body",
26652             "type": "String",
26653             "optional": false,
26654             "field": "operator",
26655             "description": ""
26656           },
26657           {
26658             "group": "Body",
26659             "type": "String",
26660             "optional": false,
26661             "field": "value",
26662             "description": ""
26663           }
26664         ]
26665       }
26666     },
26667     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26668     "version": "0.0.0",
26669     "filename": "server/api/trigger/index.js",
26670     "groupTitle": "Triggers"
26671   },
26672   {
26673     "type": "get",
26674     "url": "/api/triggers/{id}/actions",
26675     "title": "Gets Trigger Actions",
26676     "examples": [
26677       {
26678         "title": "Example usage:",
26679         "content": "curl https://{domain}/api/triggers/{id}/actions -v -u {name}:{password} -X GET",
26680         "type": "json"
26681       }
26682     ],
26683     "name": "getActions",
26684     "group": "Triggers",
26685     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26686     "version": "0.0.0",
26687     "filename": "server/api/trigger/index.js",
26688     "groupTitle": "Triggers"
26689   },
26690   {
26691     "type": "get",
26692     "url": "/api/triggers/{id}/all_conditions",
26693     "title": "Gets \"AND\" Trigger Conditions",
26694     "examples": [
26695       {
26696         "title": "Example usage:",
26697         "content": "curl https://{domain}/api/triggers/{id}/all_conditions -v -u {name}:{password} -X GET",
26698         "type": "json"
26699       }
26700     ],
26701     "name": "getAllConditions",
26702     "group": "Triggers",
26703     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26704     "version": "0.0.0",
26705     "filename": "server/api/trigger/index.js",
26706     "groupTitle": "Triggers"
26707   },
26708   {
26709     "type": "get",
26710     "url": "/api/triggers/{id}/any_conditions",
26711     "title": "Gets \"OR\" Trigger Conditions",
26712     "examples": [
26713       {
26714         "title": "Example usage:",
26715         "content": "curl https://{domain}/api/triggers/{id}/any_conditions -v -u {name}:{password} -X GET",
26716         "type": "json"
26717       }
26718     ],
26719     "name": "getAnyConditions",
26720     "group": "Triggers",
26721     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26722     "version": "0.0.0",
26723     "filename": "server/api/trigger/index.js",
26724     "groupTitle": "Triggers"
26725   },
26726   {
26727     "type": "put",
26728     "url": "/api/triggers/{id}",
26729     "title": "Update an existing Trigger",
26730     "examples": [
26731       {
26732         "title": "Example usage:",
26733         "content": "curl https://{domain}/api/triggers/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26734         "type": "json"
26735       }
26736     ],
26737     "name": "updateTriggers",
26738     "group": "Triggers",
26739     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26740     "version": "0.0.0",
26741     "filename": "server/api/trigger/index.js",
26742     "groupTitle": "Triggers"
26743   },
26744   {
26745     "type": "post",
26746     "url": "/api/trunks/clone",
26747     "title": "Clone an existing Trunk",
26748     "examples": [
26749       {
26750         "title": "Example usage:",
26751         "content": "curl https://{domain}/api/trunks/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26752         "type": "json"
26753       }
26754     ],
26755     "name": "CloneTrunks",
26756     "group": "Trunks",
26757     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26758     "version": "0.0.0",
26759     "filename": "server/api/trunk/index.js",
26760     "groupTitle": "Trunks"
26761   },
26762   {
26763     "type": "post",
26764     "url": "/api/trunks",
26765     "title": "Create a new trunk",
26766     "examples": [
26767       {
26768         "title": "Example usage:",
26769         "content": "curl https://{domain}/api/trunks -v -u {name}:{password} -X POST",
26770         "type": "json"
26771       }
26772     ],
26773     "name": "Create",
26774     "group": "Trunks",
26775     "parameter": {
26776       "fields": {
26777         "Body": [
26778           {
26779             "group": "Body",
26780             "type": "String",
26781             "optional": false,
26782             "field": "name",
26783             "description": ""
26784           },
26785           {
26786             "group": "Body",
26787             "type": "String",
26788             "allowedValues": [
26789               "\"friend\"",
26790               "\"user\"",
26791               "\"peer\""
26792             ],
26793             "optional": false,
26794             "field": "type",
26795             "description": ""
26796           },
26797           {
26798             "group": "Body",
26799             "type": "String",
26800             "optional": false,
26801             "field": "context",
26802             "description": ""
26803           },
26804           {
26805             "group": "Body",
26806             "type": "String",
26807             "allowedValues": [
26808               "\"ALLOWED_NOT_SCREENED\"",
26809               "\"ALLOWED_PASSED_SCREEN\"",
26810               "\"ALLOWED_FAILED_SCREEN\"",
26811               "\"ALLOWED\"",
26812               "\"PROHIB_NOT_SCREENED\"",
26813               "\"PROHIB_PASSED_SCREEN\"",
26814               "\"PROHIB_FAILED_SCREEN\"",
26815               "\"PROHIB\""
26816             ],
26817             "optional": true,
26818             "field": "callingpres",
26819             "description": ""
26820           },
26821           {
26822             "group": "Body",
26823             "type": "String",
26824             "optional": true,
26825             "field": "deny",
26826             "description": ""
26827           },
26828           {
26829             "group": "Body",
26830             "type": "String",
26831             "optional": true,
26832             "field": "permit",
26833             "description": ""
26834           },
26835           {
26836             "group": "Body",
26837             "type": "String",
26838             "optional": true,
26839             "field": "secret",
26840             "description": ""
26841           },
26842           {
26843             "group": "Body",
26844             "type": "String",
26845             "optional": true,
26846             "field": "md5secret",
26847             "description": ""
26848           },
26849           {
26850             "group": "Body",
26851             "type": "String",
26852             "optional": true,
26853             "field": "remotesecret",
26854             "description": ""
26855           },
26856           {
26857             "group": "Body",
26858             "type": "String",
26859             "optional": true,
26860             "field": "transport",
26861             "description": "<p>String is deprecated. Please use an Array as [&quot;udp&quot;, &quot;tcp&quot;]</p>"
26862           },
26863           {
26864             "group": "Body",
26865             "type": "String",
26866             "allowedValues": [
26867               "\"rfc2833\"",
26868               "\"info\"",
26869               "\"shortinfo\"",
26870               "\"inband\"",
26871               "\"auto\""
26872             ],
26873             "optional": true,
26874             "field": "dtmfmode",
26875             "description": ""
26876           },
26877           {
26878             "group": "Body",
26879             "type": "String",
26880             "allowedValues": [
26881               "\"yes\"",
26882               "\"no\"",
26883               "\"nonat\"",
26884               "\"update\"",
26885               "\"outgoing\""
26886             ],
26887             "optional": true,
26888             "field": "directmedia",
26889             "description": ""
26890           },
26891           {
26892             "group": "Body",
26893             "type": "String",
26894             "allowedValues": [
26895               "\"yes\"",
26896               "\"no\""
26897             ],
26898             "optional": true,
26899             "field": "directrtpsetup",
26900             "description": ""
26901           },
26902           {
26903             "group": "Body",
26904             "type": "String",
26905             "optional": true,
26906             "field": "directmediapermit",
26907             "description": ""
26908           },
26909           {
26910             "group": "Body",
26911             "type": "String",
26912             "optional": true,
26913             "field": "directmediadeny",
26914             "description": ""
26915           },
26916           {
26917             "group": "Body",
26918             "type": "String",
26919             "optional": true,
26920             "field": "nat",
26921             "description": "<p>String is deprecated. Please use an Array as [&quot;force_rport&quot;, &quot;comedia&quot;]</p>"
26922           },
26923           {
26924             "group": "Body",
26925             "type": "String",
26926             "optional": true,
26927             "field": "callgroup",
26928             "description": ""
26929           },
26930           {
26931             "group": "Body",
26932             "type": "String",
26933             "optional": true,
26934             "field": "namedcallgroup",
26935             "description": ""
26936           },
26937           {
26938             "group": "Body",
26939             "type": "String",
26940             "optional": true,
26941             "field": "pickupgroup",
26942             "description": ""
26943           },
26944           {
26945             "group": "Body",
26946             "type": "String",
26947             "optional": true,
26948             "field": "namedpickupgroup",
26949             "description": ""
26950           },
26951           {
26952             "group": "Body",
26953             "type": "String",
26954             "optional": true,
26955             "field": "language",
26956             "description": ""
26957           },
26958           {
26959             "group": "Body",
26960             "type": "String",
26961             "optional": true,
26962             "field": "tonezone",
26963             "description": ""
26964           },
26965           {
26966             "group": "Body",
26967             "type": "String",
26968             "optional": true,
26969             "field": "disallow",
26970             "description": ""
26971           },
26972           {
26973             "group": "Body",
26974             "type": "String",
26975             "optional": false,
26976             "field": "allow",
26977             "description": "<p>String is deprecated. Please use an Array as [&quot;ulaw&quot;, &quot;alaw&quot;, &quot;alaw&quot;]</p>"
26978           },
26979           {
26980             "group": "Body",
26981             "type": "String",
26982             "allowedValues": [
26983               "\"yes\"",
26984               "\"no\""
26985             ],
26986             "optional": true,
26987             "field": "autoframing",
26988             "description": ""
26989           },
26990           {
26991             "group": "Body",
26992             "type": "String",
26993             "optional": true,
26994             "field": "insecure",
26995             "description": "<p>String is deprecated. Please use an Array as [&quot;port&quot;, &quot;invite&quot;]</p>"
26996           },
26997           {
26998             "group": "Body",
26999             "type": "String",
27000             "allowedValues": [
27001               "\"yes\"",
27002               "\"no\""
27003             ],
27004             "optional": true,
27005             "field": "trustrpid",
27006             "description": ""
27007           },
27008           {
27009             "group": "Body",
27010             "type": "String",
27011             "allowedValues": [
27012               "\"yes\"",
27013               "\"no\""
27014             ],
27015             "optional": true,
27016             "field": "trust_id_outbound",
27017             "description": ""
27018           },
27019           {
27020             "group": "Body",
27021             "type": "String",
27022             "allowedValues": [
27023               "\"yes\"",
27024               "\"no\"",
27025               "\"never\""
27026             ],
27027             "optional": true,
27028             "field": "progressinband",
27029             "description": ""
27030           },
27031           {
27032             "group": "Body",
27033             "type": "String",
27034             "allowedValues": [
27035               "\"yes\"",
27036               "\"no\""
27037             ],
27038             "optional": true,
27039             "field": "promiscredir",
27040             "description": ""
27041           },
27042           {
27043             "group": "Body",
27044             "type": "String",
27045             "allowedValues": [
27046               "\"yes\"",
27047               "\"no\""
27048             ],
27049             "optional": true,
27050             "field": "useclientcode",
27051             "description": ""
27052           },
27053           {
27054             "group": "Body",
27055             "type": "Integer",
27056             "optional": true,
27057             "field": "accountcode",
27058             "description": ""
27059           },
27060           {
27061             "group": "Body",
27062             "type": "String",
27063             "optional": true,
27064             "field": "setvar",
27065             "description": ""
27066           },
27067           {
27068             "group": "Body",
27069             "type": "String",
27070             "optional": true,
27071             "field": "callerid",
27072             "description": ""
27073           },
27074           {
27075             "group": "Body",
27076             "type": "String",
27077             "optional": true,
27078             "field": "amaflags",
27079             "description": ""
27080           },
27081           {
27082             "group": "Body",
27083             "type": "String",
27084             "allowedValues": [
27085               "\"yes\"",
27086               "\"no\""
27087             ],
27088             "optional": true,
27089             "field": "callcounter",
27090             "description": ""
27091           },
27092           {
27093             "group": "Body",
27094             "type": "Integer",
27095             "optional": true,
27096             "field": "busylevel",
27097             "description": ""
27098           },
27099           {
27100             "group": "Body",
27101             "type": "String",
27102             "allowedValues": [
27103               "\"yes\"",
27104               "\"no\""
27105             ],
27106             "optional": true,
27107             "field": "allowoverlap",
27108             "description": ""
27109           },
27110           {
27111             "group": "Body",
27112             "type": "String",
27113             "allowedValues": [
27114               "\"yes\"",
27115               "\"no\""
27116             ],
27117             "optional": true,
27118             "field": "allowsubscribe",
27119             "description": ""
27120           },
27121           {
27122             "group": "Body",
27123             "type": "String",
27124             "allowedValues": [
27125               "\"yes\"",
27126               "\"no\""
27127             ],
27128             "optional": true,
27129             "field": "allowtransfer",
27130             "description": ""
27131           },
27132           {
27133             "group": "Body",
27134             "type": "String",
27135             "allowedValues": [
27136               "\"yes\"",
27137               "\"no\""
27138             ],
27139             "optional": true,
27140             "field": "ignoresdpversion",
27141             "description": ""
27142           },
27143           {
27144             "group": "Body",
27145             "type": "String",
27146             "optional": true,
27147             "field": "subscribecontext",
27148             "description": ""
27149           },
27150           {
27151             "group": "Body",
27152             "type": "String",
27153             "optional": true,
27154             "field": "template",
27155             "description": ""
27156           },
27157           {
27158             "group": "Body",
27159             "type": "String",
27160             "allowedValues": [
27161               "\"yes\"",
27162               "\"no\"",
27163               "\"always\""
27164             ],
27165             "optional": true,
27166             "field": "videosupport",
27167             "description": ""
27168           },
27169           {
27170             "group": "Body",
27171             "type": "Integer",
27172             "optional": true,
27173             "field": "maxcallbitrate",
27174             "description": ""
27175           },
27176           {
27177             "group": "Body",
27178             "type": "String",
27179             "allowedValues": [
27180               "\"yes\"",
27181               "\"no\""
27182             ],
27183             "optional": true,
27184             "field": "rfc2833compensate",
27185             "description": ""
27186           },
27187           {
27188             "group": "Body",
27189             "type": "String",
27190             "optional": true,
27191             "field": "mailbox",
27192             "description": ""
27193           },
27194           {
27195             "group": "Body",
27196             "type": "String",
27197             "allowedValues": [
27198               "\"accept\"",
27199               "\"refuse\"",
27200               "\"originate\""
27201             ],
27202             "optional": true,
27203             "field": "session_timers",
27204             "description": ""
27205           },
27206           {
27207             "group": "Body",
27208             "type": "Integer",
27209             "optional": true,
27210             "field": "session_expires",
27211             "description": ""
27212           },
27213           {
27214             "group": "Body",
27215             "type": "Integer",
27216             "optional": true,
27217             "field": "session_minse",
27218             "description": ""
27219           },
27220           {
27221             "group": "Body",
27222             "type": "String",
27223             "allowedValues": [
27224               "\"uac\"",
27225               "\"uas\""
27226             ],
27227             "optional": true,
27228             "field": "session_refresher",
27229             "description": ""
27230           },
27231           {
27232             "group": "Body",
27233             "type": "String",
27234             "optional": true,
27235             "field": "t38pt_usertpsource",
27236             "description": ""
27237           },
27238           {
27239             "group": "Body",
27240             "type": "String",
27241             "optional": true,
27242             "field": "regexten",
27243             "description": ""
27244           },
27245           {
27246             "group": "Body",
27247             "type": "String",
27248             "optional": true,
27249             "field": "fromdomain",
27250             "description": ""
27251           },
27252           {
27253             "group": "Body",
27254             "type": "String",
27255             "optional": true,
27256             "field": "fromuser",
27257             "description": ""
27258           },
27259           {
27260             "group": "Body",
27261             "type": "Integer",
27262             "optional": true,
27263             "field": "port",
27264             "description": ""
27265           },
27266           {
27267             "group": "Body",
27268             "type": "String",
27269             "allowedValues": [
27270               "\"yes\"",
27271               "\"no\""
27272             ],
27273             "optional": true,
27274             "field": "qualify",
27275             "description": ""
27276           },
27277           {
27278             "group": "Body",
27279             "type": "Integer",
27280             "optional": true,
27281             "field": "keepalive",
27282             "description": ""
27283           },
27284           {
27285             "group": "Body",
27286             "type": "String",
27287             "optional": true,
27288             "field": "defaultip",
27289             "description": ""
27290           },
27291           {
27292             "group": "Body",
27293             "type": "String",
27294             "optional": true,
27295             "field": "defaultuser",
27296             "description": ""
27297           },
27298           {
27299             "group": "Body",
27300             "type": "Integer",
27301             "optional": true,
27302             "field": "rtptimeout",
27303             "description": ""
27304           },
27305           {
27306             "group": "Body",
27307             "type": "Integer",
27308             "optional": true,
27309             "field": "rtpholdtimeout",
27310             "description": ""
27311           },
27312           {
27313             "group": "Body",
27314             "type": "Integer",
27315             "optional": true,
27316             "field": "rtpkeepalive",
27317             "description": ""
27318           },
27319           {
27320             "group": "Body",
27321             "type": "String",
27322             "allowedValues": [
27323               "\"yes\"",
27324               "\"no\"",
27325               "\"pai\""
27326             ],
27327             "optional": true,
27328             "field": "sendrpid",
27329             "description": ""
27330           },
27331           {
27332             "group": "Body",
27333             "type": "String",
27334             "optional": true,
27335             "field": "outboundproxy",
27336             "description": ""
27337           },
27338           {
27339             "group": "Body",
27340             "type": "String",
27341             "optional": true,
27342             "field": "callbackextension",
27343             "description": ""
27344           },
27345           {
27346             "group": "Body",
27347             "type": "Integer",
27348             "optional": true,
27349             "field": "timert1",
27350             "description": ""
27351           },
27352           {
27353             "group": "Body",
27354             "type": "Integer",
27355             "optional": true,
27356             "field": "timerb",
27357             "description": ""
27358           },
27359           {
27360             "group": "Body",
27361             "type": "Integer",
27362             "optional": true,
27363             "field": "qualifyfreq",
27364             "description": ""
27365           },
27366           {
27367             "group": "Body",
27368             "type": "String",
27369             "optional": true,
27370             "field": "contactpermit",
27371             "description": ""
27372           },
27373           {
27374             "group": "Body",
27375             "type": "String",
27376             "optional": true,
27377             "field": "contactdeny",
27378             "description": ""
27379           },
27380           {
27381             "group": "Body",
27382             "type": "String",
27383             "optional": true,
27384             "field": "contactacl",
27385             "description": ""
27386           },
27387           {
27388             "group": "Body",
27389             "type": "String",
27390             "optional": true,
27391             "field": "unsolicited_mailbox",
27392             "description": ""
27393           },
27394           {
27395             "group": "Body",
27396             "type": "String",
27397             "optional": true,
27398             "field": "use_q850_reason",
27399             "description": ""
27400           },
27401           {
27402             "group": "Body",
27403             "type": "Integer",
27404             "optional": true,
27405             "field": "maxforwards",
27406             "description": ""
27407           },
27408           {
27409             "group": "Body",
27410             "type": "String",
27411             "allowedValues": [
27412               "\"yes\"",
27413               "\"no\""
27414             ],
27415             "optional": true,
27416             "field": "encryption",
27417             "description": ""
27418           },
27419           {
27420             "group": "Body",
27421             "type": "String",
27422             "allowedValues": [
27423               "\"yes\"",
27424               "\"no\""
27425             ],
27426             "optional": true,
27427             "field": "avpf",
27428             "description": ""
27429           },
27430           {
27431             "group": "Body",
27432             "type": "String",
27433             "allowedValues": [
27434               "\"yes\"",
27435               "\"no\""
27436             ],
27437             "optional": true,
27438             "field": "force_avp",
27439             "description": ""
27440           },
27441           {
27442             "group": "Body",
27443             "type": "String",
27444             "allowedValues": [
27445               "\"yes\"",
27446               "\"no\""
27447             ],
27448             "optional": true,
27449             "field": "icesupport",
27450             "description": ""
27451           },
27452           {
27453             "group": "Body",
27454             "type": "String",
27455             "allowedValues": [
27456               "\"yes\"",
27457               "\"no\""
27458             ],
27459             "optional": true,
27460             "field": "dtlsenable",
27461             "description": ""
27462           },
27463           {
27464             "group": "Body",
27465             "type": "String",
27466             "allowedValues": [
27467               "\"yes\"",
27468               "\"no\"",
27469               "\"fingerprint\"",
27470               "\"certificate\""
27471             ],
27472             "optional": true,
27473             "field": "dtlsverify",
27474             "description": ""
27475           },
27476           {
27477             "group": "Body",
27478             "type": "Integer",
27479             "optional": true,
27480             "field": "dtlsrekey",
27481             "description": ""
27482           },
27483           {
27484             "group": "Body",
27485             "type": "String",
27486             "optional": true,
27487             "field": "dtlscertfile",
27488             "description": ""
27489           },
27490           {
27491             "group": "Body",
27492             "type": "String",
27493             "optional": true,
27494             "field": "dtlsprivatekey",
27495             "description": ""
27496           },
27497           {
27498             "group": "Body",
27499             "type": "String",
27500             "optional": true,
27501             "field": "dtlscipher",
27502             "description": ""
27503           },
27504           {
27505             "group": "Body",
27506             "type": "String",
27507             "optional": true,
27508             "field": "dtlscafile",
27509             "description": ""
27510           },
27511           {
27512             "group": "Body",
27513             "type": "String",
27514             "optional": true,
27515             "field": "dtlscapath",
27516             "description": ""
27517           },
27518           {
27519             "group": "Body",
27520             "type": "String",
27521             "allowedValues": [
27522               "\"active\"",
27523               "\"passive\"",
27524               "\"actpass\""
27525             ],
27526             "optional": true,
27527             "field": "dtlssetup",
27528             "description": ""
27529           },
27530           {
27531             "group": "Body",
27532             "type": "String",
27533             "optional": true,
27534             "field": "dtlsfingerprint",
27535             "description": ""
27536           },
27537           {
27538             "group": "Body",
27539             "type": "String",
27540             "allowedValues": [
27541               "\"yes\"",
27542               "\"no\""
27543             ],
27544             "optional": true,
27545             "field": "usereqphone",
27546             "description": ""
27547           },
27548           {
27549             "group": "Body",
27550             "type": "String",
27551             "optional": true,
27552             "field": "recordonfeature",
27553             "description": ""
27554           },
27555           {
27556             "group": "Body",
27557             "type": "String",
27558             "optional": true,
27559             "field": "recordofffeature",
27560             "description": ""
27561           },
27562           {
27563             "group": "Body",
27564             "type": "Integer",
27565             "optional": true,
27566             "field": "call_limit",
27567             "description": ""
27568           },
27569           {
27570             "group": "Body",
27571             "type": "String",
27572             "allowedValues": [
27573               "\"yes\"",
27574               "\"no\""
27575             ],
27576             "optional": true,
27577             "field": "registertrying",
27578             "description": ""
27579           },
27580           {
27581             "group": "Body",
27582             "type": "String",
27583             "allowedValues": [
27584               "\"yes\"",
27585               "\"no\""
27586             ],
27587             "optional": true,
27588             "field": "subscribemwi",
27589             "description": ""
27590           },
27591           {
27592             "group": "Body",
27593             "type": "String",
27594             "optional": true,
27595             "field": "vmexten",
27596             "description": ""
27597           },
27598           {
27599             "group": "Body",
27600             "type": "String",
27601             "optional": true,
27602             "field": "mohinterpret",
27603             "description": ""
27604           },
27605           {
27606             "group": "Body",
27607             "type": "String",
27608             "optional": true,
27609             "field": "mohsuggest",
27610             "description": ""
27611           },
27612           {
27613             "group": "Body",
27614             "type": "String",
27615             "optional": true,
27616             "field": "parkinglot",
27617             "description": ""
27618           },
27619           {
27620             "group": "Body",
27621             "type": "String",
27622             "optional": true,
27623             "field": "description",
27624             "description": ""
27625           },
27626           {
27627             "group": "Body",
27628             "type": "String",
27629             "optional": true,
27630             "field": "host",
27631             "description": ""
27632           },
27633           {
27634             "group": "Body",
27635             "type": "String",
27636             "allowedValues": [
27637               "\"yes\"",
27638               "\"no\"",
27639               "\"nonat\"",
27640               "\"update\"",
27641               "\"update,nonat\""
27642             ],
27643             "optional": true,
27644             "field": "canreinvite",
27645             "description": ""
27646           },
27647           {
27648             "group": "Body",
27649             "type": "String",
27650             "optional": true,
27651             "field": "registry",
27652             "description": ""
27653           },
27654           {
27655             "group": "Body",
27656             "type": "String",
27657             "optional": true,
27658             "field": "otherFields",
27659             "description": ""
27660           },
27661           {
27662             "group": "Body",
27663             "type": "Boolean",
27664             "optional": false,
27665             "field": "active",
27666             "description": ""
27667           },
27668           {
27669             "group": "Body",
27670             "type": "String",
27671             "optional": true,
27672             "field": "t38pt_udptl",
27673             "description": ""
27674           }
27675         ]
27676       }
27677     },
27678     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27679     "version": "0.0.0",
27680     "filename": "server/api/trunk/index.js",
27681     "groupTitle": "Trunks"
27682   },
27683   {
27684     "type": "delete",
27685     "url": "/api/trunks/{id}",
27686     "title": "Deletes a trunk",
27687     "examples": [
27688       {
27689         "title": "Example usage:",
27690         "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X DELETE",
27691         "type": "json"
27692       }
27693     ],
27694     "name": "Delete",
27695     "group": "Trunks",
27696     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27697     "version": "0.0.0",
27698     "filename": "server/api/trunk/index.js",
27699     "groupTitle": "Trunks"
27700   },
27701   {
27702     "type": "get",
27703     "url": "/api/trunks",
27704     "title": "Gets a list of Trunks",
27705     "examples": [
27706       {
27707         "title": "Example usage:",
27708         "content": "curl https://{domain}/api/trunks -v -u {name}:{password}",
27709         "type": "json"
27710       }
27711     ],
27712     "name": "GetTrunks",
27713     "group": "Trunks",
27714     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
27715     "version": "0.0.0",
27716     "filename": "server/api/trunk/index.js",
27717     "groupTitle": "Trunks"
27718   },
27719   {
27720     "type": "get",
27721     "url": "/api/trunks/{id}",
27722     "title": "Gets a single Trunk",
27723     "examples": [
27724       {
27725         "title": "Example usage:",
27726         "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password}",
27727         "type": "json"
27728       }
27729     ],
27730     "name": "ShowTrunks",
27731     "group": "Trunks",
27732     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27733     "version": "0.0.0",
27734     "filename": "server/api/trunk/index.js",
27735     "groupTitle": "Trunks"
27736   },
27737   {
27738     "type": "put",
27739     "url": "/api/trunks/{id}",
27740     "title": "Update an existing trunk",
27741     "examples": [
27742       {
27743         "title": "Example usage:",
27744         "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X PUT",
27745         "type": "json"
27746       }
27747     ],
27748     "name": "Update",
27749     "group": "Trunks",
27750     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27751     "version": "0.0.0",
27752     "filename": "server/api/trunk/index.js",
27753     "groupTitle": "Trunks"
27754   },
27755   {
27756     "type": "post",
27757     "url": "/api/userProfile/resources",
27758     "title": "Creates a new User Profile Resource",
27759     "examples": [
27760       {
27761         "title": "Example usage:",
27762         "content": "curl https://{domain}/api/userProfile/resources -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27763         "type": "json"
27764       }
27765     ],
27766     "name": "CreateUser_Profile_Resources",
27767     "group": "User_Profile_Resources",
27768     "parameter": {
27769       "fields": {
27770         "Body": [
27771           {
27772             "group": "Body",
27773             "type": "String",
27774             "optional": false,
27775             "field": "name",
27776             "description": ""
27777           },
27778           {
27779             "group": "Body",
27780             "type": "Integer",
27781             "optional": false,
27782             "field": "resourceId",
27783             "description": ""
27784           },
27785           {
27786             "group": "Body",
27787             "type": "String",
27788             "optional": false,
27789             "field": "type",
27790             "description": ""
27791           }
27792         ]
27793       }
27794     },
27795     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27796     "version": "0.0.0",
27797     "filename": "server/api/userProfileResource/index.js",
27798     "groupTitle": "User_Profile_Resources"
27799   },
27800   {
27801     "type": "delete",
27802     "url": "/api/userProfile/resources/{id}",
27803     "title": "Deletes a User Profile Resource",
27804     "examples": [
27805       {
27806         "title": "Example usage:",
27807         "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password} -X DELETE",
27808         "type": "json"
27809       }
27810     ],
27811     "name": "DeleteUser_Profile_Resources",
27812     "group": "User_Profile_Resources",
27813     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27814     "version": "0.0.0",
27815     "filename": "server/api/userProfileResource/index.js",
27816     "groupTitle": "User_Profile_Resources"
27817   },
27818   {
27819     "type": "get",
27820     "url": "/api/userProfile/resources/describe",
27821     "title": "Gets table info about User Profile Resources",
27822     "examples": [
27823       {
27824         "title": "Example usage:",
27825         "content": "curl https://{domain}/api/userProfile/resources/describe -v -u {name}:{password}",
27826         "type": "json"
27827       }
27828     ],
27829     "name": "DescribeUser_Profile_Resources",
27830     "group": "User_Profile_Resources",
27831     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27832     "version": "0.0.0",
27833     "filename": "server/api/userProfileResource/index.js",
27834     "groupTitle": "User_Profile_Resources"
27835   },
27836   {
27837     "type": "get",
27838     "url": "/api/userProfile/resources",
27839     "title": "Gets a list of User Profile Resources",
27840     "examples": [
27841       {
27842         "title": "Example usage:",
27843         "content": "curl https://{domain}/api/userProfile/resources -v -u {name}:{password}",
27844         "type": "json"
27845       }
27846     ],
27847     "name": "GetUser_Profile_Resources",
27848     "group": "User_Profile_Resources",
27849     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
27850     "version": "0.0.0",
27851     "filename": "server/api/userProfileResource/index.js",
27852     "groupTitle": "User_Profile_Resources"
27853   },
27854   {
27855     "type": "get",
27856     "url": "/api/userProfile/resources/{id}",
27857     "title": "Gets a single User Profile Resource",
27858     "examples": [
27859       {
27860         "title": "Example usage:",
27861         "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password}",
27862         "type": "json"
27863       }
27864     ],
27865     "name": "ShowUser_Profile_Resources",
27866     "group": "User_Profile_Resources",
27867     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27868     "version": "0.0.0",
27869     "filename": "server/api/userProfileResource/index.js",
27870     "groupTitle": "User_Profile_Resources"
27871   },
27872   {
27873     "type": "put",
27874     "url": "/api/userProfile/resources/{id}",
27875     "title": "Update an existing User Profile Resource",
27876     "examples": [
27877       {
27878         "title": "Example usage:",
27879         "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",
27880         "type": "json"
27881       }
27882     ],
27883     "name": "updateUser_Profile_Resources",
27884     "group": "User_Profile_Resources",
27885     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27886     "version": "0.0.0",
27887     "filename": "server/api/userProfileResource/index.js",
27888     "groupTitle": "User_Profile_Resources"
27889   },
27890   {
27891     "type": "post",
27892     "url": "/api/userProfile/sections",
27893     "title": "Creates a new User Profile Section",
27894     "examples": [
27895       {
27896         "title": "Example usage:",
27897         "content": "curl https://{domain}/api/userProfile/sections -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27898         "type": "json"
27899       }
27900     ],
27901     "name": "CreateUser_Profile_Sections",
27902     "group": "User_Profile_Sections",
27903     "parameter": {
27904       "fields": {
27905         "Body": [
27906           {
27907             "group": "Body",
27908             "type": "String",
27909             "optional": false,
27910             "field": "name",
27911             "description": ""
27912           },
27913           {
27914             "group": "Body",
27915             "type": "String",
27916             "optional": false,
27917             "field": "category",
27918             "description": ""
27919           },
27920           {
27921             "group": "Body",
27922             "type": "Integer",
27923             "optional": false,
27924             "field": "sectionId",
27925             "description": ""
27926           },
27927           {
27928             "group": "Body",
27929             "type": "Boolean",
27930             "optional": true,
27931             "field": "enabled",
27932             "description": ""
27933           },
27934           {
27935             "group": "Body",
27936             "type": "Boolean",
27937             "optional": true,
27938             "field": "autoAssociation",
27939             "description": ""
27940           },
27941           {
27942             "group": "Body",
27943             "type": "String",
27944             "optional": true,
27945             "field": "crudPermissions",
27946             "description": ""
27947           }
27948         ]
27949       }
27950     },
27951     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27952     "version": "0.0.0",
27953     "filename": "server/api/userProfileSection/index.js",
27954     "groupTitle": "User_Profile_Sections"
27955   },
27956   {
27957     "type": "delete",
27958     "url": "/api/userProfile/sections/{id}",
27959     "title": "Deletes a User Profile Section",
27960     "examples": [
27961       {
27962         "title": "Example usage:",
27963         "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password} -X DELETE",
27964         "type": "json"
27965       }
27966     ],
27967     "name": "DeleteUser_Profile_Sections",
27968     "group": "User_Profile_Sections",
27969     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27970     "version": "0.0.0",
27971     "filename": "server/api/userProfileSection/index.js",
27972     "groupTitle": "User_Profile_Sections"
27973   },
27974   {
27975     "type": "get",
27976     "url": "/api/userProfile/sections/describe",
27977     "title": "Gets table info about User Profile Sections",
27978     "examples": [
27979       {
27980         "title": "Example usage:",
27981         "content": "curl https://{domain}/api/userProfile/sections/describe -v -u {name}:{password}",
27982         "type": "json"
27983       }
27984     ],
27985     "name": "DescribeUser_Profile_Sections",
27986     "group": "User_Profile_Sections",
27987     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27988     "version": "0.0.0",
27989     "filename": "server/api/userProfileSection/index.js",
27990     "groupTitle": "User_Profile_Sections"
27991   },
27992   {
27993     "type": "get",
27994     "url": "/api/userProfile/sections",
27995     "title": "Gets a list of User Profile Sections",
27996     "examples": [
27997       {
27998         "title": "Example usage:",
27999         "content": "curl https://{domain}/api/userProfile/sections -v -u {name}:{password}",
28000         "type": "json"
28001       }
28002     ],
28003     "name": "GetUser_Profile_Sections",
28004     "group": "User_Profile_Sections",
28005     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
28006     "version": "0.0.0",
28007     "filename": "server/api/userProfileSection/index.js",
28008     "groupTitle": "User_Profile_Sections"
28009   },
28010   {
28011     "type": "get",
28012     "url": "/api/userProfile/sections/{id}",
28013     "title": "Gets a single User Profile Section",
28014     "examples": [
28015       {
28016         "title": "Example usage:",
28017         "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password}",
28018         "type": "json"
28019       }
28020     ],
28021     "name": "ShowUser_Profile_Sections",
28022     "group": "User_Profile_Sections",
28023     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28024     "version": "0.0.0",
28025     "filename": "server/api/userProfileSection/index.js",
28026     "groupTitle": "User_Profile_Sections"
28027   },
28028   {
28029     "type": "put",
28030     "url": "/api/userProfile/sections/{id}",
28031     "title": "Update an existing User Profile Section",
28032     "examples": [
28033       {
28034         "title": "Example usage:",
28035         "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",
28036         "type": "json"
28037       }
28038     ],
28039     "name": "updateUser_Profile_Sections",
28040     "group": "User_Profile_Sections",
28041     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28042     "version": "0.0.0",
28043     "filename": "server/api/userProfileSection/index.js",
28044     "groupTitle": "User_Profile_Sections"
28045   },
28046   {
28047     "type": "post",
28048     "url": "/api/userProfiles/{id}/resources",
28049     "title": "Add resources' permissions to User Profile",
28050     "examples": [
28051       {
28052         "title": "Example usage:",
28053         "content": "curl https://{domain}/api/userProfiles/{id}/resources -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28054         "type": "json"
28055       }
28056     ],
28057     "name": "AddResources",
28058     "group": "User_Profiles",
28059     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28060     "version": "0.0.0",
28061     "filename": "server/api/userProfile/index.js",
28062     "groupTitle": "User_Profiles"
28063   },
28064   {
28065     "type": "post",
28066     "url": "/api/userProfiles/{id}/sections",
28067     "title": "Add sections' permissions to User Profile",
28068     "examples": [
28069       {
28070         "title": "Example usage:",
28071         "content": "curl https://{domain}/api/userProfiles/{id}/sections -d '[{\"sectionId\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28072         "type": "json"
28073       }
28074     ],
28075     "name": "AddSections",
28076     "group": "User_Profiles",
28077     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28078     "version": "0.0.0",
28079     "filename": "server/api/userProfile/index.js",
28080     "groupTitle": "User_Profiles"
28081   },
28082   {
28083     "type": "post",
28084     "url": "/api/userProfiles/clone",
28085     "title": "Clone an existing User Profile",
28086     "examples": [
28087       {
28088         "title": "Example usage:",
28089         "content": "curl https://{domain}/api/userProfiles/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28090         "type": "json"
28091       }
28092     ],
28093     "name": "CloneUser_Profiles",
28094     "group": "User_Profiles",
28095     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28096     "version": "0.0.0",
28097     "filename": "server/api/userProfile/index.js",
28098     "groupTitle": "User_Profiles"
28099   },
28100   {
28101     "type": "post",
28102     "url": "/api/userProfiles",
28103     "title": "Creates a new User Profile",
28104     "examples": [
28105       {
28106         "title": "Example usage:",
28107         "content": "curl https://{domain}/api/userProfiles -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28108         "type": "json"
28109       }
28110     ],
28111     "name": "CreateUser_Profiles",
28112     "group": "User_Profiles",
28113     "parameter": {
28114       "fields": {
28115         "Body": [
28116           {
28117             "group": "Body",
28118             "type": "String",
28119             "optional": false,
28120             "field": "name",
28121             "description": ""
28122           },
28123           {
28124             "group": "Body",
28125             "type": "String",
28126             "optional": false,
28127             "field": "crudPermissions",
28128             "description": ""
28129           },
28130           {
28131             "group": "Body",
28132             "type": "String",
28133             "optional": true,
28134             "field": "description",
28135             "description": ""
28136           }
28137         ]
28138       }
28139     },
28140     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28141     "version": "0.0.0",
28142     "filename": "server/api/userProfile/index.js",
28143     "groupTitle": "User_Profiles"
28144   },
28145   {
28146     "type": "delete",
28147     "url": "/api/userProfiles/{id}",
28148     "title": "Deletes a User Profile",
28149     "examples": [
28150       {
28151         "title": "Example usage:",
28152         "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password} -X DELETE",
28153         "type": "json"
28154       }
28155     ],
28156     "name": "DeleteUser_Profiles",
28157     "group": "User_Profiles",
28158     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28159     "version": "0.0.0",
28160     "filename": "server/api/userProfile/index.js",
28161     "groupTitle": "User_Profiles"
28162   },
28163   {
28164     "type": "get",
28165     "url": "/api/userProfiles/describe",
28166     "title": "Gets table info about User Profiles",
28167     "examples": [
28168       {
28169         "title": "Example usage:",
28170         "content": "curl https://{domain}/api/userProfiles/describe -v -u {name}:{password}",
28171         "type": "json"
28172       }
28173     ],
28174     "name": "DescribeUser_Profiles",
28175     "group": "User_Profiles",
28176     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28177     "version": "0.0.0",
28178     "filename": "server/api/userProfile/index.js",
28179     "groupTitle": "User_Profiles"
28180   },
28181   {
28182     "type": "get",
28183     "url": "/api/userProfiles/{id}/resources?section={section}",
28184     "title": "Get Resources assigned to a Section",
28185     "examples": [
28186       {
28187         "title": "Example usage:",
28188         "content": "curl https://{domain}/api/userProfiles/{id}/resources?section={section} -v -u {name}:{password} -X GET",
28189         "type": "json"
28190       }
28191     ],
28192     "name": "GetResources",
28193     "group": "User_Profiles",
28194     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28195     "version": "0.0.0",
28196     "filename": "server/api/userProfile/index.js",
28197     "groupTitle": "User_Profiles"
28198   },
28199   {
28200     "type": "get",
28201     "url": "/api/userProfiles/{id}/sections",
28202     "title": "Get sections associated to a User Profile",
28203     "examples": [
28204       {
28205         "title": "Example usage:",
28206         "content": "curl https://{domain}/api/userProfiles/{id}/sections -v -u {name}:{password} -X GET",
28207         "type": "json"
28208       }
28209     ],
28210     "name": "GetSections",
28211     "group": "User_Profiles",
28212     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28213     "version": "0.0.0",
28214     "filename": "server/api/userProfile/index.js",
28215     "groupTitle": "User_Profiles"
28216   },
28217   {
28218     "type": "get",
28219     "url": "/api/userProfiles",
28220     "title": "Gets a list of User Profiles",
28221     "examples": [
28222       {
28223         "title": "Example usage:",
28224         "content": "curl https://{domain}/api/userProfiles -v -u {name}:{password}",
28225         "type": "json"
28226       }
28227     ],
28228     "name": "GetUser_Profiles",
28229     "group": "User_Profiles",
28230     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
28231     "version": "0.0.0",
28232     "filename": "server/api/userProfile/index.js",
28233     "groupTitle": "User_Profiles"
28234   },
28235   {
28236     "type": "delete",
28237     "url": "/api/userProfiles/{id}/resources",
28238     "title": "Removes resources' permissions from User Profile",
28239     "examples": [
28240       {
28241         "title": "Example usage:",
28242         "content": "curl https://{domain}/api/userProfiles/{id}/resources?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
28243         "type": "json"
28244       }
28245     ],
28246     "name": "RemoveResources",
28247     "group": "User_Profiles",
28248     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28249     "version": "0.0.0",
28250     "filename": "server/api/userProfile/index.js",
28251     "groupTitle": "User_Profiles"
28252   },
28253   {
28254     "type": "delete",
28255     "url": "/api/userProfiles/{id}/sections",
28256     "title": "Removes sections' permissions from User Profile",
28257     "examples": [
28258       {
28259         "title": "Example usage:",
28260         "content": "curl https://{domain}/api/userProfiles/{id}/sections?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
28261         "type": "json"
28262       }
28263     ],
28264     "name": "RemoveSections",
28265     "group": "User_Profiles",
28266     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28267     "version": "0.0.0",
28268     "filename": "server/api/userProfile/index.js",
28269     "groupTitle": "User_Profiles"
28270   },
28271   {
28272     "type": "get",
28273     "url": "/api/userProfiles/{id}",
28274     "title": "Gets a single User Profile",
28275     "examples": [
28276       {
28277         "title": "Example usage:",
28278         "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password}",
28279         "type": "json"
28280       }
28281     ],
28282     "name": "ShowUser_Profiles",
28283     "group": "User_Profiles",
28284     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28285     "version": "0.0.0",
28286     "filename": "server/api/userProfile/index.js",
28287     "groupTitle": "User_Profiles"
28288   },
28289   {
28290     "type": "put",
28291     "url": "/api/userProfiles/{id}",
28292     "title": "Update an existing User Profile",
28293     "examples": [
28294       {
28295         "title": "Example usage:",
28296         "content": "curl https://{domain}/api/userProfiles/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
28297         "type": "json"
28298       }
28299     ],
28300     "name": "updateUser_Profiles",
28301     "group": "User_Profiles",
28302     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28303     "version": "0.0.0",
28304     "filename": "server/api/userProfile/index.js",
28305     "groupTitle": "User_Profiles"
28306   },
28307   {
28308     "type": "post",
28309     "url": "/api/users/{id}/chat_interactions",
28310     "title": "Add chat interaction tabs to an agent",
28311     "examples": [
28312       {
28313         "title": "Example usage:",
28314         "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",
28315         "type": "json"
28316       }
28317     ],
28318     "name": "AddChatInteractions",
28319     "group": "Users",
28320     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28321     "version": "0.0.0",
28322     "filename": "server/api/user/index.js",
28323     "groupTitle": "Users"
28324   },
28325   {
28326     "type": "post",
28327     "url": "/api/users/{id}/chat_websites",
28328     "title": "Add a Chat Website to a user",
28329     "examples": [
28330       {
28331         "title": "Example usage:",
28332         "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",
28333         "type": "json"
28334       }
28335     ],
28336     "name": "AddChatWebsites",
28337     "group": "Users",
28338     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28339     "version": "0.0.0",
28340     "filename": "server/api/user/index.js",
28341     "groupTitle": "Users"
28342   },
28343   {
28344     "type": "post",
28345     "url": "/api/users/{id}/contacts",
28346     "title": "Add contacts to a user",
28347     "examples": [
28348       {
28349         "title": "Example usage:",
28350         "content": "curl https://{domain}/api/users/{id}/contacts -d '{\"ids\": [1,2]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28351         "type": "json"
28352       }
28353     ],
28354     "name": "AddContacts",
28355     "group": "Users",
28356     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28357     "version": "0.0.0",
28358     "filename": "server/api/user/index.js",
28359     "groupTitle": "Users"
28360   },
28361   {
28362     "type": "post",
28363     "url": "/api/users/{id}/fax_accounts",
28364     "title": "Add a Fax Account to a user",
28365     "examples": [
28366       {
28367         "title": "Example usage:",
28368         "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",
28369         "type": "json"
28370       }
28371     ],
28372     "name": "AddFaxAccounts",
28373     "group": "Users",
28374     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28375     "version": "0.0.0",
28376     "filename": "server/api/user/index.js",
28377     "groupTitle": "Users"
28378   },
28379   {
28380     "type": "post",
28381     "url": "/api/users/{id}/fax_interactions",
28382     "title": "Add fax interaction tabs to an agent",
28383     "examples": [
28384       {
28385         "title": "Example usage:",
28386         "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",
28387         "type": "json"
28388       }
28389     ],
28390     "name": "AddFaxInteractions",
28391     "group": "Users",
28392     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28393     "version": "0.0.0",
28394     "filename": "server/api/user/index.js",
28395     "groupTitle": "Users"
28396   },
28397   {
28398     "type": "post",
28399     "url": "/api/users/{id}/mail_accounts",
28400     "title": "Add a Mail Account to a user",
28401     "examples": [
28402       {
28403         "title": "Example usage:",
28404         "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",
28405         "type": "json"
28406       }
28407     ],
28408     "name": "AddMailAccounts",
28409     "group": "Users",
28410     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28411     "version": "0.0.0",
28412     "filename": "server/api/user/index.js",
28413     "groupTitle": "Users"
28414   },
28415   {
28416     "type": "post",
28417     "url": "/api/users/{id}/mail_interactions",
28418     "title": "Add mail interaction tabs to an agent",
28419     "examples": [
28420       {
28421         "title": "Example usage:",
28422         "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",
28423         "type": "json"
28424       }
28425     ],
28426     "name": "AddMailInteractions",
28427     "group": "Users",
28428     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28429     "version": "0.0.0",
28430     "filename": "server/api/user/index.js",
28431     "groupTitle": "Users"
28432   },
28433   {
28434     "type": "post",
28435     "url": "/api/users/{id}/openchannel_accounts",
28436     "title": "Add a Open Channel Account to a user",
28437     "examples": [
28438       {
28439         "title": "Example usage:",
28440         "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",
28441         "type": "json"
28442       }
28443     ],
28444     "name": "AddOpenchannelAccounts",
28445     "group": "Users",
28446     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28447     "version": "0.0.0",
28448     "filename": "server/api/user/index.js",
28449     "groupTitle": "Users"
28450   },
28451   {
28452     "type": "post",
28453     "url": "/api/users/{id}/openchannel_interactions",
28454     "title": "Add openchannel interaction tabs to an agent",
28455     "examples": [
28456       {
28457         "title": "Example usage:",
28458         "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",
28459         "type": "json"
28460       }
28461     ],
28462     "name": "AddOpenchannelInteractions",
28463     "group": "Users",
28464     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28465     "version": "0.0.0",
28466     "filename": "server/api/user/index.js",
28467     "groupTitle": "Users"
28468   },
28469   {
28470     "type": "post",
28471     "url": "/api/users/{id}/queues",
28472     "title": "Add queues to an agent",
28473     "examples": [
28474       {
28475         "title": "Example usage:",
28476         "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",
28477         "type": "json"
28478       }
28479     ],
28480     "name": "AddQueues",
28481     "group": "Users",
28482     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28483     "version": "0.0.0",
28484     "filename": "server/api/user/index.js",
28485     "groupTitle": "Users"
28486   },
28487   {
28488     "type": "post",
28489     "url": "/api/users/{id}/sms_accounts",
28490     "title": "Add a Sms Account to a user",
28491     "examples": [
28492       {
28493         "title": "Example usage:",
28494         "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",
28495         "type": "json"
28496       }
28497     ],
28498     "name": "AddSmsAccounts",
28499     "group": "Users",
28500     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28501     "version": "0.0.0",
28502     "filename": "server/api/user/index.js",
28503     "groupTitle": "Users"
28504   },
28505   {
28506     "type": "post",
28507     "url": "/api/users/{id}/sms_interactions",
28508     "title": "Add sms interaction tabs to an agent",
28509     "examples": [
28510       {
28511         "title": "Example usage:",
28512         "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",
28513         "type": "json"
28514       }
28515     ],
28516     "name": "AddSmsInteractions",
28517     "group": "Users",
28518     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28519     "version": "0.0.0",
28520     "filename": "server/api/user/index.js",
28521     "groupTitle": "Users"
28522   },
28523   {
28524     "type": "post",
28525     "url": "/api/users/{id}/square_projects",
28526     "title": "Add a Square Project to a user",
28527     "examples": [
28528       {
28529         "title": "Example usage:",
28530         "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",
28531         "type": "json"
28532       }
28533     ],
28534     "name": "AddSquareProjects",
28535     "group": "Users",
28536     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28537     "version": "0.0.0",
28538     "filename": "server/api/user/index.js",
28539     "groupTitle": "Users"
28540   },
28541   {
28542     "type": "post",
28543     "url": "/api/users/{id}/teams",
28544     "title": "Add teams to an agent",
28545     "examples": [
28546       {
28547         "title": "Example usage:",
28548         "content": "curl https://{domain}/api/users/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28549         "type": "json"
28550       }
28551     ],
28552     "name": "AddTeams",
28553     "group": "Users",
28554     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28555     "version": "0.0.0",
28556     "filename": "server/api/user/index.js",
28557     "groupTitle": "Users"
28558   },
28559   {
28560     "type": "post",
28561     "url": "/api/users/{id}/whatsapp_accounts",
28562     "title": "Add a Whatsapp Account to a user",
28563     "examples": [
28564       {
28565         "title": "Example usage:",
28566         "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",
28567         "type": "json"
28568       }
28569     ],
28570     "name": "AddWhatsappAccounts",
28571     "group": "Users",
28572     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28573     "version": "0.0.0",
28574     "filename": "server/api/user/index.js",
28575     "groupTitle": "Users"
28576   },
28577   {
28578     "type": "post",
28579     "url": "/api/users/{id}/whatsapp_interactions",
28580     "title": "Add Whatsapp interaction tabs to an agent",
28581     "examples": [
28582       {
28583         "title": "Example usage:",
28584         "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",
28585         "type": "json"
28586       }
28587     ],
28588     "name": "AddWhatsappInteractions",
28589     "group": "Users",
28590     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28591     "version": "0.0.0",
28592     "filename": "server/api/user/index.js",
28593     "groupTitle": "Users"
28594   },
28595   {
28596     "type": "put",
28597     "url": "/api/users/{id}/password",
28598     "title": "Change user password",
28599     "examples": [
28600       {
28601         "title": "Example usage:",
28602         "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",
28603         "type": "json"
28604       }
28605     ],
28606     "name": "ChangePwd",
28607     "group": "Users",
28608     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28609     "version": "0.0.0",
28610     "filename": "server/api/user/index.js",
28611     "groupTitle": "Users"
28612   },
28613   {
28614     "type": "post",
28615     "url": "/api/users",
28616     "title": "Create a new user",
28617     "examples": [
28618       {
28619         "title": "Example usage:",
28620         "content": "curl https://{domain}/api/users -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28621         "type": "json"
28622       }
28623     ],
28624     "name": "Create",
28625     "group": "Users",
28626     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28627     "version": "0.0.0",
28628     "filename": "server/api/user/index.js",
28629     "groupTitle": "Users"
28630   },
28631   {
28632     "type": "post",
28633     "url": "/api/users/{id}/api_key",
28634     "title": "Create a new API access key for the user",
28635     "examples": [
28636       {
28637         "title": "Example usage:",
28638         "content": "curl https://{domain}/api/users/:id/api_key -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28639         "type": "json"
28640       }
28641     ],
28642     "name": "CreateApiKey",
28643     "group": "Users",
28644     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28645     "version": "0.0.0",
28646     "filename": "server/api/user/index.js",
28647     "groupTitle": "Users"
28648   },
28649   {
28650     "type": "delete",
28651     "url": "/api/users/{id}",
28652     "title": "Deletes a user",
28653     "examples": [
28654       {
28655         "title": "Example usage:",
28656         "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password} -X DELETE",
28657         "type": "json"
28658       }
28659     ],
28660     "name": "Delete",
28661     "group": "Users",
28662     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28663     "version": "0.0.0",
28664     "filename": "server/api/user/index.js",
28665     "groupTitle": "Users"
28666   },
28667   {
28668     "type": "get",
28669     "url": "/api/users/describe",
28670     "title": "Gets table info about Users",
28671     "examples": [
28672       {
28673         "title": "Example usage:",
28674         "content": "curl https://{domain}/api/users/describe -v -u {name}:{password}",
28675         "type": "json"
28676       }
28677     ],
28678     "name": "DescribeUsers",
28679     "group": "Users",
28680     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28681     "version": "0.0.0",
28682     "filename": "server/api/user/index.js",
28683     "groupTitle": "Users"
28684   },
28685   {
28686     "type": "get",
28687     "url": "/api/users/{id}/agents",
28688     "title": "GetAgents",
28689     "examples": [
28690       {
28691         "title": "Example usage:",
28692         "content": "curl https://{domain}/api/users/{id}/agents -v -u {name}:{password} -X GET",
28693         "type": "json"
28694       }
28695     ],
28696     "name": "GetAgents",
28697     "group": "Users",
28698     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28699     "version": "0.0.0",
28700     "filename": "server/api/user/index.js",
28701     "groupTitle": "Users"
28702   },
28703   {
28704     "type": "get",
28705     "url": "/api/users/{id}/api_key",
28706     "title": "Get the API access key for the user",
28707     "examples": [
28708       {
28709         "title": "Example usage:",
28710         "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X GET",
28711         "type": "json"
28712       }
28713     ],
28714     "name": "GetApiKey",
28715     "group": "Users",
28716     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28717     "version": "0.0.0",
28718     "filename": "server/api/user/index.js",
28719     "groupTitle": "Users"
28720   },
28721   {
28722     "type": "get",
28723     "url": "/api/users/{id}/groups",
28724     "title": "GetChatGroups",
28725     "examples": [
28726       {
28727         "title": "Example usage:",
28728         "content": "curl https://{domain}/api/users/{id}/groups -v -u {name}:{password} -X GET",
28729         "type": "json"
28730       }
28731     ],
28732     "name": "GetChatGroups",
28733     "group": "Users",
28734     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28735     "version": "0.0.0",
28736     "filename": "server/api/user/index.js",
28737     "groupTitle": "Users"
28738   },
28739   {
28740     "type": "get",
28741     "url": "/api/users/{id}/chat/interactions",
28742     "title": "GetChatInteractions",
28743     "examples": [
28744       {
28745         "title": "Example usage:",
28746         "content": "curl https://{domain}/api/users/{id}/chat/interactions -v -u {name}:{password} -X GET",
28747         "type": "json"
28748       }
28749     ],
28750     "name": "GetChatInteractions",
28751     "group": "Users",
28752     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28753     "version": "0.0.0",
28754     "filename": "server/api/user/index.js",
28755     "groupTitle": "Users"
28756   },
28757   {
28758     "type": "get",
28759     "url": "/api/users/{id}/chat_websites",
28760     "title": "GetChatWebsites",
28761     "examples": [
28762       {
28763         "title": "Example usage:",
28764         "content": "curl https://{domain}/api/users/{id}/chat_websites -v -u {name}:{password} -X GET",
28765         "type": "json"
28766       }
28767     ],
28768     "name": "GetChatWebsites",
28769     "group": "Users",
28770     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28771     "version": "0.0.0",
28772     "filename": "server/api/user/index.js",
28773     "groupTitle": "Users"
28774   },
28775   {
28776     "type": "get",
28777     "url": "/api/users/{id}/contacts",
28778     "title": "GetContacts",
28779     "examples": [
28780       {
28781         "title": "Example usage:",
28782         "content": "curl https://{domain}/api/users/{id}/contacts -v -u {name}:{password} -X GET",
28783         "type": "json"
28784       }
28785     ],
28786     "name": "GetContacts",
28787     "group": "Users",
28788     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28789     "version": "0.0.0",
28790     "filename": "server/api/user/index.js",
28791     "groupTitle": "Users"
28792   },
28793   {
28794     "type": "get",
28795     "url": "/api/users/{id}/fax_accounts",
28796     "title": "GetFaxAccounts",
28797     "examples": [
28798       {
28799         "title": "Example usage:",
28800         "content": "curl https://{domain}/api/users/{id}/fax_accounts -v -u {name}:{password} -X GET",
28801         "type": "json"
28802       }
28803     ],
28804     "name": "GetFaxAccounts",
28805     "group": "Users",
28806     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28807     "version": "0.0.0",
28808     "filename": "server/api/user/index.js",
28809     "groupTitle": "Users"
28810   },
28811   {
28812     "type": "get",
28813     "url": "/api/users/{id}/fax/interactions",
28814     "title": "GetFaxInteractions",
28815     "examples": [
28816       {
28817         "title": "Example usage:",
28818         "content": "curl https://{domain}/api/users/{id}/fax/interactions -v -u {name}:{password} -X GET",
28819         "type": "json"
28820       }
28821     ],
28822     "name": "GetFaxInteractions",
28823     "group": "Users",
28824     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28825     "version": "0.0.0",
28826     "filename": "server/api/user/index.js",
28827     "groupTitle": "Users"
28828   },
28829   {
28830     "type": "get",
28831     "url": "/api/users/{id}/lists",
28832     "title": "GetLists",
28833     "examples": [
28834       {
28835         "title": "Example usage:",
28836         "content": "curl https://{domain}/api/users/{id}/lists -v -u {name}:{password} -X GET",
28837         "type": "json"
28838       }
28839     ],
28840     "name": "GetLists",
28841     "group": "Users",
28842     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28843     "version": "0.0.0",
28844     "filename": "server/api/user/index.js",
28845     "groupTitle": "Users"
28846   },
28847   {
28848     "type": "get",
28849     "url": "/api/users/{id}/mail_accounts",
28850     "title": "GetMailAccounts",
28851     "examples": [
28852       {
28853         "title": "Example usage:",
28854         "content": "curl https://{domain}/api/users/{id}/mail_accounts -v -u {name}:{password} -X GET",
28855         "type": "json"
28856       }
28857     ],
28858     "name": "GetMailAccounts",
28859     "group": "Users",
28860     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28861     "version": "0.0.0",
28862     "filename": "server/api/user/index.js",
28863     "groupTitle": "Users"
28864   },
28865   {
28866     "type": "get",
28867     "url": "/api/users/{id}/mail/interactions",
28868     "title": "GetMailInteractions",
28869     "examples": [
28870       {
28871         "title": "Example usage:",
28872         "content": "curl https://{domain}/api/users/{id}/mail/interactions -v -u {name}:{password} -X GET",
28873         "type": "json"
28874       }
28875     ],
28876     "name": "GetMailInteractions",
28877     "group": "Users",
28878     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28879     "version": "0.0.0",
28880     "filename": "server/api/user/index.js",
28881     "groupTitle": "Users"
28882   },
28883   {
28884     "type": "get",
28885     "url": "/api/users/{id}/openchannel_accounts",
28886     "title": "GetOpenchannelAccounts",
28887     "examples": [
28888       {
28889         "title": "Example usage:",
28890         "content": "curl https://{domain}/api/users/{id}/openchannel_accounts -v -u {name}:{password} -X GET",
28891         "type": "json"
28892       }
28893     ],
28894     "name": "GetOpenchannelAccounts",
28895     "group": "Users",
28896     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28897     "version": "0.0.0",
28898     "filename": "server/api/user/index.js",
28899     "groupTitle": "Users"
28900   },
28901   {
28902     "type": "get",
28903     "url": "/api/users/{id}/openchannel/interactions",
28904     "title": "GetOpenchannelInteractions",
28905     "examples": [
28906       {
28907         "title": "Example usage:",
28908         "content": "curl https://{domain}/api/users/{id}/openchannel/interactions -v -u {name}:{password}",
28909         "type": "json"
28910       }
28911     ],
28912     "name": "GetOpenchannelInteractions",
28913     "group": "Users",
28914     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28915     "version": "0.0.0",
28916     "filename": "server/api/user/index.js",
28917     "groupTitle": "Users"
28918   },
28919   {
28920     "type": "get",
28921     "url": "/api/users/{id}/prefixes",
28922     "title": "GetPrefixes",
28923     "examples": [
28924       {
28925         "title": "Example usage:",
28926         "content": "curl https://{domain}/api/users/{id}/prefixes -v -u {name}:{password} -X GET",
28927         "type": "json"
28928       }
28929     ],
28930     "name": "GetPrefixes",
28931     "group": "Users",
28932     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28933     "version": "0.0.0",
28934     "filename": "server/api/user/index.js",
28935     "groupTitle": "Users"
28936   },
28937   {
28938     "type": "get",
28939     "url": "/api/users/{id}/queues?channel={channel}",
28940     "title": "Gets Queues list",
28941     "examples": [
28942       {
28943         "title": "Example usage:",
28944         "content": "curl https://{domain}/api/users/{id}/queues/?channel={channel} -v -u {name}:{password} -X GET",
28945         "type": "json"
28946       }
28947     ],
28948     "name": "GetQueues",
28949     "group": "Users",
28950     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28951     "version": "0.0.0",
28952     "filename": "server/api/user/index.js",
28953     "groupTitle": "Users"
28954   },
28955   {
28956     "type": "get",
28957     "url": "/api/users/{id}/recordings",
28958     "title": "GetRecordings",
28959     "examples": [
28960       {
28961         "title": "Example usage:",
28962         "content": "curl https://{domain}/api/users/{id}/recordings -v -u {name}:{password} -X GET",
28963         "type": "json"
28964       }
28965     ],
28966     "name": "GetRecordings",
28967     "group": "Users",
28968     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28969     "version": "0.0.0",
28970     "filename": "server/api/user/index.js",
28971     "groupTitle": "Users"
28972   },
28973   {
28974     "type": "get",
28975     "url": "/api/users/{id}/scheduled_calls",
28976     "title": "GetScheduledCalls",
28977     "examples": [
28978       {
28979         "title": "Example usage:",
28980         "content": "curl https://{domain}/api/users/{id}/scheduled_calls -v -u {name}:{password} -X GET",
28981         "type": "json"
28982       }
28983     ],
28984     "name": "GetScheduledCalls",
28985     "group": "Users",
28986     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28987     "version": "0.0.0",
28988     "filename": "server/api/user/index.js",
28989     "groupTitle": "Users"
28990   },
28991   {
28992     "type": "get",
28993     "url": "/api/users/{id}/screen_recordings",
28994     "title": "GetScreenRecordings",
28995     "examples": [
28996       {
28997         "title": "Example usage:",
28998         "content": "curl https://{domain}/api/users/{id}/screen_recordings -v -u {name}:{password} -X GET",
28999         "type": "json"
29000       }
29001     ],
29002     "name": "GetScreenRecordings",
29003     "group": "Users",
29004     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29005     "version": "0.0.0",
29006     "filename": "server/api/user/index.js",
29007     "groupTitle": "Users"
29008   },
29009   {
29010     "type": "get",
29011     "url": "/api/users/{id}/sms_accounts",
29012     "title": "GetSmsAccounts",
29013     "examples": [
29014       {
29015         "title": "Example usage:",
29016         "content": "curl https://{domain}/api/users/{id}/sms_accounts -v -u {name}:{password} -X GET",
29017         "type": "json"
29018       }
29019     ],
29020     "name": "GetSmsAccounts",
29021     "group": "Users",
29022     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29023     "version": "0.0.0",
29024     "filename": "server/api/user/index.js",
29025     "groupTitle": "Users"
29026   },
29027   {
29028     "type": "get",
29029     "url": "/api/users/{id}/sms/interactions",
29030     "title": "GetSmsInteractions",
29031     "examples": [
29032       {
29033         "title": "Example usage:",
29034         "content": "curl https://{domain}/api/users/{id}/sms/interactions -v -u {name}:{password} -X GET",
29035         "type": "json"
29036       }
29037     ],
29038     "name": "GetSmsInteractions",
29039     "group": "Users",
29040     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29041     "version": "0.0.0",
29042     "filename": "server/api/user/index.js",
29043     "groupTitle": "Users"
29044   },
29045   {
29046     "type": "get",
29047     "url": "/api/users/{id}/square_projects",
29048     "title": "GetSquareProjects",
29049     "examples": [
29050       {
29051         "title": "Example usage:",
29052         "content": "curl https://{domain}/api/users/{id}/square_projects -v -u {name}:{password} -X GET",
29053         "type": "json"
29054       }
29055     ],
29056     "name": "GetSquareProjects",
29057     "group": "Users",
29058     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29059     "version": "0.0.0",
29060     "filename": "server/api/user/index.js",
29061     "groupTitle": "Users"
29062   },
29063   {
29064     "type": "get",
29065     "url": "/api/users/{id}/teams",
29066     "title": "GetTeams",
29067     "examples": [
29068       {
29069         "title": "Example usage:",
29070         "content": "curl https://{domain}/api/users/{id}/teams -v -u {name}:{password} -X GET",
29071         "type": "json"
29072       }
29073     ],
29074     "name": "GetTeams",
29075     "group": "Users",
29076     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29077     "version": "0.0.0",
29078     "filename": "server/api/user/index.js",
29079     "groupTitle": "Users"
29080   },
29081   {
29082     "type": "get",
29083     "url": "/api/users",
29084     "title": "Gets a list of Users",
29085     "examples": [
29086       {
29087         "title": "Example usage:",
29088         "content": "curl https://{domain}/api/users -v -u {name}:{password}",
29089         "type": "json"
29090       }
29091     ],
29092     "name": "GetUsers",
29093     "group": "Users",
29094     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
29095     "version": "0.0.0",
29096     "filename": "server/api/user/index.js",
29097     "groupTitle": "Users"
29098   },
29099   {
29100     "type": "get",
29101     "url": "/api/users/{id}/queues_rt",
29102     "title": "GetVoiceQueuesRt",
29103     "examples": [
29104       {
29105         "title": "Example usage:",
29106         "content": "curl https://{domain}/api/users/{id}/queues_rt -v -u {name}:{password} -X GET",
29107         "type": "json"
29108       }
29109     ],
29110     "name": "GetVoiceQueuesRt",
29111     "group": "Users",
29112     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29113     "version": "0.0.0",
29114     "filename": "server/api/user/index.js",
29115     "groupTitle": "Users"
29116   },
29117   {
29118     "type": "get",
29119     "url": "/api/users/{id}/whatsapp_accounts",
29120     "title": "GetWhatsappAccounts",
29121     "examples": [
29122       {
29123         "title": "Example usage:",
29124         "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts -v -u {name}:{password} -X GET",
29125         "type": "json"
29126       }
29127     ],
29128     "name": "GetWhatsappAccounts",
29129     "group": "Users",
29130     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29131     "version": "0.0.0",
29132     "filename": "server/api/user/index.js",
29133     "groupTitle": "Users"
29134   },
29135   {
29136     "type": "get",
29137     "url": "/api/users/{id}/whatsapp/interactions",
29138     "title": "GetWhatsappInteractions",
29139     "examples": [
29140       {
29141         "title": "Example usage:",
29142         "content": "curl https://{domain}/api/users/{id}/whatsapp/interactions -v -u {name}:{password} -X GET",
29143         "type": "json"
29144       }
29145     ],
29146     "name": "GetWhatsappInteractions",
29147     "group": "Users",
29148     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29149     "version": "0.0.0",
29150     "filename": "server/api/user/index.js",
29151     "groupTitle": "Users"
29152   },
29153   {
29154     "type": "post",
29155     "url": "/api/users/{id}/login",
29156     "title": "Login",
29157     "examples": [
29158       {
29159         "title": "Example usage:",
29160         "content": "curl https://{domain}/api/users/{id}/login  -v -u {name}:{password} -X POST",
29161         "type": "json"
29162       }
29163     ],
29164     "name": "Login",
29165     "group": "Users",
29166     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29167     "version": "0.0.0",
29168     "filename": "server/api/user/index.js",
29169     "groupTitle": "Users"
29170   },
29171   {
29172     "type": "post",
29173     "url": "/api/users/{id}/logout",
29174     "title": "Logout",
29175     "examples": [
29176       {
29177         "title": "Example usage:",
29178         "content": "curl https://{domain}/api/users/{id}/logout -v -u {name}:{password} -X POST",
29179         "type": "json"
29180       }
29181     ],
29182     "name": "Logout",
29183     "group": "Users",
29184     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29185     "version": "0.0.0",
29186     "filename": "server/api/user/index.js",
29187     "groupTitle": "Users"
29188   },
29189   {
29190     "type": "post",
29191     "url": "/api/users/{id}/pause",
29192     "title": "Pause",
29193     "examples": [
29194       {
29195         "title": "Example usage:",
29196         "content": "curl https://{domain}/api/users/{id}/pause -v -u {name}:{password} -X POST",
29197         "type": "json"
29198       }
29199     ],
29200     "name": "Pause",
29201     "group": "Users",
29202     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29203     "version": "0.0.0",
29204     "filename": "server/api/user/index.js",
29205     "groupTitle": "Users"
29206   },
29207   {
29208     "type": "delete",
29209     "url": "/api/users/{id}/api_key",
29210     "title": "Remove API access key for the user",
29211     "examples": [
29212       {
29213         "title": "Example usage:",
29214         "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X DELETE",
29215         "type": "json"
29216       }
29217     ],
29218     "name": "RemoveApiKey",
29219     "group": "Users",
29220     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29221     "version": "0.0.0",
29222     "filename": "server/api/user/index.js",
29223     "groupTitle": "Users"
29224   },
29225   {
29226     "type": "delete",
29227     "url": "/api/users/{id}/chat_interactions",
29228     "title": "Removes interactions from an agent",
29229     "examples": [
29230       {
29231         "title": "Example usage:",
29232         "content": "curl https://{domain}/api/users/{id}/chat_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29233         "type": "json"
29234       }
29235     ],
29236     "name": "RemoveChatInteractions",
29237     "group": "Users",
29238     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29239     "version": "0.0.0",
29240     "filename": "server/api/user/index.js",
29241     "groupTitle": "Users"
29242   },
29243   {
29244     "type": "delete",
29245     "url": "/api/users/{id}/chat_websites",
29246     "title": "Removes a Chat Website from a user",
29247     "examples": [
29248       {
29249         "title": "Example usage:",
29250         "content": "curl https://{domain}/api/users/{id}/chat_websites?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29251         "type": "json"
29252       }
29253     ],
29254     "name": "RemoveChatWebsites",
29255     "group": "Users",
29256     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29257     "version": "0.0.0",
29258     "filename": "server/api/user/index.js",
29259     "groupTitle": "Users"
29260   },
29261   {
29262     "type": "delete",
29263     "url": "/api/users/{id}/fax_accounts",
29264     "title": "Removes a Fax Account from a user",
29265     "examples": [
29266       {
29267         "title": "Example usage:",
29268         "content": "curl https://{domain}/api/users/{id}/fax_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29269         "type": "json"
29270       }
29271     ],
29272     "name": "RemoveFaxAccounts",
29273     "group": "Users",
29274     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29275     "version": "0.0.0",
29276     "filename": "server/api/user/index.js",
29277     "groupTitle": "Users"
29278   },
29279   {
29280     "type": "delete",
29281     "url": "/api/users/{id}/fax_interactions",
29282     "title": "Removes interactions from an agent",
29283     "examples": [
29284       {
29285         "title": "Example usage:",
29286         "content": "curl https://{domain}/api/users/{id}/fax_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29287         "type": "json"
29288       }
29289     ],
29290     "name": "RemoveFaxInteractions",
29291     "group": "Users",
29292     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29293     "version": "0.0.0",
29294     "filename": "server/api/user/index.js",
29295     "groupTitle": "Users"
29296   },
29297   {
29298     "type": "delete",
29299     "url": "/api/users/{id}/mail_accounts",
29300     "title": "Removes a Mail Account from a user",
29301     "examples": [
29302       {
29303         "title": "Example usage:",
29304         "content": "curl https://{domain}/api/users/{id}/mail_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29305         "type": "json"
29306       }
29307     ],
29308     "name": "RemoveMailAccounts",
29309     "group": "Users",
29310     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29311     "version": "0.0.0",
29312     "filename": "server/api/user/index.js",
29313     "groupTitle": "Users"
29314   },
29315   {
29316     "type": "delete",
29317     "url": "/api/users/{id}/mail_interactions",
29318     "title": "Removes interactions from an agent",
29319     "examples": [
29320       {
29321         "title": "Example usage:",
29322         "content": "curl https://{domain}/api/users/{id}/mail_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29323         "type": "json"
29324       }
29325     ],
29326     "name": "RemoveMailInteractions",
29327     "group": "Users",
29328     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29329     "version": "0.0.0",
29330     "filename": "server/api/user/index.js",
29331     "groupTitle": "Users"
29332   },
29333   {
29334     "type": "delete",
29335     "url": "/api/users/{id}/openchannel_accounts",
29336     "title": "Removes a Open Channel Account from a user",
29337     "examples": [
29338       {
29339         "title": "Example usage:",
29340         "content": "curl https://{domain}/api/users/{id}/openchannel_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29341         "type": "json"
29342       }
29343     ],
29344     "name": "RemoveOpenchannelAccounts",
29345     "group": "Users",
29346     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29347     "version": "0.0.0",
29348     "filename": "server/api/user/index.js",
29349     "groupTitle": "Users"
29350   },
29351   {
29352     "type": "delete",
29353     "url": "/api/users/{id}/openchannel_interactions",
29354     "title": "Removes openchannel interactions from an agent",
29355     "examples": [
29356       {
29357         "title": "Example usage:",
29358         "content": "curl https://{domain}/api/users/{id}/openchannel_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29359         "type": "json"
29360       }
29361     ],
29362     "name": "RemoveOpenchannelInteractions",
29363     "group": "Users",
29364     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29365     "version": "0.0.0",
29366     "filename": "server/api/user/index.js",
29367     "groupTitle": "Users"
29368   },
29369   {
29370     "type": "delete",
29371     "url": "/api/users/{id}/queues",
29372     "title": "Remove queues to an agent",
29373     "examples": [
29374       {
29375         "title": "Example usage:",
29376         "content": "curl https://{domain}/api/users/{id}/queues?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29377         "type": "json"
29378       }
29379     ],
29380     "name": "RemoveQueues",
29381     "group": "Users",
29382     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29383     "version": "0.0.0",
29384     "filename": "server/api/user/index.js",
29385     "groupTitle": "Users"
29386   },
29387   {
29388     "type": "delete",
29389     "url": "/api/users/{id}/sms_accounts",
29390     "title": "Removes a Sms Account from a user",
29391     "examples": [
29392       {
29393         "title": "Example usage:",
29394         "content": "curl https://{domain}/api/users/{id}/sms_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29395         "type": "json"
29396       }
29397     ],
29398     "name": "RemoveSmsAccounts",
29399     "group": "Users",
29400     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29401     "version": "0.0.0",
29402     "filename": "server/api/user/index.js",
29403     "groupTitle": "Users"
29404   },
29405   {
29406     "type": "delete",
29407     "url": "/api/users/{id}/sms_interactions",
29408     "title": "Removes interactions from an agent",
29409     "examples": [
29410       {
29411         "title": "Example usage:",
29412         "content": "curl https://{domain}/api/users/{id}/sms_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29413         "type": "json"
29414       }
29415     ],
29416     "name": "RemoveSmsInteractions",
29417     "group": "Users",
29418     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29419     "version": "0.0.0",
29420     "filename": "server/api/user/index.js",
29421     "groupTitle": "Users"
29422   },
29423   {
29424     "type": "delete",
29425     "url": "/api/users/{id}/square_projects",
29426     "title": "Removes a Square Project from a user",
29427     "examples": [
29428       {
29429         "title": "Example usage:",
29430         "content": "curl https://{domain}/api/users/{id}/square_projects?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29431         "type": "json"
29432       }
29433     ],
29434     "name": "RemoveSquareProjects",
29435     "group": "Users",
29436     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29437     "version": "0.0.0",
29438     "filename": "server/api/user/index.js",
29439     "groupTitle": "Users"
29440   },
29441   {
29442     "type": "delete",
29443     "url": "/api/users/{id}/teams",
29444     "title": "Removes teams from an agent",
29445     "examples": [
29446       {
29447         "title": "Example usage:",
29448         "content": "curl https://{domain}/api/users/{id}/teams?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29449         "type": "json"
29450       }
29451     ],
29452     "name": "RemoveTeams",
29453     "group": "Users",
29454     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29455     "version": "0.0.0",
29456     "filename": "server/api/user/index.js",
29457     "groupTitle": "Users"
29458   },
29459   {
29460     "type": "delete",
29461     "url": "/api/users/{id}/whatsapp_accounts",
29462     "title": "Removes a Whatsapp Account from a user",
29463     "examples": [
29464       {
29465         "title": "Example usage:",
29466         "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29467         "type": "json"
29468       }
29469     ],
29470     "name": "RemoveWhatsappAccounts",
29471     "group": "Users",
29472     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29473     "version": "0.0.0",
29474     "filename": "server/api/user/index.js",
29475     "groupTitle": "Users"
29476   },
29477   {
29478     "type": "delete",
29479     "url": "/api/users/{id}/whatsapp_interactions",
29480     "title": "Removes Whatsapp interactions from an agent",
29481     "examples": [
29482       {
29483         "title": "Example usage:",
29484         "content": "curl https://{domain}/api/users/{id}/whatsapp_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29485         "type": "json"
29486       }
29487     ],
29488     "name": "RemoveWhatsappInteractions",
29489     "group": "Users",
29490     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29491     "version": "0.0.0",
29492     "filename": "server/api/user/index.js",
29493     "groupTitle": "Users"
29494   },
29495   {
29496     "type": "get",
29497     "url": "/api/users/{id}",
29498     "title": "Gets a single User",
29499     "examples": [
29500       {
29501         "title": "Example usage:",
29502         "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password}",
29503         "type": "json"
29504       }
29505     ],
29506     "name": "ShowUsers",
29507     "group": "Users",
29508     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29509     "version": "0.0.0",
29510     "filename": "server/api/user/index.js",
29511     "groupTitle": "Users"
29512   },
29513   {
29514     "type": "post",
29515     "url": "/api/users/{id}/unpause",
29516     "title": "Unpause",
29517     "examples": [
29518       {
29519         "title": "Example usage:",
29520         "content": "curl https://{domain}/api/users/{id}/unpause -v -u {name}:{password} -X POST",
29521         "type": "json"
29522       }
29523     ],
29524     "name": "Unpause",
29525     "group": "Users",
29526     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29527     "version": "0.0.0",
29528     "filename": "server/api/user/index.js",
29529     "groupTitle": "Users"
29530   },
29531   {
29532     "type": "get",
29533     "url": "/api/users/whoami",
29534     "title": "WhoAmI",
29535     "examples": [
29536       {
29537         "title": "Example usage:",
29538         "content": "curl https://{domain}/api/users/whoami -v -u {name}:{password} -X GET",
29539         "type": "json"
29540       }
29541     ],
29542     "name": "WhoAmI",
29543     "group": "Users",
29544     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29545     "version": "0.0.0",
29546     "filename": "server/api/user/index.js",
29547     "groupTitle": "Users"
29548   },
29549   {
29550     "type": "post",
29551     "url": "/api/users/{id}/avatar",
29552     "title": "Add avatar",
29553     "examples": [
29554       {
29555         "title": "Example usage:",
29556         "content": "curl https://{domain}/api/users/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
29557         "type": "json"
29558       }
29559     ],
29560     "name": "addAvatar",
29561     "group": "Users",
29562     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29563     "version": "0.0.0",
29564     "filename": "server/api/user/index.js",
29565     "groupTitle": "Users"
29566   },
29567   {
29568     "type": "post",
29569     "url": "/api/users/create_many",
29570     "title": "Create Users",
29571     "examples": [
29572       {
29573         "title": "Example usage:",
29574         "content": "curl https://{domain}/api/users/create_many -d '[{\"name\": \"john.doe\", \"role\": \"user\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",
29575         "type": "json"
29576       }
29577     ],
29578     "name": "bulkCreate",
29579     "group": "Users",
29580     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29581     "version": "0.0.0",
29582     "filename": "server/api/user/index.js",
29583     "groupTitle": "Users"
29584   },
29585   {
29586     "type": "get",
29587     "url": "/api/users/{id}/avatar",
29588     "title": "Get avatar",
29589     "examples": [
29590       {
29591         "title": "Example usage:",
29592         "content": "curl https://{domain}/api/users/{id}/avatar -v -u {name}:{password} -X GET",
29593         "type": "json"
29594       }
29595     ],
29596     "name": "getAvatar",
29597     "group": "Users",
29598     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29599     "version": "0.0.0",
29600     "filename": "server/api/user/index.js",
29601     "groupTitle": "Users"
29602   },
29603   {
29604     "type": "put",
29605     "url": "/api/users/{id}",
29606     "title": "Update an existing User",
29607     "examples": [
29608       {
29609         "title": "Example usage:",
29610         "content": "curl https://{domain}/api/users/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
29611         "type": "json"
29612       }
29613     ],
29614     "name": "updateUsers",
29615     "group": "Users",
29616     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29617     "version": "0.0.0",
29618     "filename": "server/api/user/index.js",
29619     "groupTitle": "Users"
29620   },
29621   {
29622     "type": "post",
29623     "url": "/api/variables",
29624     "title": "Creates a new Variable",
29625     "examples": [
29626       {
29627         "title": "Example usage:",
29628         "content": "curl https://{domain}/api/variables -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
29629         "type": "json"
29630       }
29631     ],
29632     "name": "CreateVariables",
29633     "group": "Variables",
29634     "parameter": {
29635       "fields": {
29636         "Body": [
29637           {
29638             "group": "Body",
29639             "type": "String",
29640             "optional": false,
29641             "field": "name",
29642             "description": ""
29643           },
29644           {
29645             "group": "Body",
29646             "type": "String",
29647             "optional": true,
29648             "field": "description",
29649             "description": ""
29650           }
29651         ]
29652       }
29653     },
29654     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29655     "version": "0.0.0",
29656     "filename": "server/api/variable/index.js",
29657     "groupTitle": "Variables"
29658   },
29659   {
29660     "type": "delete",
29661     "url": "/api/variables/{id}",
29662     "title": "Deletes a Variable",
29663     "examples": [
29664       {
29665         "title": "Example usage:",
29666         "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password} -X DELETE",
29667         "type": "json"
29668       }
29669     ],
29670     "name": "DeleteVariables",
29671     "group": "Variables",
29672     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29673     "version": "0.0.0",
29674     "filename": "server/api/variable/index.js",
29675     "groupTitle": "Variables"
29676   },
29677   {
29678     "type": "get",
29679     "url": "/api/variables",
29680     "title": "Gets a list of Variables",
29681     "examples": [
29682       {
29683         "title": "Example usage:",
29684         "content": "curl https://{domain}/api/variables -v -u {name}:{password}",
29685         "type": "json"
29686       }
29687     ],
29688     "name": "GetVariables",
29689     "group": "Variables",
29690     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
29691     "version": "0.0.0",
29692     "filename": "server/api/variable/index.js",
29693     "groupTitle": "Variables"
29694   },
29695   {
29696     "type": "get",
29697     "url": "/api/variables/{id}",
29698     "title": "Gets a single Variable",
29699     "examples": [
29700       {
29701         "title": "Example usage:",
29702         "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password}",
29703         "type": "json"
29704       }
29705     ],
29706     "name": "ShowVariables",
29707     "group": "Variables",
29708     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29709     "version": "0.0.0",
29710     "filename": "server/api/variable/index.js",
29711     "groupTitle": "Variables"
29712   },
29713   {
29714     "type": "put",
29715     "url": "/api/variables/{id}",
29716     "title": "Update an existing Variable",
29717     "examples": [
29718       {
29719         "title": "Example usage:",
29720         "content": "curl https://{domain}/api/variables/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
29721         "type": "json"
29722       }
29723     ],
29724     "name": "updateVariables",
29725     "group": "Variables",
29726     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29727     "version": "0.0.0",
29728     "filename": "server/api/variable/index.js",
29729     "groupTitle": "Variables"
29730   },
29731   {
29732     "type": "get",
29733     "url": "/api/version/fetch",
29734     "title": "Fetch git version",
29735     "examples": [
29736       {
29737         "title": "Example usage:",
29738         "content": "curl https://{domain}/api/version/fetch -v -u {name}:{password}",
29739         "type": "json"
29740       }
29741     ],
29742     "name": "FetchVersion",
29743     "group": "Version",
29744     "description": "<p>Motion run the following command: git fetch origin master</p>",
29745     "version": "0.0.0",
29746     "filename": "server/api/version/index.js",
29747     "groupTitle": "Version"
29748   },
29749   {
29750     "type": "get",
29751     "url": "/api/version",
29752     "title": "Gets version",
29753     "examples": [
29754       {
29755         "title": "Example usage:",
29756         "content": "curl https://{domain}/api/version -v -u {name}:{password}",
29757         "type": "json"
29758       }
29759     ],
29760     "name": "GetVersion",
29761     "group": "Version",
29762     "description": "<p>Motion returns the current and latest motion version.</p>",
29763     "version": "0.0.0",
29764     "filename": "server/api/version/index.js",
29765     "groupTitle": "Version"
29766   },
29767   {
29768     "type": "get",
29769     "url": "/api/version/migrations",
29770     "title": "Launch database migrations",
29771     "examples": [
29772       {
29773         "title": "Example usage:",
29774         "content": "curl https://{domain}/api/version/migrations -v -u {name}:{password}",
29775         "type": "json"
29776       }
29777     ],
29778     "name": "MigrateVersion",
29779     "group": "Version",
29780     "description": "<p>Motion launch the database migrations, according to the application version</p>",
29781     "version": "0.0.0",
29782     "filename": "server/api/version/index.js",
29783     "groupTitle": "Version"
29784   },
29785   {
29786     "type": "get",
29787     "url": "/api/version/pull",
29788     "title": "Pull git version",
29789     "examples": [
29790       {
29791         "title": "Example usage:",
29792         "content": "curl https://{domain}/api/version/pull -v -u {name}:{password}",
29793         "type": "json"
29794       }
29795     ],
29796     "name": "PullVersion",
29797     "group": "Version",
29798     "description": "<p>Motion run the following command: git pull</p>",
29799     "version": "0.0.0",
29800     "filename": "server/api/version/index.js",
29801     "groupTitle": "Version"
29802   },
29803   {
29804     "type": "get",
29805     "url": "/api/version/reset",
29806     "title": "Reset git version",
29807     "examples": [
29808       {
29809         "title": "Example usage:",
29810         "content": "curl https://{domain}/api/version/reset -v -u {name}:{password}",
29811         "type": "json"
29812       }
29813     ],
29814     "name": "ResetVersion",
29815     "group": "Version",
29816     "description": "<p>Motion run the following command: git reset --hard FETCH_HEAD</p>",
29817     "version": "0.0.0",
29818     "filename": "server/api/version/index.js",
29819     "groupTitle": "Version"
29820   },
29821   {
29822     "type": "get",
29823     "url": "/api/version/restart",
29824     "title": "Restart motion2 after update",
29825     "examples": [
29826       {
29827         "title": "Example usage:",
29828         "content": "curl https://{domain}/api/version/restart -v -u {name}:{password}",
29829         "type": "json"
29830       }
29831     ],
29832     "name": "RestartVersion",
29833     "group": "Version",
29834     "description": "<p>Motion run the following command: pm2 restart motion</p>",
29835     "version": "0.0.0",
29836     "filename": "server/api/version/index.js",
29837     "groupTitle": "Version"
29838   },
29839   {
29840     "type": "get",
29841     "url": "/api/voice/agents/reports/describe",
29842     "title": "Gets table info about Agent Reports",
29843     "examples": [
29844       {
29845         "title": "Example usage:",
29846         "content": "curl https://{domain}/api/voice/agents/reports/describe -v -u {name}:{password}",
29847         "type": "json"
29848       }
29849     ],
29850     "name": "DescribeAgent_Reports",
29851     "group": "Voice_Agent_Reports",
29852     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29853     "version": "0.0.0",
29854     "filename": "server/api/voiceAgentReport/index.js",
29855     "groupTitle": "Voice_Agent_Reports"
29856   },
29857   {
29858     "type": "get",
29859     "url": "/api/voice/agents/reports",
29860     "title": "Gets a list of Agent Reports",
29861     "examples": [
29862       {
29863         "title": "Example usage:",
29864         "content": "curl https://{domain}/api/voice/agents/reports -v -u {name}:{password}",
29865         "type": "json"
29866       }
29867     ],
29868     "name": "GetAgent_Reports",
29869     "group": "Voice_Agent_Reports",
29870     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
29871     "version": "0.0.0",
29872     "filename": "server/api/voiceAgentReport/index.js",
29873     "groupTitle": "Voice_Agent_Reports"
29874   },
29875   {
29876     "type": "get",
29877     "url": "/api/voice/agents/reports/{id}",
29878     "title": "Gets a single Agent Report",
29879     "examples": [
29880       {
29881         "title": "Example usage:",
29882         "content": "curl https://{domain}/api/voice/agents/reports/{id} -v -u {name}:{password}",
29883         "type": "json"
29884       }
29885     ],
29886     "name": "ShowAgent_Reports",
29887     "group": "Voice_Agent_Reports",
29888     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29889     "version": "0.0.0",
29890     "filename": "server/api/voiceAgentReport/index.js",
29891     "groupTitle": "Voice_Agent_Reports"
29892   },
29893   {
29894     "type": "get",
29895     "url": "/api/voice/calls/reports/describe",
29896     "title": "Gets table info about Call Reports",
29897     "examples": [
29898       {
29899         "title": "Example usage:",
29900         "content": "curl https://{domain}/api/voice/calls/reports/describe -v -u {name}:{password}",
29901         "type": "json"
29902       }
29903     ],
29904     "name": "DescribeCall_Reports",
29905     "group": "Voice_Call_Reports",
29906     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29907     "version": "0.0.0",
29908     "filename": "server/api/voiceCallReport/index.js",
29909     "groupTitle": "Voice_Call_Reports"
29910   },
29911   {
29912     "type": "get",
29913     "url": "/api/voice/calls/reports",
29914     "title": "Gets a list of Call Reports",
29915     "examples": [
29916       {
29917         "title": "Example usage:",
29918         "content": "curl https://{domain}/api/voice/calls/reports -v -u {name}:{password}",
29919         "type": "json"
29920       }
29921     ],
29922     "name": "GetCall_Reports",
29923     "group": "Voice_Call_Reports",
29924     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
29925     "version": "0.0.0",
29926     "filename": "server/api/voiceCallReport/index.js",
29927     "groupTitle": "Voice_Call_Reports"
29928   },
29929   {
29930     "type": "get",
29931     "url": "/api/voice/calls/reports/{id}",
29932     "title": "Gets a single Call Report",
29933     "examples": [
29934       {
29935         "title": "Example usage:",
29936         "content": "curl https://{domain}/api/voice/calls/reports/{id} -v -u {name}:{password}",
29937         "type": "json"
29938       }
29939     ],
29940     "name": "ShowCall_Reports",
29941     "group": "Voice_Call_Reports",
29942     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29943     "version": "0.0.0",
29944     "filename": "server/api/voiceCallReport/index.js",
29945     "groupTitle": "Voice_Call_Reports"
29946   },
29947   {
29948     "type": "put",
29949     "url": "/api/voice/calls/reports/{id}",
29950     "title": "Update a single cdr",
29951     "examples": [
29952       {
29953         "title": "Example usage:",
29954         "content": "curl https://{domain}/api/voice/calls/reports/{id} -d '{\"userDispositio\": \"OK\"}' -v -u {name}:{password} -X PUT",
29955         "type": "json"
29956       }
29957     ],
29958     "name": "update",
29959     "group": "Voice_Call_Reports",
29960     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29961     "version": "0.0.0",
29962     "filename": "server/api/voiceCallReport/index.js",
29963     "groupTitle": "Voice_Call_Reports"
29964   },
29965   {
29966     "type": "post",
29967     "url": "/api/voice/chanspy",
29968     "title": "Creates a new ChanSpy",
29969     "examples": [
29970       {
29971         "title": "Example usage:",
29972         "content": "curl https://{domain}/api/voice/chanspy -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
29973         "type": "json"
29974       }
29975     ],
29976     "name": "CreateChanSpy",
29977     "group": "Voice_ChanSpy",
29978     "parameter": {
29979       "fields": {
29980         "Body": [
29981           {
29982             "group": "Body",
29983             "type": "String",
29984             "optional": true,
29985             "field": "name",
29986             "description": ""
29987           },
29988           {
29989             "group": "Body",
29990             "type": "String",
29991             "optional": false,
29992             "field": "prefix",
29993             "description": ""
29994           },
29995           {
29996             "group": "Body",
29997             "type": "String",
29998             "optional": true,
29999             "field": "options",
30000             "description": ""
30001           },
30002           {
30003             "group": "Body",
30004             "type": "Boolean",
30005             "optional": true,
30006             "field": "auth",
30007             "description": ""
30008           },
30009           {
30010             "group": "Body",
30011             "type": "String",
30012             "optional": true,
30013             "field": "password",
30014             "description": ""
30015           },
30016           {
30017             "group": "Body",
30018             "type": "Boolean",
30019             "optional": true,
30020             "field": "record",
30021             "description": ""
30022           },
30023           {
30024             "group": "Body",
30025             "type": "String",
30026             "optional": true,
30027             "field": "recordingFormat",
30028             "description": ""
30029           },
30030           {
30031             "group": "Body",
30032             "type": "String",
30033             "optional": true,
30034             "field": "description",
30035             "description": ""
30036           }
30037         ]
30038       }
30039     },
30040     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30041     "version": "0.0.0",
30042     "filename": "server/api/voiceChanSpy/index.js",
30043     "groupTitle": "Voice_ChanSpy"
30044   },
30045   {
30046     "type": "delete",
30047     "url": "/api/voice/chanspy/{id}",
30048     "title": "Deletes a ChanSpy",
30049     "examples": [
30050       {
30051         "title": "Example usage:",
30052         "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password} -X DELETE",
30053         "type": "json"
30054       }
30055     ],
30056     "name": "DeleteChanSpy",
30057     "group": "Voice_ChanSpy",
30058     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30059     "version": "0.0.0",
30060     "filename": "server/api/voiceChanSpy/index.js",
30061     "groupTitle": "Voice_ChanSpy"
30062   },
30063   {
30064     "type": "get",
30065     "url": "/api/voice/chanspy",
30066     "title": "Gets a list of ChanSpy",
30067     "examples": [
30068       {
30069         "title": "Example usage:",
30070         "content": "curl https://{domain}/api/voice/chanspy -v -u {name}:{password}",
30071         "type": "json"
30072       }
30073     ],
30074     "name": "GetChanSpy",
30075     "group": "Voice_ChanSpy",
30076     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30077     "version": "0.0.0",
30078     "filename": "server/api/voiceChanSpy/index.js",
30079     "groupTitle": "Voice_ChanSpy"
30080   },
30081   {
30082     "type": "get",
30083     "url": "/api/voice/chanspy/{id}",
30084     "title": "Gets a single ChanSpy",
30085     "examples": [
30086       {
30087         "title": "Example usage:",
30088         "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password}",
30089         "type": "json"
30090       }
30091     ],
30092     "name": "ShowChanSpy",
30093     "group": "Voice_ChanSpy",
30094     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30095     "version": "0.0.0",
30096     "filename": "server/api/voiceChanSpy/index.js",
30097     "groupTitle": "Voice_ChanSpy"
30098   },
30099   {
30100     "type": "put",
30101     "url": "/api/voice/chanspy/{id}",
30102     "title": "Update an existing ChanSpy",
30103     "examples": [
30104       {
30105         "title": "Example usage:",
30106         "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",
30107         "type": "json"
30108       }
30109     ],
30110     "name": "updateChanSpy",
30111     "group": "Voice_ChanSpy",
30112     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30113     "version": "0.0.0",
30114     "filename": "server/api/voiceChanSpy/index.js",
30115     "groupTitle": "Voice_ChanSpy"
30116   },
30117   {
30118     "type": "post",
30119     "url": "/api/voice/contexts",
30120     "title": "Create a new context",
30121     "examples": [
30122       {
30123         "title": "Example usage:",
30124         "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password} -X POST",
30125         "type": "json"
30126       }
30127     ],
30128     "name": "Create",
30129     "group": "Voice_Contexts",
30130     "parameter": {
30131       "fields": {
30132         "Body": [
30133           {
30134             "group": "Body",
30135             "type": "String",
30136             "optional": true,
30137             "field": "name",
30138             "description": ""
30139           },
30140           {
30141             "group": "Body",
30142             "type": "String",
30143             "optional": true,
30144             "field": "description",
30145             "description": ""
30146           },
30147           {
30148             "group": "Body",
30149             "type": "Boolean",
30150             "optional": true,
30151             "field": "defaultEntry",
30152             "description": ""
30153           }
30154         ]
30155       }
30156     },
30157     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30158     "version": "0.0.0",
30159     "filename": "server/api/voiceContext/index.js",
30160     "groupTitle": "Voice_Contexts"
30161   },
30162   {
30163     "type": "delete",
30164     "url": "/api/voice/contexts/{id}",
30165     "title": "Deletes a context",
30166     "examples": [
30167       {
30168         "title": "Example usage:",
30169         "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X DELETE",
30170         "type": "json"
30171       }
30172     ],
30173     "name": "Delete",
30174     "group": "Voice_Contexts",
30175     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30176     "version": "0.0.0",
30177     "filename": "server/api/voiceContext/index.js",
30178     "groupTitle": "Voice_Contexts"
30179   },
30180   {
30181     "type": "get",
30182     "url": "/api/voice/contexts",
30183     "title": "Gets a list of Contexts",
30184     "examples": [
30185       {
30186         "title": "Example usage:",
30187         "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password}",
30188         "type": "json"
30189       }
30190     ],
30191     "name": "GetContexts",
30192     "group": "Voice_Contexts",
30193     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30194     "version": "0.0.0",
30195     "filename": "server/api/voiceContext/index.js",
30196     "groupTitle": "Voice_Contexts"
30197   },
30198   {
30199     "type": "get",
30200     "url": "/api/voice/contexts/{id}",
30201     "title": "Gets a single Context",
30202     "examples": [
30203       {
30204         "title": "Example usage:",
30205         "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password}",
30206         "type": "json"
30207       }
30208     ],
30209     "name": "ShowContexts",
30210     "group": "Voice_Contexts",
30211     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30212     "version": "0.0.0",
30213     "filename": "server/api/voiceContext/index.js",
30214     "groupTitle": "Voice_Contexts"
30215   },
30216   {
30217     "type": "put",
30218     "url": "/api/voice/contexts/{id}",
30219     "title": "Update an existing context",
30220     "examples": [
30221       {
30222         "title": "Example usage:",
30223         "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X PUT",
30224         "type": "json"
30225       }
30226     ],
30227     "name": "Update",
30228     "group": "Voice_Contexts",
30229     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30230     "version": "0.0.0",
30231     "filename": "server/api/voiceContext/index.js",
30232     "groupTitle": "Voice_Contexts"
30233   },
30234   {
30235     "type": "get",
30236     "url": "/api/voice/dials/reports/describe",
30237     "title": "Gets table info about Dial Reports",
30238     "examples": [
30239       {
30240         "title": "Example usage:",
30241         "content": "curl https://{domain}/api/voice/dials/reports/describe -v -u {name}:{password}",
30242         "type": "json"
30243       }
30244     ],
30245     "name": "DescribeDial_Reports",
30246     "group": "Voice_Dial_Reports",
30247     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30248     "version": "0.0.0",
30249     "filename": "server/api/voiceDialReport/index.js",
30250     "groupTitle": "Voice_Dial_Reports"
30251   },
30252   {
30253     "type": "get",
30254     "url": "/api/voice/dials/reports",
30255     "title": "Gets a list of Dial Reports",
30256     "examples": [
30257       {
30258         "title": "Example usage:",
30259         "content": "curl https://{domain}/api/voice/dials/reports -v -u {name}:{password}",
30260         "type": "json"
30261       }
30262     ],
30263     "name": "GetDial_Reports",
30264     "group": "Voice_Dial_Reports",
30265     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30266     "version": "0.0.0",
30267     "filename": "server/api/voiceDialReport/index.js",
30268     "groupTitle": "Voice_Dial_Reports"
30269   },
30270   {
30271     "type": "get",
30272     "url": "/api/voice/dials/reports/{id}",
30273     "title": "Gets a single Dial Report",
30274     "examples": [
30275       {
30276         "title": "Example usage:",
30277         "content": "curl https://{domain}/api/voice/dials/reports/{id} -v -u {name}:{password}",
30278         "type": "json"
30279       }
30280     ],
30281     "name": "ShowDial_Reports",
30282     "group": "Voice_Dial_Reports",
30283     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30284     "version": "0.0.0",
30285     "filename": "server/api/voiceDialReport/index.js",
30286     "groupTitle": "Voice_Dial_Reports"
30287   },
30288   {
30289     "type": "delete",
30290     "url": "/api/voice/extensions/{id}",
30291     "title": "Deletes a Extension",
30292     "examples": [
30293       {
30294         "title": "Example usage:",
30295         "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password} -X DELETE",
30296         "type": "json"
30297       }
30298     ],
30299     "name": "DeleteExtensions",
30300     "group": "Voice_Extensions",
30301     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30302     "version": "0.0.0",
30303     "filename": "server/api/voiceExtension/index.js",
30304     "groupTitle": "Voice_Extensions"
30305   },
30306   {
30307     "type": "get",
30308     "url": "/api/voice/extensions",
30309     "title": "Gets a list of Extensions",
30310     "examples": [
30311       {
30312         "title": "Example usage:",
30313         "content": "curl https://{domain}/api/voice/extensions -v -u {name}:{password}",
30314         "type": "json"
30315       }
30316     ],
30317     "name": "GetExtensions",
30318     "group": "Voice_Extensions",
30319     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30320     "version": "0.0.0",
30321     "filename": "server/api/voiceExtension/index.js",
30322     "groupTitle": "Voice_Extensions"
30323   },
30324   {
30325     "type": "get",
30326     "url": "/api/voice/extensions/{id}",
30327     "title": "Gets a single Extension",
30328     "examples": [
30329       {
30330         "title": "Example usage:",
30331         "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password}",
30332         "type": "json"
30333       }
30334     ],
30335     "name": "ShowExtensions",
30336     "group": "Voice_Extensions",
30337     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30338     "version": "0.0.0",
30339     "filename": "server/api/voiceExtension/index.js",
30340     "groupTitle": "Voice_Extensions"
30341   },
30342   {
30343     "type": "post",
30344     "url": "/api/voice/extensions",
30345     "title": "Create new applications",
30346     "examples": [
30347       {
30348         "title": "Example usage:",
30349         "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",
30350         "type": "json"
30351       }
30352     ],
30353     "name": "addApplications",
30354     "group": "Voice_Extensions",
30355     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30356     "version": "0.0.0",
30357     "filename": "server/api/voiceExtension/index.js",
30358     "groupTitle": "Voice_Extensions"
30359   },
30360   {
30361     "type": "post",
30362     "url": "/api/voice/extensions",
30363     "title": "Create an extension",
30364     "examples": [
30365       {
30366         "title": "Example usage:",
30367         "content": "curl https://{domain}/api/voice/extensions -d '{\"exten\": \"12345\", \"context\": \"from-custom\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30368         "type": "json"
30369       }
30370     ],
30371     "name": "create",
30372     "group": "Voice_Extensions",
30373     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30374     "version": "0.0.0",
30375     "filename": "server/api/voiceExtension/index.js",
30376     "groupTitle": "Voice_Extensions"
30377   },
30378   {
30379     "type": "put",
30380     "url": "/api/voice/extensions/{id}",
30381     "title": "Update an extension",
30382     "examples": [
30383       {
30384         "title": "Example usage:",
30385         "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",
30386         "type": "json"
30387       }
30388     ],
30389     "name": "update",
30390     "group": "Voice_Extensions",
30391     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30392     "version": "0.0.0",
30393     "filename": "server/api/voiceExtension/index.js",
30394     "groupTitle": "Voice_Extensions"
30395   },
30396   {
30397     "type": "post",
30398     "url": "/api/voice/mohs",
30399     "title": "Create a new a new MOH",
30400     "examples": [
30401       {
30402         "title": "Example usage:",
30403         "content": "curl https://{domain}/api/voice/mohs -d '{\"name\": \"xmas_musics\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30404         "type": "json"
30405       }
30406     ],
30407     "name": "AddMoh",
30408     "group": "Voice_MOHs",
30409     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30410     "version": "0.0.0",
30411     "filename": "server/api/voiceMusicOnHold/index.js",
30412     "groupTitle": "Voice_MOHs"
30413   },
30414   {
30415     "type": "post",
30416     "url": "/api/voice/mohs/{id}/sounds",
30417     "title": "Add sound to MOH",
30418     "examples": [
30419       {
30420         "title": "Example usage:",
30421         "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -d '{\"id\": 1}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30422         "type": "json"
30423       }
30424     ],
30425     "name": "AddSound",
30426     "group": "Voice_MOHs",
30427     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30428     "version": "0.0.0",
30429     "filename": "server/api/voiceMusicOnHold/index.js",
30430     "groupTitle": "Voice_MOHs"
30431   },
30432   {
30433     "type": "delete",
30434     "url": "/api/voice/mohs/{id}",
30435     "title": "Deletes an MOH",
30436     "examples": [
30437       {
30438         "title": "Example usage:",
30439         "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password} -X DELETE",
30440         "type": "json"
30441       }
30442     ],
30443     "name": "DestroyMoh",
30444     "group": "Voice_MOHs",
30445     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30446     "version": "0.0.0",
30447     "filename": "server/api/voiceMusicOnHold/index.js",
30448     "groupTitle": "Voice_MOHs"
30449   },
30450   {
30451     "type": "get",
30452     "url": "/api/voice/mohs",
30453     "title": "Gets a list of Music On Holds",
30454     "examples": [
30455       {
30456         "title": "Example usage:",
30457         "content": "curl https://{domain}/api/voice/mohs -v -u {name}:{password}",
30458         "type": "json"
30459       }
30460     ],
30461     "name": "GetMusic_On_Holds",
30462     "group": "Voice_MOHs",
30463     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30464     "version": "0.0.0",
30465     "filename": "server/api/voiceMusicOnHold/index.js",
30466     "groupTitle": "Voice_MOHs"
30467   },
30468   {
30469     "type": "get",
30470     "url": "/api/voice/mohs/{id}/sounds",
30471     "title": "Gets sounds from MOH",
30472     "examples": [
30473       {
30474         "title": "Example usage:",
30475         "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -v -u {name}:{password} -X DELETE",
30476         "type": "json"
30477       }
30478     ],
30479     "name": "GetSounds",
30480     "group": "Voice_MOHs",
30481     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30482     "version": "0.0.0",
30483     "filename": "server/api/voiceMusicOnHold/index.js",
30484     "groupTitle": "Voice_MOHs"
30485   },
30486   {
30487     "type": "delete",
30488     "url": "/api/voice/mohs/{id}/sounds/{id2}",
30489     "title": "Remove sound from MOH",
30490     "examples": [
30491       {
30492         "title": "Example usage:",
30493         "content": "curl https://{domain}/api/voice/mohs/{id}/sounds/{id2} -v -u {name}:{password} -X DELETE",
30494         "type": "json"
30495       }
30496     ],
30497     "name": "RemoveSound",
30498     "group": "Voice_MOHs",
30499     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30500     "version": "0.0.0",
30501     "filename": "server/api/voiceMusicOnHold/index.js",
30502     "groupTitle": "Voice_MOHs"
30503   },
30504   {
30505     "type": "get",
30506     "url": "/api/voice/mohs/{id}",
30507     "title": "Gets a single Music On Hold",
30508     "examples": [
30509       {
30510         "title": "Example usage:",
30511         "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password}",
30512         "type": "json"
30513       }
30514     ],
30515     "name": "ShowMusic_On_Holds",
30516     "group": "Voice_MOHs",
30517     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30518     "version": "0.0.0",
30519     "filename": "server/api/voiceMusicOnHold/index.js",
30520     "groupTitle": "Voice_MOHs"
30521   },
30522   {
30523     "type": "put",
30524     "url": "/api/voice/mohs/{id}",
30525     "title": "Update an existing Music On Hold",
30526     "examples": [
30527       {
30528         "title": "Example usage:",
30529         "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",
30530         "type": "json"
30531       }
30532     ],
30533     "name": "updateMusic_On_Holds",
30534     "group": "Voice_MOHs",
30535     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30536     "version": "0.0.0",
30537     "filename": "server/api/voiceMusicOnHold/index.js",
30538     "groupTitle": "Voice_MOHs"
30539   },
30540   {
30541     "type": "post",
30542     "url": "/api/voice/mails",
30543     "title": "Creates a new Mail",
30544     "examples": [
30545       {
30546         "title": "Example usage:",
30547         "content": "curl https://{domain}/api/voice/mails -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
30548         "type": "json"
30549       }
30550     ],
30551     "name": "CreateMails",
30552     "group": "Voice_Mails",
30553     "parameter": {
30554       "fields": {
30555         "Body": [
30556           {
30557             "group": "Body",
30558             "type": "String",
30559             "optional": true,
30560             "field": "customer_id",
30561             "description": ""
30562           },
30563           {
30564             "group": "Body",
30565             "type": "String",
30566             "optional": true,
30567             "field": "context",
30568             "description": ""
30569           },
30570           {
30571             "group": "Body",
30572             "type": "String",
30573             "optional": false,
30574             "field": "mailbox",
30575             "description": ""
30576           },
30577           {
30578             "group": "Body",
30579             "type": "String",
30580             "optional": true,
30581             "field": "password",
30582             "description": ""
30583           },
30584           {
30585             "group": "Body",
30586             "type": "String",
30587             "optional": true,
30588             "field": "fullname",
30589             "description": ""
30590           },
30591           {
30592             "group": "Body",
30593             "type": "String",
30594             "optional": true,
30595             "field": "email",
30596             "description": ""
30597           },
30598           {
30599             "group": "Body",
30600             "type": "String",
30601             "optional": true,
30602             "field": "pager",
30603             "description": ""
30604           },
30605           {
30606             "group": "Body",
30607             "type": "String",
30608             "optional": true,
30609             "field": "tz",
30610             "description": ""
30611           },
30612           {
30613             "group": "Body",
30614             "type": "String",
30615             "allowedValues": [
30616               "\"yes\"",
30617               "\"no\""
30618             ],
30619             "optional": false,
30620             "field": "attach",
30621             "description": ""
30622           },
30623           {
30624             "group": "Body",
30625             "type": "String",
30626             "allowedValues": [
30627               "\"yes\"",
30628               "\"no\""
30629             ],
30630             "optional": false,
30631             "field": "saycid",
30632             "description": ""
30633           },
30634           {
30635             "group": "Body",
30636             "type": "String",
30637             "optional": true,
30638             "field": "dialout",
30639             "description": ""
30640           },
30641           {
30642             "group": "Body",
30643             "type": "String",
30644             "optional": true,
30645             "field": "callback",
30646             "description": ""
30647           },
30648           {
30649             "group": "Body",
30650             "type": "String",
30651             "allowedValues": [
30652               "\"yes\"",
30653               "\"no\""
30654             ],
30655             "optional": false,
30656             "field": "review",
30657             "description": ""
30658           },
30659           {
30660             "group": "Body",
30661             "type": "String",
30662             "allowedValues": [
30663               "\"yes\"",
30664               "\"no\""
30665             ],
30666             "optional": false,
30667             "field": "operator",
30668             "description": ""
30669           },
30670           {
30671             "group": "Body",
30672             "type": "String",
30673             "allowedValues": [
30674               "\"yes\"",
30675               "\"no\""
30676             ],
30677             "optional": false,
30678             "field": "envelope",
30679             "description": ""
30680           },
30681           {
30682             "group": "Body",
30683             "type": "String",
30684             "allowedValues": [
30685               "\"yes\"",
30686               "\"no\""
30687             ],
30688             "optional": false,
30689             "field": "sayduration",
30690             "description": ""
30691           },
30692           {
30693             "group": "Body",
30694             "type": "String",
30695             "optional": false,
30696             "field": "saydurationm",
30697             "description": ""
30698           },
30699           {
30700             "group": "Body",
30701             "type": "String",
30702             "allowedValues": [
30703               "\"yes\"",
30704               "\"no\""
30705             ],
30706             "optional": false,
30707             "field": "sendvoicemail",
30708             "description": ""
30709           },
30710           {
30711             "group": "Body",
30712             "type": "String",
30713             "allowedValues": [
30714               "\"yes\"",
30715               "\"no\""
30716             ],
30717             "optional": false,
30718             "field": "delete",
30719             "description": ""
30720           },
30721           {
30722             "group": "Body",
30723             "type": "String",
30724             "allowedValues": [
30725               "\"yes\"",
30726               "\"no\""
30727             ],
30728             "optional": false,
30729             "field": "nextaftercmd",
30730             "description": ""
30731           },
30732           {
30733             "group": "Body",
30734             "type": "String",
30735             "allowedValues": [
30736               "\"yes\"",
30737               "\"no\""
30738             ],
30739             "optional": false,
30740             "field": "forcename",
30741             "description": ""
30742           },
30743           {
30744             "group": "Body",
30745             "type": "String",
30746             "allowedValues": [
30747               "\"yes\"",
30748               "\"no\""
30749             ],
30750             "optional": false,
30751             "field": "forcegreetings",
30752             "description": ""
30753           },
30754           {
30755             "group": "Body",
30756             "type": "String",
30757             "allowedValues": [
30758               "\"yes\"",
30759               "\"no\""
30760             ],
30761             "optional": false,
30762             "field": "hidefromdir",
30763             "description": ""
30764           },
30765           {
30766             "group": "Body",
30767             "type": "String",
30768             "optional": true,
30769             "field": "stamp",
30770             "description": ""
30771           },
30772           {
30773             "group": "Body",
30774             "type": "String",
30775             "optional": true,
30776             "field": "emailsubject",
30777             "description": ""
30778           },
30779           {
30780             "group": "Body",
30781             "type": "String",
30782             "optional": true,
30783             "field": "emailbody",
30784             "description": ""
30785           },
30786           {
30787             "group": "Body",
30788             "type": "Integer",
30789             "optional": false,
30790             "field": "maxsecs",
30791             "description": ""
30792           },
30793           {
30794             "group": "Body",
30795             "type": "Integer",
30796             "optional": false,
30797             "field": "maxmsg",
30798             "description": ""
30799           },
30800           {
30801             "group": "Body",
30802             "type": "Virtual",
30803             "optional": true,
30804             "field": "name",
30805             "description": ""
30806           }
30807         ]
30808       }
30809     },
30810     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30811     "version": "0.0.0",
30812     "filename": "server/api/voiceMail/index.js",
30813     "groupTitle": "Voice_Mails"
30814   },
30815   {
30816     "type": "delete",
30817     "url": "/api/voice/mails/{id}",
30818     "title": "Deletes a Mail",
30819     "examples": [
30820       {
30821         "title": "Example usage:",
30822         "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password} -X DELETE",
30823         "type": "json"
30824       }
30825     ],
30826     "name": "DeleteMails",
30827     "group": "Voice_Mails",
30828     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30829     "version": "0.0.0",
30830     "filename": "server/api/voiceMail/index.js",
30831     "groupTitle": "Voice_Mails"
30832   },
30833   {
30834     "type": "get",
30835     "url": "/api/voice/mails",
30836     "title": "Gets a list of Mails",
30837     "examples": [
30838       {
30839         "title": "Example usage:",
30840         "content": "curl https://{domain}/api/voice/mails -v -u {name}:{password}",
30841         "type": "json"
30842       }
30843     ],
30844     "name": "GetMails",
30845     "group": "Voice_Mails",
30846     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30847     "version": "0.0.0",
30848     "filename": "server/api/voiceMail/index.js",
30849     "groupTitle": "Voice_Mails"
30850   },
30851   {
30852     "type": "get",
30853     "url": "/api/voice/mails/{id}",
30854     "title": "Gets a single Mail",
30855     "examples": [
30856       {
30857         "title": "Example usage:",
30858         "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password}",
30859         "type": "json"
30860       }
30861     ],
30862     "name": "ShowMails",
30863     "group": "Voice_Mails",
30864     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30865     "version": "0.0.0",
30866     "filename": "server/api/voiceMail/index.js",
30867     "groupTitle": "Voice_Mails"
30868   },
30869   {
30870     "type": "get",
30871     "url": "/api/voice/mails/{id}/messages",
30872     "title": "Gets voice mail messages",
30873     "examples": [
30874       {
30875         "title": "Example usage:",
30876         "content": "curl https://{domain}/api/voice/mails/{id}/messages -v -u {name}:{password} -X GET",
30877         "type": "json"
30878       }
30879     ],
30880     "name": "getMessages",
30881     "group": "Voice_Mails",
30882     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30883     "version": "0.0.0",
30884     "filename": "server/api/voiceMail/index.js",
30885     "groupTitle": "Voice_Mails"
30886   },
30887   {
30888     "type": "put",
30889     "url": "/api/voice/mails/{id}",
30890     "title": "Update an existing Mail",
30891     "examples": [
30892       {
30893         "title": "Example usage:",
30894         "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",
30895         "type": "json"
30896       }
30897     ],
30898     "name": "updateMails",
30899     "group": "Voice_Mails",
30900     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30901     "version": "0.0.0",
30902     "filename": "server/api/voiceMail/index.js",
30903     "groupTitle": "Voice_Mails"
30904   },
30905   {
30906     "type": "post",
30907     "url": "/api/voice/mails/messages",
30908     "title": "Creates a new Message",
30909     "examples": [
30910       {
30911         "title": "Example usage:",
30912         "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",
30913         "type": "json"
30914       }
30915     ],
30916     "name": "CreateMessages",
30917     "group": "Voice_Messages",
30918     "parameter": {
30919       "fields": {
30920         "Body": [
30921           {
30922             "group": "Body",
30923             "type": "Virtual",
30924             "optional": true,
30925             "field": "name",
30926             "description": ""
30927           },
30928           {
30929             "group": "Body",
30930             "type": "Integer",
30931             "optional": false,
30932             "field": "msgnum",
30933             "description": ""
30934           },
30935           {
30936             "group": "Body",
30937             "type": "String",
30938             "optional": true,
30939             "field": "dir",
30940             "description": ""
30941           },
30942           {
30943             "group": "Body",
30944             "type": "String",
30945             "optional": true,
30946             "field": "context",
30947             "description": ""
30948           },
30949           {
30950             "group": "Body",
30951             "type": "String",
30952             "optional": true,
30953             "field": "macrocontext",
30954             "description": ""
30955           },
30956           {
30957             "group": "Body",
30958             "type": "String",
30959             "optional": true,
30960             "field": "callerid",
30961             "description": ""
30962           },
30963           {
30964             "group": "Body",
30965             "type": "String",
30966             "optional": true,
30967             "field": "origtime",
30968             "description": ""
30969           },
30970           {
30971             "group": "Body",
30972             "type": "String",
30973             "optional": true,
30974             "field": "duration",
30975             "description": ""
30976           },
30977           {
30978             "group": "Body",
30979             "type": "String",
30980             "optional": true,
30981             "field": "mailboxuser",
30982             "description": ""
30983           },
30984           {
30985             "group": "Body",
30986             "type": "String",
30987             "optional": true,
30988             "field": "mailboxcontext",
30989             "description": ""
30990           },
30991           {
30992             "group": "Body",
30993             "type": "Blob",
30994             "optional": true,
30995             "field": "recording",
30996             "description": ""
30997           },
30998           {
30999             "group": "Body",
31000             "type": "String",
31001             "optional": true,
31002             "field": "flag",
31003             "description": ""
31004           },
31005           {
31006             "group": "Body",
31007             "type": "String",
31008             "optional": true,
31009             "field": "msg_id",
31010             "description": ""
31011           },
31012           {
31013             "group": "Body",
31014             "type": "String",
31015             "optional": false,
31016             "field": "stamp",
31017             "description": ""
31018           }
31019         ]
31020       }
31021     },
31022     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31023     "version": "0.0.0",
31024     "filename": "server/api/voiceMailMessage/index.js",
31025     "groupTitle": "Voice_Messages"
31026   },
31027   {
31028     "type": "delete",
31029     "url": "/api/voice/mails/messages/{id}",
31030     "title": "Deletes a Message",
31031     "examples": [
31032       {
31033         "title": "Example usage:",
31034         "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password} -X DELETE",
31035         "type": "json"
31036       }
31037     ],
31038     "name": "DeleteMessages",
31039     "group": "Voice_Messages",
31040     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31041     "version": "0.0.0",
31042     "filename": "server/api/voiceMailMessage/index.js",
31043     "groupTitle": "Voice_Messages"
31044   },
31045   {
31046     "type": "get",
31047     "url": "/api/voice/mails/messages",
31048     "title": "Gets a list of Messages",
31049     "examples": [
31050       {
31051         "title": "Example usage:",
31052         "content": "curl https://{domain}/api/voice/mails/messages -v -u {name}:{password}",
31053         "type": "json"
31054       }
31055     ],
31056     "name": "GetMessages",
31057     "group": "Voice_Messages",
31058     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31059     "version": "0.0.0",
31060     "filename": "server/api/voiceMailMessage/index.js",
31061     "groupTitle": "Voice_Messages"
31062   },
31063   {
31064     "type": "get",
31065     "url": "/api/voice/mails/messages/{id}",
31066     "title": "Gets a single Message",
31067     "examples": [
31068       {
31069         "title": "Example usage:",
31070         "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password}",
31071         "type": "json"
31072       }
31073     ],
31074     "name": "ShowMessages",
31075     "group": "Voice_Messages",
31076     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31077     "version": "0.0.0",
31078     "filename": "server/api/voiceMailMessage/index.js",
31079     "groupTitle": "Voice_Messages"
31080   },
31081   {
31082     "type": "get",
31083     "url": "voice/mails/messages/{id}/download",
31084     "title": "Download Voice Message",
31085     "examples": [
31086       {
31087         "title": "Example usage:",
31088         "content": "curl https://{domain}voice/mails/messages/{id}/download -v -u {name}:{password} -X GET",
31089         "type": "json"
31090       }
31091     ],
31092     "name": "download",
31093     "group": "Voice_Messages",
31094     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31095     "version": "0.0.0",
31096     "filename": "server/api/voiceMailMessage/index.js",
31097     "groupTitle": "Voice_Messages"
31098   },
31099   {
31100     "type": "put",
31101     "url": "/api/voice/mails/messages/{id}",
31102     "title": "Update an existing Message",
31103     "examples": [
31104       {
31105         "title": "Example usage:",
31106         "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",
31107         "type": "json"
31108       }
31109     ],
31110     "name": "updateMessages",
31111     "group": "Voice_Messages",
31112     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31113     "version": "0.0.0",
31114     "filename": "server/api/voiceMailMessage/index.js",
31115     "groupTitle": "Voice_Messages"
31116   },
31117   {
31118     "type": "post",
31119     "url": "/api/voice/prefixes/{id}/users",
31120     "title": "Add agents to a prefix",
31121     "examples": [
31122       {
31123         "title": "Example usage:",
31124         "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",
31125         "type": "json"
31126       }
31127     ],
31128     "name": "AddAgents",
31129     "group": "Voice_Prefixes",
31130     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31131     "version": "0.0.0",
31132     "filename": "server/api/voicePrefix/index.js",
31133     "groupTitle": "Voice_Prefixes"
31134   },
31135   {
31136     "type": "delete",
31137     "url": "/api/voice/prefixes/{id}",
31138     "title": "Deletes a Prefix",
31139     "examples": [
31140       {
31141         "title": "Example usage:",
31142         "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X DELETE",
31143         "type": "json"
31144       }
31145     ],
31146     "name": "DeletePrefixes",
31147     "group": "Voice_Prefixes",
31148     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31149     "version": "0.0.0",
31150     "filename": "server/api/voicePrefix/index.js",
31151     "groupTitle": "Voice_Prefixes"
31152   },
31153   {
31154     "type": "get",
31155     "url": "/api/voice/prefixes/describe",
31156     "title": "Gets table info about Prefixes",
31157     "examples": [
31158       {
31159         "title": "Example usage:",
31160         "content": "curl https://{domain}/api/voice/prefixes/describe -v -u {name}:{password}",
31161         "type": "json"
31162       }
31163     ],
31164     "name": "DescribePrefixes",
31165     "group": "Voice_Prefixes",
31166     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31167     "version": "0.0.0",
31168     "filename": "server/api/voicePrefix/index.js",
31169     "groupTitle": "Voice_Prefixes"
31170   },
31171   {
31172     "type": "get",
31173     "url": "/api/voice/prefixes/{id}/users",
31174     "title": "Gets agents from prefix",
31175     "examples": [
31176       {
31177         "title": "Example usage:",
31178         "content": "curl https://{domain}/api/voice/prefixes/{id}/users -v -u {name}:{password} -X GET",
31179         "type": "json"
31180       }
31181     ],
31182     "name": "GetAgents",
31183     "group": "Voice_Prefixes",
31184     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31185     "version": "0.0.0",
31186     "filename": "server/api/voicePrefix/index.js",
31187     "groupTitle": "Voice_Prefixes"
31188   },
31189   {
31190     "type": "get",
31191     "url": "/api/voice/prefixes",
31192     "title": "Gets a list of Prefixes",
31193     "examples": [
31194       {
31195         "title": "Example usage:",
31196         "content": "curl https://{domain}/api/voice/prefixes -v -u {name}:{password}",
31197         "type": "json"
31198       }
31199     ],
31200     "name": "GetPrefixes",
31201     "group": "Voice_Prefixes",
31202     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31203     "version": "0.0.0",
31204     "filename": "server/api/voicePrefix/index.js",
31205     "groupTitle": "Voice_Prefixes"
31206   },
31207   {
31208     "type": "delete",
31209     "url": "/api/voice/prefixes/{id}/users",
31210     "title": "Removes agents from a prefix",
31211     "examples": [
31212       {
31213         "title": "Example usage:",
31214         "content": "curl https://{domain}/api/voice/prefixes/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
31215         "type": "json"
31216       }
31217     ],
31218     "name": "RemoveAgents",
31219     "group": "Voice_Prefixes",
31220     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31221     "version": "0.0.0",
31222     "filename": "server/api/voicePrefix/index.js",
31223     "groupTitle": "Voice_Prefixes"
31224   },
31225   {
31226     "type": "get",
31227     "url": "/api/voice/prefixes/{id}",
31228     "title": "Gets a single Prefix",
31229     "examples": [
31230       {
31231         "title": "Example usage:",
31232         "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password}",
31233         "type": "json"
31234       }
31235     ],
31236     "name": "ShowPrefixes",
31237     "group": "Voice_Prefixes",
31238     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31239     "version": "0.0.0",
31240     "filename": "server/api/voicePrefix/index.js",
31241     "groupTitle": "Voice_Prefixes"
31242   },
31243   {
31244     "type": "put",
31245     "url": "/api/voice/prefixes/{id}",
31246     "title": "Update an existing prefix",
31247     "examples": [
31248       {
31249         "title": "Example usage:",
31250         "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X PUT",
31251         "type": "json"
31252       }
31253     ],
31254     "name": "Update",
31255     "group": "Voice_Prefixes",
31256     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31257     "version": "0.0.0",
31258     "filename": "server/api/voicePrefix/index.js",
31259     "groupTitle": "Voice_Prefixes"
31260   },
31261   {
31262     "type": "post",
31263     "url": "/api/voice/prefixes",
31264     "title": "Create a prefix",
31265     "examples": [
31266       {
31267         "title": "Example usage:",
31268         "content": "curl https://{domain}/api/voice/prefixes -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31269         "type": "json"
31270       }
31271     ],
31272     "name": "create",
31273     "group": "Voice_Prefixes",
31274     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31275     "version": "0.0.0",
31276     "filename": "server/api/voicePrefix/index.js",
31277     "groupTitle": "Voice_Prefixes"
31278   },
31279   {
31280     "type": "get",
31281     "url": "/api/voice/queues/reports/describe",
31282     "title": "Gets table info about Queue Reports",
31283     "examples": [
31284       {
31285         "title": "Example usage:",
31286         "content": "curl https://{domain}/api/voice/queues/reports/describe -v -u {name}:{password}",
31287         "type": "json"
31288       }
31289     ],
31290     "name": "DescribeQueue_Reports",
31291     "group": "Voice_Queue_Reports",
31292     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31293     "version": "0.0.0",
31294     "filename": "server/api/voiceQueueReport/index.js",
31295     "groupTitle": "Voice_Queue_Reports"
31296   },
31297   {
31298     "type": "get",
31299     "url": "/api/voice/queues/reports",
31300     "title": "Gets a list of Queue Reports",
31301     "examples": [
31302       {
31303         "title": "Example usage:",
31304         "content": "curl https://{domain}/api/voice/queues/reports -v -u {name}:{password}",
31305         "type": "json"
31306       }
31307     ],
31308     "name": "GetQueue_Reports",
31309     "group": "Voice_Queue_Reports",
31310     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31311     "version": "0.0.0",
31312     "filename": "server/api/voiceQueueReport/index.js",
31313     "groupTitle": "Voice_Queue_Reports"
31314   },
31315   {
31316     "type": "get",
31317     "url": "/api/voice/queues/reports/{id}",
31318     "title": "Gets a single Queue Report",
31319     "examples": [
31320       {
31321         "title": "Example usage:",
31322         "content": "curl https://{domain}/api/voice/queues/reports/{id} -v -u {name}:{password}",
31323         "type": "json"
31324       }
31325     ],
31326     "name": "ShowQueue_Reports",
31327     "group": "Voice_Queue_Reports",
31328     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31329     "version": "0.0.0",
31330     "filename": "server/api/voiceQueueReport/index.js",
31331     "groupTitle": "Voice_Queue_Reports"
31332   },
31333   {
31334     "type": "get",
31335     "url": "/api/voice/queues/reports/index",
31336     "title": "Get Voice Queues Report",
31337     "examples": [
31338       {
31339         "title": "Example usage:",
31340         "content": "curl https://{domain}/api/voice/queues/reports/index -v -u {name}:{password} -X GET",
31341         "type": "json"
31342       }
31343     ],
31344     "name": "getVoiceQueuesReport",
31345     "group": "Voice_Queue_Reports",
31346     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31347     "version": "0.0.0",
31348     "filename": "server/api/voiceQueueReport/index.js",
31349     "groupTitle": "Voice_Queue_Reports"
31350   },
31351   {
31352     "type": "post",
31353     "url": "/api/voice/queues/{id}/users",
31354     "title": "Add agents to queue",
31355     "examples": [
31356       {
31357         "title": "Example usage:",
31358         "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",
31359         "type": "json"
31360       }
31361     ],
31362     "name": "AddAgents",
31363     "group": "Voice_Queues",
31364     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31365     "version": "0.0.0",
31366     "filename": "server/api/voiceQueue/index.js",
31367     "groupTitle": "Voice_Queues"
31368   },
31369   {
31370     "type": "post",
31371     "url": "/api/voice/queues/{id}/blacklists",
31372     "title": "Add blacklists to a queue",
31373     "examples": [
31374       {
31375         "title": "Example usage:",
31376         "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",
31377         "type": "json"
31378       }
31379     ],
31380     "name": "AddBlackLists",
31381     "group": "Voice_Queues",
31382     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31383     "version": "0.0.0",
31384     "filename": "server/api/voiceQueue/index.js",
31385     "groupTitle": "Voice_Queues"
31386   },
31387   {
31388     "type": "post",
31389     "url": "/api/voice/queues/{id}/lists",
31390     "title": "Add lists to a queue",
31391     "examples": [
31392       {
31393         "title": "Example usage:",
31394         "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",
31395         "type": "json"
31396       }
31397     ],
31398     "name": "AddLists",
31399     "group": "Voice_Queues",
31400     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31401     "version": "0.0.0",
31402     "filename": "server/api/voiceQueue/index.js",
31403     "groupTitle": "Voice_Queues"
31404   },
31405   {
31406     "type": "post",
31407     "url": "/api/voice/queues/{id}/teams",
31408     "title": "Add teams to queue",
31409     "examples": [
31410       {
31411         "title": "Example usage:",
31412         "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",
31413         "type": "json"
31414       }
31415     ],
31416     "name": "AddTeams",
31417     "group": "Voice_Queues",
31418     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31419     "version": "0.0.0",
31420     "filename": "server/api/voiceQueue/index.js",
31421     "groupTitle": "Voice_Queues"
31422   },
31423   {
31424     "type": "post",
31425     "url": "/api/voice/queues/clone",
31426     "title": "Clone an existing Queue",
31427     "examples": [
31428       {
31429         "title": "Example usage:",
31430         "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",
31431         "type": "json"
31432       }
31433     ],
31434     "name": "CloneQueues",
31435     "group": "Voice_Queues",
31436     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31437     "version": "0.0.0",
31438     "filename": "server/api/voiceQueue/index.js",
31439     "groupTitle": "Voice_Queues"
31440   },
31441   {
31442     "type": "post",
31443     "url": "/api/voice/queues",
31444     "title": "Creates a new Queue",
31445     "examples": [
31446       {
31447         "title": "Example usage:",
31448         "content": "curl https://{domain}/api/voice/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
31449         "type": "json"
31450       }
31451     ],
31452     "name": "CreateQueues",
31453     "group": "Voice_Queues",
31454     "parameter": {
31455       "fields": {
31456         "Body": [
31457           {
31458             "group": "Body",
31459             "type": "String",
31460             "optional": false,
31461             "field": "name",
31462             "description": ""
31463           },
31464           {
31465             "group": "Body",
31466             "type": "String",
31467             "allowedValues": [
31468               "\"inbound\"",
31469               "\"outbound\""
31470             ],
31471             "optional": false,
31472             "field": "type",
31473             "description": ""
31474           },
31475           {
31476             "group": "Body",
31477             "type": "String",
31478             "optional": true,
31479             "field": "musiconhold",
31480             "description": ""
31481           },
31482           {
31483             "group": "Body",
31484             "type": "String",
31485             "optional": true,
31486             "field": "announce",
31487             "description": ""
31488           },
31489           {
31490             "group": "Body",
31491             "type": "String",
31492             "allowedValues": [
31493               "\"rr\"",
31494               "\"ringall\"",
31495               "\"leastrecent\"",
31496               "\"fewestcalls\"",
31497               "\"random\"",
31498               "\"rrmemory\"",
31499               "\"linear\"",
31500               "\"wrandom\"",
31501               "\"rrordered\""
31502             ],
31503             "optional": false,
31504             "field": "strategy",
31505             "description": ""
31506           },
31507           {
31508             "group": "Body",
31509             "type": "Integer",
31510             "optional": true,
31511             "field": "servicelevel",
31512             "description": ""
31513           },
31514           {
31515             "group": "Body",
31516             "type": "String",
31517             "optional": true,
31518             "field": "context",
31519             "description": ""
31520           },
31521           {
31522             "group": "Body",
31523             "type": "Integer",
31524             "optional": true,
31525             "field": "penaltymemberslimit",
31526             "description": ""
31527           },
31528           {
31529             "group": "Body",
31530             "type": "Integer",
31531             "optional": true,
31532             "field": "timeout",
31533             "description": ""
31534           },
31535           {
31536             "group": "Body",
31537             "type": "Integer",
31538             "optional": true,
31539             "field": "retry",
31540             "description": ""
31541           },
31542           {
31543             "group": "Body",
31544             "type": "String",
31545             "optional": true,
31546             "field": "timeoutpriority",
31547             "description": ""
31548           },
31549           {
31550             "group": "Body",
31551             "type": "Integer",
31552             "optional": true,
31553             "field": "weight",
31554             "description": ""
31555           },
31556           {
31557             "group": "Body",
31558             "type": "Integer",
31559             "optional": true,
31560             "field": "wrapuptime",
31561             "description": ""
31562           },
31563           {
31564             "group": "Body",
31565             "type": "String",
31566             "allowedValues": [
31567               "\"yes\"",
31568               "\"no\""
31569             ],
31570             "optional": true,
31571             "field": "autofill",
31572             "description": ""
31573           },
31574           {
31575             "group": "Body",
31576             "type": "String",
31577             "allowedValues": [
31578               "\"yes\"",
31579               "\"no\"",
31580               "\"all\""
31581             ],
31582             "optional": true,
31583             "field": "autopause",
31584             "description": ""
31585           },
31586           {
31587             "group": "Body",
31588             "type": "Integer",
31589             "optional": true,
31590             "field": "autopausedelay",
31591             "description": ""
31592           },
31593           {
31594             "group": "Body",
31595             "type": "String",
31596             "allowedValues": [
31597               "\"yes\"",
31598               "\"no\""
31599             ],
31600             "optional": true,
31601             "field": "autopausebusy",
31602             "description": ""
31603           },
31604           {
31605             "group": "Body",
31606             "type": "String",
31607             "allowedValues": [
31608               "\"yes\"",
31609               "\"no\""
31610             ],
31611             "optional": true,
31612             "field": "autopauseunavail",
31613             "description": ""
31614           },
31615           {
31616             "group": "Body",
31617             "type": "Integer",
31618             "optional": true,
31619             "field": "maxlen",
31620             "description": ""
31621           },
31622           {
31623             "group": "Body",
31624             "type": "String",
31625             "allowedValues": [
31626               "\"yes\"",
31627               "\"no\""
31628             ],
31629             "optional": true,
31630             "field": "setinterfacevar",
31631             "description": ""
31632           },
31633           {
31634             "group": "Body",
31635             "type": "String",
31636             "allowedValues": [
31637               "\"yes\"",
31638               "\"no\""
31639             ],
31640             "optional": true,
31641             "field": "setqueueentryvar",
31642             "description": ""
31643           },
31644           {
31645             "group": "Body",
31646             "type": "String",
31647             "allowedValues": [
31648               "\"yes\"",
31649               "\"no\""
31650             ],
31651             "optional": true,
31652             "field": "setqueuevar",
31653             "description": ""
31654           },
31655           {
31656             "group": "Body",
31657             "type": "String",
31658             "allowedValues": [
31659               "\"yes\"",
31660               "\"no\""
31661             ],
31662             "optional": true,
31663             "field": "eventmemberstatus",
31664             "description": ""
31665           },
31666           {
31667             "group": "Body",
31668             "type": "String",
31669             "optional": true,
31670             "field": "membermacro",
31671             "description": ""
31672           },
31673           {
31674             "group": "Body",
31675             "type": "String",
31676             "optional": true,
31677             "field": "membergosub",
31678             "description": ""
31679           },
31680           {
31681             "group": "Body",
31682             "type": "Integer",
31683             "optional": true,
31684             "field": "announce_frequency",
31685             "description": ""
31686           },
31687           {
31688             "group": "Body",
31689             "type": "Integer",
31690             "optional": true,
31691             "field": "min_announce_frequency",
31692             "description": ""
31693           },
31694           {
31695             "group": "Body",
31696             "type": "Integer",
31697             "optional": true,
31698             "field": "periodic_announce_frequency",
31699             "description": ""
31700           },
31701           {
31702             "group": "Body",
31703             "type": "String",
31704             "allowedValues": [
31705               "\"yes\"",
31706               "\"no\""
31707             ],
31708             "optional": true,
31709             "field": "random_periodic_announce",
31710             "description": ""
31711           },
31712           {
31713             "group": "Body",
31714             "type": "String",
31715             "allowedValues": [
31716               "\"yes\"",
31717               "\"no\""
31718             ],
31719             "optional": true,
31720             "field": "relative_periodic_announce",
31721             "description": ""
31722           },
31723           {
31724             "group": "Body",
31725             "type": "String",
31726             "allowedValues": [
31727               "\"yes\"",
31728               "\"no\"",
31729               "\"once\""
31730             ],
31731             "optional": true,
31732             "field": "announce_holdtime",
31733             "description": ""
31734           },
31735           {
31736             "group": "Body",
31737             "type": "String",
31738             "optional": true,
31739             "field": "announce_position",
31740             "description": ""
31741           },
31742           {
31743             "group": "Body",
31744             "type": "String",
31745             "allowedValues": [
31746               "\"yes\"",
31747               "\"no\""
31748             ],
31749             "optional": true,
31750             "field": "announce_to_first_user",
31751             "description": ""
31752           },
31753           {
31754             "group": "Body",
31755             "type": "Integer",
31756             "optional": true,
31757             "field": "announce_position_limit",
31758             "description": ""
31759           },
31760           {
31761             "group": "Body",
31762             "type": "String",
31763             "allowedValues": [
31764               "\"0\"",
31765               "\"5\"",
31766               "\"10\"",
31767               "\"15\"",
31768               "\"20\"",
31769               "\"30\""
31770             ],
31771             "optional": true,
31772             "field": "announce_round_seconds",
31773             "description": ""
31774           },
31775           {
31776             "group": "Body",
31777             "type": "String",
31778             "optional": true,
31779             "field": "monitor_format",
31780             "description": ""
31781           },
31782           {
31783             "group": "Body",
31784             "type": "String",
31785             "optional": true,
31786             "field": "monitor_type",
31787             "description": ""
31788           },
31789           {
31790             "group": "Body",
31791             "type": "String",
31792             "optional": true,
31793             "field": "queue_youarenext",
31794             "description": ""
31795           },
31796           {
31797             "group": "Body",
31798             "type": "String",
31799             "optional": true,
31800             "field": "queue_thereare",
31801             "description": ""
31802           },
31803           {
31804             "group": "Body",
31805             "type": "String",
31806             "optional": true,
31807             "field": "queue_callswaiting",
31808             "description": ""
31809           },
31810           {
31811             "group": "Body",
31812             "type": "String",
31813             "optional": true,
31814             "field": "queue_holdtime",
31815             "description": ""
31816           },
31817           {
31818             "group": "Body",
31819             "type": "String",
31820             "optional": true,
31821             "field": "queue_minute",
31822             "description": ""
31823           },
31824           {
31825             "group": "Body",
31826             "type": "String",
31827             "optional": true,
31828             "field": "queue_minutes",
31829             "description": ""
31830           },
31831           {
31832             "group": "Body",
31833             "type": "String",
31834             "optional": true,
31835             "field": "queue_seconds",
31836             "description": ""
31837           },
31838           {
31839             "group": "Body",
31840             "type": "String",
31841             "optional": true,
31842             "field": "queue_thankyou",
31843             "description": ""
31844           },
31845           {
31846             "group": "Body",
31847             "type": "String",
31848             "optional": true,
31849             "field": "queue_reporthold",
31850             "description": ""
31851           },
31852           {
31853             "group": "Body",
31854             "type": "String",
31855             "optional": true,
31856             "field": "queue_quantity1",
31857             "description": ""
31858           },
31859           {
31860             "group": "Body",
31861             "type": "String",
31862             "optional": true,
31863             "field": "queue_quantity2",
31864             "description": ""
31865           },
31866           {
31867             "group": "Body",
31868             "type": "String",
31869             "optional": true,
31870             "field": "queue_periodic_announce",
31871             "description": ""
31872           },
31873           {
31874             "group": "Body",
31875             "type": "String",
31876             "optional": true,
31877             "field": "queue_less_than",
31878             "description": ""
31879           },
31880           {
31881             "group": "Body",
31882             "type": "Text",
31883             "optional": true,
31884             "field": "periodic_announce",
31885             "description": ""
31886           },
31887           {
31888             "group": "Body",
31889             "type": "String",
31890             "optional": true,
31891             "field": "joinempty",
31892             "description": ""
31893           },
31894           {
31895             "group": "Body",
31896             "type": "String",
31897             "optional": true,
31898             "field": "leavewhenempty",
31899             "description": ""
31900           },
31901           {
31902             "group": "Body",
31903             "type": "String",
31904             "allowedValues": [
31905               "\"yes\"",
31906               "\"no\""
31907             ],
31908             "optional": true,
31909             "field": "reportholdtime",
31910             "description": ""
31911           },
31912           {
31913             "group": "Body",
31914             "type": "String",
31915             "allowedValues": [
31916               "\"yes\"",
31917               "\"no\""
31918             ],
31919             "optional": true,
31920             "field": "ringinuse",
31921             "description": ""
31922           },
31923           {
31924             "group": "Body",
31925             "type": "Integer",
31926             "optional": true,
31927             "field": "memberdelay",
31928             "description": ""
31929           },
31930           {
31931             "group": "Body",
31932             "type": "String",
31933             "allowedValues": [
31934               "\"yes\"",
31935               "\"no\""
31936             ],
31937             "optional": true,
31938             "field": "timeoutrestart",
31939             "description": ""
31940           },
31941           {
31942             "group": "Body",
31943             "type": "String",
31944             "optional": true,
31945             "field": "defaultrule",
31946             "description": ""
31947           },
31948           {
31949             "group": "Body",
31950             "type": "String",
31951             "optional": true,
31952             "field": "description",
31953             "description": ""
31954           },
31955           {
31956             "group": "Body",
31957             "type": "Boolean",
31958             "optional": true,
31959             "field": "acw",
31960             "description": ""
31961           },
31962           {
31963             "group": "Body",
31964             "type": "Integer",
31965             "optional": true,
31966             "field": "acwTimeout",
31967             "description": ""
31968           },
31969           {
31970             "group": "Body",
31971             "type": "Boolean",
31972             "optional": true,
31973             "field": "dialActive",
31974             "description": "<p>Active/Disactive Campaign</p>"
31975           },
31976           {
31977             "group": "Body",
31978             "type": "String",
31979             "allowedValues": [
31980               "\"preview\"",
31981               "\"progressive\"",
31982               "\"power\"",
31983               "\"predictive\"",
31984               "\"booked\""
31985             ],
31986             "optional": true,
31987             "field": "dialMethod",
31988             "description": "<p>Dial Method.</p>"
31989           },
31990           {
31991             "group": "Body",
31992             "type": "Integer",
31993             "optional": true,
31994             "field": "dialLimitChannel",
31995             "description": "<p>Max 9999 channels, 0 means unlimited.</p>"
31996           },
31997           {
31998             "group": "Body",
31999             "type": "Integer",
32000             "optional": true,
32001             "field": "dialLimitQueue",
32002             "description": "<p>Max 9999 member in queue(min:1, max:9999), 0 means unlimited.</p>"
32003           },
32004           {
32005             "group": "Body",
32006             "type": "Float",
32007             "optional": true,
32008             "field": "dialPowerLevel",
32009             "description": "<p>Power Level: Calls for agents (min:1, max:10).</p>"
32010           },
32011           {
32012             "group": "Body",
32013             "type": "String",
32014             "allowedValues": [
32015               "\"agentBusyFactor\"",
32016               "\"dropRate\""
32017             ],
32018             "optional": true,
32019             "field": "dialPredictiveOptimization",
32020             "description": "<p>Only for predictive method.</p>"
32021           },
32022           {
32023             "group": "Body",
32024             "type": "Float",
32025             "optional": true,
32026             "field": "dialPredictiveOptimizationPercentage",
32027             "description": "<p>Predictive Optimization Percentage (min: 1, max: 95)</p>"
32028           },
32029           {
32030             "group": "Body",
32031             "type": "Integer",
32032             "optional": true,
32033             "field": "dialPredictiveInterval",
32034             "description": "<p>Interval Predictive Minutes (min:5 max:30)</p>"
32035           },
32036           {
32037             "group": "Body",
32038             "type": "String",
32039             "optional": true,
32040             "field": "dialOriginateCallerIdName",
32041             "description": ""
32042           },
32043           {
32044             "group": "Body",
32045             "type": "String",
32046             "optional": true,
32047             "field": "dialOriginateCallerIdNumber",
32048             "description": ""
32049           },
32050           {
32051             "group": "Body",
32052             "type": "Integer",
32053             "optional": true,
32054             "field": "dialOriginateTimeout",
32055             "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
32056           },
32057           {
32058             "group": "Body",
32059             "type": "String",
32060             "optional": true,
32061             "field": "dialQueueOptions",
32062             "description": "<p>https://wiki.asterisk.org/wiki/display/AST/Asterisk+13+Application_Queue</p>"
32063           },
32064           {
32065             "group": "Body",
32066             "type": "Integer",
32067             "optional": true,
32068             "field": "dialQueueTimeout",
32069             "description": "<p>Queue Timeout Seconds (min:1, max:999)</p>"
32070           },
32071           {
32072             "group": "Body",
32073             "type": "String",
32074             "optional": true,
32075             "field": "dialQueueProject",
32076             "description": "<p>AGI queue option (use: agi://127.0.0.1/square,&lt;project_name&gt;)</p>"
32077           },
32078           {
32079             "group": "Body",
32080             "type": "Integer",
32081             "optional": true,
32082             "field": "dialCongestionMaxRetry",
32083             "description": "<p>#Congestion Retry (min:1, max:999)</p>"
32084           },
32085           {
32086             "group": "Body",
32087             "type": "Integer",
32088             "optional": true,
32089             "field": "dialCongestionRetryFrequency",
32090             "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
32091           },
32092           {
32093             "group": "Body",
32094             "type": "Integer",
32095             "optional": true,
32096             "field": "dialBusyMaxRetry",
32097             "description": "<p>#Busy Retry (min:1, max:999)</p>"
32098           },
32099           {
32100             "group": "Body",
32101             "type": "Integer",
32102             "optional": true,
32103             "field": "dialBusyRetryFrequency",
32104             "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
32105           },
32106           {
32107             "group": "Body",
32108             "type": "Integer",
32109             "optional": true,
32110             "field": "dialNoAnswerMaxRetry",
32111             "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
32112           },
32113           {
32114             "group": "Body",
32115             "type": "Integer",
32116             "optional": true,
32117             "field": "dialNoAnswerRetryFrequency",
32118             "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
32119           },
32120           {
32121             "group": "Body",
32122             "type": "Integer",
32123             "optional": true,
32124             "field": "dialGlobalMaxRetry",
32125             "description": "<p>#Global Max Retry (min:1, max:999)</p>"
32126           },
32127           {
32128             "group": "Body",
32129             "type": "String",
32130             "optional": true,
32131             "field": "dialTimezone",
32132             "description": ""
32133           },
32134           {
32135             "group": "Body",
32136             "type": "String",
32137             "optional": true,
32138             "field": "dialGlobalInterval",
32139             "description": ""
32140           },
32141           {
32142             "group": "Body",
32143             "type": "String",
32144             "optional": true,
32145             "field": "dialPrefix",
32146             "description": ""
32147           },
32148           {
32149             "group": "Body",
32150             "type": "String",
32151             "allowedValues": [
32152               "\"always\"",
32153               "\"never\"",
32154               "\"onlyIfOpen\""
32155             ],
32156             "optional": true,
32157             "field": "dialCheckDuplicateType",
32158             "description": ""
32159           },
32160           {
32161             "group": "Body",
32162             "type": "Boolean",
32163             "optional": true,
32164             "field": "dialAMDActive",
32165             "description": "<p>Active/Disactive AMD</p>"
32166           },
32167           {
32168             "group": "Body",
32169             "type": "Integer",
32170             "optional": true,
32171             "field": "dialAMDInitialSilence",
32172             "description": "<p>#AMD Initial Silence</p>"
32173           },
32174           {
32175             "group": "Body",
32176             "type": "Integer",
32177             "optional": true,
32178             "field": "dialAMDGreeting",
32179             "description": "<p>#AMD Greeting</p>"
32180           },
32181           {
32182             "group": "Body",
32183             "type": "Integer",
32184             "optional": true,
32185             "field": "dialAMDAfterGreetingSilence",
32186             "description": "<p>#AMD After Greeting Silence</p>"
32187           },
32188           {
32189             "group": "Body",
32190             "type": "Integer",
32191             "optional": true,
32192             "field": "dialAMDTotalAnalysisTime",
32193             "description": "<p>#AMD Total Analysis Time</p>"
32194           },
32195           {
32196             "group": "Body",
32197             "type": "Integer",
32198             "optional": true,
32199             "field": "dialAMDMinWordLength",
32200             "description": "<p>#AMD Min Word Length</p>"
32201           },
32202           {
32203             "group": "Body",
32204             "type": "Integer",
32205             "optional": true,
32206             "field": "dialAMDBetweenWordsSilence",
32207             "description": "<p>#AMD Between Words Silence</p>"
32208           },
32209           {
32210             "group": "Body",
32211             "type": "Integer",
32212             "optional": true,
32213             "field": "dialAMDMaximumNumberOfWords",
32214             "description": "<p>#AMD Maximum Number Of Words</p>"
32215           },
32216           {
32217             "group": "Body",
32218             "type": "Integer",
32219             "optional": true,
32220             "field": "dialAMDSilenceThreshold",
32221             "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
32222           },
32223           {
32224             "group": "Body",
32225             "type": "Integer",
32226             "optional": true,
32227             "field": "dialAMDMaximumWordLength",
32228             "description": "<p>#AMD Maximum Word Length</p>"
32229           },
32230           {
32231             "group": "Body",
32232             "type": "Integer",
32233             "optional": true,
32234             "field": "dialRecallMeTimeout",
32235             "description": "<p>#RecallMe Timeout (min:1)</p>"
32236           },
32237           {
32238             "group": "Body",
32239             "type": "Boolean",
32240             "optional": true,
32241             "field": "dialRecallInQueue",
32242             "description": "<p>Active/Disactive Recall In Queue</p>"
32243           },
32244           {
32245             "group": "Body",
32246             "type": "String",
32247             "allowedValues": [
32248               "\"DESC\"",
32249               "\"ASC\""
32250             ],
32251             "optional": true,
32252             "field": "dialOrderByScheduledAt",
32253             "description": ""
32254           },
32255           {
32256             "group": "Body",
32257             "type": "String",
32258             "optional": true,
32259             "field": "dialQueueProject2",
32260             "description": "<p>AGI queue option (use: agi://127.0.0.1/square,&lt;project_name&gt;)</p>"
32261           },
32262           {
32263             "group": "Body",
32264             "type": "Boolean",
32265             "optional": true,
32266             "field": "dialAgiAfterHangupClient",
32267             "description": ""
32268           },
32269           {
32270             "group": "Body",
32271             "type": "Boolean",
32272             "optional": true,
32273             "field": "dialAgiAfterHangupAgent",
32274             "description": ""
32275           },
32276           {
32277             "group": "Body",
32278             "type": "Integer",
32279             "optional": true,
32280             "field": "dialRandomLastDigitCallerIdNumber",
32281             "description": "<p>Random Last Digit (min:1, max:15)</p>"
32282           },
32283           {
32284             "group": "Body",
32285             "type": "Integer",
32286             "optional": true,
32287             "field": "dialCutDigit",
32288             "description": "<p>Cut Digit (min:1, max:15)</p>"
32289           },
32290           {
32291             "group": "Body",
32292             "type": "Integer",
32293             "optional": true,
32294             "field": "dialNoSuchNumberMaxRetry",
32295             "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
32296           },
32297           {
32298             "group": "Body",
32299             "type": "Integer",
32300             "optional": true,
32301             "field": "dialNoSuchNumberRetryFrequency",
32302             "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
32303           },
32304           {
32305             "group": "Body",
32306             "type": "Integer",
32307             "optional": true,
32308             "field": "dialDropMaxRetry",
32309             "description": "<p>#Drop Retry (min:1, max:999)</p>"
32310           },
32311           {
32312             "group": "Body",
32313             "type": "Integer",
32314             "optional": true,
32315             "field": "dialDropRetryFrequency",
32316             "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
32317           },
32318           {
32319             "group": "Body",
32320             "type": "Integer",
32321             "optional": true,
32322             "field": "dialAbandonedMaxRetry",
32323             "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
32324           },
32325           {
32326             "group": "Body",
32327             "type": "Integer",
32328             "optional": true,
32329             "field": "dialAbandonedRetryFrequency",
32330             "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
32331           },
32332           {
32333             "group": "Body",
32334             "type": "Integer",
32335             "optional": true,
32336             "field": "dialMachineMaxRetry",
32337             "description": "<p>#Machine Retry (min:1, max:999)</p>"
32338           },
32339           {
32340             "group": "Body",
32341             "type": "Integer",
32342             "optional": true,
32343             "field": "dialMachineRetryFrequency",
32344             "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
32345           },
32346           {
32347             "group": "Body",
32348             "type": "Integer",
32349             "optional": true,
32350             "field": "dialAgentRejectMaxRetry",
32351             "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
32352           },
32353           {
32354             "group": "Body",
32355             "type": "Integer",
32356             "optional": true,
32357             "field": "dialAgentRejectRetryFrequency",
32358             "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
32359           },
32360           {
32361             "group": "Body",
32362             "type": "Integer",
32363             "optional": true,
32364             "field": "mandatoryDispositionPauseId",
32365             "description": "<p>Status to put when mandatory disposition is enabled</p>"
32366           },
32367           {
32368             "group": "Body",
32369             "type": "Boolean",
32370             "optional": true,
32371             "field": "mandatoryDisposition",
32372             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
32373           },
32374           {
32375             "group": "Body",
32376             "type": "Integer",
32377             "optional": true,
32378             "field": "dialPredictiveIntervalMaxThreshold",
32379             "description": ""
32380           },
32381           {
32382             "group": "Body",
32383             "type": "Integer",
32384             "optional": true,
32385             "field": "dialPredictiveIntervalMinThreshold",
32386             "description": ""
32387           }
32388         ]
32389       }
32390     },
32391     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32392     "version": "0.0.0",
32393     "filename": "server/api/voiceQueue/index.js",
32394     "groupTitle": "Voice_Queues"
32395   },
32396   {
32397     "type": "delete",
32398     "url": "/api/voice/queues/{id}",
32399     "title": "Deletes a Queue",
32400     "examples": [
32401       {
32402         "title": "Example usage:",
32403         "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password} -X DELETE",
32404         "type": "json"
32405       }
32406     ],
32407     "name": "DeleteQueues",
32408     "group": "Voice_Queues",
32409     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32410     "version": "0.0.0",
32411     "filename": "server/api/voiceQueue/index.js",
32412     "groupTitle": "Voice_Queues"
32413   },
32414   {
32415     "type": "get",
32416     "url": "/api/voice/queues/{id}/users",
32417     "title": "Gets queue agents",
32418     "examples": [
32419       {
32420         "title": "Example usage:",
32421         "content": "curl https://{domain}/api/voice/queues/{id}/users -v -u {name}:{password} -X GET",
32422         "type": "json"
32423       }
32424     ],
32425     "name": "GetAgents",
32426     "group": "Voice_Queues",
32427     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32428     "version": "0.0.0",
32429     "filename": "server/api/voiceQueue/index.js",
32430     "groupTitle": "Voice_Queues"
32431   },
32432   {
32433     "type": "get",
32434     "url": "/api/voice/queues/{id}/blacklists",
32435     "title": "Get queue blacklists",
32436     "examples": [
32437       {
32438         "title": "Example usage:",
32439         "content": "curl https://{domain}/api/voice/queues/{id}/blacklists -v -u {name}:{password} -X GET",
32440         "type": "json"
32441       }
32442     ],
32443     "name": "GetBlackLists",
32444     "group": "Voice_Queues",
32445     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32446     "version": "0.0.0",
32447     "filename": "server/api/voiceQueue/index.js",
32448     "groupTitle": "Voice_Queues"
32449   },
32450   {
32451     "type": "get",
32452     "url": "/api/voice/queues/{id}/finals",
32453     "title": "Gets queue hopper finals",
32454     "examples": [
32455       {
32456         "title": "Example usage:",
32457         "content": "curl https://{domain}/api/voice/queues/{id}/hopper_finals -v -u {name}:{password}  -X GET",
32458         "type": "json"
32459       }
32460     ],
32461     "name": "GetHopperFinals",
32462     "group": "Voice_Queues",
32463     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32464     "version": "0.0.0",
32465     "filename": "server/api/voiceQueue/index.js",
32466     "groupTitle": "Voice_Queues"
32467   },
32468   {
32469     "type": "get",
32470     "url": "/api/voice/queues/{id}/hopper_histories",
32471     "title": "Gets queue hopper histories",
32472     "examples": [
32473       {
32474         "title": "Example usage:",
32475         "content": "curl https://{domain}/api/voice/queues/{id}/hopper_histories -v -u {name}:{password} -X GET",
32476         "type": "json"
32477       }
32478     ],
32479     "name": "GetHopperHistories",
32480     "group": "Voice_Queues",
32481     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32482     "version": "0.0.0",
32483     "filename": "server/api/voiceQueue/index.js",
32484     "groupTitle": "Voice_Queues"
32485   },
32486   {
32487     "type": "get",
32488     "url": "/api/voice/queues/{id}/hoppers",
32489     "title": "Gets queue hoppers",
32490     "examples": [
32491       {
32492         "title": "Example usage:",
32493         "content": "curl https://{domain}/api/voice/queues/{id}/hoppers -v -u {name}:{password} -X GET",
32494         "type": "json"
32495       }
32496     ],
32497     "name": "GetHoppers",
32498     "group": "Voice_Queues",
32499     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32500     "version": "0.0.0",
32501     "filename": "server/api/voiceQueue/index.js",
32502     "groupTitle": "Voice_Queues"
32503   },
32504   {
32505     "type": "get",
32506     "url": "/api/voice/queues/{id}/lists",
32507     "title": "Get queue lists",
32508     "examples": [
32509       {
32510         "title": "Example usage:",
32511         "content": "curl https://{domain}/api/voice/queues/{id}/lists -v -u {name}:{password} -X GET",
32512         "type": "json"
32513       }
32514     ],
32515     "name": "GetLists",
32516     "group": "Voice_Queues",
32517     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32518     "version": "0.0.0",
32519     "filename": "server/api/voiceQueue/index.js",
32520     "groupTitle": "Voice_Queues"
32521   },
32522   {
32523     "type": "get",
32524     "url": "/api/voice/queues/{id}/members",
32525     "title": "Gets queue members",
32526     "examples": [
32527       {
32528         "title": "Example usage:",
32529         "content": "curl https://{domain}/api/voice/queues/{id}/members -v -u {name}:{password} -X GET",
32530         "type": "json"
32531       }
32532     ],
32533     "name": "GetMembers",
32534     "group": "Voice_Queues",
32535     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32536     "version": "0.0.0",
32537     "filename": "server/api/voiceQueue/index.js",
32538     "groupTitle": "Voice_Queues"
32539   },
32540   {
32541     "type": "get",
32542     "url": "/api/voice/queues",
32543     "title": "Gets a list of Queues",
32544     "examples": [
32545       {
32546         "title": "Example usage:",
32547         "content": "curl https://{domain}/api/voice/queues -v -u {name}:{password}",
32548         "type": "json"
32549       }
32550     ],
32551     "name": "GetQueues",
32552     "group": "Voice_Queues",
32553     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
32554     "version": "0.0.0",
32555     "filename": "server/api/voiceQueue/index.js",
32556     "groupTitle": "Voice_Queues"
32557   },
32558   {
32559     "type": "get",
32560     "url": "/api/voice/queues/{id}/teams",
32561     "title": "Gets queue team",
32562     "examples": [
32563       {
32564         "title": "Example usage:",
32565         "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password}  -X GET",
32566         "type": "json"
32567       }
32568     ],
32569     "name": "GetTeams",
32570     "group": "Voice_Queues",
32571     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32572     "version": "0.0.0",
32573     "filename": "server/api/voiceQueue/index.js",
32574     "groupTitle": "Voice_Queues"
32575   },
32576   {
32577     "type": "delete",
32578     "url": "/api/voice/queues/{id}/users",
32579     "title": "Removes agents from a queue",
32580     "examples": [
32581       {
32582         "title": "Example usage:",
32583         "content": "curl https://{domain}/api/voice/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32584         "type": "json"
32585       }
32586     ],
32587     "name": "RemoveAgents",
32588     "group": "Voice_Queues",
32589     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32590     "version": "0.0.0",
32591     "filename": "server/api/voiceQueue/index.js",
32592     "groupTitle": "Voice_Queues"
32593   },
32594   {
32595     "type": "delete",
32596     "url": "/api/voice/queues/{id}/blacklists",
32597     "title": "Remove blacklists from a queue",
32598     "examples": [
32599       {
32600         "title": "Example usage:",
32601         "content": "curl https://{domain}/api/voice/queues/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32602         "type": "json"
32603       }
32604     ],
32605     "name": "RemoveBlackLists",
32606     "group": "Voice_Queues",
32607     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32608     "version": "0.0.0",
32609     "filename": "server/api/voiceQueue/index.js",
32610     "groupTitle": "Voice_Queues"
32611   },
32612   {
32613     "type": "delete",
32614     "url": "/api/voice/queues/{id}/lists",
32615     "title": "Remove lists from a queue",
32616     "examples": [
32617       {
32618         "title": "Example usage:",
32619         "content": "curl https://{domain}/api/voice/queues/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32620         "type": "json"
32621       }
32622     ],
32623     "name": "RemoveLists",
32624     "group": "Voice_Queues",
32625     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32626     "version": "0.0.0",
32627     "filename": "server/api/voiceQueue/index.js",
32628     "groupTitle": "Voice_Queues"
32629   },
32630   {
32631     "type": "get",
32632     "url": "/api/voice/queues/{id}",
32633     "title": "Gets a single Queue",
32634     "examples": [
32635       {
32636         "title": "Example usage:",
32637         "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password}",
32638         "type": "json"
32639       }
32640     ],
32641     "name": "ShowQueues",
32642     "group": "Voice_Queues",
32643     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32644     "version": "0.0.0",
32645     "filename": "server/api/voiceQueue/index.js",
32646     "groupTitle": "Voice_Queues"
32647   },
32648   {
32649     "type": "get",
32650     "url": "/api/voice/queues/{id}/blacks",
32651     "title": "Gets queue hopper blacks",
32652     "examples": [
32653       {
32654         "title": "Example usage:",
32655         "content": "curl https://{domain}/api/voice/queues/{id}/hopper_black -v -u {name}:{password}  -X GET",
32656         "type": "json"
32657       }
32658     ],
32659     "name": "getHopperBlacks",
32660     "group": "Voice_Queues",
32661     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32662     "version": "0.0.0",
32663     "filename": "server/api/voiceQueue/index.js",
32664     "groupTitle": "Voice_Queues"
32665   },
32666   {
32667     "type": "put",
32668     "url": "/api/voice/queues/{id}",
32669     "title": "Update an existing Queue",
32670     "examples": [
32671       {
32672         "title": "Example usage:",
32673         "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",
32674         "type": "json"
32675       }
32676     ],
32677     "name": "updateQueues",
32678     "group": "Voice_Queues",
32679     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32680     "version": "0.0.0",
32681     "filename": "server/api/voiceQueue/index.js",
32682     "groupTitle": "Voice_Queues"
32683   },
32684   {
32685     "type": "post",
32686     "url": "/api/voice/recordings",
32687     "title": "Creates a new Recording",
32688     "examples": [
32689       {
32690         "title": "Example usage:",
32691         "content": "curl https://{domain}/api/voice/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
32692         "type": "json"
32693       }
32694     ],
32695     "name": "CreateRecordings",
32696     "group": "Voice_Recordings",
32697     "parameter": {
32698       "fields": {
32699         "Body": [
32700           {
32701             "group": "Body",
32702             "type": "Virtual",
32703             "optional": true,
32704             "field": "format",
32705             "description": ""
32706           },
32707           {
32708             "group": "Body",
32709             "type": "String",
32710             "optional": true,
32711             "field": "uniqueid",
32712             "description": ""
32713           },
32714           {
32715             "group": "Body",
32716             "type": "String",
32717             "optional": true,
32718             "field": "channel",
32719             "description": ""
32720           },
32721           {
32722             "group": "Body",
32723             "type": "String",
32724             "optional": true,
32725             "field": "membername",
32726             "description": ""
32727           },
32728           {
32729             "group": "Body",
32730             "type": "String",
32731             "optional": true,
32732             "field": "calleridnum",
32733             "description": ""
32734           },
32735           {
32736             "group": "Body",
32737             "type": "String",
32738             "optional": true,
32739             "field": "calleridname",
32740             "description": ""
32741           },
32742           {
32743             "group": "Body",
32744             "type": "String",
32745             "optional": true,
32746             "field": "connectedlinenum",
32747             "description": ""
32748           },
32749           {
32750             "group": "Body",
32751             "type": "String",
32752             "optional": true,
32753             "field": "connectedlinename",
32754             "description": ""
32755           },
32756           {
32757             "group": "Body",
32758             "type": "String",
32759             "optional": true,
32760             "field": "accountcode",
32761             "description": ""
32762           },
32763           {
32764             "group": "Body",
32765             "type": "String",
32766             "optional": true,
32767             "field": "context",
32768             "description": ""
32769           },
32770           {
32771             "group": "Body",
32772             "type": "String",
32773             "optional": true,
32774             "field": "exten",
32775             "description": ""
32776           },
32777           {
32778             "group": "Body",
32779             "type": "String",
32780             "optional": true,
32781             "field": "value",
32782             "description": ""
32783           },
32784           {
32785             "group": "Body",
32786             "type": "String",
32787             "optional": true,
32788             "field": "type",
32789             "description": ""
32790           },
32791           {
32792             "group": "Body",
32793             "type": "Integer",
32794             "optional": true,
32795             "field": "rating",
32796             "description": ""
32797           },
32798           {
32799             "group": "Body",
32800             "type": "String",
32801             "optional": true,
32802             "field": "queue",
32803             "description": ""
32804           },
32805           {
32806             "group": "Body",
32807             "type": "String",
32808             "optional": true,
32809             "field": "userDisposition",
32810             "description": ""
32811           },
32812           {
32813             "group": "Body",
32814             "type": "String",
32815             "optional": true,
32816             "field": "userSecondDisposition",
32817             "description": ""
32818           },
32819           {
32820             "group": "Body",
32821             "type": "String",
32822             "optional": true,
32823             "field": "userThirdDisposition",
32824             "description": ""
32825           },
32826           {
32827             "group": "Body",
32828             "type": "Text",
32829             "optional": true,
32830             "field": "location",
32831             "description": ""
32832           },
32833           {
32834             "group": "Body",
32835             "type": "String",
32836             "optional": true,
32837             "field": "transcribeName",
32838             "description": ""
32839           },
32840           {
32841             "group": "Body",
32842             "type": "String",
32843             "optional": true,
32844             "field": "transcribeStatus",
32845             "description": ""
32846           },
32847           {
32848             "group": "Body",
32849             "type": "Text",
32850             "optional": true,
32851             "field": "fileUri",
32852             "description": ""
32853           },
32854           {
32855             "group": "Body",
32856             "type": "Text",
32857             "optional": true,
32858             "field": "fileText",
32859             "description": ""
32860           },
32861           {
32862             "group": "Body",
32863             "type": "Text",
32864             "optional": true,
32865             "field": "failureReason",
32866             "description": ""
32867           },
32868           {
32869             "group": "Body",
32870             "type": "String",
32871             "optional": true,
32872             "field": "sentiment",
32873             "description": ""
32874           },
32875           {
32876             "group": "Body",
32877             "type": "Float",
32878             "optional": true,
32879             "field": "sPositive",
32880             "description": ""
32881           },
32882           {
32883             "group": "Body",
32884             "type": "Float",
32885             "optional": true,
32886             "field": "sNegative",
32887             "description": ""
32888           },
32889           {
32890             "group": "Body",
32891             "type": "Float",
32892             "optional": true,
32893             "field": "sNeutral",
32894             "description": ""
32895           },
32896           {
32897             "group": "Body",
32898             "type": "Float",
32899             "optional": true,
32900             "field": "sMixed",
32901             "description": ""
32902           },
32903           {
32904             "group": "Body",
32905             "type": "Boolean",
32906             "optional": true,
32907             "field": "tempSentiment",
32908             "description": ""
32909           },
32910           {
32911             "group": "Body",
32912             "type": "String",
32913             "optional": true,
32914             "field": "createdAt",
32915             "description": ""
32916           },
32917           {
32918             "group": "Body",
32919             "type": "String",
32920             "optional": true,
32921             "field": "updatedAt",
32922             "description": ""
32923           }
32924         ]
32925       }
32926     },
32927     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32928     "version": "0.0.0",
32929     "filename": "server/api/voiceRecording/index.js",
32930     "groupTitle": "Voice_Recordings"
32931   },
32932   {
32933     "type": "get",
32934     "url": "/api/voice/recordings/describe",
32935     "title": "Gets table info about Recordings",
32936     "examples": [
32937       {
32938         "title": "Example usage:",
32939         "content": "curl https://{domain}/api/voice/recordings/describe -v -u {name}:{password}",
32940         "type": "json"
32941       }
32942     ],
32943     "name": "DescribeRecordings",
32944     "group": "Voice_Recordings",
32945     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32946     "version": "0.0.0",
32947     "filename": "server/api/voiceRecording/index.js",
32948     "groupTitle": "Voice_Recordings"
32949   },
32950   {
32951     "type": "get",
32952     "url": "/api/voice/recordings",
32953     "title": "Gets a list of Recordings",
32954     "examples": [
32955       {
32956         "title": "Example usage:",
32957         "content": "curl https://{domain}/api/voice/recordings -v -u {name}:{password}",
32958         "type": "json"
32959       }
32960     ],
32961     "name": "GetRecordings",
32962     "group": "Voice_Recordings",
32963     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
32964     "version": "0.0.0",
32965     "filename": "server/api/voiceRecording/index.js",
32966     "groupTitle": "Voice_Recordings"
32967   },
32968   {
32969     "type": "get",
32970     "url": "/api/voice/recordings/{id}",
32971     "title": "Gets a single Recording",
32972     "examples": [
32973       {
32974         "title": "Example usage:",
32975         "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password}",
32976         "type": "json"
32977       }
32978     ],
32979     "name": "ShowRecordings",
32980     "group": "Voice_Recordings",
32981     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32982     "version": "0.0.0",
32983     "filename": "server/api/voiceRecording/index.js",
32984     "groupTitle": "Voice_Recordings"
32985   },
32986   {
32987     "type": "delete",
32988     "url": "/api/voice/recordings/{id}",
32989     "title": "Delete voice recording",
32990     "examples": [
32991       {
32992         "title": "Example usage:",
32993         "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password} -X DELETE",
32994         "type": "json"
32995       }
32996     ],
32997     "name": "destroy",
32998     "group": "Voice_Recordings",
32999     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33000     "version": "0.0.0",
33001     "filename": "server/api/voiceRecording/index.js",
33002     "groupTitle": "Voice_Recordings"
33003   },
33004   {
33005     "type": "get",
33006     "url": "/api/voice/recordings/{id}/download",
33007     "title": "Download Recording",
33008     "examples": [
33009       {
33010         "title": "Example usage:",
33011         "content": "curl https://{domain}/api/voice/recordings/{id}/download -v -u {name}:{password} -X GET",
33012         "type": "json"
33013       }
33014     ],
33015     "name": "download",
33016     "group": "Voice_Recordings",
33017     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33018     "version": "0.0.0",
33019     "filename": "server/api/voiceRecording/index.js",
33020     "groupTitle": "Voice_Recordings"
33021   },
33022   {
33023     "type": "get",
33024     "url": "/api/voice/recordings/{id}/downloads",
33025     "title": "Download Recording",
33026     "examples": [
33027       {
33028         "title": "Example usage:",
33029         "content": "curl https://{domain}/api/voice/recordings/{id}/downloads -v -u {name}:{password} -X GET",
33030         "type": "json"
33031       }
33032     ],
33033     "name": "downloads",
33034     "group": "Voice_Recordings",
33035     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33036     "version": "0.0.0",
33037     "filename": "server/api/voiceRecording/index.js",
33038     "groupTitle": "Voice_Recordings"
33039   },
33040   {
33041     "type": "post",
33042     "url": "/api/voice/recordings/{id}/transcribe",
33043     "title": "Run Transcribe Recording",
33044     "examples": [
33045       {
33046         "title": "Example usage:",
33047         "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -d '{\"runSentiment\": \"true\"}' -v -u {name}:{password} -X POST",
33048         "type": "json"
33049       }
33050     ],
33051     "name": "transcribe",
33052     "group": "Voice_Recordings",
33053     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33054     "version": "0.0.0",
33055     "filename": "server/api/voiceRecording/index.js",
33056     "groupTitle": "Voice_Recordings"
33057   },
33058   {
33059     "type": "get",
33060     "url": "/api/voice/recordings/{id}/transcribe",
33061     "title": "Run Transcribe Recording",
33062     "examples": [
33063       {
33064         "title": "Example usage:",
33065         "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -v -u {name}:{password} -X GET",
33066         "type": "json"
33067       }
33068     ],
33069     "name": "transcribe",
33070     "group": "Voice_Recordings",
33071     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33072     "version": "0.0.0",
33073     "filename": "server/api/voiceRecording/index.js",
33074     "groupTitle": "Voice_Recordings"
33075   },
33076   {
33077     "type": "put",
33078     "url": "/api/voice/recordings/{id}",
33079     "title": "Update an existing Recording",
33080     "examples": [
33081       {
33082         "title": "Example usage:",
33083         "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",
33084         "type": "json"
33085       }
33086     ],
33087     "name": "updateRecordings",
33088     "group": "Voice_Recordings",
33089     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33090     "version": "0.0.0",
33091     "filename": "server/api/voiceRecording/index.js",
33092     "groupTitle": "Voice_Recordings"
33093   },
33094   {
33095     "type": "post",
33096     "url": "/api/voice/transfers/reports",
33097     "title": "Creates a new Transfer Report",
33098     "examples": [
33099       {
33100         "title": "Example usage:",
33101         "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",
33102         "type": "json"
33103       }
33104     ],
33105     "name": "CreateTransfer_Reports",
33106     "group": "Voice_Transfer_Reports",
33107     "parameter": {
33108       "fields": {
33109         "Body": [
33110           {
33111             "group": "Body",
33112             "type": "String",
33113             "allowedValues": [
33114               "\"blind\"",
33115               "\"attended\""
33116             ],
33117             "optional": true,
33118             "field": "type",
33119             "description": ""
33120           },
33121           {
33122             "group": "Body",
33123             "type": "String",
33124             "optional": true,
33125             "field": "result",
33126             "description": ""
33127           },
33128           {
33129             "group": "Body",
33130             "type": "String",
33131             "optional": true,
33132             "field": "transfererchannel",
33133             "description": ""
33134           },
33135           {
33136             "group": "Body",
33137             "type": "String",
33138             "optional": true,
33139             "field": "transferercalleridnum",
33140             "description": ""
33141           },
33142           {
33143             "group": "Body",
33144             "type": "String",
33145             "optional": true,
33146             "field": "transferercalleridname",
33147             "description": ""
33148           },
33149           {
33150             "group": "Body",
33151             "type": "String",
33152             "optional": true,
33153             "field": "transfererconnectedlinenum",
33154             "description": ""
33155           },
33156           {
33157             "group": "Body",
33158             "type": "String",
33159             "optional": true,
33160             "field": "transfererconnectedlinename",
33161             "description": ""
33162           },
33163           {
33164             "group": "Body",
33165             "type": "String",
33166             "optional": true,
33167             "field": "transfereraccountcode",
33168             "description": ""
33169           },
33170           {
33171             "group": "Body",
33172             "type": "String",
33173             "optional": true,
33174             "field": "transferercontext",
33175             "description": ""
33176           },
33177           {
33178             "group": "Body",
33179             "type": "String",
33180             "optional": true,
33181             "field": "transfererexten",
33182             "description": ""
33183           },
33184           {
33185             "group": "Body",
33186             "type": "String",
33187             "optional": true,
33188             "field": "transfererlinkedid",
33189             "description": ""
33190           },
33191           {
33192             "group": "Body",
33193             "type": "String",
33194             "optional": true,
33195             "field": "transfereechannel",
33196             "description": ""
33197           },
33198           {
33199             "group": "Body",
33200             "type": "String",
33201             "optional": true,
33202             "field": "transfereecalleridnum",
33203             "description": ""
33204           },
33205           {
33206             "group": "Body",
33207             "type": "String",
33208             "optional": true,
33209             "field": "transfereecalleridname",
33210             "description": ""
33211           },
33212           {
33213             "group": "Body",
33214             "type": "String",
33215             "optional": true,
33216             "field": "transfereeconnectedlinenum",
33217             "description": ""
33218           },
33219           {
33220             "group": "Body",
33221             "type": "String",
33222             "optional": true,
33223             "field": "transfereeconnectedlinename",
33224             "description": ""
33225           },
33226           {
33227             "group": "Body",
33228             "type": "String",
33229             "optional": true,
33230             "field": "transfereeaccountcode",
33231             "description": ""
33232           },
33233           {
33234             "group": "Body",
33235             "type": "String",
33236             "optional": true,
33237             "field": "transfereecontext",
33238             "description": ""
33239           },
33240           {
33241             "group": "Body",
33242             "type": "String",
33243             "optional": true,
33244             "field": "transfereeexten",
33245             "description": ""
33246           },
33247           {
33248             "group": "Body",
33249             "type": "String",
33250             "optional": true,
33251             "field": "transfereelinkedid",
33252             "description": ""
33253           },
33254           {
33255             "group": "Body",
33256             "type": "String",
33257             "allowedValues": [
33258               "\"Yes\"",
33259               "\"No\""
33260             ],
33261             "optional": true,
33262             "field": "isexternal",
33263             "description": ""
33264           },
33265           {
33266             "group": "Body",
33267             "type": "String",
33268             "optional": true,
33269             "field": "context",
33270             "description": ""
33271           },
33272           {
33273             "group": "Body",
33274             "type": "String",
33275             "optional": true,
33276             "field": "extension",
33277             "description": ""
33278           }
33279         ]
33280       }
33281     },
33282     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33283     "version": "0.0.0",
33284     "filename": "server/api/voiceTransferReport/index.js",
33285     "groupTitle": "Voice_Transfer_Reports"
33286   },
33287   {
33288     "type": "delete",
33289     "url": "/api/voice/transfers/reports/{id}",
33290     "title": "Deletes a Transfer Report",
33291     "examples": [
33292       {
33293         "title": "Example usage:",
33294         "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password} -X DELETE",
33295         "type": "json"
33296       }
33297     ],
33298     "name": "DeleteTransfer_Reports",
33299     "group": "Voice_Transfer_Reports",
33300     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33301     "version": "0.0.0",
33302     "filename": "server/api/voiceTransferReport/index.js",
33303     "groupTitle": "Voice_Transfer_Reports"
33304   },
33305   {
33306     "type": "get",
33307     "url": "/api/voice/transfers/reports",
33308     "title": "Gets a list of Transfer Reports",
33309     "examples": [
33310       {
33311         "title": "Example usage:",
33312         "content": "curl https://{domain}/api/voice/transfers/reports -v -u {name}:{password}",
33313         "type": "json"
33314       }
33315     ],
33316     "name": "GetTransfer_Reports",
33317     "group": "Voice_Transfer_Reports",
33318     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33319     "version": "0.0.0",
33320     "filename": "server/api/voiceTransferReport/index.js",
33321     "groupTitle": "Voice_Transfer_Reports"
33322   },
33323   {
33324     "type": "get",
33325     "url": "/api/voice/transfers/reports/{id}",
33326     "title": "Gets a single Transfer Report",
33327     "examples": [
33328       {
33329         "title": "Example usage:",
33330         "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password}",
33331         "type": "json"
33332       }
33333     ],
33334     "name": "ShowTransfer_Reports",
33335     "group": "Voice_Transfer_Reports",
33336     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33337     "version": "0.0.0",
33338     "filename": "server/api/voiceTransferReport/index.js",
33339     "groupTitle": "Voice_Transfer_Reports"
33340   },
33341   {
33342     "type": "put",
33343     "url": "/api/voice/transfers/reports/{id}",
33344     "title": "Update an existing Transfer Report",
33345     "examples": [
33346       {
33347         "title": "Example usage:",
33348         "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",
33349         "type": "json"
33350       }
33351     ],
33352     "name": "updateTransfer_Reports",
33353     "group": "Voice_Transfer_Reports",
33354     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33355     "version": "0.0.0",
33356     "filename": "server/api/voiceTransferReport/index.js",
33357     "groupTitle": "Voice_Transfer_Reports"
33358   },
33359   {
33360     "type": "post",
33361     "url": "/api/integrations/vtiger/accounts",
33362     "title": "Creates a new Vtiger Account",
33363     "examples": [
33364       {
33365         "title": "Example usage:",
33366         "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",
33367         "type": "json"
33368       }
33369     ],
33370     "name": "CreateVtiger_Accounts",
33371     "group": "Vtiger_Accounts",
33372     "parameter": {
33373       "fields": {
33374         "Body": [
33375           {
33376             "group": "Body",
33377             "type": "String",
33378             "optional": false,
33379             "field": "name",
33380             "description": ""
33381           },
33382           {
33383             "group": "Body",
33384             "type": "String",
33385             "optional": true,
33386             "field": "description",
33387             "description": ""
33388           },
33389           {
33390             "group": "Body",
33391             "type": "String",
33392             "optional": false,
33393             "field": "username",
33394             "description": ""
33395           },
33396           {
33397             "group": "Body",
33398             "type": "String",
33399             "optional": false,
33400             "field": "moduleName",
33401             "description": ""
33402           },
33403           {
33404             "group": "Body",
33405             "type": "String",
33406             "optional": false,
33407             "field": "remoteUri",
33408             "description": ""
33409           },
33410           {
33411             "group": "Body",
33412             "type": "String",
33413             "optional": true,
33414             "field": "serverUrl",
33415             "description": ""
33416           },
33417           {
33418             "group": "Body",
33419             "type": "String",
33420             "optional": false,
33421             "field": "accessKey",
33422             "description": ""
33423           }
33424         ]
33425       }
33426     },
33427     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33428     "version": "0.0.0",
33429     "filename": "server/api/intVtigerAccount/index.js",
33430     "groupTitle": "Vtiger_Accounts"
33431   },
33432   {
33433     "type": "delete",
33434     "url": "/api/integrations/vtiger/accounts/{id}",
33435     "title": "Deletes a Vtiger Account",
33436     "examples": [
33437       {
33438         "title": "Example usage:",
33439         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password} -X DELETE",
33440         "type": "json"
33441       }
33442     ],
33443     "name": "DeleteVtiger_Accounts",
33444     "group": "Vtiger_Accounts",
33445     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33446     "version": "0.0.0",
33447     "filename": "server/api/intVtigerAccount/index.js",
33448     "groupTitle": "Vtiger_Accounts"
33449   },
33450   {
33451     "type": "get",
33452     "url": "/api/integrations/vtiger/accounts",
33453     "title": "Gets a list of Vtiger Accounts",
33454     "examples": [
33455       {
33456         "title": "Example usage:",
33457         "content": "curl https://{domain}/api/integrations/vtiger/accounts -v -u {name}:{password}",
33458         "type": "json"
33459       }
33460     ],
33461     "name": "GetVtiger_Accounts",
33462     "group": "Vtiger_Accounts",
33463     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33464     "version": "0.0.0",
33465     "filename": "server/api/intVtigerAccount/index.js",
33466     "groupTitle": "Vtiger_Accounts"
33467   },
33468   {
33469     "type": "get",
33470     "url": "/api/integrations/vtiger/accounts/{id}",
33471     "title": "Gets a single Vtiger Account",
33472     "examples": [
33473       {
33474         "title": "Example usage:",
33475         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password}",
33476         "type": "json"
33477       }
33478     ],
33479     "name": "ShowVtiger_Accounts",
33480     "group": "Vtiger_Accounts",
33481     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33482     "version": "0.0.0",
33483     "filename": "server/api/intVtigerAccount/index.js",
33484     "groupTitle": "Vtiger_Accounts"
33485   },
33486   {
33487     "type": "post",
33488     "url": "/api/integrations/vtiger/accounts/{id}/configurations",
33489     "title": "Creates new configuration",
33490     "examples": [
33491       {
33492         "title": "Example usage:",
33493         "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",
33494         "type": "json"
33495       }
33496     ],
33497     "name": "addConfiguration",
33498     "group": "Vtiger_Accounts",
33499     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33500     "version": "0.0.0",
33501     "filename": "server/api/intVtigerAccount/index.js",
33502     "groupTitle": "Vtiger_Accounts"
33503   },
33504   {
33505     "type": "get",
33506     "url": "/api/integrations/vtiger/accounts/{id}/configurations",
33507     "title": "Gets account configurations",
33508     "examples": [
33509       {
33510         "title": "Example usage:",
33511         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/configurations -v -u {name}:{password} -X GET",
33512         "type": "json"
33513       }
33514     ],
33515     "name": "getConfigurations",
33516     "group": "Vtiger_Accounts",
33517     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33518     "version": "0.0.0",
33519     "filename": "server/api/intVtigerAccount/index.js",
33520     "groupTitle": "Vtiger_Accounts"
33521   },
33522   {
33523     "type": "get",
33524     "url": "/api/integrations/vtiger/accounts/{id}/fields",
33525     "title": "Gets account fields",
33526     "examples": [
33527       {
33528         "title": "Example usage:",
33529         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/fields -v -u {name}:{password} -X GET",
33530         "type": "json"
33531       }
33532     ],
33533     "name": "getFields",
33534     "group": "Vtiger_Accounts",
33535     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33536     "version": "0.0.0",
33537     "filename": "server/api/intVtigerAccount/index.js",
33538     "groupTitle": "Vtiger_Accounts"
33539   },
33540   {
33541     "type": "put",
33542     "url": "/api/integrations/vtiger/accounts/{id}",
33543     "title": "Update an existing Vtiger Account",
33544     "examples": [
33545       {
33546         "title": "Example usage:",
33547         "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",
33548         "type": "json"
33549       }
33550     ],
33551     "name": "updateVtiger_Accounts",
33552     "group": "Vtiger_Accounts",
33553     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33554     "version": "0.0.0",
33555     "filename": "server/api/intVtigerAccount/index.js",
33556     "groupTitle": "Vtiger_Accounts"
33557   },
33558   {
33559     "type": "post",
33560     "url": "/api/integrations/vtiger/configurations",
33561     "title": "Creates a new Vtiger Configuration",
33562     "examples": [
33563       {
33564         "title": "Example usage:",
33565         "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",
33566         "type": "json"
33567       }
33568     ],
33569     "name": "CreateVtiger_Configurations",
33570     "group": "Vtiger_Configurations",
33571     "parameter": {
33572       "fields": {
33573         "Body": [
33574           {
33575             "group": "Body",
33576             "type": "String",
33577             "optional": true,
33578             "field": "name",
33579             "description": ""
33580           },
33581           {
33582             "group": "Body",
33583             "type": "String",
33584             "optional": true,
33585             "field": "description",
33586             "description": ""
33587           }
33588         ]
33589       }
33590     },
33591     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33592     "version": "0.0.0",
33593     "filename": "server/api/intVtigerConfiguration/index.js",
33594     "groupTitle": "Vtiger_Configurations"
33595   },
33596   {
33597     "type": "delete",
33598     "url": "/api/integrations/vtiger/configurations/{id}",
33599     "title": "Deletes a Vtiger Configuration",
33600     "examples": [
33601       {
33602         "title": "Example usage:",
33603         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password} -X DELETE",
33604         "type": "json"
33605       }
33606     ],
33607     "name": "DeleteVtiger_Configurations",
33608     "group": "Vtiger_Configurations",
33609     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33610     "version": "0.0.0",
33611     "filename": "server/api/intVtigerConfiguration/index.js",
33612     "groupTitle": "Vtiger_Configurations"
33613   },
33614   {
33615     "type": "get",
33616     "url": "/api/integrations/vtiger/configurations",
33617     "title": "Gets a list of Vtiger Configurations",
33618     "examples": [
33619       {
33620         "title": "Example usage:",
33621         "content": "curl https://{domain}/api/integrations/vtiger/configurations -v -u {name}:{password}",
33622         "type": "json"
33623       }
33624     ],
33625     "name": "GetVtiger_Configurations",
33626     "group": "Vtiger_Configurations",
33627     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33628     "version": "0.0.0",
33629     "filename": "server/api/intVtigerConfiguration/index.js",
33630     "groupTitle": "Vtiger_Configurations"
33631   },
33632   {
33633     "type": "get",
33634     "url": "/api/integrations/vtiger/configurations/{id}",
33635     "title": "Gets a single Vtiger Configuration",
33636     "examples": [
33637       {
33638         "title": "Example usage:",
33639         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password}",
33640         "type": "json"
33641       }
33642     ],
33643     "name": "ShowVtiger_Configurations",
33644     "group": "Vtiger_Configurations",
33645     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33646     "version": "0.0.0",
33647     "filename": "server/api/intVtigerConfiguration/index.js",
33648     "groupTitle": "Vtiger_Configurations"
33649   },
33650   {
33651     "type": "get",
33652     "url": "/api/integrations/vtiger/configurations/{id}/descriptions",
33653     "title": "Gets configurations descriptions",
33654     "examples": [
33655       {
33656         "title": "Example usage:",
33657         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
33658         "type": "json"
33659       }
33660     ],
33661     "name": "getDescriptions",
33662     "group": "Vtiger_Configurations",
33663     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33664     "version": "0.0.0",
33665     "filename": "server/api/intVtigerConfiguration/index.js",
33666     "groupTitle": "Vtiger_Configurations"
33667   },
33668   {
33669     "type": "get",
33670     "url": "/api/integrations/vtiger/configurations/{id}/fields",
33671     "title": "Gets configurations fields",
33672     "examples": [
33673       {
33674         "title": "Example usage:",
33675         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/fields -v -u {name}:{password} -X GET",
33676         "type": "json"
33677       }
33678     ],
33679     "name": "getFields",
33680     "group": "Vtiger_Configurations",
33681     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33682     "version": "0.0.0",
33683     "filename": "server/api/intVtigerConfiguration/index.js",
33684     "groupTitle": "Vtiger_Configurations"
33685   },
33686   {
33687     "type": "get",
33688     "url": "/api/integrations/vtiger/configurations/{id}/subjects",
33689     "title": "Gets configurations subjects",
33690     "examples": [
33691       {
33692         "title": "Example usage:",
33693         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/subjects -v -u {name}:{password} -X GET",
33694         "type": "json"
33695       }
33696     ],
33697     "name": "getSubjects",
33698     "group": "Vtiger_Configurations",
33699     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33700     "version": "0.0.0",
33701     "filename": "server/api/intVtigerConfiguration/index.js",
33702     "groupTitle": "Vtiger_Configurations"
33703   },
33704   {
33705     "type": "put",
33706     "url": "/api/integrations/vtiger/configurations/{id}",
33707     "title": "Update an existing Vtiger Configuration",
33708     "examples": [
33709       {
33710         "title": "Example usage:",
33711         "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",
33712         "type": "json"
33713       }
33714     ],
33715     "name": "updateVtiger_Configurations",
33716     "group": "Vtiger_Configurations",
33717     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33718     "version": "0.0.0",
33719     "filename": "server/api/intVtigerConfiguration/index.js",
33720     "groupTitle": "Vtiger_Configurations"
33721   },
33722   {
33723     "type": "post",
33724     "url": "/api/integrations/vtiger/fields",
33725     "title": "Creates a new Vtiger Field",
33726     "examples": [
33727       {
33728         "title": "Example usage:",
33729         "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",
33730         "type": "json"
33731       }
33732     ],
33733     "name": "CreateVtiger_Fields",
33734     "group": "Vtiger_Fields",
33735     "parameter": {
33736       "fields": {
33737         "Body": [
33738           {
33739             "group": "Body",
33740             "type": "String",
33741             "allowedValues": [
33742               "\"string\"",
33743               "\"variable\"",
33744               "\"customVariable\"",
33745               "\"keyValue\""
33746             ],
33747             "optional": true,
33748             "field": "type",
33749             "description": ""
33750           },
33751           {
33752             "group": "Body",
33753             "type": "String",
33754             "optional": true,
33755             "field": "content",
33756             "description": ""
33757           },
33758           {
33759             "group": "Body",
33760             "type": "String",
33761             "optional": true,
33762             "field": "key",
33763             "description": ""
33764           },
33765           {
33766             "group": "Body",
33767             "type": "String",
33768             "allowedValues": [
33769               "\"string\"",
33770               "\"variable\"",
33771               "\"customVariable\""
33772             ],
33773             "optional": true,
33774             "field": "keyType",
33775             "description": ""
33776           },
33777           {
33778             "group": "Body",
33779             "type": "String",
33780             "optional": true,
33781             "field": "keyContent",
33782             "description": ""
33783           },
33784           {
33785             "group": "Body",
33786             "type": "String",
33787             "optional": true,
33788             "field": "idField",
33789             "description": ""
33790           },
33791           {
33792             "group": "Body",
33793             "type": "String",
33794             "optional": true,
33795             "field": "nameField",
33796             "description": ""
33797           },
33798           {
33799             "group": "Body",
33800             "type": "Boolean",
33801             "optional": true,
33802             "field": "customField",
33803             "description": ""
33804           },
33805           {
33806             "group": "Body",
33807             "type": "String",
33808             "optional": true,
33809             "field": "variableName",
33810             "description": ""
33811           }
33812         ]
33813       }
33814     },
33815     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33816     "version": "0.0.0",
33817     "filename": "server/api/intVtigerField/index.js",
33818     "groupTitle": "Vtiger_Fields"
33819   },
33820   {
33821     "type": "delete",
33822     "url": "/api/integrations/vtiger/fields/{id}",
33823     "title": "Deletes a Vtiger Field",
33824     "examples": [
33825       {
33826         "title": "Example usage:",
33827         "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password} -X DELETE",
33828         "type": "json"
33829       }
33830     ],
33831     "name": "DeleteVtiger_Fields",
33832     "group": "Vtiger_Fields",
33833     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33834     "version": "0.0.0",
33835     "filename": "server/api/intVtigerField/index.js",
33836     "groupTitle": "Vtiger_Fields"
33837   },
33838   {
33839     "type": "get",
33840     "url": "/api/integrations/vtiger/fields",
33841     "title": "Gets a list of Vtiger Fields",
33842     "examples": [
33843       {
33844         "title": "Example usage:",
33845         "content": "curl https://{domain}/api/integrations/vtiger/fields -v -u {name}:{password}",
33846         "type": "json"
33847       }
33848     ],
33849     "name": "GetVtiger_Fields",
33850     "group": "Vtiger_Fields",
33851     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33852     "version": "0.0.0",
33853     "filename": "server/api/intVtigerField/index.js",
33854     "groupTitle": "Vtiger_Fields"
33855   },
33856   {
33857     "type": "get",
33858     "url": "/api/integrations/vtiger/fields/{id}",
33859     "title": "Gets a single Vtiger Field",
33860     "examples": [
33861       {
33862         "title": "Example usage:",
33863         "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password}",
33864         "type": "json"
33865       }
33866     ],
33867     "name": "ShowVtiger_Fields",
33868     "group": "Vtiger_Fields",
33869     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33870     "version": "0.0.0",
33871     "filename": "server/api/intVtigerField/index.js",
33872     "groupTitle": "Vtiger_Fields"
33873   },
33874   {
33875     "type": "put",
33876     "url": "/api/integrations/vtiger/fields/{id}",
33877     "title": "Update an existing Vtiger Field",
33878     "examples": [
33879       {
33880         "title": "Example usage:",
33881         "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",
33882         "type": "json"
33883       }
33884     ],
33885     "name": "updateVtiger_Fields",
33886     "group": "Vtiger_Fields",
33887     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33888     "version": "0.0.0",
33889     "filename": "server/api/intVtigerField/index.js",
33890     "groupTitle": "Vtiger_Fields"
33891   },
33892   {
33893     "type": "post",
33894     "url": "/api/webbar/answer",
33895     "title": "answer webrtc call",
33896     "examples": [
33897       {
33898         "title": "Example usage:",
33899         "content": "curl https://{domain}/api/webbar/answer -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
33900         "type": "json"
33901       }
33902     ],
33903     "name": "Web_Bar_answer",
33904     "group": "WebBar",
33905     "parameter": {
33906       "fields": {
33907         "Body": [
33908           {
33909             "group": "Body",
33910             "type": "String",
33911             "optional": false,
33912             "field": "sessionId",
33913             "description": ""
33914           },
33915           {
33916             "group": "Body",
33917             "type": "number",
33918             "optional": false,
33919             "field": "userId",
33920             "description": ""
33921           }
33922         ]
33923       }
33924     },
33925     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33926     "version": "0.0.0",
33927     "filename": "server/api/webbar/index.js",
33928     "groupTitle": "WebBar"
33929   },
33930   {
33931     "type": "post",
33932     "url": "/api/webbar/calls",
33933     "title": "webrtc call list",
33934     "examples": [
33935       {
33936         "title": "Example usage:",
33937         "content": "curl https://{domain}/api/webbar/calls -d '{\"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
33938         "type": "json"
33939       }
33940     ],
33941     "name": "Web_Bar_calls",
33942     "group": "WebBar",
33943     "parameter": {
33944       "fields": {
33945         "Body": [
33946           {
33947             "group": "Body",
33948             "type": "number",
33949             "optional": false,
33950             "field": "userId",
33951             "description": ""
33952           }
33953         ]
33954       }
33955     },
33956     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33957     "version": "0.0.0",
33958     "filename": "server/api/webbar/index.js",
33959     "groupTitle": "WebBar"
33960   },
33961   {
33962     "type": "post",
33963     "url": "/api/webbar/hangup",
33964     "title": "hangup webrtc call",
33965     "examples": [
33966       {
33967         "title": "Example usage:",
33968         "content": "curl https://{domain}/api/webbar/hangup -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
33969         "type": "json"
33970       }
33971     ],
33972     "name": "Web_Bar_hangup",
33973     "group": "WebBar",
33974     "parameter": {
33975       "fields": {
33976         "Body": [
33977           {
33978             "group": "Body",
33979             "type": "String",
33980             "optional": false,
33981             "field": "sessionId",
33982             "description": ""
33983           },
33984           {
33985             "group": "Body",
33986             "type": "number",
33987             "optional": false,
33988             "field": "userId",
33989             "description": ""
33990           }
33991         ]
33992       }
33993     },
33994     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33995     "version": "0.0.0",
33996     "filename": "server/api/webbar/index.js",
33997     "groupTitle": "WebBar"
33998   },
33999   {
34000     "type": "post",
34001     "url": "/api/webbar/unhold",
34002     "title": "unhold webrtc call",
34003     "examples": [
34004       {
34005         "title": "Example usage:",
34006         "content": "curl https://{domain}/api/webbar/unhold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34007         "type": "json"
34008       }
34009     ],
34010     "name": "Web_Bar_hold",
34011     "group": "WebBar",
34012     "parameter": {
34013       "fields": {
34014         "Body": [
34015           {
34016             "group": "Body",
34017             "type": "String",
34018             "optional": false,
34019             "field": "sessionId",
34020             "description": ""
34021           },
34022           {
34023             "group": "Body",
34024             "type": "number",
34025             "optional": false,
34026             "field": "userId",
34027             "description": ""
34028           }
34029         ]
34030       }
34031     },
34032     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34033     "version": "0.0.0",
34034     "filename": "server/api/webbar/index.js",
34035     "groupTitle": "WebBar"
34036   },
34037   {
34038     "type": "post",
34039     "url": "/api/webbar/hold",
34040     "title": "hold webrtc call",
34041     "examples": [
34042       {
34043         "title": "Example usage:",
34044         "content": "curl https://{domain}/api/webbar/hold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34045         "type": "json"
34046       }
34047     ],
34048     "name": "Web_Bar_hold",
34049     "group": "WebBar",
34050     "parameter": {
34051       "fields": {
34052         "Body": [
34053           {
34054             "group": "Body",
34055             "type": "String",
34056             "optional": true,
34057             "field": "sessionId",
34058             "description": ""
34059           },
34060           {
34061             "group": "Body",
34062             "type": "number",
34063             "optional": false,
34064             "field": "userId",
34065             "description": ""
34066           }
34067         ]
34068       }
34069     },
34070     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34071     "version": "0.0.0",
34072     "filename": "server/api/webbar/index.js",
34073     "groupTitle": "WebBar"
34074   },
34075   {
34076     "type": "post",
34077     "url": "/api/webbar/originate",
34078     "title": "Originate new webrtc call",
34079     "examples": [
34080       {
34081         "title": "Example usage:",
34082         "content": "curl https://{domain}/api/webbar/originate -d '{\"callNumber\": \"0119692844\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34083         "type": "json"
34084       }
34085     ],
34086     "name": "Web_Bar_originate",
34087     "group": "WebBar",
34088     "parameter": {
34089       "fields": {
34090         "Body": [
34091           {
34092             "group": "Body",
34093             "type": "String",
34094             "optional": false,
34095             "field": "callNumber",
34096             "description": ""
34097           },
34098           {
34099             "group": "Body",
34100             "type": "number",
34101             "optional": false,
34102             "field": "userId",
34103             "description": ""
34104           },
34105           {
34106             "group": "Body",
34107             "type": "String",
34108             "optional": false,
34109             "field": "callerId",
34110             "description": ""
34111           },
34112           {
34113             "group": "Body",
34114             "type": "String",
34115             "optional": false,
34116             "field": "callbackUrl",
34117             "description": ""
34118           }
34119         ]
34120       }
34121     },
34122     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34123     "version": "0.0.0",
34124     "filename": "server/api/webbar/index.js",
34125     "groupTitle": "WebBar"
34126   },
34127   {
34128     "type": "post",
34129     "url": "/api/webbar/transfer",
34130     "title": "blind transfer webrtc call",
34131     "examples": [
34132       {
34133         "title": "Example usage:",
34134         "content": "curl https://{domain}/api/webbar/transfer -d '{\"userId\": 54, \"sessionId\":\"<sessionId>\", \"transferNumber\":\"<transferNumber>\"}' \\\n -H \"Content-Type: application/json\" -X POST",
34135         "type": "json"
34136       }
34137     ],
34138     "name": "Web_Bar_transfer",
34139     "group": "WebBar",
34140     "parameter": {
34141       "fields": {
34142         "Body": [
34143           {
34144             "group": "Body",
34145             "type": "number",
34146             "optional": false,
34147             "field": "userId",
34148             "description": ""
34149           },
34150           {
34151             "group": "Body",
34152             "type": "string",
34153             "optional": false,
34154             "field": "sessionId",
34155             "description": ""
34156           },
34157           {
34158             "group": "Body",
34159             "type": "string",
34160             "optional": false,
34161             "field": "transferNumber",
34162             "description": ""
34163           }
34164         ]
34165       }
34166     },
34167     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34168     "version": "0.0.0",
34169     "filename": "server/api/webbar/index.js",
34170     "groupTitle": "WebBar"
34171   },
34172   {
34173     "type": "post",
34174     "url": "/api/whatsapp/accounts/{id}/users",
34175     "title": "Add agents to a whatsapp account",
34176     "examples": [
34177       {
34178         "title": "Example usage:",
34179         "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",
34180         "type": "json"
34181       }
34182     ],
34183     "name": "AddAgents",
34184     "group": "Whatsapp_Accounts",
34185     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34186     "version": "0.0.0",
34187     "filename": "server/api/whatsappAccount/index.js",
34188     "groupTitle": "Whatsapp_Accounts"
34189   },
34190   {
34191     "type": "post",
34192     "url": "/api/whatsapp/accounts",
34193     "title": "Creates a new Account",
34194     "examples": [
34195       {
34196         "title": "Example usage:",
34197         "content": "curl https://{domain}/api/whatsapp/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
34198         "type": "json"
34199       }
34200     ],
34201     "name": "CreateAccounts",
34202     "group": "Whatsapp_Accounts",
34203     "parameter": {
34204       "fields": {
34205         "Body": [
34206           {
34207             "group": "Body",
34208             "type": "String",
34209             "optional": false,
34210             "field": "name",
34211             "description": ""
34212           },
34213           {
34214             "group": "Body",
34215             "type": "String",
34216             "optional": false,
34217             "field": "key",
34218             "description": ""
34219           },
34220           {
34221             "group": "Body",
34222             "type": "String",
34223             "optional": false,
34224             "field": "remote",
34225             "description": ""
34226           },
34227           {
34228             "group": "Body",
34229             "type": "String",
34230             "optional": true,
34231             "field": "token",
34232             "description": ""
34233           },
34234           {
34235             "group": "Body",
34236             "type": "String",
34237             "optional": true,
34238             "field": "phone",
34239             "description": ""
34240           },
34241           {
34242             "group": "Body",
34243             "type": "String",
34244             "allowedValues": [
34245               "\"twilio\""
34246             ],
34247             "optional": true,
34248             "field": "type",
34249             "description": ""
34250           },
34251           {
34252             "group": "Body",
34253             "type": "String",
34254             "optional": true,
34255             "field": "accountSid",
34256             "description": ""
34257           },
34258           {
34259             "group": "Body",
34260             "type": "String",
34261             "optional": true,
34262             "field": "authToken",
34263             "description": ""
34264           },
34265           {
34266             "group": "Body",
34267             "type": "Text",
34268             "optional": true,
34269             "field": "notificationTemplate",
34270             "description": ""
34271           },
34272           {
34273             "group": "Body",
34274             "type": "Boolean",
34275             "optional": true,
34276             "field": "notificationSound",
34277             "description": ""
34278           },
34279           {
34280             "group": "Body",
34281             "type": "Boolean",
34282             "optional": true,
34283             "field": "notificationShake",
34284             "description": ""
34285           },
34286           {
34287             "group": "Body",
34288             "type": "Integer",
34289             "optional": true,
34290             "field": "waitForTheAssignedAgent",
34291             "description": ""
34292           },
34293           {
34294             "group": "Body",
34295             "type": "Boolean",
34296             "optional": true,
34297             "field": "queueTransfer",
34298             "description": ""
34299           },
34300           {
34301             "group": "Body",
34302             "type": "Integer",
34303             "optional": true,
34304             "field": "queueTransferTimeout",
34305             "description": ""
34306           },
34307           {
34308             "group": "Body",
34309             "type": "Boolean",
34310             "optional": true,
34311             "field": "agentTransfer",
34312             "description": ""
34313           },
34314           {
34315             "group": "Body",
34316             "type": "Integer",
34317             "optional": true,
34318             "field": "agentTransferTimeout",
34319             "description": ""
34320           },
34321           {
34322             "group": "Body",
34323             "type": "Integer",
34324             "optional": true,
34325             "field": "mandatoryDispositionPauseId",
34326             "description": "<p>Status to put when mandatory disposition is enabled</p>"
34327           },
34328           {
34329             "group": "Body",
34330             "type": "Boolean",
34331             "optional": true,
34332             "field": "mandatoryDisposition",
34333             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
34334           },
34335           {
34336             "group": "Body",
34337             "type": "String",
34338             "optional": true,
34339             "field": "description",
34340             "description": ""
34341           }
34342         ]
34343       }
34344     },
34345     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34346     "version": "0.0.0",
34347     "filename": "server/api/whatsappAccount/index.js",
34348     "groupTitle": "Whatsapp_Accounts"
34349   },
34350   {
34351     "type": "delete",
34352     "url": "/api/whatsapp/accounts/{id}",
34353     "title": "Deletes a Account",
34354     "examples": [
34355       {
34356         "title": "Example usage:",
34357         "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password} -X DELETE",
34358         "type": "json"
34359       }
34360     ],
34361     "name": "DeleteAccounts",
34362     "group": "Whatsapp_Accounts",
34363     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34364     "version": "0.0.0",
34365     "filename": "server/api/whatsappAccount/index.js",
34366     "groupTitle": "Whatsapp_Accounts"
34367   },
34368   {
34369     "type": "get",
34370     "url": "/api/whatsapp/accounts/describe",
34371     "title": "Gets table info about Accounts",
34372     "examples": [
34373       {
34374         "title": "Example usage:",
34375         "content": "curl https://{domain}/api/whatsapp/accounts/describe -v -u {name}:{password}",
34376         "type": "json"
34377       }
34378     ],
34379     "name": "DescribeAccounts",
34380     "group": "Whatsapp_Accounts",
34381     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34382     "version": "0.0.0",
34383     "filename": "server/api/whatsappAccount/index.js",
34384     "groupTitle": "Whatsapp_Accounts"
34385   },
34386   {
34387     "type": "get",
34388     "url": "/api/whatsapp/accounts",
34389     "title": "Gets a list of Accounts",
34390     "examples": [
34391       {
34392         "title": "Example usage:",
34393         "content": "curl https://{domain}/api/whatsapp/accounts -v -u {name}:{password}",
34394         "type": "json"
34395       }
34396     ],
34397     "name": "GetAccounts",
34398     "group": "Whatsapp_Accounts",
34399     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34400     "version": "0.0.0",
34401     "filename": "server/api/whatsappAccount/index.js",
34402     "groupTitle": "Whatsapp_Accounts"
34403   },
34404   {
34405     "type": "get",
34406     "url": "/api/whatsapp/accounts/{id}/users",
34407     "title": "Gets agents from whatsapp account",
34408     "examples": [
34409       {
34410         "title": "Example usage:",
34411         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users -v -u {name}:{password} -X GET",
34412         "type": "json"
34413       }
34414     ],
34415     "name": "GetAgents",
34416     "group": "Whatsapp_Accounts",
34417     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34418     "version": "0.0.0",
34419     "filename": "server/api/whatsappAccount/index.js",
34420     "groupTitle": "Whatsapp_Accounts"
34421   },
34422   {
34423     "type": "delete",
34424     "url": "/api/whatsapp/accounts/{id}/users",
34425     "title": "Removes agents from a whatsapp account",
34426     "examples": [
34427       {
34428         "title": "Example usage:",
34429         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
34430         "type": "json"
34431       }
34432     ],
34433     "name": "RemoveAgents",
34434     "group": "Whatsapp_Accounts",
34435     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34436     "version": "0.0.0",
34437     "filename": "server/api/whatsappAccount/index.js",
34438     "groupTitle": "Whatsapp_Accounts"
34439   },
34440   {
34441     "type": "delete",
34442     "url": "/api/whatsapp/accounts/{id}/canned_answers",
34443     "title": "Removes canned answers from account",
34444     "examples": [
34445       {
34446         "title": "Example usage:",
34447         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
34448         "type": "json"
34449       }
34450     ],
34451     "name": "RemoveAnswers",
34452     "group": "Whatsapp_Accounts",
34453     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34454     "version": "0.0.0",
34455     "filename": "server/api/whatsappAccount/index.js",
34456     "groupTitle": "Whatsapp_Accounts"
34457   },
34458   {
34459     "type": "delete",
34460     "url": "/api/whatsapp/accounts/{id}/dispositions",
34461     "title": "Removes dispositions from account",
34462     "examples": [
34463       {
34464         "title": "Example usage:",
34465         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
34466         "type": "json"
34467       }
34468     ],
34469     "name": "RemoveDispositions",
34470     "group": "Whatsapp_Accounts",
34471     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34472     "version": "0.0.0",
34473     "filename": "server/api/whatsappAccount/index.js",
34474     "groupTitle": "Whatsapp_Accounts"
34475   },
34476   {
34477     "type": "get",
34478     "url": "/api/whatsapp/accounts/{id}",
34479     "title": "Gets a single Account",
34480     "examples": [
34481       {
34482         "title": "Example usage:",
34483         "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password}",
34484         "type": "json"
34485       }
34486     ],
34487     "name": "ShowAccounts",
34488     "group": "Whatsapp_Accounts",
34489     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34490     "version": "0.0.0",
34491     "filename": "server/api/whatsappAccount/index.js",
34492     "groupTitle": "Whatsapp_Accounts"
34493   },
34494   {
34495     "type": "put",
34496     "url": "/api/whatsapp/messages/{id}/accept",
34497     "title": "Accepts message",
34498     "examples": [
34499       {
34500         "title": "Example usage:",
34501         "content": "curl https://{domain}/api/whatsapp/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
34502         "type": "json"
34503       }
34504     ],
34505     "name": "acceptMessage",
34506     "group": "Whatsapp_Accounts",
34507     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34508     "version": "0.0.0",
34509     "filename": "server/api/whatsappMessage/index.js",
34510     "groupTitle": "Whatsapp_Accounts"
34511   },
34512   {
34513     "type": "post",
34514     "url": "/api/whatsapp/accounts/{id}/canned_answers",
34515     "title": "Creates new canned answer",
34516     "examples": [
34517       {
34518         "title": "Example usage:",
34519         "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",
34520         "type": "json"
34521       }
34522     ],
34523     "name": "addAnswer",
34524     "group": "Whatsapp_Accounts",
34525     "parameter": {
34526       "fields": {
34527         "Body": [
34528           {
34529             "group": "Body",
34530             "type": "String",
34531             "optional": false,
34532             "field": "key",
34533             "description": ""
34534           },
34535           {
34536             "group": "Body",
34537             "type": "Text",
34538             "optional": false,
34539             "field": "value",
34540             "description": ""
34541           },
34542           {
34543             "group": "Body",
34544             "type": "String",
34545             "optional": true,
34546             "field": "description",
34547             "description": ""
34548           },
34549           {
34550             "group": "Body",
34551             "type": "Virtual",
34552             "optional": true,
34553             "field": "name",
34554             "description": ""
34555           }
34556         ]
34557       }
34558     },
34559     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34560     "version": "0.0.0",
34561     "filename": "server/api/whatsappAccount/index.js",
34562     "groupTitle": "Whatsapp_Accounts"
34563   },
34564   {
34565     "type": "post",
34566     "url": "/api/whatsapp/accounts/{id}/applications",
34567     "title": "Creates new applications",
34568     "examples": [
34569       {
34570         "title": "Example usage:",
34571         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
34572         "type": "json"
34573       }
34574     ],
34575     "name": "addApplications",
34576     "group": "Whatsapp_Accounts",
34577     "parameter": {
34578       "fields": {
34579         "Body": [
34580           {
34581             "group": "Body",
34582             "type": "Integer",
34583             "optional": false,
34584             "field": "priority",
34585             "description": ""
34586           },
34587           {
34588             "group": "Body",
34589             "type": "String",
34590             "optional": false,
34591             "field": "app",
34592             "description": ""
34593           },
34594           {
34595             "group": "Body",
34596             "type": "Text",
34597             "optional": true,
34598             "field": "appdata",
34599             "description": ""
34600           },
34601           {
34602             "group": "Body",
34603             "type": "String",
34604             "optional": true,
34605             "field": "description",
34606             "description": ""
34607           },
34608           {
34609             "group": "Body",
34610             "type": "String",
34611             "optional": true,
34612             "field": "interval",
34613             "description": ""
34614           }
34615         ]
34616       }
34617     },
34618     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34619     "version": "0.0.0",
34620     "filename": "server/api/whatsappAccount/index.js",
34621     "groupTitle": "Whatsapp_Accounts"
34622   },
34623   {
34624     "type": "post",
34625     "url": "/api/whatsapp/accounts/{id}/dispositions",
34626     "title": "Creates new disposition",
34627     "examples": [
34628       {
34629         "title": "Example usage:",
34630         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
34631         "type": "json"
34632       }
34633     ],
34634     "name": "addDisposition",
34635     "group": "Whatsapp_Accounts",
34636     "parameter": {
34637       "fields": {
34638         "Body": [
34639           {
34640             "group": "Body",
34641             "type": "String",
34642             "optional": false,
34643             "field": "name",
34644             "description": ""
34645           },
34646           {
34647             "group": "Body",
34648             "type": "String",
34649             "allowedValues": [
34650               "\"first\"",
34651               "\"second\"",
34652               "\"third\""
34653             ],
34654             "optional": false,
34655             "field": "level",
34656             "description": ""
34657           },
34658           {
34659             "group": "Body",
34660             "type": "String",
34661             "optional": true,
34662             "field": "description",
34663             "description": ""
34664           }
34665         ]
34666       }
34667     },
34668     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34669     "version": "0.0.0",
34670     "filename": "server/api/whatsappAccount/index.js",
34671     "groupTitle": "Whatsapp_Accounts"
34672   },
34673   {
34674     "type": "get",
34675     "url": "/api/whatsapp/accounts/{id}/canned_answers",
34676     "title": "Gets account canned answers",
34677     "examples": [
34678       {
34679         "title": "Example usage:",
34680         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
34681         "type": "json"
34682       }
34683     ],
34684     "name": "getAnswers",
34685     "group": "Whatsapp_Accounts",
34686     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34687     "version": "0.0.0",
34688     "filename": "server/api/whatsappAccount/index.js",
34689     "groupTitle": "Whatsapp_Accounts"
34690   },
34691   {
34692     "type": "get",
34693     "url": "/api/whatsapp/accounts/{id}/applications",
34694     "title": "Gets account applications",
34695     "examples": [
34696       {
34697         "title": "Example usage:",
34698         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -v -u {name}:{password} -X GET",
34699         "type": "json"
34700       }
34701     ],
34702     "name": "getApplications",
34703     "group": "Whatsapp_Accounts",
34704     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34705     "version": "0.0.0",
34706     "filename": "server/api/whatsappAccount/index.js",
34707     "groupTitle": "Whatsapp_Accounts"
34708   },
34709   {
34710     "type": "get",
34711     "url": "/api/whatsapp/accounts/{id}/dispositions",
34712     "title": "Gets account dispositions",
34713     "examples": [
34714       {
34715         "title": "Example usage:",
34716         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
34717         "type": "json"
34718       }
34719     ],
34720     "name": "getDispositions",
34721     "group": "Whatsapp_Accounts",
34722     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34723     "version": "0.0.0",
34724     "filename": "server/api/whatsappAccount/index.js",
34725     "groupTitle": "Whatsapp_Accounts"
34726   },
34727   {
34728     "type": "post",
34729     "url": "/api/whatsapp/accounts/{id}/notify",
34730     "title": "Notify new message",
34731     "examples": [
34732       {
34733         "title": "Example usage:",
34734         "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",
34735         "type": "json"
34736       }
34737     ],
34738     "name": "notify",
34739     "group": "Whatsapp_Accounts",
34740     "description": "<p>Motion 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>",
34741     "version": "0.0.0",
34742     "filename": "server/api/whatsappAccount/index.js",
34743     "groupTitle": "Whatsapp_Accounts"
34744   },
34745   {
34746     "type": "put",
34747     "url": "/api/whatsapp/messages/{id}/reject",
34748     "title": "Rejects message",
34749     "examples": [
34750       {
34751         "title": "Example usage:",
34752         "content": "curl https://{domain}/api/whatsapp/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
34753         "type": "json"
34754       }
34755     ],
34756     "name": "rejectMessage",
34757     "group": "Whatsapp_Accounts",
34758     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34759     "version": "0.0.0",
34760     "filename": "server/api/whatsappMessage/index.js",
34761     "groupTitle": "Whatsapp_Accounts"
34762   },
34763   {
34764     "type": "post",
34765     "url": "/api/whatsapp/accounts/{id}/send",
34766     "title": "Send new whatsapp message",
34767     "examples": [
34768       {
34769         "title": "Example usage:",
34770         "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",
34771         "type": "json"
34772       }
34773     ],
34774     "name": "sendWhatsapp",
34775     "group": "Whatsapp_Accounts",
34776     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34777     "version": "0.0.0",
34778     "filename": "server/api/whatsappAccount/index.js",
34779     "groupTitle": "Whatsapp_Accounts"
34780   },
34781   {
34782     "type": "post",
34783     "url": "/api/whatsapp/messages/{id}/status",
34784     "title": "Receive message status",
34785     "examples": [
34786       {
34787         "title": "Example usage:",
34788         "content": "curl https://{domain}/api/whatsapp/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
34789         "type": "json"
34790       }
34791     ],
34792     "name": "statusMessage",
34793     "group": "Whatsapp_Accounts",
34794     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34795     "version": "0.0.0",
34796     "filename": "server/api/whatsappMessage/index.js",
34797     "groupTitle": "Whatsapp_Accounts"
34798   },
34799   {
34800     "type": "put",
34801     "url": "/api/whatsapp/accounts/{id}",
34802     "title": "Update an existing Account",
34803     "examples": [
34804       {
34805         "title": "Example usage:",
34806         "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",
34807         "type": "json"
34808       }
34809     ],
34810     "name": "updateAccounts",
34811     "group": "Whatsapp_Accounts",
34812     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34813     "version": "0.0.0",
34814     "filename": "server/api/whatsappAccount/index.js",
34815     "groupTitle": "Whatsapp_Accounts"
34816   },
34817   {
34818     "type": "post",
34819     "url": "/api/whatsapp/applications",
34820     "title": "Creates a new Application",
34821     "examples": [
34822       {
34823         "title": "Example usage:",
34824         "content": "curl https://{domain}/api/whatsapp/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
34825         "type": "json"
34826       }
34827     ],
34828     "name": "CreateApplications",
34829     "group": "Whatsapp_Applications",
34830     "parameter": {
34831       "fields": {
34832         "Body": [
34833           {
34834             "group": "Body",
34835             "type": "Integer",
34836             "optional": false,
34837             "field": "priority",
34838             "description": ""
34839           },
34840           {
34841             "group": "Body",
34842             "type": "String",
34843             "optional": false,
34844             "field": "app",
34845             "description": ""
34846           },
34847           {
34848             "group": "Body",
34849             "type": "Text",
34850             "optional": true,
34851             "field": "appdata",
34852             "description": ""
34853           },
34854           {
34855             "group": "Body",
34856             "type": "String",
34857             "optional": true,
34858             "field": "description",
34859             "description": ""
34860           },
34861           {
34862             "group": "Body",
34863             "type": "String",
34864             "optional": true,
34865             "field": "interval",
34866             "description": ""
34867           }
34868         ]
34869       }
34870     },
34871     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34872     "version": "0.0.0",
34873     "filename": "server/api/whatsappApplication/index.js",
34874     "groupTitle": "Whatsapp_Applications"
34875   },
34876   {
34877     "type": "delete",
34878     "url": "/api/whatsapp/applications/{id}",
34879     "title": "Deletes a Application",
34880     "examples": [
34881       {
34882         "title": "Example usage:",
34883         "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password} -X DELETE",
34884         "type": "json"
34885       }
34886     ],
34887     "name": "DeleteApplications",
34888     "group": "Whatsapp_Applications",
34889     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34890     "version": "0.0.0",
34891     "filename": "server/api/whatsappApplication/index.js",
34892     "groupTitle": "Whatsapp_Applications"
34893   },
34894   {
34895     "type": "get",
34896     "url": "/api/whatsapp/applications",
34897     "title": "Gets a list of Applications",
34898     "examples": [
34899       {
34900         "title": "Example usage:",
34901         "content": "curl https://{domain}/api/whatsapp/applications -v -u {name}:{password}",
34902         "type": "json"
34903       }
34904     ],
34905     "name": "GetApplications",
34906     "group": "Whatsapp_Applications",
34907     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34908     "version": "0.0.0",
34909     "filename": "server/api/whatsappApplication/index.js",
34910     "groupTitle": "Whatsapp_Applications"
34911   },
34912   {
34913     "type": "get",
34914     "url": "/api/whatsapp/applications/{id}",
34915     "title": "Gets a single Application",
34916     "examples": [
34917       {
34918         "title": "Example usage:",
34919         "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password}",
34920         "type": "json"
34921       }
34922     ],
34923     "name": "ShowApplications",
34924     "group": "Whatsapp_Applications",
34925     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34926     "version": "0.0.0",
34927     "filename": "server/api/whatsappApplication/index.js",
34928     "groupTitle": "Whatsapp_Applications"
34929   },
34930   {
34931     "type": "put",
34932     "url": "/api/whatsapp/applications/{id}",
34933     "title": "Update an existing Application",
34934     "examples": [
34935       {
34936         "title": "Example usage:",
34937         "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",
34938         "type": "json"
34939       }
34940     ],
34941     "name": "updateApplications",
34942     "group": "Whatsapp_Applications",
34943     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34944     "version": "0.0.0",
34945     "filename": "server/api/whatsappApplication/index.js",
34946     "groupTitle": "Whatsapp_Applications"
34947   },
34948   {
34949     "type": "post",
34950     "url": "/api/whatsapp/interactions/{id}/tags",
34951     "title": "Add tags to the interaction",
34952     "examples": [
34953       {
34954         "title": "Example usage:",
34955         "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",
34956         "type": "json"
34957       }
34958     ],
34959     "name": "AddTags",
34960     "group": "Whatsapp_Interactions",
34961     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34962     "version": "0.0.0",
34963     "filename": "server/api/whatsappInteraction/index.js",
34964     "groupTitle": "Whatsapp_Interactions"
34965   },
34966   {
34967     "type": "post",
34968     "url": "/api/whatsapp/interactions",
34969     "title": "Creates a new Interaction",
34970     "examples": [
34971       {
34972         "title": "Example usage:",
34973         "content": "curl https://{domain}/api/whatsapp/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
34974         "type": "json"
34975       }
34976     ],
34977     "name": "CreateInteractions",
34978     "group": "Whatsapp_Interactions",
34979     "parameter": {
34980       "fields": {
34981         "Body": [
34982           {
34983             "group": "Body",
34984             "type": "Boolean",
34985             "optional": true,
34986             "field": "closed",
34987             "description": ""
34988           },
34989           {
34990             "group": "Body",
34991             "type": "String",
34992             "optional": true,
34993             "field": "closedAt",
34994             "description": ""
34995           },
34996           {
34997             "group": "Body",
34998             "type": "String",
34999             "optional": true,
35000             "field": "disposition",
35001             "description": ""
35002           },
35003           {
35004             "group": "Body",
35005             "type": "String",
35006             "optional": true,
35007             "field": "secondDisposition",
35008             "description": ""
35009           },
35010           {
35011             "group": "Body",
35012             "type": "String",
35013             "optional": true,
35014             "field": "thirdDisposition",
35015             "description": ""
35016           },
35017           {
35018             "group": "Body",
35019             "type": "String",
35020             "optional": true,
35021             "field": "note",
35022             "description": ""
35023           },
35024           {
35025             "group": "Body",
35026             "type": "String",
35027             "optional": true,
35028             "field": "phone",
35029             "description": ""
35030           },
35031           {
35032             "group": "Body",
35033             "type": "String",
35034             "optional": true,
35035             "field": "read1stAt",
35036             "description": ""
35037           },
35038           {
35039             "group": "Body",
35040             "type": "String",
35041             "allowedValues": [
35042               "\"in\"",
35043               "\"out\""
35044             ],
35045             "optional": false,
35046             "field": "firstMsgDirection",
35047             "description": ""
35048           },
35049           {
35050             "group": "Body",
35051             "type": "String",
35052             "optional": true,
35053             "field": "lastMsgAt",
35054             "description": ""
35055           },
35056           {
35057             "group": "Body",
35058             "type": "String",
35059             "allowedValues": [
35060               "\"in\"",
35061               "\"out\""
35062             ],
35063             "optional": false,
35064             "field": "lastMsgDirection",
35065             "description": ""
35066           }
35067         ]
35068       }
35069     },
35070     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35071     "version": "0.0.0",
35072     "filename": "server/api/whatsappInteraction/index.js",
35073     "groupTitle": "Whatsapp_Interactions"
35074   },
35075   {
35076     "type": "delete",
35077     "url": "/api/whatsapp/interactions/{id}",
35078     "title": "Deletes a Interaction",
35079     "examples": [
35080       {
35081         "title": "Example usage:",
35082         "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password} -X DELETE",
35083         "type": "json"
35084       }
35085     ],
35086     "name": "DeleteInteractions",
35087     "group": "Whatsapp_Interactions",
35088     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35089     "version": "0.0.0",
35090     "filename": "server/api/whatsappInteraction/index.js",
35091     "groupTitle": "Whatsapp_Interactions"
35092   },
35093   {
35094     "type": "get",
35095     "url": "/api/whatsapp/interactions/describe",
35096     "title": "Gets table info about Interactions",
35097     "examples": [
35098       {
35099         "title": "Example usage:",
35100         "content": "curl https://{domain}/api/whatsapp/interactions/describe -v -u {name}:{password}",
35101         "type": "json"
35102       }
35103     ],
35104     "name": "DescribeInteractions",
35105     "group": "Whatsapp_Interactions",
35106     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35107     "version": "0.0.0",
35108     "filename": "server/api/whatsappInteraction/index.js",
35109     "groupTitle": "Whatsapp_Interactions"
35110   },
35111   {
35112     "type": "get",
35113     "url": "/api/whatsapp/interactions",
35114     "title": "Gets a list of Interactions",
35115     "examples": [
35116       {
35117         "title": "Example usage:",
35118         "content": "curl https://{domain}/api/whatsapp/interactions -v -u {name}:{password}",
35119         "type": "json"
35120       }
35121     ],
35122     "name": "GetInteractions",
35123     "group": "Whatsapp_Interactions",
35124     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35125     "version": "0.0.0",
35126     "filename": "server/api/whatsappInteraction/index.js",
35127     "groupTitle": "Whatsapp_Interactions"
35128   },
35129   {
35130     "type": "delete",
35131     "url": "/api/whatsapp/interactions/{id}/tags",
35132     "title": "Removes tags from interaction",
35133     "examples": [
35134       {
35135         "title": "Example usage:",
35136         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
35137         "type": "json"
35138       }
35139     ],
35140     "name": "RemoveTags",
35141     "group": "Whatsapp_Interactions",
35142     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35143     "version": "0.0.0",
35144     "filename": "server/api/whatsappInteraction/index.js",
35145     "groupTitle": "Whatsapp_Interactions"
35146   },
35147   {
35148     "type": "get",
35149     "url": "/api/whatsapp/interactions/{id}",
35150     "title": "Gets a single Interaction",
35151     "examples": [
35152       {
35153         "title": "Example usage:",
35154         "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password}",
35155         "type": "json"
35156       }
35157     ],
35158     "name": "ShowInteractions",
35159     "group": "Whatsapp_Interactions",
35160     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35161     "version": "0.0.0",
35162     "filename": "server/api/whatsappInteraction/index.js",
35163     "groupTitle": "Whatsapp_Interactions"
35164   },
35165   {
35166     "type": "post",
35167     "url": "/api/whatsapp/interactions/{id}/messages",
35168     "title": "Creates new messages",
35169     "examples": [
35170       {
35171         "title": "Example usage:",
35172         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35173         "type": "json"
35174       }
35175     ],
35176     "name": "addMessage",
35177     "group": "Whatsapp_Interactions",
35178     "parameter": {
35179       "fields": {
35180         "Body": [
35181           {
35182             "group": "Body",
35183             "type": "Text",
35184             "optional": false,
35185             "field": "body",
35186             "description": ""
35187           },
35188           {
35189             "group": "Body",
35190             "type": "Boolean",
35191             "optional": true,
35192             "field": "read",
35193             "description": ""
35194           },
35195           {
35196             "group": "Body",
35197             "type": "String",
35198             "allowedValues": [
35199               "\"in\"",
35200               "\"out\""
35201             ],
35202             "optional": false,
35203             "field": "direction",
35204             "description": ""
35205           },
35206           {
35207             "group": "Body",
35208             "type": "String",
35209             "optional": true,
35210             "field": "messageId",
35211             "description": ""
35212           },
35213           {
35214             "group": "Body",
35215             "type": "String",
35216             "optional": true,
35217             "field": "phone",
35218             "description": ""
35219           },
35220           {
35221             "group": "Body",
35222             "type": "String",
35223             "optional": true,
35224             "field": "readAt",
35225             "description": ""
35226           },
35227           {
35228             "group": "Body",
35229             "type": "Boolean",
35230             "optional": true,
35231             "field": "secret",
35232             "description": ""
35233           },
35234           {
35235             "group": "Body",
35236             "type": "String",
35237             "optional": true,
35238             "field": "providerName",
35239             "description": ""
35240           },
35241           {
35242             "group": "Body",
35243             "type": "Text",
35244             "optional": true,
35245             "field": "providerResponse",
35246             "description": ""
35247           }
35248         ]
35249       }
35250     },
35251     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35252     "version": "0.0.0",
35253     "filename": "server/api/whatsappInteraction/index.js",
35254     "groupTitle": "Whatsapp_Interactions"
35255   },
35256   {
35257     "type": "get",
35258     "url": "/api/whatsapp/interactions/{id}/download",
35259     "title": "Gets interaction",
35260     "examples": [
35261       {
35262         "title": "Example usage:",
35263         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/download -v -u {name}:{password} -X GET",
35264         "type": "json"
35265       }
35266     ],
35267     "name": "download",
35268     "group": "Whatsapp_Interactions",
35269     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35270     "version": "0.0.0",
35271     "filename": "server/api/whatsappInteraction/index.js",
35272     "groupTitle": "Whatsapp_Interactions"
35273   },
35274   {
35275     "type": "get",
35276     "url": "/api/whatsapp/interactions/{id}/messages",
35277     "title": "Gets interaction messages",
35278     "examples": [
35279       {
35280         "title": "Example usage:",
35281         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -v -u {name}:{password} -X GET",
35282         "type": "json"
35283       }
35284     ],
35285     "name": "getMessages",
35286     "group": "Whatsapp_Interactions",
35287     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35288     "version": "0.0.0",
35289     "filename": "server/api/whatsappInteraction/index.js",
35290     "groupTitle": "Whatsapp_Interactions"
35291   },
35292   {
35293     "type": "put",
35294     "url": "/api/whatsapp/interactions/{id}",
35295     "title": "Update an existing Interaction",
35296     "examples": [
35297       {
35298         "title": "Example usage:",
35299         "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",
35300         "type": "json"
35301       }
35302     ],
35303     "name": "updateInteractions",
35304     "group": "Whatsapp_Interactions",
35305     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35306     "version": "0.0.0",
35307     "filename": "server/api/whatsappInteraction/index.js",
35308     "groupTitle": "Whatsapp_Interactions"
35309   },
35310   {
35311     "type": "post",
35312     "url": "/api/whatsapp/messages",
35313     "title": "Creates a new Message",
35314     "examples": [
35315       {
35316         "title": "Example usage:",
35317         "content": "curl https://{domain}/api/whatsapp/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35318         "type": "json"
35319       }
35320     ],
35321     "name": "CreateMessages",
35322     "group": "Whatsapp_Messages",
35323     "parameter": {
35324       "fields": {
35325         "Body": [
35326           {
35327             "group": "Body",
35328             "type": "Text",
35329             "optional": false,
35330             "field": "body",
35331             "description": ""
35332           },
35333           {
35334             "group": "Body",
35335             "type": "Boolean",
35336             "optional": true,
35337             "field": "read",
35338             "description": ""
35339           },
35340           {
35341             "group": "Body",
35342             "type": "String",
35343             "allowedValues": [
35344               "\"in\"",
35345               "\"out\""
35346             ],
35347             "optional": false,
35348             "field": "direction",
35349             "description": ""
35350           },
35351           {
35352             "group": "Body",
35353             "type": "String",
35354             "optional": true,
35355             "field": "messageId",
35356             "description": ""
35357           },
35358           {
35359             "group": "Body",
35360             "type": "String",
35361             "optional": true,
35362             "field": "phone",
35363             "description": ""
35364           },
35365           {
35366             "group": "Body",
35367             "type": "String",
35368             "optional": true,
35369             "field": "readAt",
35370             "description": ""
35371           },
35372           {
35373             "group": "Body",
35374             "type": "Boolean",
35375             "optional": true,
35376             "field": "secret",
35377             "description": ""
35378           },
35379           {
35380             "group": "Body",
35381             "type": "String",
35382             "optional": true,
35383             "field": "providerName",
35384             "description": ""
35385           },
35386           {
35387             "group": "Body",
35388             "type": "Text",
35389             "optional": true,
35390             "field": "providerResponse",
35391             "description": ""
35392           }
35393         ]
35394       }
35395     },
35396     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35397     "version": "0.0.0",
35398     "filename": "server/api/whatsappMessage/index.js",
35399     "groupTitle": "Whatsapp_Messages"
35400   },
35401   {
35402     "type": "delete",
35403     "url": "/api/whatsapp/messages/{id}",
35404     "title": "Deletes a Message",
35405     "examples": [
35406       {
35407         "title": "Example usage:",
35408         "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password} -X DELETE",
35409         "type": "json"
35410       }
35411     ],
35412     "name": "DeleteMessages",
35413     "group": "Whatsapp_Messages",
35414     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35415     "version": "0.0.0",
35416     "filename": "server/api/whatsappMessage/index.js",
35417     "groupTitle": "Whatsapp_Messages"
35418   },
35419   {
35420     "type": "get",
35421     "url": "/api/whatsapp/messages/describe",
35422     "title": "Gets table info about Messages",
35423     "examples": [
35424       {
35425         "title": "Example usage:",
35426         "content": "curl https://{domain}/api/whatsapp/messages/describe -v -u {name}:{password}",
35427         "type": "json"
35428       }
35429     ],
35430     "name": "DescribeMessages",
35431     "group": "Whatsapp_Messages",
35432     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35433     "version": "0.0.0",
35434     "filename": "server/api/whatsappMessage/index.js",
35435     "groupTitle": "Whatsapp_Messages"
35436   },
35437   {
35438     "type": "get",
35439     "url": "/api/whatsapp/messages",
35440     "title": "Gets a list of Messages",
35441     "examples": [
35442       {
35443         "title": "Example usage:",
35444         "content": "curl https://{domain}/api/whatsapp/messages -v -u {name}:{password}",
35445         "type": "json"
35446       }
35447     ],
35448     "name": "GetMessages",
35449     "group": "Whatsapp_Messages",
35450     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35451     "version": "0.0.0",
35452     "filename": "server/api/whatsappMessage/index.js",
35453     "groupTitle": "Whatsapp_Messages"
35454   },
35455   {
35456     "type": "get",
35457     "url": "/api/whatsapp/messages/{id}",
35458     "title": "Gets a single Message",
35459     "examples": [
35460       {
35461         "title": "Example usage:",
35462         "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password}",
35463         "type": "json"
35464       }
35465     ],
35466     "name": "ShowMessages",
35467     "group": "Whatsapp_Messages",
35468     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35469     "version": "0.0.0",
35470     "filename": "server/api/whatsappMessage/index.js",
35471     "groupTitle": "Whatsapp_Messages"
35472   },
35473   {
35474     "type": "put",
35475     "url": "/api/whatsapp/messages/{id}",
35476     "title": "Update an existing Message",
35477     "examples": [
35478       {
35479         "title": "Example usage:",
35480         "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",
35481         "type": "json"
35482       }
35483     ],
35484     "name": "updateMessages",
35485     "group": "Whatsapp_Messages",
35486     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35487     "version": "0.0.0",
35488     "filename": "server/api/whatsappMessage/index.js",
35489     "groupTitle": "Whatsapp_Messages"
35490   },
35491   {
35492     "type": "post",
35493     "url": "/api/whatsapp/reports/queue",
35494     "title": "Creates a new Whatsapp Queue Report",
35495     "examples": [
35496       {
35497         "title": "Example usage:",
35498         "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",
35499         "type": "json"
35500       }
35501     ],
35502     "name": "CreateWhatsapp_Queue_Reports",
35503     "group": "Whatsapp_Queue_Reports",
35504     "parameter": {
35505       "fields": {
35506         "Body": [
35507           {
35508             "group": "Body",
35509             "type": "String",
35510             "optional": false,
35511             "field": "uniqueid",
35512             "description": ""
35513           },
35514           {
35515             "group": "Body",
35516             "type": "String",
35517             "optional": true,
35518             "field": "from",
35519             "description": ""
35520           },
35521           {
35522             "group": "Body",
35523             "type": "String",
35524             "optional": true,
35525             "field": "joinAt",
35526             "description": ""
35527           },
35528           {
35529             "group": "Body",
35530             "type": "String",
35531             "optional": true,
35532             "field": "leaveAt",
35533             "description": ""
35534           },
35535           {
35536             "group": "Body",
35537             "type": "String",
35538             "optional": true,
35539             "field": "acceptAt",
35540             "description": ""
35541           },
35542           {
35543             "group": "Body",
35544             "type": "String",
35545             "optional": true,
35546             "field": "exitAt",
35547             "description": ""
35548           },
35549           {
35550             "group": "Body",
35551             "type": "String",
35552             "optional": true,
35553             "field": "reason",
35554             "description": ""
35555           }
35556         ]
35557       }
35558     },
35559     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35560     "version": "0.0.0",
35561     "filename": "server/api/whatsappQueueReport/index.js",
35562     "groupTitle": "Whatsapp_Queue_Reports"
35563   },
35564   {
35565     "type": "delete",
35566     "url": "/api/whatsapp/reports/queue/{id}",
35567     "title": "Deletes a Whatsapp Queue Report",
35568     "examples": [
35569       {
35570         "title": "Example usage:",
35571         "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password} -X DELETE",
35572         "type": "json"
35573       }
35574     ],
35575     "name": "DeleteWhatsapp_Queue_Reports",
35576     "group": "Whatsapp_Queue_Reports",
35577     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35578     "version": "0.0.0",
35579     "filename": "server/api/whatsappQueueReport/index.js",
35580     "groupTitle": "Whatsapp_Queue_Reports"
35581   },
35582   {
35583     "type": "get",
35584     "url": "/api/whatsapp/reports/queue/describe",
35585     "title": "Gets table info about Whatsapp Queue Reports",
35586     "examples": [
35587       {
35588         "title": "Example usage:",
35589         "content": "curl https://{domain}/api/whatsapp/reports/queue/describe -v -u {name}:{password}",
35590         "type": "json"
35591       }
35592     ],
35593     "name": "DescribeWhatsapp_Queue_Reports",
35594     "group": "Whatsapp_Queue_Reports",
35595     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35596     "version": "0.0.0",
35597     "filename": "server/api/whatsappQueueReport/index.js",
35598     "groupTitle": "Whatsapp_Queue_Reports"
35599   },
35600   {
35601     "type": "get",
35602     "url": "/api/whatsapp/reports/queue",
35603     "title": "Gets a list of Whatsapp Queue Reports",
35604     "examples": [
35605       {
35606         "title": "Example usage:",
35607         "content": "curl https://{domain}/api/whatsapp/reports/queue -v -u {name}:{password}",
35608         "type": "json"
35609       }
35610     ],
35611     "name": "GetWhatsapp_Queue_Reports",
35612     "group": "Whatsapp_Queue_Reports",
35613     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35614     "version": "0.0.0",
35615     "filename": "server/api/whatsappQueueReport/index.js",
35616     "groupTitle": "Whatsapp_Queue_Reports"
35617   },
35618   {
35619     "type": "get",
35620     "url": "/api/whatsapp/reports/queue/{id}",
35621     "title": "Gets a single Whatsapp Queue Report",
35622     "examples": [
35623       {
35624         "title": "Example usage:",
35625         "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password}",
35626         "type": "json"
35627       }
35628     ],
35629     "name": "ShowWhatsapp_Queue_Reports",
35630     "group": "Whatsapp_Queue_Reports",
35631     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35632     "version": "0.0.0",
35633     "filename": "server/api/whatsappQueueReport/index.js",
35634     "groupTitle": "Whatsapp_Queue_Reports"
35635   },
35636   {
35637     "type": "put",
35638     "url": "/api/whatsapp/reports/queue/{id}",
35639     "title": "Update an existing Whatsapp Queue Report",
35640     "examples": [
35641       {
35642         "title": "Example usage:",
35643         "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",
35644         "type": "json"
35645       }
35646     ],
35647     "name": "updateWhatsapp_Queue_Reports",
35648     "group": "Whatsapp_Queue_Reports",
35649     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35650     "version": "0.0.0",
35651     "filename": "server/api/whatsappQueueReport/index.js",
35652     "groupTitle": "Whatsapp_Queue_Reports"
35653   },
35654   {
35655     "type": "post",
35656     "url": "/api/whatsapp/queues/{id}/users",
35657     "title": "Add agents to a queue",
35658     "examples": [
35659       {
35660         "title": "Example usage:",
35661         "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",
35662         "type": "json"
35663       }
35664     ],
35665     "name": "AddAgents",
35666     "group": "Whatsapp_Queues",
35667     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35668     "version": "0.0.0",
35669     "filename": "server/api/whatsappQueue/index.js",
35670     "groupTitle": "Whatsapp_Queues"
35671   },
35672   {
35673     "type": "post",
35674     "url": "/api/whatsapp/queues/{id}/teams",
35675     "title": "Add teams to a queue",
35676     "examples": [
35677       {
35678         "title": "Example usage:",
35679         "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",
35680         "type": "json"
35681       }
35682     ],
35683     "name": "AddTeams",
35684     "group": "Whatsapp_Queues",
35685     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35686     "version": "0.0.0",
35687     "filename": "server/api/whatsappQueue/index.js",
35688     "groupTitle": "Whatsapp_Queues"
35689   },
35690   {
35691     "type": "post",
35692     "url": "/api/whatsapp/queues",
35693     "title": "Creates a new Queue",
35694     "examples": [
35695       {
35696         "title": "Example usage:",
35697         "content": "curl https://{domain}/api/whatsapp/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35698         "type": "json"
35699       }
35700     ],
35701     "name": "CreateQueues",
35702     "group": "Whatsapp_Queues",
35703     "parameter": {
35704       "fields": {
35705         "Body": [
35706           {
35707             "group": "Body",
35708             "type": "String",
35709             "optional": true,
35710             "field": "name",
35711             "description": ""
35712           },
35713           {
35714             "group": "Body",
35715             "type": "Integer",
35716             "optional": true,
35717             "field": "timeout",
35718             "description": ""
35719           },
35720           {
35721             "group": "Body",
35722             "type": "String",
35723             "allowedValues": [
35724               "\"rrmemory\"",
35725               "\"beepall\"",
35726               "\"roundrobin\""
35727             ],
35728             "optional": true,
35729             "field": "strategy",
35730             "description": ""
35731           },
35732           {
35733             "group": "Body",
35734             "type": "String",
35735             "optional": true,
35736             "field": "description",
35737             "description": ""
35738           }
35739         ]
35740       }
35741     },
35742     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35743     "version": "0.0.0",
35744     "filename": "server/api/whatsappQueue/index.js",
35745     "groupTitle": "Whatsapp_Queues"
35746   },
35747   {
35748     "type": "delete",
35749     "url": "/api/whatsapp/queues/{id}",
35750     "title": "Deletes a Queue",
35751     "examples": [
35752       {
35753         "title": "Example usage:",
35754         "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password} -X DELETE",
35755         "type": "json"
35756       }
35757     ],
35758     "name": "DeleteQueues",
35759     "group": "Whatsapp_Queues",
35760     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35761     "version": "0.0.0",
35762     "filename": "server/api/whatsappQueue/index.js",
35763     "groupTitle": "Whatsapp_Queues"
35764   },
35765   {
35766     "type": "get",
35767     "url": "/api/whatsapp/queues/describe",
35768     "title": "Gets table info about Queues",
35769     "examples": [
35770       {
35771         "title": "Example usage:",
35772         "content": "curl https://{domain}/api/whatsapp/queues/describe -v -u {name}:{password}",
35773         "type": "json"
35774       }
35775     ],
35776     "name": "DescribeQueues",
35777     "group": "Whatsapp_Queues",
35778     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35779     "version": "0.0.0",
35780     "filename": "server/api/whatsappQueue/index.js",
35781     "groupTitle": "Whatsapp_Queues"
35782   },
35783   {
35784     "type": "get",
35785     "url": "/api/whatsapp/queues/{id}/users",
35786     "title": "Gets queue agents",
35787     "examples": [
35788       {
35789         "title": "Example usage:",
35790         "content": "curl https://{domain}/api/whatsapp/queues/{id}/users -v -u {name}:{password} -X POST",
35791         "type": "json"
35792       }
35793     ],
35794     "name": "GetAgents",
35795     "group": "Whatsapp_Queues",
35796     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35797     "version": "0.0.0",
35798     "filename": "server/api/whatsappQueue/index.js",
35799     "groupTitle": "Whatsapp_Queues"
35800   },
35801   {
35802     "type": "get",
35803     "url": "/api/whatsapp/queues/{id}/members",
35804     "title": "GetMembers",
35805     "examples": [
35806       {
35807         "title": "Example usage:",
35808         "content": "curl https://{domain}/api/whatsapp/queues/{id}/members  -v -u {name}:{password}",
35809         "type": "json"
35810       }
35811     ],
35812     "name": "GetMembers",
35813     "group": "Whatsapp_Queues",
35814     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35815     "version": "0.0.0",
35816     "filename": "server/api/whatsappQueue/index.js",
35817     "groupTitle": "Whatsapp_Queues"
35818   },
35819   {
35820     "type": "get",
35821     "url": "/api/whatsapp/queues",
35822     "title": "Gets a list of Queues",
35823     "examples": [
35824       {
35825         "title": "Example usage:",
35826         "content": "curl https://{domain}/api/whatsapp/queues -v -u {name}:{password}",
35827         "type": "json"
35828       }
35829     ],
35830     "name": "GetQueues",
35831     "group": "Whatsapp_Queues",
35832     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35833     "version": "0.0.0",
35834     "filename": "server/api/whatsappQueue/index.js",
35835     "groupTitle": "Whatsapp_Queues"
35836   },
35837   {
35838     "type": "get",
35839     "url": "/api/whatsapp/queues/{id}/teams",
35840     "title": "Gets queues list",
35841     "examples": [
35842       {
35843         "title": "Example usage:",
35844         "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password}",
35845         "type": "json"
35846       }
35847     ],
35848     "name": "GetTeams",
35849     "group": "Whatsapp_Queues",
35850     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35851     "version": "0.0.0",
35852     "filename": "server/api/whatsappQueue/index.js",
35853     "groupTitle": "Whatsapp_Queues"
35854   },
35855   {
35856     "type": "delete",
35857     "url": "/api/whatsapp/queues/{id}/users",
35858     "title": "Removes agents from a queue",
35859     "examples": [
35860       {
35861         "title": "Example usage:",
35862         "content": "curl https://{domain}/api/whatsapp/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
35863         "type": "json"
35864       }
35865     ],
35866     "name": "RemoveAgents",
35867     "group": "Whatsapp_Queues",
35868     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35869     "version": "0.0.0",
35870     "filename": "server/api/whatsappQueue/index.js",
35871     "groupTitle": "Whatsapp_Queues"
35872   },
35873   {
35874     "type": "get",
35875     "url": "/api/whatsapp/queues/{id}",
35876     "title": "Gets a single Queue",
35877     "examples": [
35878       {
35879         "title": "Example usage:",
35880         "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password}",
35881         "type": "json"
35882       }
35883     ],
35884     "name": "ShowQueues",
35885     "group": "Whatsapp_Queues",
35886     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35887     "version": "0.0.0",
35888     "filename": "server/api/whatsappQueue/index.js",
35889     "groupTitle": "Whatsapp_Queues"
35890   },
35891   {
35892     "type": "put",
35893     "url": "/api/whatsapp/queues/{id}",
35894     "title": "Update an existing Queue",
35895     "examples": [
35896       {
35897         "title": "Example usage:",
35898         "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",
35899         "type": "json"
35900       }
35901     ],
35902     "name": "updateQueues",
35903     "group": "Whatsapp_Queues",
35904     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35905     "version": "0.0.0",
35906     "filename": "server/api/whatsappQueue/index.js",
35907     "groupTitle": "Whatsapp_Queues"
35908   },
35909   {
35910     "type": "post",
35911     "url": "/api/whatsapp/reports/transfer",
35912     "title": "Creates a new Whatsapp Transfer Report",
35913     "examples": [
35914       {
35915         "title": "Example usage:",
35916         "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",
35917         "type": "json"
35918       }
35919     ],
35920     "name": "CreateWhatsapp_Transfer_Reports",
35921     "group": "Whatsapp_Transfer_Reports",
35922     "parameter": {
35923       "fields": {
35924         "Body": [
35925           {
35926             "group": "Body",
35927             "type": "String",
35928             "optional": false,
35929             "field": "uniqueid",
35930             "description": ""
35931           },
35932           {
35933             "group": "Body",
35934             "type": "String",
35935             "allowedValues": [
35936               "\"account\"",
35937               "\"agent\"",
35938               "\"queue\""
35939             ],
35940             "optional": false,
35941             "field": "type",
35942             "description": ""
35943           },
35944           {
35945             "group": "Body",
35946             "type": "String",
35947             "optional": true,
35948             "field": "transferredAt",
35949             "description": ""
35950           }
35951         ]
35952       }
35953     },
35954     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35955     "version": "0.0.0",
35956     "filename": "server/api/whatsappTransferReport/index.js",
35957     "groupTitle": "Whatsapp_Transfer_Reports"
35958   },
35959   {
35960     "type": "delete",
35961     "url": "/api/whatsapp/reports/transfer/{id}",
35962     "title": "Deletes a Whatsapp Transfer Report",
35963     "examples": [
35964       {
35965         "title": "Example usage:",
35966         "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
35967         "type": "json"
35968       }
35969     ],
35970     "name": "DeleteWhatsapp_Transfer_Reports",
35971     "group": "Whatsapp_Transfer_Reports",
35972     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35973     "version": "0.0.0",
35974     "filename": "server/api/whatsappTransferReport/index.js",
35975     "groupTitle": "Whatsapp_Transfer_Reports"
35976   },
35977   {
35978     "type": "get",
35979     "url": "/api/whatsapp/reports/transfer/describe",
35980     "title": "Gets table info about Whatsapp Transfer Reports",
35981     "examples": [
35982       {
35983         "title": "Example usage:",
35984         "content": "curl https://{domain}/api/whatsapp/reports/transfer/describe -v -u {name}:{password}",
35985         "type": "json"
35986       }
35987     ],
35988     "name": "DescribeWhatsapp_Transfer_Reports",
35989     "group": "Whatsapp_Transfer_Reports",
35990     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35991     "version": "0.0.0",
35992     "filename": "server/api/whatsappTransferReport/index.js",
35993     "groupTitle": "Whatsapp_Transfer_Reports"
35994   },
35995   {
35996     "type": "get",
35997     "url": "/api/whatsapp/reports/transfer",
35998     "title": "Gets a list of Whatsapp Transfer Reports",
35999     "examples": [
36000       {
36001         "title": "Example usage:",
36002         "content": "curl https://{domain}/api/whatsapp/reports/transfer -v -u {name}:{password}",
36003         "type": "json"
36004       }
36005     ],
36006     "name": "GetWhatsapp_Transfer_Reports",
36007     "group": "Whatsapp_Transfer_Reports",
36008     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36009     "version": "0.0.0",
36010     "filename": "server/api/whatsappTransferReport/index.js",
36011     "groupTitle": "Whatsapp_Transfer_Reports"
36012   },
36013   {
36014     "type": "get",
36015     "url": "/api/whatsapp/reports/transfer/{id}",
36016     "title": "Gets a single Whatsapp Transfer Report",
36017     "examples": [
36018       {
36019         "title": "Example usage:",
36020         "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password}",
36021         "type": "json"
36022       }
36023     ],
36024     "name": "ShowWhatsapp_Transfer_Reports",
36025     "group": "Whatsapp_Transfer_Reports",
36026     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36027     "version": "0.0.0",
36028     "filename": "server/api/whatsappTransferReport/index.js",
36029     "groupTitle": "Whatsapp_Transfer_Reports"
36030   },
36031   {
36032     "type": "put",
36033     "url": "/api/whatsapp/reports/transfer/{id}",
36034     "title": "Update an existing Whatsapp Transfer Report",
36035     "examples": [
36036       {
36037         "title": "Example usage:",
36038         "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",
36039         "type": "json"
36040       }
36041     ],
36042     "name": "updateWhatsapp_Transfer_Reports",
36043     "group": "Whatsapp_Transfer_Reports",
36044     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36045     "version": "0.0.0",
36046     "filename": "server/api/whatsappTransferReport/index.js",
36047     "groupTitle": "Whatsapp_Transfer_Reports"
36048   },
36049   {
36050     "type": "post",
36051     "url": "/api/integrations/zendesk/accounts",
36052     "title": "Creates a new Zendesk Account",
36053     "examples": [
36054       {
36055         "title": "Example usage:",
36056         "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",
36057         "type": "json"
36058       }
36059     ],
36060     "name": "CreateZendesk_Accounts",
36061     "group": "Zendesk_Accounts",
36062     "parameter": {
36063       "fields": {
36064         "Body": [
36065           {
36066             "group": "Body",
36067             "type": "String",
36068             "optional": true,
36069             "field": "name",
36070             "description": ""
36071           },
36072           {
36073             "group": "Body",
36074             "type": "String",
36075             "optional": true,
36076             "field": "description",
36077             "description": ""
36078           },
36079           {
36080             "group": "Body",
36081             "type": "String",
36082             "optional": true,
36083             "field": "username",
36084             "description": ""
36085           },
36086           {
36087             "group": "Body",
36088             "type": "String",
36089             "optional": true,
36090             "field": "password",
36091             "description": ""
36092           },
36093           {
36094             "group": "Body",
36095             "type": "String",
36096             "optional": true,
36097             "field": "token",
36098             "description": ""
36099           },
36100           {
36101             "group": "Body",
36102             "type": "String",
36103             "optional": true,
36104             "field": "remoteUri",
36105             "description": ""
36106           },
36107           {
36108             "group": "Body",
36109             "type": "String",
36110             "allowedValues": [
36111               "\"password\"",
36112               "\"token\""
36113             ],
36114             "optional": true,
36115             "field": "authType",
36116             "description": ""
36117           },
36118           {
36119             "group": "Body",
36120             "type": "String",
36121             "optional": true,
36122             "field": "serverUrl",
36123             "description": ""
36124           },
36125           {
36126             "group": "Body",
36127             "type": "String",
36128             "allowedValues": [
36129               "\"integrationTab\"",
36130               "\"newTab\""
36131             ],
36132             "optional": true,
36133             "field": "type",
36134             "description": ""
36135           }
36136         ]
36137       }
36138     },
36139     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36140     "version": "0.0.0",
36141     "filename": "server/api/intZendeskAccount/index.js",
36142     "groupTitle": "Zendesk_Accounts"
36143   },
36144   {
36145     "type": "delete",
36146     "url": "/api/integrations/zendesk/accounts/{id}",
36147     "title": "Deletes a Zendesk Account",
36148     "examples": [
36149       {
36150         "title": "Example usage:",
36151         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password} -X DELETE",
36152         "type": "json"
36153       }
36154     ],
36155     "name": "DeleteZendesk_Accounts",
36156     "group": "Zendesk_Accounts",
36157     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36158     "version": "0.0.0",
36159     "filename": "server/api/intZendeskAccount/index.js",
36160     "groupTitle": "Zendesk_Accounts"
36161   },
36162   {
36163     "type": "get",
36164     "url": "/api/integrations/zendesk/accounts",
36165     "title": "Gets a list of Zendesk Accounts",
36166     "examples": [
36167       {
36168         "title": "Example usage:",
36169         "content": "curl https://{domain}/api/integrations/zendesk/accounts -v -u {name}:{password}",
36170         "type": "json"
36171       }
36172     ],
36173     "name": "GetZendesk_Accounts",
36174     "group": "Zendesk_Accounts",
36175     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36176     "version": "0.0.0",
36177     "filename": "server/api/intZendeskAccount/index.js",
36178     "groupTitle": "Zendesk_Accounts"
36179   },
36180   {
36181     "type": "get",
36182     "url": "/api/integrations/zendesk/accounts/{id}",
36183     "title": "Gets a single Zendesk Account",
36184     "examples": [
36185       {
36186         "title": "Example usage:",
36187         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password}",
36188         "type": "json"
36189       }
36190     ],
36191     "name": "ShowZendesk_Accounts",
36192     "group": "Zendesk_Accounts",
36193     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36194     "version": "0.0.0",
36195     "filename": "server/api/intZendeskAccount/index.js",
36196     "groupTitle": "Zendesk_Accounts"
36197   },
36198   {
36199     "type": "post",
36200     "url": "/api/integrations/zendesk/accounts/{id}/configurations",
36201     "title": "Creates new configuration",
36202     "examples": [
36203       {
36204         "title": "Example usage:",
36205         "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",
36206         "type": "json"
36207       }
36208     ],
36209     "name": "addConfiguration",
36210     "group": "Zendesk_Accounts",
36211     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36212     "version": "0.0.0",
36213     "filename": "server/api/intZendeskAccount/index.js",
36214     "groupTitle": "Zendesk_Accounts"
36215   },
36216   {
36217     "type": "get",
36218     "url": "/api/integrations/zendesk/accounts/{id}/configurations",
36219     "title": "Gets account configurations",
36220     "examples": [
36221       {
36222         "title": "Example usage:",
36223         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
36224         "type": "json"
36225       }
36226     ],
36227     "name": "getConfigurations",
36228     "group": "Zendesk_Accounts",
36229     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36230     "version": "0.0.0",
36231     "filename": "server/api/intZendeskAccount/index.js",
36232     "groupTitle": "Zendesk_Accounts"
36233   },
36234   {
36235     "type": "get",
36236     "url": "/api/integrations/zendesk/accounts/{id}/fields",
36237     "title": "Gets account fields",
36238     "examples": [
36239       {
36240         "title": "Example usage:",
36241         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
36242         "type": "json"
36243       }
36244     ],
36245     "name": "getFields",
36246     "group": "Zendesk_Accounts",
36247     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36248     "version": "0.0.0",
36249     "filename": "server/api/intZendeskAccount/index.js",
36250     "groupTitle": "Zendesk_Accounts"
36251   },
36252   {
36253     "type": "put",
36254     "url": "/api/integrations/zendesk/accounts/{id}",
36255     "title": "Update an existing Zendesk Account",
36256     "examples": [
36257       {
36258         "title": "Example usage:",
36259         "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",
36260         "type": "json"
36261       }
36262     ],
36263     "name": "updateZendesk_Accounts",
36264     "group": "Zendesk_Accounts",
36265     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36266     "version": "0.0.0",
36267     "filename": "server/api/intZendeskAccount/index.js",
36268     "groupTitle": "Zendesk_Accounts"
36269   },
36270   {
36271     "type": "post",
36272     "url": "/api/integrations/zendesk/configurations",
36273     "title": "Creates a new Zendesk Configuration",
36274     "examples": [
36275       {
36276         "title": "Example usage:",
36277         "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",
36278         "type": "json"
36279       }
36280     ],
36281     "name": "CreateZendesk_Configurations",
36282     "group": "Zendesk_Configurations",
36283     "parameter": {
36284       "fields": {
36285         "Body": [
36286           {
36287             "group": "Body",
36288             "type": "String",
36289             "optional": true,
36290             "field": "name",
36291             "description": ""
36292           },
36293           {
36294             "group": "Body",
36295             "type": "String",
36296             "optional": true,
36297             "field": "description",
36298             "description": ""
36299           }
36300         ]
36301       }
36302     },
36303     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36304     "version": "0.0.0",
36305     "filename": "server/api/intZendeskConfiguration/index.js",
36306     "groupTitle": "Zendesk_Configurations"
36307   },
36308   {
36309     "type": "delete",
36310     "url": "/api/integrations/zendesk/configurations/{id}",
36311     "title": "Deletes a Zendesk Configuration",
36312     "examples": [
36313       {
36314         "title": "Example usage:",
36315         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password} -X DELETE",
36316         "type": "json"
36317       }
36318     ],
36319     "name": "DeleteZendesk_Configurations",
36320     "group": "Zendesk_Configurations",
36321     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36322     "version": "0.0.0",
36323     "filename": "server/api/intZendeskConfiguration/index.js",
36324     "groupTitle": "Zendesk_Configurations"
36325   },
36326   {
36327     "type": "get",
36328     "url": "/api/integrations/zendesk/configurations",
36329     "title": "Gets a list of Zendesk Configurations",
36330     "examples": [
36331       {
36332         "title": "Example usage:",
36333         "content": "curl https://{domain}/api/integrations/zendesk/configurations -v -u {name}:{password}",
36334         "type": "json"
36335       }
36336     ],
36337     "name": "GetZendesk_Configurations",
36338     "group": "Zendesk_Configurations",
36339     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36340     "version": "0.0.0",
36341     "filename": "server/api/intZendeskConfiguration/index.js",
36342     "groupTitle": "Zendesk_Configurations"
36343   },
36344   {
36345     "type": "get",
36346     "url": "/api/integrations/zendesk/configurations/{id}",
36347     "title": "Gets a single Zendesk Configuration",
36348     "examples": [
36349       {
36350         "title": "Example usage:",
36351         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password}",
36352         "type": "json"
36353       }
36354     ],
36355     "name": "ShowZendesk_Configurations",
36356     "group": "Zendesk_Configurations",
36357     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36358     "version": "0.0.0",
36359     "filename": "server/api/intZendeskConfiguration/index.js",
36360     "groupTitle": "Zendesk_Configurations"
36361   },
36362   {
36363     "type": "get",
36364     "url": "/api/integrations/zendesk/configurations/{id}/descriptions",
36365     "title": "Gets configurations descriptions",
36366     "examples": [
36367       {
36368         "title": "Example usage:",
36369         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
36370         "type": "json"
36371       }
36372     ],
36373     "name": "getDescriptions",
36374     "group": "Zendesk_Configurations",
36375     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36376     "version": "0.0.0",
36377     "filename": "server/api/intZendeskConfiguration/index.js",
36378     "groupTitle": "Zendesk_Configurations"
36379   },
36380   {
36381     "type": "get",
36382     "url": "/api/integrations/zendesk/configurations/{id}/fields",
36383     "title": "Gets configurations fields",
36384     "examples": [
36385       {
36386         "title": "Example usage:",
36387         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
36388         "type": "json"
36389       }
36390     ],
36391     "name": "getFields",
36392     "group": "Zendesk_Configurations",
36393     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36394     "version": "0.0.0",
36395     "filename": "server/api/intZendeskConfiguration/index.js",
36396     "groupTitle": "Zendesk_Configurations"
36397   },
36398   {
36399     "type": "get",
36400     "url": "/api/integrations/zendesk/configurations/{id}/subjects",
36401     "title": "Gets configurations subjects",
36402     "examples": [
36403       {
36404         "title": "Example usage:",
36405         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
36406         "type": "json"
36407       }
36408     ],
36409     "name": "getSubjects",
36410     "group": "Zendesk_Configurations",
36411     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36412     "version": "0.0.0",
36413     "filename": "server/api/intZendeskConfiguration/index.js",
36414     "groupTitle": "Zendesk_Configurations"
36415   },
36416   {
36417     "type": "get",
36418     "url": "/api/integrations/zendesk/configurations/{id}/tags",
36419     "title": "Gets configurations tags",
36420     "examples": [
36421       {
36422         "title": "Example usage:",
36423         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
36424         "type": "json"
36425       }
36426     ],
36427     "name": "getTags",
36428     "group": "Zendesk_Configurations",
36429     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36430     "version": "0.0.0",
36431     "filename": "server/api/intZendeskConfiguration/index.js",
36432     "groupTitle": "Zendesk_Configurations"
36433   },
36434   {
36435     "type": "post",
36436     "url": "/api/integrations/zendesk/configurations/{id}/tags",
36437     "title": "Sets new tags",
36438     "examples": [
36439       {
36440         "title": "Example usage:",
36441         "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",
36442         "type": "json"
36443       }
36444     ],
36445     "name": "setTags",
36446     "group": "Zendesk_Configurations",
36447     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36448     "version": "0.0.0",
36449     "filename": "server/api/intZendeskConfiguration/index.js",
36450     "groupTitle": "Zendesk_Configurations"
36451   },
36452   {
36453     "type": "put",
36454     "url": "/api/integrations/zendesk/configurations/{id}",
36455     "title": "Update an existing Zendesk Configuration",
36456     "examples": [
36457       {
36458         "title": "Example usage:",
36459         "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",
36460         "type": "json"
36461       }
36462     ],
36463     "name": "updateZendesk_Configurations",
36464     "group": "Zendesk_Configurations",
36465     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36466     "version": "0.0.0",
36467     "filename": "server/api/intZendeskConfiguration/index.js",
36468     "groupTitle": "Zendesk_Configurations"
36469   },
36470   {
36471     "type": "post",
36472     "url": "/api/integrations/zendesk/fields",
36473     "title": "Creates a new Zendesk Field",
36474     "examples": [
36475       {
36476         "title": "Example usage:",
36477         "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",
36478         "type": "json"
36479       }
36480     ],
36481     "name": "CreateZendesk_Fields",
36482     "group": "Zendesk_Fields",
36483     "parameter": {
36484       "fields": {
36485         "Body": [
36486           {
36487             "group": "Body",
36488             "type": "String",
36489             "allowedValues": [
36490               "\"string\"",
36491               "\"variable\"",
36492               "\"customVariable\"",
36493               "\"keyValue\""
36494             ],
36495             "optional": true,
36496             "field": "type",
36497             "description": ""
36498           },
36499           {
36500             "group": "Body",
36501             "type": "String",
36502             "optional": true,
36503             "field": "content",
36504             "description": ""
36505           },
36506           {
36507             "group": "Body",
36508             "type": "String",
36509             "optional": true,
36510             "field": "key",
36511             "description": ""
36512           },
36513           {
36514             "group": "Body",
36515             "type": "String",
36516             "allowedValues": [
36517               "\"string\"",
36518               "\"variable\"",
36519               "\"customVariable\""
36520             ],
36521             "optional": true,
36522             "field": "keyType",
36523             "description": ""
36524           },
36525           {
36526             "group": "Body",
36527             "type": "String",
36528             "optional": true,
36529             "field": "keyContent",
36530             "description": ""
36531           },
36532           {
36533             "group": "Body",
36534             "type": "String",
36535             "optional": true,
36536             "field": "idField",
36537             "description": ""
36538           },
36539           {
36540             "group": "Body",
36541             "type": "String",
36542             "optional": true,
36543             "field": "nameField",
36544             "description": ""
36545           },
36546           {
36547             "group": "Body",
36548             "type": "Boolean",
36549             "optional": true,
36550             "field": "customField",
36551             "description": ""
36552           },
36553           {
36554             "group": "Body",
36555             "type": "String",
36556             "optional": true,
36557             "field": "variableName",
36558             "description": ""
36559           }
36560         ]
36561       }
36562     },
36563     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36564     "version": "0.0.0",
36565     "filename": "server/api/intZendeskField/index.js",
36566     "groupTitle": "Zendesk_Fields"
36567   },
36568   {
36569     "type": "delete",
36570     "url": "/api/integrations/zendesk/fields/{id}",
36571     "title": "Deletes a Zendesk Field",
36572     "examples": [
36573       {
36574         "title": "Example usage:",
36575         "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password} -X DELETE",
36576         "type": "json"
36577       }
36578     ],
36579     "name": "DeleteZendesk_Fields",
36580     "group": "Zendesk_Fields",
36581     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36582     "version": "0.0.0",
36583     "filename": "server/api/intZendeskField/index.js",
36584     "groupTitle": "Zendesk_Fields"
36585   },
36586   {
36587     "type": "get",
36588     "url": "/api/integrations/zendesk/fields",
36589     "title": "Gets a list of Zendesk Fields",
36590     "examples": [
36591       {
36592         "title": "Example usage:",
36593         "content": "curl https://{domain}/api/integrations/zendesk/fields -v -u {name}:{password}",
36594         "type": "json"
36595       }
36596     ],
36597     "name": "GetZendesk_Fields",
36598     "group": "Zendesk_Fields",
36599     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36600     "version": "0.0.0",
36601     "filename": "server/api/intZendeskField/index.js",
36602     "groupTitle": "Zendesk_Fields"
36603   },
36604   {
36605     "type": "get",
36606     "url": "/api/integrations/zendesk/fields/{id}",
36607     "title": "Gets a single Zendesk Field",
36608     "examples": [
36609       {
36610         "title": "Example usage:",
36611         "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password}",
36612         "type": "json"
36613       }
36614     ],
36615     "name": "ShowZendesk_Fields",
36616     "group": "Zendesk_Fields",
36617     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36618     "version": "0.0.0",
36619     "filename": "server/api/intZendeskField/index.js",
36620     "groupTitle": "Zendesk_Fields"
36621   },
36622   {
36623     "type": "put",
36624     "url": "/api/integrations/zendesk/fields/{id}",
36625     "title": "Update an existing Zendesk Field",
36626     "examples": [
36627       {
36628         "title": "Example usage:",
36629         "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",
36630         "type": "json"
36631       }
36632     ],
36633     "name": "updateZendesk_Fields",
36634     "group": "Zendesk_Fields",
36635     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36636     "version": "0.0.0",
36637     "filename": "server/api/intZendeskField/index.js",
36638     "groupTitle": "Zendesk_Fields"
36639   },
36640   {
36641     "type": "post",
36642     "url": "/api/integrations/zoho/accounts",
36643     "title": "Creates a new Zoho Account",
36644     "examples": [
36645       {
36646         "title": "Example usage:",
36647         "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",
36648         "type": "json"
36649       }
36650     ],
36651     "name": "CreateZoho_Accounts",
36652     "group": "Zoho_Accounts",
36653     "parameter": {
36654       "fields": {
36655         "Body": [
36656           {
36657             "group": "Body",
36658             "type": "String",
36659             "optional": true,
36660             "field": "name",
36661             "description": ""
36662           },
36663           {
36664             "group": "Body",
36665             "type": "String",
36666             "optional": true,
36667             "field": "description",
36668             "description": ""
36669           },
36670           {
36671             "group": "Body",
36672             "type": "String",
36673             "optional": true,
36674             "field": "host",
36675             "description": ""
36676           },
36677           {
36678             "group": "Body",
36679             "type": "String",
36680             "optional": true,
36681             "field": "zone",
36682             "description": ""
36683           },
36684           {
36685             "group": "Body",
36686             "type": "String",
36687             "optional": true,
36688             "field": "clientId",
36689             "description": ""
36690           },
36691           {
36692             "group": "Body",
36693             "type": "String",
36694             "optional": true,
36695             "field": "clientSecret",
36696             "description": ""
36697           },
36698           {
36699             "group": "Body",
36700             "type": "String",
36701             "optional": true,
36702             "field": "serverUrl",
36703             "description": ""
36704           },
36705           {
36706             "group": "Body",
36707             "type": "String",
36708             "optional": true,
36709             "field": "code",
36710             "description": ""
36711           },
36712           {
36713             "group": "Body",
36714             "type": "String",
36715             "optional": true,
36716             "field": "refreshToken",
36717             "description": ""
36718           }
36719         ]
36720       }
36721     },
36722     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36723     "version": "0.0.0",
36724     "filename": "server/api/intZohoAccount/index.js",
36725     "groupTitle": "Zoho_Accounts"
36726   },
36727   {
36728     "type": "delete",
36729     "url": "/api/integrations/zoho/accounts/{id}",
36730     "title": "Deletes a Zoho Account",
36731     "examples": [
36732       {
36733         "title": "Example usage:",
36734         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password} -X DELETE",
36735         "type": "json"
36736       }
36737     ],
36738     "name": "DeleteZoho_Accounts",
36739     "group": "Zoho_Accounts",
36740     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36741     "version": "0.0.0",
36742     "filename": "server/api/intZohoAccount/index.js",
36743     "groupTitle": "Zoho_Accounts"
36744   },
36745   {
36746     "type": "get",
36747     "url": "/api/integrations/zoho/accounts",
36748     "title": "Gets a list of Zoho Accounts",
36749     "examples": [
36750       {
36751         "title": "Example usage:",
36752         "content": "curl https://{domain}/api/integrations/zoho/accounts -v -u {name}:{password}",
36753         "type": "json"
36754       }
36755     ],
36756     "name": "GetZoho_Accounts",
36757     "group": "Zoho_Accounts",
36758     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36759     "version": "0.0.0",
36760     "filename": "server/api/intZohoAccount/index.js",
36761     "groupTitle": "Zoho_Accounts"
36762   },
36763   {
36764     "type": "get",
36765     "url": "/api/integrations/zoho/accounts/{id}",
36766     "title": "Gets a single Zoho Account",
36767     "examples": [
36768       {
36769         "title": "Example usage:",
36770         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password}",
36771         "type": "json"
36772       }
36773     ],
36774     "name": "ShowZoho_Accounts",
36775     "group": "Zoho_Accounts",
36776     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36777     "version": "0.0.0",
36778     "filename": "server/api/intZohoAccount/index.js",
36779     "groupTitle": "Zoho_Accounts"
36780   },
36781   {
36782     "type": "post",
36783     "url": "/api/integrations/zoho/accounts/{id}/configurations",
36784     "title": "Creates new configuration",
36785     "examples": [
36786       {
36787         "title": "Example usage:",
36788         "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",
36789         "type": "json"
36790       }
36791     ],
36792     "name": "addConfiguration",
36793     "group": "Zoho_Accounts",
36794     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36795     "version": "0.0.0",
36796     "filename": "server/api/intZohoAccount/index.js",
36797     "groupTitle": "Zoho_Accounts"
36798   },
36799   {
36800     "type": "get",
36801     "url": "/api/integrations/zoho/accounts/{id}/configurations",
36802     "title": "Gets account configurations",
36803     "examples": [
36804       {
36805         "title": "Example usage:",
36806         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/configurations -v -u {name}:{password} -X GET",
36807         "type": "json"
36808       }
36809     ],
36810     "name": "getConfigurations",
36811     "group": "Zoho_Accounts",
36812     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36813     "version": "0.0.0",
36814     "filename": "server/api/intZohoAccount/index.js",
36815     "groupTitle": "Zoho_Accounts"
36816   },
36817   {
36818     "type": "get",
36819     "url": "/api/integrations/zoho/accounts/{id}/fields",
36820     "title": "Gets account fields",
36821     "examples": [
36822       {
36823         "title": "Example usage:",
36824         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/fields -v -u {name}:{password} -X GET",
36825         "type": "json"
36826       }
36827     ],
36828     "name": "getFields",
36829     "group": "Zoho_Accounts",
36830     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36831     "version": "0.0.0",
36832     "filename": "server/api/intZohoAccount/index.js",
36833     "groupTitle": "Zoho_Accounts"
36834   },
36835   {
36836     "type": "put",
36837     "url": "/api/integrations/zoho/accounts/{id}",
36838     "title": "Update an existing Zoho Account",
36839     "examples": [
36840       {
36841         "title": "Example usage:",
36842         "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",
36843         "type": "json"
36844       }
36845     ],
36846     "name": "updateZoho_Accounts",
36847     "group": "Zoho_Accounts",
36848     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36849     "version": "0.0.0",
36850     "filename": "server/api/intZohoAccount/index.js",
36851     "groupTitle": "Zoho_Accounts"
36852   },
36853   {
36854     "type": "post",
36855     "url": "/api/integrations/zoho/configurations",
36856     "title": "Creates a new Zoho Configuration",
36857     "examples": [
36858       {
36859         "title": "Example usage:",
36860         "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",
36861         "type": "json"
36862       }
36863     ],
36864     "name": "CreateZoho_Configurations",
36865     "group": "Zoho_Configurations",
36866     "parameter": {
36867       "fields": {
36868         "Body": [
36869           {
36870             "group": "Body",
36871             "type": "String",
36872             "optional": true,
36873             "field": "name",
36874             "description": ""
36875           },
36876           {
36877             "group": "Body",
36878             "type": "String",
36879             "allowedValues": [
36880               "\"lead\"",
36881               "\"contact\"",
36882               "\"nothing\""
36883             ],
36884             "optional": true,
36885             "field": "moduleCreate",
36886             "description": ""
36887           },
36888           {
36889             "group": "Body",
36890             "type": "String",
36891             "allowedValues": [
36892               "\"contact_lead\"",
36893               "\"contact\"",
36894               "\"lead\""
36895             ],
36896             "optional": true,
36897             "field": "moduleSearch",
36898             "description": ""
36899           },
36900           {
36901             "group": "Body",
36902             "type": "String",
36903             "optional": true,
36904             "field": "description",
36905             "description": ""
36906           }
36907         ]
36908       }
36909     },
36910     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36911     "version": "0.0.0",
36912     "filename": "server/api/intZohoConfiguration/index.js",
36913     "groupTitle": "Zoho_Configurations"
36914   },
36915   {
36916     "type": "delete",
36917     "url": "/api/integrations/zoho/configurations/{id}",
36918     "title": "Deletes a Zoho Configuration",
36919     "examples": [
36920       {
36921         "title": "Example usage:",
36922         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password} -X DELETE",
36923         "type": "json"
36924       }
36925     ],
36926     "name": "DeleteZoho_Configurations",
36927     "group": "Zoho_Configurations",
36928     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36929     "version": "0.0.0",
36930     "filename": "server/api/intZohoConfiguration/index.js",
36931     "groupTitle": "Zoho_Configurations"
36932   },
36933   {
36934     "type": "get",
36935     "url": "/api/integrations/zoho/configurations",
36936     "title": "Gets a list of Zoho Configurations",
36937     "examples": [
36938       {
36939         "title": "Example usage:",
36940         "content": "curl https://{domain}/api/integrations/zoho/configurations -v -u {name}:{password}",
36941         "type": "json"
36942       }
36943     ],
36944     "name": "GetZoho_Configurations",
36945     "group": "Zoho_Configurations",
36946     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36947     "version": "0.0.0",
36948     "filename": "server/api/intZohoConfiguration/index.js",
36949     "groupTitle": "Zoho_Configurations"
36950   },
36951   {
36952     "type": "get",
36953     "url": "/api/integrations/zoho/configurations/{id}",
36954     "title": "Gets a single Zoho Configuration",
36955     "examples": [
36956       {
36957         "title": "Example usage:",
36958         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password}",
36959         "type": "json"
36960       }
36961     ],
36962     "name": "ShowZoho_Configurations",
36963     "group": "Zoho_Configurations",
36964     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36965     "version": "0.0.0",
36966     "filename": "server/api/intZohoConfiguration/index.js",
36967     "groupTitle": "Zoho_Configurations"
36968   },
36969   {
36970     "type": "get",
36971     "url": "/api/integrations/zoho/configurations/{id}/descriptions",
36972     "title": "Gets configurations descriptions",
36973     "examples": [
36974       {
36975         "title": "Example usage:",
36976         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
36977         "type": "json"
36978       }
36979     ],
36980     "name": "getDescriptions",
36981     "group": "Zoho_Configurations",
36982     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36983     "version": "0.0.0",
36984     "filename": "server/api/intZohoConfiguration/index.js",
36985     "groupTitle": "Zoho_Configurations"
36986   },
36987   {
36988     "type": "get",
36989     "url": "/api/integrations/zoho/configurations/{id}/fields",
36990     "title": "Gets configurations fields",
36991     "examples": [
36992       {
36993         "title": "Example usage:",
36994         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
36995         "type": "json"
36996       }
36997     ],
36998     "name": "getFields",
36999     "group": "Zoho_Configurations",
37000     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37001     "version": "0.0.0",
37002     "filename": "server/api/intZohoConfiguration/index.js",
37003     "groupTitle": "Zoho_Configurations"
37004   },
37005   {
37006     "type": "get",
37007     "url": "/api/integrations/zoho/configurations/{id}/subjects",
37008     "title": "Gets configurations subjects",
37009     "examples": [
37010       {
37011         "title": "Example usage:",
37012         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/subjects -v -u {name}:{password} -X GET",
37013         "type": "json"
37014       }
37015     ],
37016     "name": "getSubjects",
37017     "group": "Zoho_Configurations",
37018     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37019     "version": "0.0.0",
37020     "filename": "server/api/intZohoConfiguration/index.js",
37021     "groupTitle": "Zoho_Configurations"
37022   },
37023   {
37024     "type": "put",
37025     "url": "/api/integrations/zoho/configurations/{id}",
37026     "title": "Update an existing Zoho Configuration",
37027     "examples": [
37028       {
37029         "title": "Example usage:",
37030         "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",
37031         "type": "json"
37032       }
37033     ],
37034     "name": "updateZoho_Configurations",
37035     "group": "Zoho_Configurations",
37036     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37037     "version": "0.0.0",
37038     "filename": "server/api/intZohoConfiguration/index.js",
37039     "groupTitle": "Zoho_Configurations"
37040   },
37041   {
37042     "type": "post",
37043     "url": "/api/integrations/zoho/fields",
37044     "title": "Creates a new Zoho Field",
37045     "examples": [
37046       {
37047         "title": "Example usage:",
37048         "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",
37049         "type": "json"
37050       }
37051     ],
37052     "name": "CreateZoho_Fields",
37053     "group": "Zoho_Fields",
37054     "parameter": {
37055       "fields": {
37056         "Body": [
37057           {
37058             "group": "Body",
37059             "type": "String",
37060             "allowedValues": [
37061               "\"string\"",
37062               "\"variable\"",
37063               "\"customVariable\"",
37064               "\"keyValue\""
37065             ],
37066             "optional": true,
37067             "field": "type",
37068             "description": ""
37069           },
37070           {
37071             "group": "Body",
37072             "type": "String",
37073             "optional": true,
37074             "field": "content",
37075             "description": ""
37076           },
37077           {
37078             "group": "Body",
37079             "type": "String",
37080             "optional": true,
37081             "field": "key",
37082             "description": ""
37083           },
37084           {
37085             "group": "Body",
37086             "type": "String",
37087             "allowedValues": [
37088               "\"string\"",
37089               "\"variable\"",
37090               "\"customVariable\""
37091             ],
37092             "optional": true,
37093             "field": "keyType",
37094             "description": ""
37095           },
37096           {
37097             "group": "Body",
37098             "type": "String",
37099             "optional": true,
37100             "field": "keyContent",
37101             "description": ""
37102           },
37103           {
37104             "group": "Body",
37105             "type": "String",
37106             "optional": true,
37107             "field": "idField",
37108             "description": ""
37109           },
37110           {
37111             "group": "Body",
37112             "type": "String",
37113             "optional": true,
37114             "field": "nameField",
37115             "description": ""
37116           },
37117           {
37118             "group": "Body",
37119             "type": "Boolean",
37120             "optional": true,
37121             "field": "customField",
37122             "description": ""
37123           },
37124           {
37125             "group": "Body",
37126             "type": "String",
37127             "optional": true,
37128             "field": "variableName",
37129             "description": ""
37130           }
37131         ]
37132       }
37133     },
37134     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37135     "version": "0.0.0",
37136     "filename": "server/api/intZohoField/index.js",
37137     "groupTitle": "Zoho_Fields"
37138   },
37139   {
37140     "type": "delete",
37141     "url": "/api/integrations/zoho/fields/{id}",
37142     "title": "Deletes a Zoho Field",
37143     "examples": [
37144       {
37145         "title": "Example usage:",
37146         "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password} -X DELETE",
37147         "type": "json"
37148       }
37149     ],
37150     "name": "DeleteZoho_Fields",
37151     "group": "Zoho_Fields",
37152     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37153     "version": "0.0.0",
37154     "filename": "server/api/intZohoField/index.js",
37155     "groupTitle": "Zoho_Fields"
37156   },
37157   {
37158     "type": "get",
37159     "url": "/api/integrations/zoho/fields",
37160     "title": "Gets a list of Zoho Fields",
37161     "examples": [
37162       {
37163         "title": "Example usage:",
37164         "content": "curl https://{domain}/api/integrations/zoho/fields -v -u {name}:{password}",
37165         "type": "json"
37166       }
37167     ],
37168     "name": "GetZoho_Fields",
37169     "group": "Zoho_Fields",
37170     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37171     "version": "0.0.0",
37172     "filename": "server/api/intZohoField/index.js",
37173     "groupTitle": "Zoho_Fields"
37174   },
37175   {
37176     "type": "get",
37177     "url": "/api/integrations/zoho/fields/{id}",
37178     "title": "Gets a single Zoho Field",
37179     "examples": [
37180       {
37181         "title": "Example usage:",
37182         "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password}",
37183         "type": "json"
37184       }
37185     ],
37186     "name": "ShowZoho_Fields",
37187     "group": "Zoho_Fields",
37188     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37189     "version": "0.0.0",
37190     "filename": "server/api/intZohoField/index.js",
37191     "groupTitle": "Zoho_Fields"
37192   },
37193   {
37194     "type": "put",
37195     "url": "/api/integrations/zoho/fields/{id}",
37196     "title": "Update an existing Zoho Field",
37197     "examples": [
37198       {
37199         "title": "Example usage:",
37200         "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",
37201         "type": "json"
37202       }
37203     ],
37204     "name": "updateZoho_Fields",
37205     "group": "Zoho_Fields",
37206     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37207     "version": "0.0.0",
37208     "filename": "server/api/intZohoField/index.js",
37209     "groupTitle": "Zoho_Fields"
37210   },
37211   {
37212     "type": "post",
37213     "url": "/api/cdr",
37214     "title": "Creates a new Cdr",
37215     "examples": [
37216       {
37217         "title": "Example usage:",
37218         "content": "curl https://{domain}/api/cdr -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
37219         "type": "json"
37220       }
37221     ],
37222     "name": "CreateCdrs",
37223     "group": "cdr",
37224     "parameter": {
37225       "fields": {
37226         "Body": [
37227           {
37228             "group": "Body",
37229             "type": "String",
37230             "optional": false,
37231             "field": "calldate",
37232             "description": ""
37233           },
37234           {
37235             "group": "Body",
37236             "type": "String",
37237             "optional": true,
37238             "field": "clid",
37239             "description": ""
37240           },
37241           {
37242             "group": "Body",
37243             "type": "String",
37244             "optional": true,
37245             "field": "src",
37246             "description": ""
37247           },
37248           {
37249             "group": "Body",
37250             "type": "String",
37251             "optional": true,
37252             "field": "dst",
37253             "description": ""
37254           },
37255           {
37256             "group": "Body",
37257             "type": "String",
37258             "optional": true,
37259             "field": "dcontext",
37260             "description": ""
37261           },
37262           {
37263             "group": "Body",
37264             "type": "String",
37265             "optional": true,
37266             "field": "channel",
37267             "description": ""
37268           },
37269           {
37270             "group": "Body",
37271             "type": "String",
37272             "optional": true,
37273             "field": "dstchannel",
37274             "description": ""
37275           },
37276           {
37277             "group": "Body",
37278             "type": "String",
37279             "optional": true,
37280             "field": "lastapp",
37281             "description": ""
37282           },
37283           {
37284             "group": "Body",
37285             "type": "String",
37286             "optional": true,
37287             "field": "lastdata",
37288             "description": ""
37289           },
37290           {
37291             "group": "Body",
37292             "type": "Integer",
37293             "optional": false,
37294             "field": "duration",
37295             "description": ""
37296           },
37297           {
37298             "group": "Body",
37299             "type": "Integer",
37300             "optional": false,
37301             "field": "billsec",
37302             "description": ""
37303           },
37304           {
37305             "group": "Body",
37306             "type": "String",
37307             "optional": true,
37308             "field": "disposition",
37309             "description": ""
37310           },
37311           {
37312             "group": "Body",
37313             "type": "Integer",
37314             "optional": false,
37315             "field": "amaflags",
37316             "description": ""
37317           },
37318           {
37319             "group": "Body",
37320             "type": "String",
37321             "optional": true,
37322             "field": "accountcode",
37323             "description": ""
37324           },
37325           {
37326             "group": "Body",
37327             "type": "String",
37328             "optional": true,
37329             "field": "userfield",
37330             "description": ""
37331           },
37332           {
37333             "group": "Body",
37334             "type": "String",
37335             "optional": true,
37336             "field": "uniqueid",
37337             "description": ""
37338           },
37339           {
37340             "group": "Body",
37341             "type": "String",
37342             "optional": true,
37343             "field": "linkedid",
37344             "description": ""
37345           },
37346           {
37347             "group": "Body",
37348             "type": "String",
37349             "optional": true,
37350             "field": "sequence",
37351             "description": ""
37352           },
37353           {
37354             "group": "Body",
37355             "type": "String",
37356             "optional": true,
37357             "field": "peeraccount",
37358             "description": ""
37359           },
37360           {
37361             "group": "Body",
37362             "type": "String",
37363             "optional": true,
37364             "field": "type",
37365             "description": ""
37366           },
37367           {
37368             "group": "Body",
37369             "type": "String",
37370             "optional": true,
37371             "field": "tag",
37372             "description": ""
37373           }
37374         ]
37375       }
37376     },
37377     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37378     "version": "0.0.0",
37379     "filename": "server/api/cdr/index.js",
37380     "groupTitle": "cdr"
37381   },
37382   {
37383     "type": "delete",
37384     "url": "/api/cdr/{id}",
37385     "title": "Deletes a Cdr",
37386     "examples": [
37387       {
37388         "title": "Example usage:",
37389         "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password} -X DELETE",
37390         "type": "json"
37391       }
37392     ],
37393     "name": "DeleteCdrs",
37394     "group": "cdr",
37395     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37396     "version": "0.0.0",
37397     "filename": "server/api/cdr/index.js",
37398     "groupTitle": "cdr"
37399   },
37400   {
37401     "type": "get",
37402     "url": "/api/cdr/describe",
37403     "title": "Gets table info about Cdrs",
37404     "examples": [
37405       {
37406         "title": "Example usage:",
37407         "content": "curl https://{domain}/api/cdr/describe -v -u {name}:{password}",
37408         "type": "json"
37409       }
37410     ],
37411     "name": "DescribeCdrs",
37412     "group": "cdr",
37413     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37414     "version": "0.0.0",
37415     "filename": "server/api/cdr/index.js",
37416     "groupTitle": "cdr"
37417   },
37418   {
37419     "type": "get",
37420     "url": "/api/cdr",
37421     "title": "Gets a list of Cdrs",
37422     "examples": [
37423       {
37424         "title": "Example usage:",
37425         "content": "curl https://{domain}/api/cdr -v -u {name}:{password}",
37426         "type": "json"
37427       }
37428     ],
37429     "name": "GetCdrs",
37430     "group": "cdr",
37431     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37432     "version": "0.0.0",
37433     "filename": "server/api/cdr/index.js",
37434     "groupTitle": "cdr"
37435   },
37436   {
37437     "type": "get",
37438     "url": "/api/cdr/{id}",
37439     "title": "Gets a single Cdr",
37440     "examples": [
37441       {
37442         "title": "Example usage:",
37443         "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password}",
37444         "type": "json"
37445       }
37446     ],
37447     "name": "ShowCdrs",
37448     "group": "cdr",
37449     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37450     "version": "0.0.0",
37451     "filename": "server/api/cdr/index.js",
37452     "groupTitle": "cdr"
37453   },
37454   {
37455     "type": "put",
37456     "url": "/api/cdr/{id}",
37457     "title": "Update an existing Cdr",
37458     "examples": [
37459       {
37460         "title": "Example usage:",
37461         "content": "curl https://{domain}/api/cdr/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
37462         "type": "json"
37463       }
37464     ],
37465     "name": "updateCdrs",
37466     "group": "cdr",
37467     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37468     "version": "0.0.0",
37469     "filename": "server/api/cdr/index.js",
37470     "groupTitle": "cdr"
37471   },
37472   {
37473     "type": "post",
37474     "url": "/api/voiceQueuesLog",
37475     "title": "Creates a new VoiceQueuesLog",
37476     "examples": [
37477       {
37478         "title": "Example usage:",
37479         "content": "curl https://{domain}/api/voiceQueuesLog -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
37480         "type": "json"
37481       }
37482     ],
37483     "name": "CreateVoiceQueuesLogs",
37484     "group": "voiceQueuesLog",
37485     "parameter": {
37486       "fields": {
37487         "Body": [
37488           {
37489             "group": "Body",
37490             "type": "String",
37491             "optional": true,
37492             "field": "time",
37493             "description": ""
37494           },
37495           {
37496             "group": "Body",
37497             "type": "String",
37498             "optional": false,
37499             "field": "callid",
37500             "description": ""
37501           },
37502           {
37503             "group": "Body",
37504             "type": "String",
37505             "optional": false,
37506             "field": "queuename",
37507             "description": ""
37508           },
37509           {
37510             "group": "Body",
37511             "type": "String",
37512             "optional": false,
37513             "field": "agent",
37514             "description": ""
37515           },
37516           {
37517             "group": "Body",
37518             "type": "String",
37519             "optional": false,
37520             "field": "event",
37521             "description": ""
37522           },
37523           {
37524             "group": "Body",
37525             "type": "String",
37526             "optional": false,
37527             "field": "data",
37528             "description": ""
37529           },
37530           {
37531             "group": "Body",
37532             "type": "String",
37533             "optional": false,
37534             "field": "data1",
37535             "description": ""
37536           },
37537           {
37538             "group": "Body",
37539             "type": "String",
37540             "optional": false,
37541             "field": "data2",
37542             "description": ""
37543           },
37544           {
37545             "group": "Body",
37546             "type": "String",
37547             "optional": false,
37548             "field": "data3",
37549             "description": ""
37550           },
37551           {
37552             "group": "Body",
37553             "type": "String",
37554             "optional": false,
37555             "field": "data4",
37556             "description": ""
37557           },
37558           {
37559             "group": "Body",
37560             "type": "String",
37561             "optional": false,
37562             "field": "data5",
37563             "description": ""
37564           },
37565           {
37566             "group": "Body",
37567             "type": "String",
37568             "optional": false,
37569             "field": "dtm",
37570             "description": ""
37571           }
37572         ]
37573       }
37574     },
37575     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37576     "version": "0.0.0",
37577     "filename": "server/api/voiceQueuesLog/index.js",
37578     "groupTitle": "voiceQueuesLog"
37579   },
37580   {
37581     "type": "delete",
37582     "url": "/api/voiceQueuesLog/{id}",
37583     "title": "Deletes a VoiceQueuesLog",
37584     "examples": [
37585       {
37586         "title": "Example usage:",
37587         "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password} -X DELETE",
37588         "type": "json"
37589       }
37590     ],
37591     "name": "DeleteVoiceQueuesLogs",
37592     "group": "voiceQueuesLog",
37593     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37594     "version": "0.0.0",
37595     "filename": "server/api/voiceQueuesLog/index.js",
37596     "groupTitle": "voiceQueuesLog"
37597   },
37598   {
37599     "type": "get",
37600     "url": "/api/voiceQueuesLog",
37601     "title": "Gets a list of VoiceQueuesLogs",
37602     "examples": [
37603       {
37604         "title": "Example usage:",
37605         "content": "curl https://{domain}/api/voiceQueuesLog -v -u {name}:{password}",
37606         "type": "json"
37607       }
37608     ],
37609     "name": "GetVoiceQueuesLogs",
37610     "group": "voiceQueuesLog",
37611     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37612     "version": "0.0.0",
37613     "filename": "server/api/voiceQueuesLog/index.js",
37614     "groupTitle": "voiceQueuesLog"
37615   },
37616   {
37617     "type": "get",
37618     "url": "/api/voiceQueuesLog/{id}",
37619     "title": "Gets a single VoiceQueuesLog",
37620     "examples": [
37621       {
37622         "title": "Example usage:",
37623         "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password}",
37624         "type": "json"
37625       }
37626     ],
37627     "name": "ShowVoiceQueuesLogs",
37628     "group": "voiceQueuesLog",
37629     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37630     "version": "0.0.0",
37631     "filename": "server/api/voiceQueuesLog/index.js",
37632     "groupTitle": "voiceQueuesLog"
37633   },
37634   {
37635     "type": "put",
37636     "url": "/api/voiceQueuesLog/{id}",
37637     "title": "Update an existing VoiceQueuesLog",
37638     "examples": [
37639       {
37640         "title": "Example usage:",
37641         "content": "curl https://{domain}/api/voiceQueuesLog/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
37642         "type": "json"
37643       }
37644     ],
37645     "name": "updateVoiceQueuesLogs",
37646     "group": "voiceQueuesLog",
37647     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37648     "version": "0.0.0",
37649     "filename": "server/api/voiceQueuesLog/index.js",
37650     "groupTitle": "voiceQueuesLog"
37651   }
37652 ]