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             "group": "Body",
2322             "type": "Boolean",
2323             "optional": true,
2324             "field": "autoreplyExecuted",
2325             "description": ""
2326           }
2327         ]
2328       }
2329     },
2330     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2331     "version": "0.0.0",
2332     "filename": "server/api/chatInteraction/index.js",
2333     "groupTitle": "Chat_Interactions"
2334   },
2335   {
2336     "type": "delete",
2337     "url": "/api/chat/interactions/{id}",
2338     "title": "Deletes a Interaction",
2339     "examples": [
2340       {
2341         "title": "Example usage:",
2342         "content": "curl https://{domain}/api/chat/interactions/{id} -v -u {name}:{password} -X DELETE",
2343         "type": "json"
2344       }
2345     ],
2346     "name": "DeleteInteractions",
2347     "group": "Chat_Interactions",
2348     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2349     "version": "0.0.0",
2350     "filename": "server/api/chatInteraction/index.js",
2351     "groupTitle": "Chat_Interactions"
2352   },
2353   {
2354     "type": "get",
2355     "url": "/api/chat/interactions/describe",
2356     "title": "Gets table info about Interactions",
2357     "examples": [
2358       {
2359         "title": "Example usage:",
2360         "content": "curl https://{domain}/api/chat/interactions/describe -v -u {name}:{password}",
2361         "type": "json"
2362       }
2363     ],
2364     "name": "DescribeInteractions",
2365     "group": "Chat_Interactions",
2366     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2367     "version": "0.0.0",
2368     "filename": "server/api/chatInteraction/index.js",
2369     "groupTitle": "Chat_Interactions"
2370   },
2371   {
2372     "type": "get",
2373     "url": "/api/chat/interactions",
2374     "title": "Gets a list of Interactions",
2375     "examples": [
2376       {
2377         "title": "Example usage:",
2378         "content": "curl https://{domain}/api/chat/interactions -v -u {name}:{password}",
2379         "type": "json"
2380       }
2381     ],
2382     "name": "GetInteractions",
2383     "group": "Chat_Interactions",
2384     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
2385     "version": "0.0.0",
2386     "filename": "server/api/chatInteraction/index.js",
2387     "groupTitle": "Chat_Interactions"
2388   },
2389   {
2390     "type": "delete",
2391     "url": "/api/chat/interactions/{id}/tags",
2392     "title": "Removes tags from interaction",
2393     "examples": [
2394       {
2395         "title": "Example usage:",
2396         "content": "curl https://{domain}/api/chat/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
2397         "type": "json"
2398       }
2399     ],
2400     "name": "RemoveTags",
2401     "group": "Chat_Interactions",
2402     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2403     "version": "0.0.0",
2404     "filename": "server/api/chatInteraction/index.js",
2405     "groupTitle": "Chat_Interactions"
2406   },
2407   {
2408     "type": "get",
2409     "url": "/api/chat/interactions/{id}",
2410     "title": "Gets a single Interaction",
2411     "examples": [
2412       {
2413         "title": "Example usage:",
2414         "content": "curl https://{domain}/api/chat/interactions/{id} -v -u {name}:{password}",
2415         "type": "json"
2416       }
2417     ],
2418     "name": "ShowInteractions",
2419     "group": "Chat_Interactions",
2420     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2421     "version": "0.0.0",
2422     "filename": "server/api/chatInteraction/index.js",
2423     "groupTitle": "Chat_Interactions"
2424   },
2425   {
2426     "type": "put",
2427     "url": "/api/chat/interactions/{id}/abandon",
2428     "title": "Abandon interaction",
2429     "examples": [
2430       {
2431         "title": "Example usage:",
2432         "content": "curl https://{domain}/api/chat/interactions/{id}/abandon -d '{\"channel\": \"chat\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
2433         "type": "json"
2434       }
2435     ],
2436     "name": "abandon",
2437     "group": "Chat_Interactions",
2438     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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>",
2439     "version": "0.0.0",
2440     "filename": "server/api/chatInteraction/index.js",
2441     "groupTitle": "Chat_Interactions"
2442   },
2443   {
2444     "type": "post",
2445     "url": "/api/chat/interactions/{id}/messages",
2446     "title": "Creates new messages",
2447     "examples": [
2448       {
2449         "title": "Example usage:",
2450         "content": "curl https://{domain}/api/chat/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2451         "type": "json"
2452       }
2453     ],
2454     "name": "addMessage",
2455     "group": "Chat_Interactions",
2456     "parameter": {
2457       "fields": {
2458         "Body": [
2459           {
2460             "group": "Body",
2461             "type": "Text",
2462             "optional": false,
2463             "field": "body",
2464             "description": ""
2465           },
2466           {
2467             "group": "Body",
2468             "type": "Boolean",
2469             "optional": true,
2470             "field": "read",
2471             "description": ""
2472           },
2473           {
2474             "group": "Body",
2475             "type": "Boolean",
2476             "optional": true,
2477             "field": "secret",
2478             "description": ""
2479           },
2480           {
2481             "group": "Body",
2482             "type": "String",
2483             "allowedValues": [
2484               "\"in\"",
2485               "\"out\""
2486             ],
2487             "optional": false,
2488             "field": "direction",
2489             "description": ""
2490           },
2491           {
2492             "group": "Body",
2493             "type": "String",
2494             "optional": true,
2495             "field": "readAt",
2496             "description": ""
2497           },
2498           {
2499             "group": "Body",
2500             "type": "String",
2501             "optional": true,
2502             "field": "providerName",
2503             "description": ""
2504           },
2505           {
2506             "group": "Body",
2507             "type": "Text",
2508             "optional": true,
2509             "field": "providerResponse",
2510             "description": ""
2511           }
2512         ]
2513       }
2514     },
2515     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2516     "version": "0.0.0",
2517     "filename": "server/api/chatInteraction/index.js",
2518     "groupTitle": "Chat_Interactions"
2519   },
2520   {
2521     "type": "put",
2522     "url": "/api/chat/interactions/{id}/close",
2523     "title": "Close Interaction",
2524     "examples": [
2525       {
2526         "title": "Example usage:",
2527         "content": "curl https://{domain}/api/chat/interactions/{id}/close -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2528         "type": "json"
2529       }
2530     ],
2531     "name": "addMessage",
2532     "group": "Chat_Interactions",
2533     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2534     "version": "0.0.0",
2535     "filename": "server/api/chatInteraction/index.js",
2536     "groupTitle": "Chat_Interactions"
2537   },
2538   {
2539     "type": "post",
2540     "url": "/api/chat/interactions/{id}/attachment_upload",
2541     "title": "Add attachment",
2542     "examples": [
2543       {
2544         "title": "Example usage:",
2545         "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",
2546         "type": "json"
2547       }
2548     ],
2549     "name": "attachmentUpload",
2550     "group": "Chat_Interactions",
2551     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2552     "version": "0.0.0",
2553     "filename": "server/api/chatInteraction/index.js",
2554     "groupTitle": "Chat_Interactions"
2555   },
2556   {
2557     "type": "post",
2558     "url": "/api/chat/interactions/{id}/vidaoo",
2559     "title": "Create Vidaoo Session",
2560     "examples": [
2561       {
2562         "title": "Example usage:",
2563         "content": "curl https://{domain}/api/chat/interactions/{id}/vidaoo  -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2564         "type": "json"
2565       }
2566     ],
2567     "name": "createVidaooSession",
2568     "group": "Chat_Interactions",
2569     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2570     "version": "0.0.0",
2571     "filename": "server/api/chatInteraction/index.js",
2572     "groupTitle": "Chat_Interactions"
2573   },
2574   {
2575     "type": "put",
2576     "url": "/api/chat/interactions/{id}/custom_update",
2577     "title": "Update interaction",
2578     "examples": [
2579       {
2580         "title": "Example usage:",
2581         "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",
2582         "type": "json"
2583       }
2584     ],
2585     "name": "customUpdate",
2586     "group": "Chat_Interactions",
2587     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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>",
2588     "version": "0.0.0",
2589     "filename": "server/api/chatInteraction/index.js",
2590     "groupTitle": "Chat_Interactions"
2591   },
2592   {
2593     "type": "get",
2594     "url": "/api/chat/interactions/{id}/download",
2595     "title": "Gets interaction",
2596     "examples": [
2597       {
2598         "title": "Example usage:",
2599         "content": "curl https://{domain}/api/chat/interactions/{id}/download -v -u {name}:{password} -X GET",
2600         "type": "json"
2601       }
2602     ],
2603     "name": "download",
2604     "group": "Chat_Interactions",
2605     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2606     "version": "0.0.0",
2607     "filename": "server/api/chatInteraction/index.js",
2608     "groupTitle": "Chat_Interactions"
2609   },
2610   {
2611     "type": "get",
2612     "url": "/api/chat/interactions/{id}/messages",
2613     "title": "Gets interaction messages",
2614     "examples": [
2615       {
2616         "title": "Example usage:",
2617         "content": "curl https://{domain}/api/chat/interactions/{id}/messages -v -u {name}:{password} -X GET",
2618         "type": "json"
2619       }
2620     ],
2621     "name": "getMessages",
2622     "group": "Chat_Interactions",
2623     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2624     "version": "0.0.0",
2625     "filename": "server/api/chatInteraction/index.js",
2626     "groupTitle": "Chat_Interactions"
2627   },
2628   {
2629     "type": "get",
2630     "url": "/api/chat/interactions/{id}/my_messages",
2631     "title": "Gets interaction messages",
2632     "examples": [
2633       {
2634         "title": "Example usage:",
2635         "content": "curl https://{domain}/api/chat/interactions/{id}/my_messages -v -u {name}:{password} -X GET",
2636         "type": "json"
2637       }
2638     ],
2639     "name": "getMyMessages",
2640     "group": "Chat_Interactions",
2641     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2642     "version": "0.0.0",
2643     "filename": "server/api/chatInteraction/index.js",
2644     "groupTitle": "Chat_Interactions"
2645   },
2646   {
2647     "type": "put",
2648     "url": "/api/chat/interactions/{id}",
2649     "title": "Update an existing Interaction",
2650     "examples": [
2651       {
2652         "title": "Example usage:",
2653         "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",
2654         "type": "json"
2655       }
2656     ],
2657     "name": "updateInteractions",
2658     "group": "Chat_Interactions",
2659     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2660     "version": "0.0.0",
2661     "filename": "server/api/chatInteraction/index.js",
2662     "groupTitle": "Chat_Interactions"
2663   },
2664   {
2665     "type": "post",
2666     "url": "/api/chat/internal/messages",
2667     "title": "Creates a new Message",
2668     "examples": [
2669       {
2670         "title": "Example usage:",
2671         "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",
2672         "type": "json"
2673       }
2674     ],
2675     "name": "CreateMessages",
2676     "group": "Chat_Internal_Messages",
2677     "parameter": {
2678       "fields": {
2679         "Body": [
2680           {
2681             "group": "Body",
2682             "type": "Text",
2683             "optional": false,
2684             "field": "body",
2685             "description": ""
2686           },
2687           {
2688             "group": "Body",
2689             "type": "Boolean",
2690             "optional": true,
2691             "field": "read",
2692             "description": ""
2693           },
2694           {
2695             "group": "Body",
2696             "type": "Integer",
2697             "optional": true,
2698             "field": "ChatInternalMessageId",
2699             "description": ""
2700           }
2701         ]
2702       }
2703     },
2704     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2705     "version": "0.0.0",
2706     "filename": "server/api/chatInternalMessage/index.js",
2707     "groupTitle": "Chat_Internal_Messages"
2708   },
2709   {
2710     "type": "delete",
2711     "url": "/api/chat/internal/messages/{id}",
2712     "title": "Deletes a Message",
2713     "examples": [
2714       {
2715         "title": "Example usage:",
2716         "content": "curl https://{domain}/api/chat/internal/messages/{id} -v -u {name}:{password} -X DELETE",
2717         "type": "json"
2718       }
2719     ],
2720     "name": "DeleteMessages",
2721     "group": "Chat_Internal_Messages",
2722     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2723     "version": "0.0.0",
2724     "filename": "server/api/chatInternalMessage/index.js",
2725     "groupTitle": "Chat_Internal_Messages"
2726   },
2727   {
2728     "type": "get",
2729     "url": "/api/chat/internal/messages/describe",
2730     "title": "Gets table info about Messages",
2731     "examples": [
2732       {
2733         "title": "Example usage:",
2734         "content": "curl https://{domain}/api/chat/internal/messages/describe -v -u {name}:{password}",
2735         "type": "json"
2736       }
2737     ],
2738     "name": "DescribeMessages",
2739     "group": "Chat_Internal_Messages",
2740     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2741     "version": "0.0.0",
2742     "filename": "server/api/chatInternalMessage/index.js",
2743     "groupTitle": "Chat_Internal_Messages"
2744   },
2745   {
2746     "type": "get",
2747     "url": "/api/chat/internal/messages",
2748     "title": "Gets a list of Messages",
2749     "examples": [
2750       {
2751         "title": "Example usage:",
2752         "content": "curl https://{domain}/api/chat/internal/messages -v -u {name}:{password}",
2753         "type": "json"
2754       }
2755     ],
2756     "name": "GetMessages",
2757     "group": "Chat_Internal_Messages",
2758     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
2759     "version": "0.0.0",
2760     "filename": "server/api/chatInternalMessage/index.js",
2761     "groupTitle": "Chat_Internal_Messages"
2762   },
2763   {
2764     "type": "get",
2765     "url": "/api/chat/internal/messages/{id}",
2766     "title": "Gets a single Message",
2767     "examples": [
2768       {
2769         "title": "Example usage:",
2770         "content": "curl https://{domain}/api/chat/internal/messages/{id} -v -u {name}:{password}",
2771         "type": "json"
2772       }
2773     ],
2774     "name": "ShowMessages",
2775     "group": "Chat_Internal_Messages",
2776     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2777     "version": "0.0.0",
2778     "filename": "server/api/chatInternalMessage/index.js",
2779     "groupTitle": "Chat_Internal_Messages"
2780   },
2781   {
2782     "type": "put",
2783     "url": "/api/chat/internal/messages/{id}",
2784     "title": "Update an existing Message",
2785     "examples": [
2786       {
2787         "title": "Example usage:",
2788         "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",
2789         "type": "json"
2790       }
2791     ],
2792     "name": "updateMessages",
2793     "group": "Chat_Internal_Messages",
2794     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2795     "version": "0.0.0",
2796     "filename": "server/api/chatInternalMessage/index.js",
2797     "groupTitle": "Chat_Internal_Messages"
2798   },
2799   {
2800     "type": "post",
2801     "url": "/api/chat/messages",
2802     "title": "Creates a new Message",
2803     "examples": [
2804       {
2805         "title": "Example usage:",
2806         "content": "curl https://{domain}/api/chat/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2807         "type": "json"
2808       }
2809     ],
2810     "name": "CreateMessages",
2811     "group": "Chat_Messages",
2812     "parameter": {
2813       "fields": {
2814         "Body": [
2815           {
2816             "group": "Body",
2817             "type": "Text",
2818             "optional": false,
2819             "field": "body",
2820             "description": ""
2821           },
2822           {
2823             "group": "Body",
2824             "type": "Boolean",
2825             "optional": true,
2826             "field": "read",
2827             "description": ""
2828           },
2829           {
2830             "group": "Body",
2831             "type": "Boolean",
2832             "optional": true,
2833             "field": "secret",
2834             "description": ""
2835           },
2836           {
2837             "group": "Body",
2838             "type": "String",
2839             "allowedValues": [
2840               "\"in\"",
2841               "\"out\""
2842             ],
2843             "optional": false,
2844             "field": "direction",
2845             "description": ""
2846           },
2847           {
2848             "group": "Body",
2849             "type": "String",
2850             "optional": true,
2851             "field": "readAt",
2852             "description": ""
2853           },
2854           {
2855             "group": "Body",
2856             "type": "String",
2857             "optional": true,
2858             "field": "providerName",
2859             "description": ""
2860           },
2861           {
2862             "group": "Body",
2863             "type": "Text",
2864             "optional": true,
2865             "field": "providerResponse",
2866             "description": ""
2867           }
2868         ]
2869       }
2870     },
2871     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2872     "version": "0.0.0",
2873     "filename": "server/api/chatMessage/index.js",
2874     "groupTitle": "Chat_Messages"
2875   },
2876   {
2877     "type": "delete",
2878     "url": "/api/chat/messages/{id}",
2879     "title": "Deletes a Message",
2880     "examples": [
2881       {
2882         "title": "Example usage:",
2883         "content": "curl https://{domain}/api/chat/messages/{id} -v -u {name}:{password} -X DELETE",
2884         "type": "json"
2885       }
2886     ],
2887     "name": "DeleteMessages",
2888     "group": "Chat_Messages",
2889     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2890     "version": "0.0.0",
2891     "filename": "server/api/chatMessage/index.js",
2892     "groupTitle": "Chat_Messages"
2893   },
2894   {
2895     "type": "get",
2896     "url": "/api/chat/messages/describe",
2897     "title": "Gets table info about Messages",
2898     "examples": [
2899       {
2900         "title": "Example usage:",
2901         "content": "curl https://{domain}/api/chat/messages/describe -v -u {name}:{password}",
2902         "type": "json"
2903       }
2904     ],
2905     "name": "DescribeMessages",
2906     "group": "Chat_Messages",
2907     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2908     "version": "0.0.0",
2909     "filename": "server/api/chatMessage/index.js",
2910     "groupTitle": "Chat_Messages"
2911   },
2912   {
2913     "type": "get",
2914     "url": "/api/chat/messages",
2915     "title": "Gets a list of Messages",
2916     "examples": [
2917       {
2918         "title": "Example usage:",
2919         "content": "curl https://{domain}/api/chat/messages -v -u {name}:{password}",
2920         "type": "json"
2921       }
2922     ],
2923     "name": "GetMessages",
2924     "group": "Chat_Messages",
2925     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
2926     "version": "0.0.0",
2927     "filename": "server/api/chatMessage/index.js",
2928     "groupTitle": "Chat_Messages"
2929   },
2930   {
2931     "type": "get",
2932     "url": "/api/chat/messages/{id}",
2933     "title": "Gets a single Message",
2934     "examples": [
2935       {
2936         "title": "Example usage:",
2937         "content": "curl https://{domain}/api/chat/messages/{id} -v -u {name}:{password}",
2938         "type": "json"
2939       }
2940     ],
2941     "name": "ShowMessages",
2942     "group": "Chat_Messages",
2943     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2944     "version": "0.0.0",
2945     "filename": "server/api/chatMessage/index.js",
2946     "groupTitle": "Chat_Messages"
2947   },
2948   {
2949     "type": "put",
2950     "url": "/api/chat/messages/{id}",
2951     "title": "Update an existing Message",
2952     "examples": [
2953       {
2954         "title": "Example usage:",
2955         "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",
2956         "type": "json"
2957       }
2958     ],
2959     "name": "updateMessages",
2960     "group": "Chat_Messages",
2961     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2962     "version": "0.0.0",
2963     "filename": "server/api/chatMessage/index.js",
2964     "groupTitle": "Chat_Messages"
2965   },
2966   {
2967     "type": "post",
2968     "url": "/api/chat/offline_messages",
2969     "title": "Creates a new OfflineMessage",
2970     "examples": [
2971       {
2972         "title": "Example usage:",
2973         "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",
2974         "type": "json"
2975       }
2976     ],
2977     "name": "CreateOfflineMessages",
2978     "group": "Chat_Offline_Messages",
2979     "parameter": {
2980       "fields": {
2981         "Body": [
2982           {
2983             "group": "Body",
2984             "type": "Text",
2985             "optional": false,
2986             "field": "body",
2987             "description": ""
2988           }
2989         ]
2990       }
2991     },
2992     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2993     "version": "0.0.0",
2994     "filename": "server/api/chatOfflineMessage/index.js",
2995     "groupTitle": "Chat_Offline_Messages"
2996   },
2997   {
2998     "type": "delete",
2999     "url": "/api/chat/offline_messages/{id}",
3000     "title": "Deletes a OfflineMessage",
3001     "examples": [
3002       {
3003         "title": "Example usage:",
3004         "content": "curl https://{domain}/api/chat/offline_messages/{id} -v -u {name}:{password} -X DELETE",
3005         "type": "json"
3006       }
3007     ],
3008     "name": "DeleteOfflineMessages",
3009     "group": "Chat_Offline_Messages",
3010     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3011     "version": "0.0.0",
3012     "filename": "server/api/chatOfflineMessage/index.js",
3013     "groupTitle": "Chat_Offline_Messages"
3014   },
3015   {
3016     "type": "get",
3017     "url": "/api/chat/offline_messages/describe",
3018     "title": "Gets table info about OfflineMessages",
3019     "examples": [
3020       {
3021         "title": "Example usage:",
3022         "content": "curl https://{domain}/api/chat/offline_messages/describe -v -u {name}:{password}",
3023         "type": "json"
3024       }
3025     ],
3026     "name": "DescribeOfflineMessages",
3027     "group": "Chat_Offline_Messages",
3028     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3029     "version": "0.0.0",
3030     "filename": "server/api/chatOfflineMessage/index.js",
3031     "groupTitle": "Chat_Offline_Messages"
3032   },
3033   {
3034     "type": "get",
3035     "url": "/api/chat/offline_messages",
3036     "title": "Gets a list of OfflineMessages",
3037     "examples": [
3038       {
3039         "title": "Example usage:",
3040         "content": "curl https://{domain}/api/chat/offline_messages -v -u {name}:{password}",
3041         "type": "json"
3042       }
3043     ],
3044     "name": "GetOfflineMessages",
3045     "group": "Chat_Offline_Messages",
3046     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
3047     "version": "0.0.0",
3048     "filename": "server/api/chatOfflineMessage/index.js",
3049     "groupTitle": "Chat_Offline_Messages"
3050   },
3051   {
3052     "type": "get",
3053     "url": "/api/chat/offline_messages/{id}",
3054     "title": "Gets a single OfflineMessage",
3055     "examples": [
3056       {
3057         "title": "Example usage:",
3058         "content": "curl https://{domain}/api/chat/offline_messages/{id} -v -u {name}:{password}",
3059         "type": "json"
3060       }
3061     ],
3062     "name": "ShowOfflineMessages",
3063     "group": "Chat_Offline_Messages",
3064     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3065     "version": "0.0.0",
3066     "filename": "server/api/chatOfflineMessage/index.js",
3067     "groupTitle": "Chat_Offline_Messages"
3068   },
3069   {
3070     "type": "put",
3071     "url": "/api/chat/offline_messages/{id}",
3072     "title": "Update an existing OfflineMessage",
3073     "examples": [
3074       {
3075         "title": "Example usage:",
3076         "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",
3077         "type": "json"
3078       }
3079     ],
3080     "name": "updateOfflineMessages",
3081     "group": "Chat_Offline_Messages",
3082     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3083     "version": "0.0.0",
3084     "filename": "server/api/chatOfflineMessage/index.js",
3085     "groupTitle": "Chat_Offline_Messages"
3086   },
3087   {
3088     "type": "post",
3089     "url": "/api/chat/proactive_actions",
3090     "title": "Creates a new Proactive Action",
3091     "examples": [
3092       {
3093         "title": "Example usage:",
3094         "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",
3095         "type": "json"
3096       }
3097     ],
3098     "name": "CreateProactive_Actions",
3099     "group": "Chat_Proactive_Actions",
3100     "parameter": {
3101       "fields": {
3102         "Body": [
3103           {
3104             "group": "Body",
3105             "type": "String",
3106             "optional": false,
3107             "field": "name",
3108             "description": ""
3109           },
3110           {
3111             "group": "Body",
3112             "type": "String",
3113             "allowedValues": [
3114               "\"mouseOver\"",
3115               "\"timeout\""
3116             ],
3117             "optional": true,
3118             "field": "type",
3119             "description": ""
3120           },
3121           {
3122             "group": "Body",
3123             "type": "String",
3124             "optional": true,
3125             "field": "selector",
3126             "description": ""
3127           },
3128           {
3129             "group": "Body",
3130             "type": "Integer",
3131             "optional": true,
3132             "field": "timeout",
3133             "description": ""
3134           }
3135         ]
3136       }
3137     },
3138     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3139     "version": "0.0.0",
3140     "filename": "server/api/chatProactiveAction/index.js",
3141     "groupTitle": "Chat_Proactive_Actions"
3142   },
3143   {
3144     "type": "delete",
3145     "url": "/api/chat/proactive_actions/{id}",
3146     "title": "Deletes a Proactive Action",
3147     "examples": [
3148       {
3149         "title": "Example usage:",
3150         "content": "curl https://{domain}/api/chat/proactive_actions/{id} -v -u {name}:{password} -X DELETE",
3151         "type": "json"
3152       }
3153     ],
3154     "name": "DeleteProactive_Actions",
3155     "group": "Chat_Proactive_Actions",
3156     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3157     "version": "0.0.0",
3158     "filename": "server/api/chatProactiveAction/index.js",
3159     "groupTitle": "Chat_Proactive_Actions"
3160   },
3161   {
3162     "type": "get",
3163     "url": "/api/chat/proactive_actions/{id}",
3164     "title": "Gets a single Proactive Action",
3165     "examples": [
3166       {
3167         "title": "Example usage:",
3168         "content": "curl https://{domain}/api/chat/proactive_actions/{id} -v -u {name}:{password}",
3169         "type": "json"
3170       }
3171     ],
3172     "name": "ShowProactive_Actions",
3173     "group": "Chat_Proactive_Actions",
3174     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3175     "version": "0.0.0",
3176     "filename": "server/api/chatProactiveAction/index.js",
3177     "groupTitle": "Chat_Proactive_Actions"
3178   },
3179   {
3180     "type": "put",
3181     "url": "/api/chat/proactive_actions/{id}",
3182     "title": "Update an existing Proactive Action",
3183     "examples": [
3184       {
3185         "title": "Example usage:",
3186         "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",
3187         "type": "json"
3188       }
3189     ],
3190     "name": "updateProactive_Actions",
3191     "group": "Chat_Proactive_Actions",
3192     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3193     "version": "0.0.0",
3194     "filename": "server/api/chatProactiveAction/index.js",
3195     "groupTitle": "Chat_Proactive_Actions"
3196   },
3197   {
3198     "type": "post",
3199     "url": "/api/chat/reports/queue",
3200     "title": "Creates a new Chat Queue Report",
3201     "examples": [
3202       {
3203         "title": "Example usage:",
3204         "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",
3205         "type": "json"
3206       }
3207     ],
3208     "name": "CreateChat_Queue_Reports",
3209     "group": "Chat_Queue_Reports",
3210     "parameter": {
3211       "fields": {
3212         "Body": [
3213           {
3214             "group": "Body",
3215             "type": "String",
3216             "optional": false,
3217             "field": "uniqueid",
3218             "description": ""
3219           },
3220           {
3221             "group": "Body",
3222             "type": "String",
3223             "optional": true,
3224             "field": "from",
3225             "description": ""
3226           },
3227           {
3228             "group": "Body",
3229             "type": "String",
3230             "optional": true,
3231             "field": "joinAt",
3232             "description": ""
3233           },
3234           {
3235             "group": "Body",
3236             "type": "String",
3237             "optional": true,
3238             "field": "leaveAt",
3239             "description": ""
3240           },
3241           {
3242             "group": "Body",
3243             "type": "String",
3244             "optional": true,
3245             "field": "acceptAt",
3246             "description": ""
3247           },
3248           {
3249             "group": "Body",
3250             "type": "String",
3251             "optional": true,
3252             "field": "exitAt",
3253             "description": ""
3254           },
3255           {
3256             "group": "Body",
3257             "type": "String",
3258             "optional": true,
3259             "field": "reason",
3260             "description": ""
3261           }
3262         ]
3263       }
3264     },
3265     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3266     "version": "0.0.0",
3267     "filename": "server/api/chatQueueReport/index.js",
3268     "groupTitle": "Chat_Queue_Reports"
3269   },
3270   {
3271     "type": "delete",
3272     "url": "/api/chat/reports/queue/{id}",
3273     "title": "Deletes a Chat Queue Report",
3274     "examples": [
3275       {
3276         "title": "Example usage:",
3277         "content": "curl https://{domain}/api/chat/reports/queue/{id} -v -u {name}:{password} -X DELETE",
3278         "type": "json"
3279       }
3280     ],
3281     "name": "DeleteChat_Queue_Reports",
3282     "group": "Chat_Queue_Reports",
3283     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3284     "version": "0.0.0",
3285     "filename": "server/api/chatQueueReport/index.js",
3286     "groupTitle": "Chat_Queue_Reports"
3287   },
3288   {
3289     "type": "get",
3290     "url": "/api/chat/reports/queue/describe",
3291     "title": "Gets table info about Chat Queue Reports",
3292     "examples": [
3293       {
3294         "title": "Example usage:",
3295         "content": "curl https://{domain}/api/chat/reports/queue/describe -v -u {name}:{password}",
3296         "type": "json"
3297       }
3298     ],
3299     "name": "DescribeChat_Queue_Reports",
3300     "group": "Chat_Queue_Reports",
3301     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3302     "version": "0.0.0",
3303     "filename": "server/api/chatQueueReport/index.js",
3304     "groupTitle": "Chat_Queue_Reports"
3305   },
3306   {
3307     "type": "get",
3308     "url": "/api/chat/reports/queue",
3309     "title": "Gets a list of Chat Queue Reports",
3310     "examples": [
3311       {
3312         "title": "Example usage:",
3313         "content": "curl https://{domain}/api/chat/reports/queue -v -u {name}:{password}",
3314         "type": "json"
3315       }
3316     ],
3317     "name": "GetChat_Queue_Reports",
3318     "group": "Chat_Queue_Reports",
3319     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
3320     "version": "0.0.0",
3321     "filename": "server/api/chatQueueReport/index.js",
3322     "groupTitle": "Chat_Queue_Reports"
3323   },
3324   {
3325     "type": "get",
3326     "url": "/api/chat/reports/queue/{id}",
3327     "title": "Gets a single Chat Queue Report",
3328     "examples": [
3329       {
3330         "title": "Example usage:",
3331         "content": "curl https://{domain}/api/chat/reports/queue/{id} -v -u {name}:{password}",
3332         "type": "json"
3333       }
3334     ],
3335     "name": "ShowChat_Queue_Reports",
3336     "group": "Chat_Queue_Reports",
3337     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3338     "version": "0.0.0",
3339     "filename": "server/api/chatQueueReport/index.js",
3340     "groupTitle": "Chat_Queue_Reports"
3341   },
3342   {
3343     "type": "put",
3344     "url": "/api/chat/reports/queue/{id}",
3345     "title": "Update an existing Chat Queue Report",
3346     "examples": [
3347       {
3348         "title": "Example usage:",
3349         "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",
3350         "type": "json"
3351       }
3352     ],
3353     "name": "updateChat_Queue_Reports",
3354     "group": "Chat_Queue_Reports",
3355     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3356     "version": "0.0.0",
3357     "filename": "server/api/chatQueueReport/index.js",
3358     "groupTitle": "Chat_Queue_Reports"
3359   },
3360   {
3361     "type": "post",
3362     "url": "/api/chat/queues/{id}/users",
3363     "title": "Add agents to a queue",
3364     "examples": [
3365       {
3366         "title": "Example usage:",
3367         "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",
3368         "type": "json"
3369       }
3370     ],
3371     "name": "AddAgents",
3372     "group": "Chat_Queues",
3373     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3374     "version": "0.0.0",
3375     "filename": "server/api/chatQueue/index.js",
3376     "groupTitle": "Chat_Queues"
3377   },
3378   {
3379     "type": "post",
3380     "url": "/api/chat/queues/{id}/teams",
3381     "title": "Add teams to a queue",
3382     "examples": [
3383       {
3384         "title": "Example usage:",
3385         "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",
3386         "type": "json"
3387       }
3388     ],
3389     "name": "AddTeams",
3390     "group": "Chat_Queues",
3391     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3392     "version": "0.0.0",
3393     "filename": "server/api/chatQueue/index.js",
3394     "groupTitle": "Chat_Queues"
3395   },
3396   {
3397     "type": "post",
3398     "url": "/api/chat/queues",
3399     "title": "Creates a new Queue",
3400     "examples": [
3401       {
3402         "title": "Example usage:",
3403         "content": "curl https://{domain}/api/chat/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3404         "type": "json"
3405       }
3406     ],
3407     "name": "CreateQueues",
3408     "group": "Chat_Queues",
3409     "parameter": {
3410       "fields": {
3411         "Body": [
3412           {
3413             "group": "Body",
3414             "type": "String",
3415             "optional": false,
3416             "field": "name",
3417             "description": ""
3418           },
3419           {
3420             "group": "Body",
3421             "type": "String",
3422             "optional": true,
3423             "field": "description",
3424             "description": ""
3425           },
3426           {
3427             "group": "Body",
3428             "type": "Integer",
3429             "optional": true,
3430             "field": "timeout",
3431             "description": ""
3432           },
3433           {
3434             "group": "Body",
3435             "type": "String",
3436             "allowedValues": [
3437               "\"rrmemory\"",
3438               "\"beepall\"",
3439               "\"roundrobin\""
3440             ],
3441             "optional": true,
3442             "field": "strategy",
3443             "description": ""
3444           }
3445         ]
3446       }
3447     },
3448     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3449     "version": "0.0.0",
3450     "filename": "server/api/chatQueue/index.js",
3451     "groupTitle": "Chat_Queues"
3452   },
3453   {
3454     "type": "delete",
3455     "url": "/api/chat/queues/{id}",
3456     "title": "Deletes a Queue",
3457     "examples": [
3458       {
3459         "title": "Example usage:",
3460         "content": "curl https://{domain}/api/chat/queues/{id} -v -u {name}:{password} -X DELETE",
3461         "type": "json"
3462       }
3463     ],
3464     "name": "DeleteQueues",
3465     "group": "Chat_Queues",
3466     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3467     "version": "0.0.0",
3468     "filename": "server/api/chatQueue/index.js",
3469     "groupTitle": "Chat_Queues"
3470   },
3471   {
3472     "type": "get",
3473     "url": "/api/chat/queues/describe",
3474     "title": "Gets table info about Queues",
3475     "examples": [
3476       {
3477         "title": "Example usage:",
3478         "content": "curl https://{domain}/api/chat/queues/describe -v -u {name}:{password}",
3479         "type": "json"
3480       }
3481     ],
3482     "name": "DescribeQueues",
3483     "group": "Chat_Queues",
3484     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3485     "version": "0.0.0",
3486     "filename": "server/api/chatQueue/index.js",
3487     "groupTitle": "Chat_Queues"
3488   },
3489   {
3490     "type": "get",
3491     "url": "/api/chat/queues/{id}/users",
3492     "title": "Gets queue agents",
3493     "examples": [
3494       {
3495         "title": "Example usage:",
3496         "content": "curl https://{domain}/api/chat/queues/{id}/users -v -u {name}:{password} -X POST",
3497         "type": "json"
3498       }
3499     ],
3500     "name": "GetAgents",
3501     "group": "Chat_Queues",
3502     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3503     "version": "0.0.0",
3504     "filename": "server/api/chatQueue/index.js",
3505     "groupTitle": "Chat_Queues"
3506   },
3507   {
3508     "type": "get",
3509     "url": "/api/chat/queues/{id}/members",
3510     "title": "GetMembers",
3511     "examples": [
3512       {
3513         "title": "Example usage:",
3514         "content": "curl https://{domain}/api/chat/queues/{id}/members  -v -u {name}:{password}",
3515         "type": "json"
3516       }
3517     ],
3518     "name": "GetMembers",
3519     "group": "Chat_Queues",
3520     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3521     "version": "0.0.0",
3522     "filename": "server/api/chatQueue/index.js",
3523     "groupTitle": "Chat_Queues"
3524   },
3525   {
3526     "type": "get",
3527     "url": "/api/chat/queues",
3528     "title": "Gets a list of Queues",
3529     "examples": [
3530       {
3531         "title": "Example usage:",
3532         "content": "curl https://{domain}/api/chat/queues -v -u {name}:{password}",
3533         "type": "json"
3534       }
3535     ],
3536     "name": "GetQueues",
3537     "group": "Chat_Queues",
3538     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
3539     "version": "0.0.0",
3540     "filename": "server/api/chatQueue/index.js",
3541     "groupTitle": "Chat_Queues"
3542   },
3543   {
3544     "type": "get",
3545     "url": "/api/chat/queues/{id}/teams",
3546     "title": "Gets queues list",
3547     "examples": [
3548       {
3549         "title": "Example usage:",
3550         "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password}",
3551         "type": "json"
3552       }
3553     ],
3554     "name": "GetTeams",
3555     "group": "Chat_Queues",
3556     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3557     "version": "0.0.0",
3558     "filename": "server/api/chatQueue/index.js",
3559     "groupTitle": "Chat_Queues"
3560   },
3561   {
3562     "type": "delete",
3563     "url": "/api/chat/queues/{id}/users",
3564     "title": "Removes agents from a queue",
3565     "examples": [
3566       {
3567         "title": "Example usage:",
3568         "content": "curl https://{domain}/api/chat/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
3569         "type": "json"
3570       }
3571     ],
3572     "name": "RemoveAgents",
3573     "group": "Chat_Queues",
3574     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3575     "version": "0.0.0",
3576     "filename": "server/api/chatQueue/index.js",
3577     "groupTitle": "Chat_Queues"
3578   },
3579   {
3580     "type": "get",
3581     "url": "/api/chat/queues/{id}",
3582     "title": "Gets a single Queue",
3583     "examples": [
3584       {
3585         "title": "Example usage:",
3586         "content": "curl https://{domain}/api/chat/queues/{id} -v -u {name}:{password}",
3587         "type": "json"
3588       }
3589     ],
3590     "name": "ShowQueues",
3591     "group": "Chat_Queues",
3592     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3593     "version": "0.0.0",
3594     "filename": "server/api/chatQueue/index.js",
3595     "groupTitle": "Chat_Queues"
3596   },
3597   {
3598     "type": "put",
3599     "url": "/api/chat/queues/{id}",
3600     "title": "Update an existing Queue",
3601     "examples": [
3602       {
3603         "title": "Example usage:",
3604         "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",
3605         "type": "json"
3606       }
3607     ],
3608     "name": "updateQueues",
3609     "group": "Chat_Queues",
3610     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3611     "version": "0.0.0",
3612     "filename": "server/api/chatQueue/index.js",
3613     "groupTitle": "Chat_Queues"
3614   },
3615   {
3616     "type": "post",
3617     "url": "/api/chat/reports/transfer",
3618     "title": "Creates a new Chat Transfer Report",
3619     "examples": [
3620       {
3621         "title": "Example usage:",
3622         "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",
3623         "type": "json"
3624       }
3625     ],
3626     "name": "CreateChat_Transfer_Reports",
3627     "group": "Chat_Transfer_Reports",
3628     "parameter": {
3629       "fields": {
3630         "Body": [
3631           {
3632             "group": "Body",
3633             "type": "String",
3634             "optional": false,
3635             "field": "uniqueid",
3636             "description": ""
3637           },
3638           {
3639             "group": "Body",
3640             "type": "String",
3641             "allowedValues": [
3642               "\"account\"",
3643               "\"agent\"",
3644               "\"queue\""
3645             ],
3646             "optional": false,
3647             "field": "type",
3648             "description": ""
3649           },
3650           {
3651             "group": "Body",
3652             "type": "String",
3653             "optional": false,
3654             "field": "transferredAt",
3655             "description": ""
3656           }
3657         ]
3658       }
3659     },
3660     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3661     "version": "0.0.0",
3662     "filename": "server/api/chatTransferReport/index.js",
3663     "groupTitle": "Chat_Transfer_Reports"
3664   },
3665   {
3666     "type": "delete",
3667     "url": "/api/chat/reports/transfer/{id}",
3668     "title": "Deletes a Chat Transfer Report",
3669     "examples": [
3670       {
3671         "title": "Example usage:",
3672         "content": "curl https://{domain}/api/chat/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
3673         "type": "json"
3674       }
3675     ],
3676     "name": "DeleteChat_Transfer_Reports",
3677     "group": "Chat_Transfer_Reports",
3678     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3679     "version": "0.0.0",
3680     "filename": "server/api/chatTransferReport/index.js",
3681     "groupTitle": "Chat_Transfer_Reports"
3682   },
3683   {
3684     "type": "get",
3685     "url": "/api/chat/reports/transfer/describe",
3686     "title": "Gets table info about Chat Transfer Reports",
3687     "examples": [
3688       {
3689         "title": "Example usage:",
3690         "content": "curl https://{domain}/api/chat/reports/transfer/describe -v -u {name}:{password}",
3691         "type": "json"
3692       }
3693     ],
3694     "name": "DescribeChat_Transfer_Reports",
3695     "group": "Chat_Transfer_Reports",
3696     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3697     "version": "0.0.0",
3698     "filename": "server/api/chatTransferReport/index.js",
3699     "groupTitle": "Chat_Transfer_Reports"
3700   },
3701   {
3702     "type": "get",
3703     "url": "/api/chat/reports/transfer",
3704     "title": "Gets a list of Chat Transfer Reports",
3705     "examples": [
3706       {
3707         "title": "Example usage:",
3708         "content": "curl https://{domain}/api/chat/reports/transfer -v -u {name}:{password}",
3709         "type": "json"
3710       }
3711     ],
3712     "name": "GetChat_Transfer_Reports",
3713     "group": "Chat_Transfer_Reports",
3714     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
3715     "version": "0.0.0",
3716     "filename": "server/api/chatTransferReport/index.js",
3717     "groupTitle": "Chat_Transfer_Reports"
3718   },
3719   {
3720     "type": "get",
3721     "url": "/api/chat/reports/transfer/{id}",
3722     "title": "Gets a single Chat Transfer Report",
3723     "examples": [
3724       {
3725         "title": "Example usage:",
3726         "content": "curl https://{domain}/api/chat/reports/transfer/{id} -v -u {name}:{password}",
3727         "type": "json"
3728       }
3729     ],
3730     "name": "ShowChat_Transfer_Reports",
3731     "group": "Chat_Transfer_Reports",
3732     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3733     "version": "0.0.0",
3734     "filename": "server/api/chatTransferReport/index.js",
3735     "groupTitle": "Chat_Transfer_Reports"
3736   },
3737   {
3738     "type": "put",
3739     "url": "/api/chat/reports/transfer/{id}",
3740     "title": "Update an existing Chat Transfer Report",
3741     "examples": [
3742       {
3743         "title": "Example usage:",
3744         "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",
3745         "type": "json"
3746       }
3747     ],
3748     "name": "updateChat_Transfer_Reports",
3749     "group": "Chat_Transfer_Reports",
3750     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3751     "version": "0.0.0",
3752     "filename": "server/api/chatTransferReport/index.js",
3753     "groupTitle": "Chat_Transfer_Reports"
3754   },
3755   {
3756     "type": "post",
3757     "url": "/api/chat/websites/{id}/users",
3758     "title": "Add agents to a website",
3759     "examples": [
3760       {
3761         "title": "Example usage:",
3762         "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",
3763         "type": "json"
3764       }
3765     ],
3766     "name": "AddAgents",
3767     "group": "Chat_Websites",
3768     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3769     "version": "0.0.0",
3770     "filename": "server/api/chatWebsite/index.js",
3771     "groupTitle": "Chat_Websites"
3772   },
3773   {
3774     "type": "post",
3775     "url": "/api/chat/websites",
3776     "title": "Creates a new Website",
3777     "examples": [
3778       {
3779         "title": "Example usage:",
3780         "content": "curl https://{domain}/api/chat/websites -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3781         "type": "json"
3782       }
3783     ],
3784     "name": "CreateWebsites",
3785     "group": "Chat_Websites",
3786     "parameter": {
3787       "fields": {
3788         "Body": [
3789           {
3790             "group": "Body",
3791             "type": "String",
3792             "optional": false,
3793             "field": "name",
3794             "description": ""
3795           },
3796           {
3797             "group": "Body",
3798             "type": "String",
3799             "optional": false,
3800             "field": "address",
3801             "description": ""
3802           },
3803           {
3804             "group": "Body",
3805             "type": "String",
3806             "optional": true,
3807             "field": "description",
3808             "description": ""
3809           },
3810           {
3811             "group": "Body",
3812             "type": "String",
3813             "optional": true,
3814             "field": "mapKey",
3815             "description": ""
3816           },
3817           {
3818             "group": "Body",
3819             "type": "String",
3820             "optional": true,
3821             "field": "mapKeyOffline",
3822             "description": ""
3823           },
3824           {
3825             "group": "Body",
3826             "type": "String",
3827             "optional": false,
3828             "field": "key",
3829             "description": ""
3830           },
3831           {
3832             "group": "Body",
3833             "type": "String",
3834             "optional": true,
3835             "field": "agentAlias",
3836             "description": ""
3837           },
3838           {
3839             "group": "Body",
3840             "type": "String",
3841             "optional": true,
3842             "field": "customerAlias",
3843             "description": ""
3844           },
3845           {
3846             "group": "Body",
3847             "type": "String",
3848             "optional": false,
3849             "field": "color",
3850             "description": ""
3851           },
3852           {
3853             "group": "Body",
3854             "type": "String",
3855             "optional": false,
3856             "field": "color_button",
3857             "description": ""
3858           },
3859           {
3860             "group": "Body",
3861             "type": "String",
3862             "optional": false,
3863             "field": "textColor",
3864             "description": ""
3865           },
3866           {
3867             "group": "Body",
3868             "type": "Integer",
3869             "optional": true,
3870             "field": "fontSize",
3871             "description": ""
3872           },
3873           {
3874             "group": "Body",
3875             "type": "String",
3876             "optional": true,
3877             "field": "remote",
3878             "description": ""
3879           },
3880           {
3881             "group": "Body",
3882             "type": "Boolean",
3883             "optional": true,
3884             "field": "animation",
3885             "description": ""
3886           },
3887           {
3888             "group": "Body",
3889             "type": "String",
3890             "allowedValues": [
3891               "\"rounded\"",
3892               "\"squared\""
3893             ],
3894             "optional": true,
3895             "field": "header_shape",
3896             "description": ""
3897           },
3898           {
3899             "group": "Body",
3900             "type": "String",
3901             "optional": true,
3902             "field": "header_online",
3903             "description": ""
3904           },
3905           {
3906             "group": "Body",
3907             "type": "String",
3908             "optional": true,
3909             "field": "start_chat_button",
3910             "description": ""
3911           },
3912           {
3913             "group": "Body",
3914             "type": "String",
3915             "optional": true,
3916             "field": "offline_chat_button",
3917             "description": ""
3918           },
3919           {
3920             "group": "Body",
3921             "type": "String",
3922             "optional": true,
3923             "field": "header_offline",
3924             "description": ""
3925           },
3926           {
3927             "group": "Body",
3928             "type": "Boolean",
3929             "optional": true,
3930             "field": "download_transcript",
3931             "description": ""
3932           },
3933           {
3934             "group": "Body",
3935             "type": "Integer",
3936             "optional": true,
3937             "field": "timeout",
3938             "description": ""
3939           },
3940           {
3941             "group": "Body",
3942             "type": "String",
3943             "optional": true,
3944             "field": "whiteLabel",
3945             "description": ""
3946           },
3947           {
3948             "group": "Body",
3949             "type": "Boolean",
3950             "optional": true,
3951             "field": "defaultWhiteLabel",
3952             "description": ""
3953           },
3954           {
3955             "group": "Body",
3956             "type": "Text",
3957             "optional": true,
3958             "field": "sitepic",
3959             "description": ""
3960           },
3961           {
3962             "group": "Body",
3963             "type": "String",
3964             "optional": true,
3965             "field": "closingQuestion",
3966             "description": ""
3967           },
3968           {
3969             "group": "Body",
3970             "type": "String",
3971             "optional": true,
3972             "field": "formSubmitSuccessMessage",
3973             "description": ""
3974           },
3975           {
3976             "group": "Body",
3977             "type": "String",
3978             "optional": true,
3979             "field": "formSubmitFailureMessage",
3980             "description": ""
3981           },
3982           {
3983             "group": "Body",
3984             "type": "String",
3985             "optional": true,
3986             "field": "noteTitle",
3987             "description": ""
3988           },
3989           {
3990             "group": "Body",
3991             "type": "String",
3992             "optional": true,
3993             "field": "placeholderMessage",
3994             "description": ""
3995           },
3996           {
3997             "group": "Body",
3998             "type": "String",
3999             "optional": true,
4000             "field": "closingMessage",
4001             "description": ""
4002           },
4003           {
4004             "group": "Body",
4005             "type": "String",
4006             "optional": true,
4007             "field": "closingMessageButton",
4008             "description": ""
4009           },
4010           {
4011             "group": "Body",
4012             "type": "String",
4013             "optional": true,
4014             "field": "skipMessageButton",
4015             "description": ""
4016           },
4017           {
4018             "group": "Body",
4019             "type": "Boolean",
4020             "optional": true,
4021             "field": "conditionAgreement",
4022             "description": ""
4023           },
4024           {
4025             "group": "Body",
4026             "type": "Boolean",
4027             "optional": true,
4028             "field": "enableRating",
4029             "description": ""
4030           },
4031           {
4032             "group": "Body",
4033             "type": "Boolean",
4034             "optional": true,
4035             "field": "enableFeedback",
4036             "description": ""
4037           },
4038           {
4039             "group": "Body",
4040             "type": "Boolean",
4041             "optional": true,
4042             "field": "enableSendButton",
4043             "description": ""
4044           },
4045           {
4046             "group": "Body",
4047             "type": "String",
4048             "optional": true,
4049             "field": "feedbackTitle",
4050             "description": ""
4051           },
4052           {
4053             "group": "Body",
4054             "type": "String",
4055             "allowedValues": [
4056               "\"star\"",
4057               "\"thumb\""
4058             ],
4059             "optional": true,
4060             "field": "ratingType",
4061             "description": ""
4062           },
4063           {
4064             "group": "Body",
4065             "type": "Integer",
4066             "optional": true,
4067             "field": "ratingStarsNumber",
4068             "description": ""
4069           },
4070           {
4071             "group": "Body",
4072             "type": "Text",
4073             "optional": true,
4074             "field": "onlineForm",
4075             "description": ""
4076           },
4077           {
4078             "group": "Body",
4079             "type": "Text",
4080             "optional": true,
4081             "field": "offlineForm",
4082             "description": ""
4083           },
4084           {
4085             "group": "Body",
4086             "type": "String",
4087             "optional": true,
4088             "field": "token",
4089             "description": ""
4090           },
4091           {
4092             "group": "Body",
4093             "type": "Boolean",
4094             "optional": true,
4095             "field": "autoclose",
4096             "description": ""
4097           },
4098           {
4099             "group": "Body",
4100             "type": "Boolean",
4101             "optional": true,
4102             "field": "enableCustomerWriting",
4103             "description": ""
4104           },
4105           {
4106             "group": "Body",
4107             "type": "Boolean",
4108             "optional": true,
4109             "field": "forwardTranscript",
4110             "description": ""
4111           },
4112           {
4113             "group": "Body",
4114             "type": "String",
4115             "optional": true,
4116             "field": "forwardTranscriptMessage",
4117             "description": ""
4118           },
4119           {
4120             "group": "Body",
4121             "type": "Boolean",
4122             "optional": true,
4123             "field": "forwardOffline",
4124             "description": ""
4125           },
4126           {
4127             "group": "Body",
4128             "type": "String",
4129             "optional": true,
4130             "field": "forwardOfflineAddress",
4131             "description": ""
4132           },
4133           {
4134             "group": "Body",
4135             "type": "String",
4136             "optional": true,
4137             "field": "waitingTitle",
4138             "description": ""
4139           },
4140           {
4141             "group": "Body",
4142             "type": "String",
4143             "optional": true,
4144             "field": "waitingMessage",
4145             "description": ""
4146           },
4147           {
4148             "group": "Body",
4149             "type": "String",
4150             "optional": true,
4151             "field": "offlineMessageSubject",
4152             "description": ""
4153           },
4154           {
4155             "group": "Body",
4156             "type": "String",
4157             "optional": true,
4158             "field": "offlineMessageBody",
4159             "description": ""
4160           },
4161           {
4162             "group": "Body",
4163             "type": "Boolean",
4164             "optional": true,
4165             "field": "enableUnmanagedNote",
4166             "description": ""
4167           },
4168           {
4169             "group": "Body",
4170             "type": "String",
4171             "optional": true,
4172             "field": "unmanagedMessage",
4173             "description": ""
4174           },
4175           {
4176             "group": "Body",
4177             "type": "String",
4178             "optional": true,
4179             "field": "skipUnmanaged",
4180             "description": ""
4181           },
4182           {
4183             "group": "Body",
4184             "type": "String",
4185             "optional": true,
4186             "field": "sendUnmanaged",
4187             "description": ""
4188           },
4189           {
4190             "group": "Body",
4191             "type": "Boolean",
4192             "optional": true,
4193             "field": "enableCustomerAttachment",
4194             "description": ""
4195           },
4196           {
4197             "group": "Body",
4198             "type": "Boolean",
4199             "optional": true,
4200             "field": "enableCustomerCheckmarks",
4201             "description": ""
4202           },
4203           {
4204             "group": "Body",
4205             "type": "Text",
4206             "optional": true,
4207             "field": "agentAvatar",
4208             "description": ""
4209           },
4210           {
4211             "group": "Body",
4212             "type": "Boolean",
4213             "optional": true,
4214             "field": "showAgentAvatar",
4215             "description": ""
4216           },
4217           {
4218             "group": "Body",
4219             "type": "String",
4220             "optional": true,
4221             "field": "timezone",
4222             "description": ""
4223           },
4224           {
4225             "group": "Body",
4226             "type": "Text",
4227             "optional": true,
4228             "field": "notificationTemplate",
4229             "description": ""
4230           },
4231           {
4232             "group": "Body",
4233             "type": "Boolean",
4234             "optional": true,
4235             "field": "notificationSound",
4236             "description": ""
4237           },
4238           {
4239             "group": "Body",
4240             "type": "Boolean",
4241             "optional": true,
4242             "field": "notificationShake",
4243             "description": ""
4244           },
4245           {
4246             "group": "Body",
4247             "type": "Boolean",
4248             "optional": true,
4249             "field": "hideWhenOffline",
4250             "description": ""
4251           },
4252           {
4253             "group": "Body",
4254             "type": "String",
4255             "optional": true,
4256             "field": "agentIdentifier",
4257             "description": ""
4258           },
4259           {
4260             "group": "Body",
4261             "type": "Integer",
4262             "optional": true,
4263             "field": "waitForTheAssignedAgent",
4264             "description": ""
4265           },
4266           {
4267             "group": "Body",
4268             "type": "String",
4269             "optional": true,
4270             "field": "alignment",
4271             "description": ""
4272           },
4273           {
4274             "group": "Body",
4275             "type": "Integer",
4276             "optional": true,
4277             "field": "verticalAlignment",
4278             "description": ""
4279           },
4280           {
4281             "group": "Body",
4282             "type": "String",
4283             "optional": true,
4284             "field": "messagesAlignment",
4285             "description": ""
4286           },
4287           {
4288             "group": "Body",
4289             "type": "String",
4290             "optional": true,
4291             "field": "defaultTitle",
4292             "description": ""
4293           },
4294           {
4295             "group": "Body",
4296             "type": "Text",
4297             "optional": true,
4298             "field": "customerAvatar",
4299             "description": ""
4300           },
4301           {
4302             "group": "Body",
4303             "type": "Boolean",
4304             "optional": true,
4305             "field": "showCustomerAvatar",
4306             "description": ""
4307           },
4308           {
4309             "group": "Body",
4310             "type": "Integer",
4311             "optional": true,
4312             "field": "messageFontSize",
4313             "description": ""
4314           },
4315           {
4316             "group": "Body",
4317             "type": "String",
4318             "optional": false,
4319             "field": "backgroundColor",
4320             "description": ""
4321           },
4322           {
4323             "group": "Body",
4324             "type": "Boolean",
4325             "optional": true,
4326             "field": "queueTransfer",
4327             "description": ""
4328           },
4329           {
4330             "group": "Body",
4331             "type": "Integer",
4332             "optional": true,
4333             "field": "queueTransferTimeout",
4334             "description": ""
4335           },
4336           {
4337             "group": "Body",
4338             "type": "Boolean",
4339             "optional": true,
4340             "field": "agentTransfer",
4341             "description": ""
4342           },
4343           {
4344             "group": "Body",
4345             "type": "Integer",
4346             "optional": true,
4347             "field": "agentTransferTimeout",
4348             "description": ""
4349           },
4350           {
4351             "group": "Body",
4352             "type": "String",
4353             "optional": true,
4354             "field": "systemAlias",
4355             "description": ""
4356           },
4357           {
4358             "group": "Body",
4359             "type": "Text",
4360             "optional": true,
4361             "field": "systemAvatar",
4362             "description": ""
4363           },
4364           {
4365             "group": "Body",
4366             "type": "Integer",
4367             "optional": true,
4368             "field": "mandatoryDispositionPauseId",
4369             "description": "<p>Status to put when mandatory disposition is enabled</p>"
4370           },
4371           {
4372             "group": "Body",
4373             "type": "Boolean",
4374             "optional": true,
4375             "field": "mandatoryDisposition",
4376             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
4377           },
4378           {
4379             "group": "Body",
4380             "type": "Boolean",
4381             "optional": true,
4382             "field": "vidaooEscalation",
4383             "description": ""
4384           },
4385           {
4386             "group": "Body",
4387             "type": "String",
4388             "optional": true,
4389             "field": "vidaooApiKey",
4390             "description": ""
4391           },
4392           {
4393             "group": "Body",
4394             "type": "String",
4395             "optional": false,
4396             "field": "vidaooTopic",
4397             "description": ""
4398           },
4399           {
4400             "group": "Body",
4401             "type": "String",
4402             "optional": true,
4403             "field": "vidaooNote",
4404             "description": ""
4405           },
4406           {
4407             "group": "Body",
4408             "type": "Text",
4409             "optional": true,
4410             "field": "vidaooMetadata",
4411             "description": ""
4412           },
4413           {
4414             "group": "Body",
4415             "type": "Boolean",
4416             "optional": true,
4417             "field": "openNewInteraction",
4418             "description": ""
4419           },
4420           {
4421             "group": "Body",
4422             "type": "Text",
4423             "optional": true,
4424             "field": "subjectOffline",
4425             "description": ""
4426           }
4427         ]
4428       }
4429     },
4430     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4431     "version": "0.0.0",
4432     "filename": "server/api/chatWebsite/index.js",
4433     "groupTitle": "Chat_Websites"
4434   },
4435   {
4436     "type": "delete",
4437     "url": "/api/chat/websites/{id}",
4438     "title": "Deletes a Website",
4439     "examples": [
4440       {
4441         "title": "Example usage:",
4442         "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password} -X DELETE",
4443         "type": "json"
4444       }
4445     ],
4446     "name": "DeleteWebsites",
4447     "group": "Chat_Websites",
4448     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4449     "version": "0.0.0",
4450     "filename": "server/api/chatWebsite/index.js",
4451     "groupTitle": "Chat_Websites"
4452   },
4453   {
4454     "type": "get",
4455     "url": "/api/chat/websites/describe",
4456     "title": "Gets table info about Websites",
4457     "examples": [
4458       {
4459         "title": "Example usage:",
4460         "content": "curl https://{domain}/api/chat/websites/describe -v -u {name}:{password}",
4461         "type": "json"
4462       }
4463     ],
4464     "name": "DescribeWebsites",
4465     "group": "Chat_Websites",
4466     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4467     "version": "0.0.0",
4468     "filename": "server/api/chatWebsite/index.js",
4469     "groupTitle": "Chat_Websites"
4470   },
4471   {
4472     "type": "get",
4473     "url": "/api/chat/websites/{id}/users",
4474     "title": "Gets agents from website",
4475     "examples": [
4476       {
4477         "title": "Example usage:",
4478         "content": "curl https://{domain}/api/chat/websites/{id}/users -v -u {name}:{password} -X GET",
4479         "type": "json"
4480       }
4481     ],
4482     "name": "GetAgents",
4483     "group": "Chat_Websites",
4484     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4485     "version": "0.0.0",
4486     "filename": "server/api/chatWebsite/index.js",
4487     "groupTitle": "Chat_Websites"
4488   },
4489   {
4490     "type": "get",
4491     "url": "/api/chat/websites",
4492     "title": "Gets a list of Websites",
4493     "examples": [
4494       {
4495         "title": "Example usage:",
4496         "content": "curl https://{domain}/api/chat/websites -v -u {name}:{password}",
4497         "type": "json"
4498       }
4499     ],
4500     "name": "GetWebsites",
4501     "group": "Chat_Websites",
4502     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
4503     "version": "0.0.0",
4504     "filename": "server/api/chatWebsite/index.js",
4505     "groupTitle": "Chat_Websites"
4506   },
4507   {
4508     "type": "delete",
4509     "url": "/api/chat/websites/{id}/users",
4510     "title": "Removes agents from a website",
4511     "examples": [
4512       {
4513         "title": "Example usage:",
4514         "content": "curl https://{domain}/api/chat/websites/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4515         "type": "json"
4516       }
4517     ],
4518     "name": "RemoveAgents",
4519     "group": "Chat_Websites",
4520     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4521     "version": "0.0.0",
4522     "filename": "server/api/chatWebsite/index.js",
4523     "groupTitle": "Chat_Websites"
4524   },
4525   {
4526     "type": "delete",
4527     "url": "/api/chat/websites/{id}/canned_answers",
4528     "title": "Removes canned answers from account",
4529     "examples": [
4530       {
4531         "title": "Example usage:",
4532         "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4533         "type": "json"
4534       }
4535     ],
4536     "name": "RemoveAnswers",
4537     "group": "Chat_Websites",
4538     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4539     "version": "0.0.0",
4540     "filename": "server/api/chatWebsite/index.js",
4541     "groupTitle": "Chat_Websites"
4542   },
4543   {
4544     "type": "delete",
4545     "url": "/api/chat/websites/{id}/dispositions",
4546     "title": "Removes canned answers from account",
4547     "examples": [
4548       {
4549         "title": "Example usage:",
4550         "content": "curl https://{domain}/api/chat/websites/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4551         "type": "json"
4552       }
4553     ],
4554     "name": "RemoveDispositions",
4555     "group": "Chat_Websites",
4556     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4557     "version": "0.0.0",
4558     "filename": "server/api/chatWebsite/index.js",
4559     "groupTitle": "Chat_Websites"
4560   },
4561   {
4562     "type": "get",
4563     "url": "/api/chat/websites/{id}",
4564     "title": "Gets a single Website",
4565     "examples": [
4566       {
4567         "title": "Example usage:",
4568         "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password}",
4569         "type": "json"
4570       }
4571     ],
4572     "name": "ShowWebsites",
4573     "group": "Chat_Websites",
4574     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4575     "version": "0.0.0",
4576     "filename": "server/api/chatWebsite/index.js",
4577     "groupTitle": "Chat_Websites"
4578   },
4579   {
4580     "type": "put",
4581     "url": "/api/chat/messages/{id}/accept",
4582     "title": "Accepts message",
4583     "examples": [
4584       {
4585         "title": "Example usage:",
4586         "content": "curl https://{domain}/api/chat/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
4587         "type": "json"
4588       }
4589     ],
4590     "name": "acceptMessage",
4591     "group": "Chat_Websites",
4592     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4593     "version": "0.0.0",
4594     "filename": "server/api/chatMessage/index.js",
4595     "groupTitle": "Chat_Websites"
4596   },
4597   {
4598     "type": "post",
4599     "url": "/api/chat/websites/{id}/canned_answers",
4600     "title": "Creates new canned answer",
4601     "examples": [
4602       {
4603         "title": "Example usage:",
4604         "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",
4605         "type": "json"
4606       }
4607     ],
4608     "name": "addAnswer",
4609     "group": "Chat_Websites",
4610     "parameter": {
4611       "fields": {
4612         "Body": [
4613           {
4614             "group": "Body",
4615             "type": "String",
4616             "optional": false,
4617             "field": "key",
4618             "description": ""
4619           },
4620           {
4621             "group": "Body",
4622             "type": "Text",
4623             "optional": false,
4624             "field": "value",
4625             "description": ""
4626           },
4627           {
4628             "group": "Body",
4629             "type": "String",
4630             "optional": true,
4631             "field": "description",
4632             "description": ""
4633           },
4634           {
4635             "group": "Body",
4636             "type": "Virtual",
4637             "optional": true,
4638             "field": "name",
4639             "description": ""
4640           }
4641         ]
4642       }
4643     },
4644     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4645     "version": "0.0.0",
4646     "filename": "server/api/chatWebsite/index.js",
4647     "groupTitle": "Chat_Websites"
4648   },
4649   {
4650     "type": "post",
4651     "url": "/api/chat/websites/{id}/applications",
4652     "title": "Creates new applications",
4653     "examples": [
4654       {
4655         "title": "Example usage:",
4656         "content": "curl https://{domain}/api/chat/websites/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4657         "type": "json"
4658       }
4659     ],
4660     "name": "addApplications",
4661     "group": "Chat_Websites",
4662     "parameter": {
4663       "fields": {
4664         "Body": [
4665           {
4666             "group": "Body",
4667             "type": "Integer",
4668             "optional": false,
4669             "field": "priority",
4670             "description": ""
4671           },
4672           {
4673             "group": "Body",
4674             "type": "String",
4675             "optional": false,
4676             "field": "app",
4677             "description": ""
4678           },
4679           {
4680             "group": "Body",
4681             "type": "Text",
4682             "optional": true,
4683             "field": "appdata",
4684             "description": ""
4685           },
4686           {
4687             "group": "Body",
4688             "type": "String",
4689             "optional": true,
4690             "field": "description",
4691             "description": ""
4692           },
4693           {
4694             "group": "Body",
4695             "type": "String",
4696             "optional": true,
4697             "field": "interval",
4698             "description": ""
4699           }
4700         ]
4701       }
4702     },
4703     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4704     "version": "0.0.0",
4705     "filename": "server/api/chatWebsite/index.js",
4706     "groupTitle": "Chat_Websites"
4707   },
4708   {
4709     "type": "post",
4710     "url": "/api/chat/websites/{id}/avatar",
4711     "title": "Add avatar",
4712     "examples": [
4713       {
4714         "title": "Example usage:",
4715         "content": "curl https://{domain}/api/chat/websites/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
4716         "type": "json"
4717       }
4718     ],
4719     "name": "addAvatar",
4720     "group": "Chat_Websites",
4721     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4722     "version": "0.0.0",
4723     "filename": "server/api/chatWebsite/index.js",
4724     "groupTitle": "Chat_Websites"
4725   },
4726   {
4727     "type": "post",
4728     "url": "/api/chat/websites/{id}/customer_avatar",
4729     "title": "Add customer avatar",
4730     "examples": [
4731       {
4732         "title": "Example usage:",
4733         "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",
4734         "type": "json"
4735       }
4736     ],
4737     "name": "addCustomerAvatar",
4738     "group": "Chat_Websites",
4739     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4740     "version": "0.0.0",
4741     "filename": "server/api/chatWebsite/index.js",
4742     "groupTitle": "Chat_Websites"
4743   },
4744   {
4745     "type": "post",
4746     "url": "/api/chat/websites/{id}/dispositions",
4747     "title": "Creates new disposition",
4748     "examples": [
4749       {
4750         "title": "Example usage:",
4751         "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4752         "type": "json"
4753       }
4754     ],
4755     "name": "addDisposition",
4756     "group": "Chat_Websites",
4757     "parameter": {
4758       "fields": {
4759         "Body": [
4760           {
4761             "group": "Body",
4762             "type": "String",
4763             "optional": false,
4764             "field": "name",
4765             "description": ""
4766           },
4767           {
4768             "group": "Body",
4769             "type": "String",
4770             "allowedValues": [
4771               "\"first\"",
4772               "\"second\"",
4773               "\"third\""
4774             ],
4775             "optional": false,
4776             "field": "level",
4777             "description": ""
4778           },
4779           {
4780             "group": "Body",
4781             "type": "String",
4782             "optional": true,
4783             "field": "description",
4784             "description": ""
4785           }
4786         ]
4787       }
4788     },
4789     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4790     "version": "0.0.0",
4791     "filename": "server/api/chatWebsite/index.js",
4792     "groupTitle": "Chat_Websites"
4793   },
4794   {
4795     "type": "post",
4796     "url": "/api/chat/accounts/{id}/interactions",
4797     "title": "Creates new interactions",
4798     "examples": [
4799       {
4800         "title": "Example usage:",
4801         "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",
4802         "type": "json"
4803       }
4804     ],
4805     "name": "addInteraction",
4806     "group": "Chat_Websites",
4807     "parameter": {
4808       "fields": {
4809         "Body": [
4810           {
4811             "group": "Body",
4812             "type": "Boolean",
4813             "optional": true,
4814             "field": "closed",
4815             "description": ""
4816           },
4817           {
4818             "group": "Body",
4819             "type": "Integer",
4820             "optional": true,
4821             "field": "ratingValue",
4822             "description": ""
4823           },
4824           {
4825             "group": "Body",
4826             "type": "String",
4827             "allowedValues": [
4828               "\"star\"",
4829               "\"thumb\""
4830             ],
4831             "optional": true,
4832             "field": "ratingType",
4833             "description": ""
4834           },
4835           {
4836             "group": "Body",
4837             "type": "Text",
4838             "optional": true,
4839             "field": "ratingMessage",
4840             "description": ""
4841           },
4842           {
4843             "group": "Body",
4844             "type": "Text",
4845             "optional": true,
4846             "field": "pathTranscript",
4847             "description": ""
4848           },
4849           {
4850             "group": "Body",
4851             "type": "String",
4852             "optional": true,
4853             "field": "mailTranscript",
4854             "description": ""
4855           },
4856           {
4857             "group": "Body",
4858             "type": "String",
4859             "optional": true,
4860             "field": "closedAt",
4861             "description": ""
4862           },
4863           {
4864             "group": "Body",
4865             "type": "String",
4866             "optional": true,
4867             "field": "disposition",
4868             "description": ""
4869           },
4870           {
4871             "group": "Body",
4872             "type": "String",
4873             "optional": true,
4874             "field": "secondDisposition",
4875             "description": ""
4876           },
4877           {
4878             "group": "Body",
4879             "type": "String",
4880             "optional": true,
4881             "field": "thirdDisposition",
4882             "description": ""
4883           },
4884           {
4885             "group": "Body",
4886             "type": "String",
4887             "optional": true,
4888             "field": "note",
4889             "description": ""
4890           },
4891           {
4892             "group": "Body",
4893             "type": "String",
4894             "optional": true,
4895             "field": "browserName",
4896             "description": ""
4897           },
4898           {
4899             "group": "Body",
4900             "type": "String",
4901             "optional": true,
4902             "field": "browserVersion",
4903             "description": ""
4904           },
4905           {
4906             "group": "Body",
4907             "type": "String",
4908             "optional": true,
4909             "field": "osName",
4910             "description": ""
4911           },
4912           {
4913             "group": "Body",
4914             "type": "String",
4915             "optional": true,
4916             "field": "osVersion",
4917             "description": ""
4918           },
4919           {
4920             "group": "Body",
4921             "type": "String",
4922             "optional": true,
4923             "field": "deviceModel",
4924             "description": ""
4925           },
4926           {
4927             "group": "Body",
4928             "type": "String",
4929             "optional": true,
4930             "field": "deviceVendor",
4931             "description": ""
4932           },
4933           {
4934             "group": "Body",
4935             "type": "String",
4936             "optional": true,
4937             "field": "deviceType",
4938             "description": ""
4939           },
4940           {
4941             "group": "Body",
4942             "type": "Text",
4943             "optional": true,
4944             "field": "referer",
4945             "description": ""
4946           },
4947           {
4948             "group": "Body",
4949             "type": "String",
4950             "optional": true,
4951             "field": "customerIp",
4952             "description": ""
4953           },
4954           {
4955             "group": "Body",
4956             "type": "Text",
4957             "optional": true,
4958             "field": "formData",
4959             "description": ""
4960           },
4961           {
4962             "group": "Body",
4963             "type": "String",
4964             "optional": true,
4965             "field": "read1stAt",
4966             "description": ""
4967           },
4968           {
4969             "group": "Body",
4970             "type": "String",
4971             "optional": true,
4972             "field": "lastMsgAt",
4973             "description": ""
4974           },
4975           {
4976             "group": "Body",
4977             "type": "String",
4978             "allowedValues": [
4979               "\"in\"",
4980               "\"out\""
4981             ],
4982             "optional": false,
4983             "field": "lastMsgDirection",
4984             "description": ""
4985           },
4986           {
4987             "group": "Body",
4988             "type": "String",
4989             "optional": true,
4990             "field": "closeReason",
4991             "description": ""
4992           },
4993           {
4994             "group": "Body",
4995             "type": "String",
4996             "optional": true,
4997             "field": "customerPort",
4998             "description": ""
4999           },
5000           {
5001             "group": "Body",
5002             "type": "Text",
5003             "optional": true,
5004             "field": "vidaooSessionId",
5005             "description": ""
5006           },
5007           {
5008             "group": "Body",
5009             "type": "Boolean",
5010             "optional": true,
5011             "field": "autoreplyExecuted",
5012             "description": ""
5013           }
5014         ]
5015       }
5016     },
5017     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5018     "version": "0.0.0",
5019     "filename": "server/api/chatWebsite/index.js",
5020     "groupTitle": "Chat_Websites"
5021   },
5022   {
5023     "type": "post",
5024     "url": "/api/chat/websites/{id}/logo",
5025     "title": "Add logo",
5026     "examples": [
5027       {
5028         "title": "Example usage:",
5029         "content": "curl https://{domain}/api/chat/websites/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
5030         "type": "json"
5031       }
5032     ],
5033     "name": "addLogo",
5034     "group": "Chat_Websites",
5035     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5036     "version": "0.0.0",
5037     "filename": "server/api/chatWebsite/index.js",
5038     "groupTitle": "Chat_Websites"
5039   },
5040   {
5041     "type": "post",
5042     "url": "/api/chat/websites/{id}/proactive_actions",
5043     "title": "Creates new Proactive Actions",
5044     "examples": [
5045       {
5046         "title": "Example usage:",
5047         "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",
5048         "type": "json"
5049       }
5050     ],
5051     "name": "addProactiveActions",
5052     "group": "Chat_Websites",
5053     "parameter": {
5054       "fields": {
5055         "Body": [
5056           {
5057             "group": "Body",
5058             "type": "String",
5059             "optional": false,
5060             "field": "name",
5061             "description": ""
5062           },
5063           {
5064             "group": "Body",
5065             "type": "String",
5066             "allowedValues": [
5067               "\"mouseOver\"",
5068               "\"timeout\""
5069             ],
5070             "optional": true,
5071             "field": "type",
5072             "description": ""
5073           },
5074           {
5075             "group": "Body",
5076             "type": "String",
5077             "optional": true,
5078             "field": "selector",
5079             "description": ""
5080           },
5081           {
5082             "group": "Body",
5083             "type": "Integer",
5084             "optional": true,
5085             "field": "timeout",
5086             "description": ""
5087           }
5088         ]
5089       }
5090     },
5091     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5092     "version": "0.0.0",
5093     "filename": "server/api/chatWebsite/index.js",
5094     "groupTitle": "Chat_Websites"
5095   },
5096   {
5097     "type": "post",
5098     "url": "/api/chat/websites/{id}/system_avatar",
5099     "title": "Add system avatar",
5100     "examples": [
5101       {
5102         "title": "Example usage:",
5103         "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",
5104         "type": "json"
5105       }
5106     ],
5107     "name": "addSystemAvatar",
5108     "group": "Chat_Websites",
5109     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5110     "version": "0.0.0",
5111     "filename": "server/api/chatWebsite/index.js",
5112     "groupTitle": "Chat_Websites"
5113   },
5114   {
5115     "type": "get",
5116     "url": "/api/chat/websites/{id}/canned_answers",
5117     "title": "Gets account canned answers",
5118     "examples": [
5119       {
5120         "title": "Example usage:",
5121         "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers -v -u {name}:{password} -X GET",
5122         "type": "json"
5123       }
5124     ],
5125     "name": "getAnswers",
5126     "group": "Chat_Websites",
5127     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5128     "version": "0.0.0",
5129     "filename": "server/api/chatWebsite/index.js",
5130     "groupTitle": "Chat_Websites"
5131   },
5132   {
5133     "type": "get",
5134     "url": "/api/chat/websites/{id}/applications",
5135     "title": "Gets Website Applications",
5136     "examples": [
5137       {
5138         "title": "Example usage:",
5139         "content": "curl https://{domain}/api/chat/websites/{id}/applications -v -u {name}:{password} -X GET",
5140         "type": "json"
5141       }
5142     ],
5143     "name": "getApplications",
5144     "group": "Chat_Websites",
5145     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5146     "version": "0.0.0",
5147     "filename": "server/api/chatWebsite/index.js",
5148     "groupTitle": "Chat_Websites"
5149   },
5150   {
5151     "type": "get",
5152     "url": "/api/chat/websites/{id}/avatar",
5153     "title": "Get avatar",
5154     "examples": [
5155       {
5156         "title": "Example usage:",
5157         "content": "curl https://{domain}/api/chat/websites/{id}/avatar -v -u {name}:{password} -X GET",
5158         "type": "json"
5159       }
5160     ],
5161     "name": "getAvatar",
5162     "group": "Chat_Websites",
5163     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5164     "version": "0.0.0",
5165     "filename": "server/api/chatWebsite/index.js",
5166     "groupTitle": "Chat_Websites"
5167   },
5168   {
5169     "type": "get",
5170     "url": "/api/chat/websites/{id}/customer_avatar",
5171     "title": "Get Customer Avatar",
5172     "examples": [
5173       {
5174         "title": "Example usage:",
5175         "content": "curl https://{domain}/api/chat/websites/{id}/customer_avatar -v -u {name}:{password} -X GET",
5176         "type": "json"
5177       }
5178     ],
5179     "name": "getCustomerAvatar",
5180     "group": "Chat_Websites",
5181     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5182     "version": "0.0.0",
5183     "filename": "server/api/chatWebsite/index.js",
5184     "groupTitle": "Chat_Websites"
5185   },
5186   {
5187     "type": "get",
5188     "url": "/api/chat/websites/{id}/dispositions",
5189     "title": "Gets account dispositions",
5190     "examples": [
5191       {
5192         "title": "Example usage:",
5193         "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -v -u {name}:{password} -X GET",
5194         "type": "json"
5195       }
5196     ],
5197     "name": "getDispositions",
5198     "group": "Chat_Websites",
5199     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5200     "version": "0.0.0",
5201     "filename": "server/api/chatWebsite/index.js",
5202     "groupTitle": "Chat_Websites"
5203   },
5204   {
5205     "type": "get",
5206     "url": "/api/chat/websites/{id}/fields",
5207     "title": "Gets Website Fields",
5208     "examples": [
5209       {
5210         "title": "Example usage:",
5211         "content": "curl https://{domain}/api/chat/websites/{id}/fields -v -u {name}:{password} -X GET",
5212         "type": "json"
5213       }
5214     ],
5215     "name": "getFields",
5216     "group": "Chat_Websites",
5217     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5218     "version": "0.0.0",
5219     "filename": "server/api/chatWebsite/index.js",
5220     "groupTitle": "Chat_Websites"
5221   },
5222   {
5223     "type": "get",
5224     "url": "/api/chat/websites/{id}/interactions",
5225     "title": "Gets Website Interactions",
5226     "examples": [
5227       {
5228         "title": "Example usage:",
5229         "content": "curl https://{domain}/api/chat/websites/{id}/interactions -v -u {name}:{password} -X GET",
5230         "type": "json"
5231       }
5232     ],
5233     "name": "getInteraction",
5234     "group": "Chat_Websites",
5235     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5236     "version": "0.0.0",
5237     "filename": "server/api/chatWebsite/index.js",
5238     "groupTitle": "Chat_Websites"
5239   },
5240   {
5241     "type": "get",
5242     "url": "/api/chat/websites/{id}/logo",
5243     "title": "Get logo",
5244     "examples": [
5245       {
5246         "title": "Example usage:",
5247         "content": "curl https://{domain}/api/chat/websites/{id}/logo -v -u {name}:{password} -X GET",
5248         "type": "json"
5249       }
5250     ],
5251     "name": "getLogo",
5252     "group": "Chat_Websites",
5253     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5254     "version": "0.0.0",
5255     "filename": "server/api/chatWebsite/index.js",
5256     "groupTitle": "Chat_Websites"
5257   },
5258   {
5259     "type": "get",
5260     "url": "/api/chat/websites/{id}/offline_messages",
5261     "title": "Gets Website Offline Messages",
5262     "examples": [
5263       {
5264         "title": "Example usage:",
5265         "content": "curl https://{domain}/api/chat/websites/{id}/offline_messages -v -u {name}:{password} -X GET",
5266         "type": "json"
5267       }
5268     ],
5269     "name": "getOfflineMessages",
5270     "group": "Chat_Websites",
5271     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5272     "version": "0.0.0",
5273     "filename": "server/api/chatWebsite/index.js",
5274     "groupTitle": "Chat_Websites"
5275   },
5276   {
5277     "type": "get",
5278     "url": "/api/chat/websites/{id}/proactive_actions",
5279     "title": "Gets Website Proactive Actions",
5280     "examples": [
5281       {
5282         "title": "Example usage:",
5283         "content": "curl https://{domain}/api/chat/websites/{id}/proactive_actions -v -u {name}:{password} -X GET",
5284         "type": "json"
5285       }
5286     ],
5287     "name": "getProactiveActions",
5288     "group": "Chat_Websites",
5289     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5290     "version": "0.0.0",
5291     "filename": "server/api/chatWebsite/index.js",
5292     "groupTitle": "Chat_Websites"
5293   },
5294   {
5295     "type": "get",
5296     "url": "/api/chat/websites/{id}/snippet",
5297     "title": "Gets Website Snippet",
5298     "examples": [
5299       {
5300         "title": "Example usage:",
5301         "content": "curl https://{domain}/api/chat/websites/{id}/snippet -v -u {name}:{password} -X GET",
5302         "type": "json"
5303       }
5304     ],
5305     "name": "getSnippet",
5306     "group": "Chat_Websites",
5307     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5308     "version": "0.0.0",
5309     "filename": "server/api/chatWebsite/index.js",
5310     "groupTitle": "Chat_Websites"
5311   },
5312   {
5313     "type": "get",
5314     "url": "/api/chat/websites/{id}/system_avatar",
5315     "title": "Get System Avatar",
5316     "examples": [
5317       {
5318         "title": "Example usage:",
5319         "content": "curl https://{domain}/api/chat/websites/{id}/system_avatar -v -u {name}:{password} -X GET",
5320         "type": "json"
5321       }
5322     ],
5323     "name": "getSystemAvatar",
5324     "group": "Chat_Websites",
5325     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5326     "version": "0.0.0",
5327     "filename": "server/api/chatWebsite/index.js",
5328     "groupTitle": "Chat_Websites"
5329   },
5330   {
5331     "type": "post",
5332     "url": "/api/chat/websites/{id}/notify",
5333     "title": "Notify new message",
5334     "examples": [
5335       {
5336         "title": "Example usage:",
5337         "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",
5338         "type": "json"
5339       }
5340     ],
5341     "name": "notify",
5342     "group": "Chat_Websites",
5343     "description": "<p>Motion 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>",
5344     "version": "0.0.0",
5345     "filename": "server/api/chatWebsite/index.js",
5346     "groupTitle": "Chat_Websites"
5347   },
5348   {
5349     "type": "post",
5350     "url": "/api/chat/websites/{id}/offline",
5351     "title": "Offline message",
5352     "examples": [
5353       {
5354         "title": "Example usage:",
5355         "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",
5356         "type": "json"
5357       }
5358     ],
5359     "name": "offline",
5360     "group": "Chat_Websites",
5361     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5362     "version": "0.0.0",
5363     "filename": "server/api/chatWebsite/index.js",
5364     "groupTitle": "Chat_Websites"
5365   },
5366   {
5367     "type": "put",
5368     "url": "/api/chat/messages/{id}/reject",
5369     "title": "Rejects message",
5370     "examples": [
5371       {
5372         "title": "Example usage:",
5373         "content": "curl https://{domain}/api/chat/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
5374         "type": "json"
5375       }
5376     ],
5377     "name": "rejectMessage",
5378     "group": "Chat_Websites",
5379     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5380     "version": "0.0.0",
5381     "filename": "server/api/chatMessage/index.js",
5382     "groupTitle": "Chat_Websites"
5383   },
5384   {
5385     "type": "put",
5386     "url": "/api/chat/websites/{id}",
5387     "title": "Update an existing Website",
5388     "examples": [
5389       {
5390         "title": "Example usage:",
5391         "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",
5392         "type": "json"
5393       }
5394     ],
5395     "name": "updateWebsites",
5396     "group": "Chat_Websites",
5397     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5398     "version": "0.0.0",
5399     "filename": "server/api/chatWebsite/index.js",
5400     "groupTitle": "Chat_Websites"
5401   },
5402   {
5403     "type": "post",
5404     "url": "/api/cloudProviders",
5405     "title": "Creates a new CloudProvider",
5406     "examples": [
5407       {
5408         "title": "Example usage:",
5409         "content": "curl https://{domain}/api/cloudProviders -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5410         "type": "json"
5411       }
5412     ],
5413     "name": "CreateCloudProviders",
5414     "group": "CloudProviders",
5415     "parameter": {
5416       "fields": {
5417         "Body": [
5418           {
5419             "group": "Body",
5420             "type": "String",
5421             "optional": false,
5422             "field": "name",
5423             "description": ""
5424           },
5425           {
5426             "group": "Body",
5427             "type": "String",
5428             "allowedValues": [
5429               "\"AmazonAWS\"",
5430               "\"Google\""
5431             ],
5432             "optional": false,
5433             "field": "service",
5434             "description": ""
5435           },
5436           {
5437             "group": "Body",
5438             "type": "String",
5439             "optional": true,
5440             "field": "data1",
5441             "description": ""
5442           },
5443           {
5444             "group": "Body",
5445             "type": "String",
5446             "optional": true,
5447             "field": "data2",
5448             "description": ""
5449           }
5450         ]
5451       }
5452     },
5453     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5454     "version": "0.0.0",
5455     "filename": "server/api/cloudProvider/index.js",
5456     "groupTitle": "CloudProviders"
5457   },
5458   {
5459     "type": "delete",
5460     "url": "/api/cloudProviders/{id}",
5461     "title": "Deletes a CloudProvider",
5462     "examples": [
5463       {
5464         "title": "Example usage:",
5465         "content": "curl https://{domain}/api/cloudProviders/{id} -v -u {name}:{password} -X DELETE",
5466         "type": "json"
5467       }
5468     ],
5469     "name": "DeleteCloudProviders",
5470     "group": "CloudProviders",
5471     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5472     "version": "0.0.0",
5473     "filename": "server/api/cloudProvider/index.js",
5474     "groupTitle": "CloudProviders"
5475   },
5476   {
5477     "type": "get",
5478     "url": "/api/cloudProviders",
5479     "title": "Gets a list of CloudProviders",
5480     "examples": [
5481       {
5482         "title": "Example usage:",
5483         "content": "curl https://{domain}/api/cloudProviders -v -u {name}:{password}",
5484         "type": "json"
5485       }
5486     ],
5487     "name": "GetCloudProviders",
5488     "group": "CloudProviders",
5489     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
5490     "version": "0.0.0",
5491     "filename": "server/api/cloudProvider/index.js",
5492     "groupTitle": "CloudProviders"
5493   },
5494   {
5495     "type": "get",
5496     "url": "/api/cloudProviders/{id}",
5497     "title": "Gets a single CloudProvider",
5498     "examples": [
5499       {
5500         "title": "Example usage:",
5501         "content": "curl https://{domain}/api/cloudProviders/{id} -v -u {name}:{password}",
5502         "type": "json"
5503       }
5504     ],
5505     "name": "ShowCloudProviders",
5506     "group": "CloudProviders",
5507     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5508     "version": "0.0.0",
5509     "filename": "server/api/cloudProvider/index.js",
5510     "groupTitle": "CloudProviders"
5511   },
5512   {
5513     "type": "put",
5514     "url": "/api/cloudProviders/{id}",
5515     "title": "Update an existing CloudProvider",
5516     "examples": [
5517       {
5518         "title": "Example usage:",
5519         "content": "curl https://{domain}/api/cloudProviders/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
5520         "type": "json"
5521       }
5522     ],
5523     "name": "updateCloudProviders",
5524     "group": "CloudProviders",
5525     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5526     "version": "0.0.0",
5527     "filename": "server/api/cloudProvider/index.js",
5528     "groupTitle": "CloudProviders"
5529   },
5530   {
5531     "type": "post",
5532     "url": "/api/cm/companies",
5533     "title": "Creates a new Company",
5534     "examples": [
5535       {
5536         "title": "Example usage:",
5537         "content": "curl https://{domain}/api/cm/companies -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5538         "type": "json"
5539       }
5540     ],
5541     "name": "CreateCompanies",
5542     "group": "Cm_Companies",
5543     "parameter": {
5544       "fields": {
5545         "Body": [
5546           {
5547             "group": "Body",
5548             "type": "String",
5549             "optional": false,
5550             "field": "name",
5551             "description": ""
5552           },
5553           {
5554             "group": "Body",
5555             "type": "String",
5556             "optional": true,
5557             "field": "vat",
5558             "description": ""
5559           },
5560           {
5561             "group": "Body",
5562             "type": "String",
5563             "optional": true,
5564             "field": "companyId",
5565             "description": ""
5566           },
5567           {
5568             "group": "Body",
5569             "type": "String",
5570             "optional": true,
5571             "field": "website",
5572             "description": ""
5573           },
5574           {
5575             "group": "Body",
5576             "type": "String",
5577             "optional": true,
5578             "field": "phone",
5579             "description": ""
5580           },
5581           {
5582             "group": "Body",
5583             "type": "String",
5584             "optional": true,
5585             "field": "fax",
5586             "description": ""
5587           },
5588           {
5589             "group": "Body",
5590             "type": "String",
5591             "optional": true,
5592             "field": "type",
5593             "description": ""
5594           },
5595           {
5596             "group": "Body",
5597             "type": "String",
5598             "optional": true,
5599             "field": "street",
5600             "description": ""
5601           },
5602           {
5603             "group": "Body",
5604             "type": "String",
5605             "optional": true,
5606             "field": "postalCode",
5607             "description": ""
5608           },
5609           {
5610             "group": "Body",
5611             "type": "String",
5612             "optional": true,
5613             "field": "city",
5614             "description": ""
5615           },
5616           {
5617             "group": "Body",
5618             "type": "String",
5619             "optional": true,
5620             "field": "country",
5621             "description": ""
5622           },
5623           {
5624             "group": "Body",
5625             "type": "String",
5626             "optional": true,
5627             "field": "email",
5628             "description": ""
5629           },
5630           {
5631             "group": "Body",
5632             "type": "String",
5633             "optional": true,
5634             "field": "emailDomain",
5635             "description": ""
5636           },
5637           {
5638             "group": "Body",
5639             "type": "String",
5640             "optional": true,
5641             "field": "sStreet",
5642             "description": ""
5643           },
5644           {
5645             "group": "Body",
5646             "type": "String",
5647             "optional": true,
5648             "field": "sPostalCode",
5649             "description": ""
5650           },
5651           {
5652             "group": "Body",
5653             "type": "String",
5654             "optional": true,
5655             "field": "sCity",
5656             "description": ""
5657           },
5658           {
5659             "group": "Body",
5660             "type": "String",
5661             "optional": true,
5662             "field": "sCountry",
5663             "description": ""
5664           },
5665           {
5666             "group": "Body",
5667             "type": "String",
5668             "optional": true,
5669             "field": "description",
5670             "description": ""
5671           }
5672         ]
5673       }
5674     },
5675     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5676     "version": "0.0.0",
5677     "filename": "server/api/cmCompany/index.js",
5678     "groupTitle": "Cm_Companies"
5679   },
5680   {
5681     "type": "delete",
5682     "url": "/api/cm/companies/{id}",
5683     "title": "Deletes a Company",
5684     "examples": [
5685       {
5686         "title": "Example usage:",
5687         "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password} -X DELETE",
5688         "type": "json"
5689       }
5690     ],
5691     "name": "DeleteCompanies",
5692     "group": "Cm_Companies",
5693     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5694     "version": "0.0.0",
5695     "filename": "server/api/cmCompany/index.js",
5696     "groupTitle": "Cm_Companies"
5697   },
5698   {
5699     "type": "get",
5700     "url": "/api/cm/companies/describe",
5701     "title": "Gets table info about Companies",
5702     "examples": [
5703       {
5704         "title": "Example usage:",
5705         "content": "curl https://{domain}/api/cm/companies/describe -v -u {name}:{password}",
5706         "type": "json"
5707       }
5708     ],
5709     "name": "DescribeCompanies",
5710     "group": "Cm_Companies",
5711     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5712     "version": "0.0.0",
5713     "filename": "server/api/cmCompany/index.js",
5714     "groupTitle": "Cm_Companies"
5715   },
5716   {
5717     "type": "get",
5718     "url": "/api/cm/companies",
5719     "title": "Gets a list of Companies",
5720     "examples": [
5721       {
5722         "title": "Example usage:",
5723         "content": "curl https://{domain}/api/cm/companies -v -u {name}:{password}",
5724         "type": "json"
5725       }
5726     ],
5727     "name": "GetCompanies",
5728     "group": "Cm_Companies",
5729     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
5730     "version": "0.0.0",
5731     "filename": "server/api/cmCompany/index.js",
5732     "groupTitle": "Cm_Companies"
5733   },
5734   {
5735     "type": "get",
5736     "url": "/api/cm/companies/{id}",
5737     "title": "Gets a single Company",
5738     "examples": [
5739       {
5740         "title": "Example usage:",
5741         "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password}",
5742         "type": "json"
5743       }
5744     ],
5745     "name": "ShowCompanies",
5746     "group": "Cm_Companies",
5747     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5748     "version": "0.0.0",
5749     "filename": "server/api/cmCompany/index.js",
5750     "groupTitle": "Cm_Companies"
5751   },
5752   {
5753     "type": "post",
5754     "url": "/api/cm/companies/{id}/contacts",
5755     "title": "Creates new contacts",
5756     "examples": [
5757       {
5758         "title": "Example usage:",
5759         "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",
5760         "type": "json"
5761       }
5762     ],
5763     "name": "addContacts",
5764     "group": "Cm_Companies",
5765     "parameter": {
5766       "fields": {
5767         "Body": [
5768           {
5769             "group": "Body",
5770             "type": "String",
5771             "optional": false,
5772             "field": "firstName",
5773             "description": ""
5774           },
5775           {
5776             "group": "Body",
5777             "type": "String",
5778             "optional": true,
5779             "field": "lastName",
5780             "description": ""
5781           },
5782           {
5783             "group": "Body",
5784             "type": "String",
5785             "optional": true,
5786             "field": "street",
5787             "description": ""
5788           },
5789           {
5790             "group": "Body",
5791             "type": "String",
5792             "optional": true,
5793             "field": "postalCode",
5794             "description": ""
5795           },
5796           {
5797             "group": "Body",
5798             "type": "String",
5799             "optional": true,
5800             "field": "city",
5801             "description": ""
5802           },
5803           {
5804             "group": "Body",
5805             "type": "String",
5806             "optional": true,
5807             "field": "country",
5808             "description": ""
5809           },
5810           {
5811             "group": "Body",
5812             "type": "String",
5813             "optional": true,
5814             "field": "dateOfBirth",
5815             "description": ""
5816           },
5817           {
5818             "group": "Body",
5819             "type": "Text",
5820             "optional": true,
5821             "field": "description",
5822             "description": ""
5823           },
5824           {
5825             "group": "Body",
5826             "type": "String",
5827             "optional": true,
5828             "field": "phone",
5829             "description": ""
5830           },
5831           {
5832             "group": "Body",
5833             "type": "String",
5834             "optional": true,
5835             "field": "mobile",
5836             "description": ""
5837           },
5838           {
5839             "group": "Body",
5840             "type": "String",
5841             "optional": true,
5842             "field": "fax",
5843             "description": ""
5844           },
5845           {
5846             "group": "Body",
5847             "type": "String",
5848             "optional": true,
5849             "field": "email",
5850             "description": ""
5851           },
5852           {
5853             "group": "Body",
5854             "type": "String",
5855             "optional": true,
5856             "field": "url",
5857             "description": ""
5858           },
5859           {
5860             "group": "Body",
5861             "type": "String",
5862             "optional": true,
5863             "field": "facebook",
5864             "description": ""
5865           },
5866           {
5867             "group": "Body",
5868             "type": "String",
5869             "optional": true,
5870             "field": "fb_data",
5871             "description": ""
5872           },
5873           {
5874             "group": "Body",
5875             "type": "String",
5876             "optional": true,
5877             "field": "twitter",
5878             "description": ""
5879           },
5880           {
5881             "group": "Body",
5882             "type": "String",
5883             "optional": true,
5884             "field": "skype",
5885             "description": ""
5886           },
5887           {
5888             "group": "Body",
5889             "type": "String",
5890             "optional": true,
5891             "field": "teams",
5892             "description": ""
5893           },
5894           {
5895             "group": "Body",
5896             "type": "String",
5897             "optional": true,
5898             "field": "viber",
5899             "description": ""
5900           },
5901           {
5902             "group": "Body",
5903             "type": "String",
5904             "optional": true,
5905             "field": "line",
5906             "description": ""
5907           },
5908           {
5909             "group": "Body",
5910             "type": "String",
5911             "optional": true,
5912             "field": "wechat",
5913             "description": ""
5914           },
5915           {
5916             "group": "Body",
5917             "type": "String",
5918             "optional": true,
5919             "field": "telegram",
5920             "description": ""
5921           },
5922           {
5923             "group": "Body",
5924             "type": "Integer",
5925             "optional": true,
5926             "field": "UserId",
5927             "description": ""
5928           },
5929           {
5930             "group": "Body",
5931             "type": "Integer",
5932             "optional": true,
5933             "field": "priority",
5934             "description": ""
5935           },
5936           {
5937             "group": "Body",
5938             "type": "String",
5939             "optional": true,
5940             "field": "scheduledat",
5941             "description": ""
5942           }
5943         ]
5944       }
5945     },
5946     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5947     "version": "0.0.0",
5948     "filename": "server/api/cmCompany/index.js",
5949     "groupTitle": "Cm_Companies"
5950   },
5951   {
5952     "type": "get",
5953     "url": "/api/cm/companies/{id}/contacts",
5954     "title": "Gets List Contacts",
5955     "examples": [
5956       {
5957         "title": "Example usage:",
5958         "content": "curl https://{domain}/api/fax/companies/{id}/contacts -v -u {name}:{password} -X GET",
5959         "type": "json"
5960       }
5961     ],
5962     "name": "getContacts",
5963     "group": "Cm_Companies",
5964     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5965     "version": "0.0.0",
5966     "filename": "server/api/cmCompany/index.js",
5967     "groupTitle": "Cm_Companies"
5968   },
5969   {
5970     "type": "put",
5971     "url": "/api/cm/companies/{id}",
5972     "title": "Update an existing Company",
5973     "examples": [
5974       {
5975         "title": "Example usage:",
5976         "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",
5977         "type": "json"
5978       }
5979     ],
5980     "name": "updateCompanies",
5981     "group": "Cm_Companies",
5982     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5983     "version": "0.0.0",
5984     "filename": "server/api/cmCompany/index.js",
5985     "groupTitle": "Cm_Companies"
5986   },
5987   {
5988     "type": "delete",
5989     "url": "/api/cm/contacts/{id}",
5990     "title": "Deletes a Contact",
5991     "examples": [
5992       {
5993         "title": "Example usage:",
5994         "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X DELETE",
5995         "type": "json"
5996       }
5997     ],
5998     "name": "DeleteContacts",
5999     "group": "Cm_Contacts",
6000     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6001     "version": "0.0.0",
6002     "filename": "server/api/cmContact/index.js",
6003     "groupTitle": "Cm_Contacts"
6004   },
6005   {
6006     "type": "get",
6007     "url": "/api/cm/contacts/describe",
6008     "title": "Gets table info about Contacts",
6009     "examples": [
6010       {
6011         "title": "Example usage:",
6012         "content": "curl https://{domain}/api/cm/contacts/describe -v -u {name}:{password}",
6013         "type": "json"
6014       }
6015     ],
6016     "name": "DescribeContacts",
6017     "group": "Cm_Contacts",
6018     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6019     "version": "0.0.0",
6020     "filename": "server/api/cmContact/index.js",
6021     "groupTitle": "Cm_Contacts"
6022   },
6023   {
6024     "type": "get",
6025     "url": "/api/cm/contacts",
6026     "title": "Gets a list of Contacts",
6027     "examples": [
6028       {
6029         "title": "Example usage:",
6030         "content": "curl https://{domain}/api/cm/contacts -v -u {name}:{password}",
6031         "type": "json"
6032       }
6033     ],
6034     "name": "GetContacts",
6035     "group": "Cm_Contacts",
6036     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6037     "version": "0.0.0",
6038     "filename": "server/api/cmContact/index.js",
6039     "groupTitle": "Cm_Contacts"
6040   },
6041   {
6042     "type": "get",
6043     "url": "/api/cm/contacts/{id}/finals",
6044     "title": "Gets contact hopper finals",
6045     "examples": [
6046       {
6047         "title": "Example usage:",
6048         "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_finals -v -u {name}:{password}  -X GET",
6049         "type": "json"
6050       }
6051     ],
6052     "name": "GetHopperFinals",
6053     "group": "Cm_Contacts",
6054     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6055     "version": "0.0.0",
6056     "filename": "server/api/cmContact/index.js",
6057     "groupTitle": "Cm_Contacts"
6058   },
6059   {
6060     "type": "get",
6061     "url": "/api/cm/contacts/{id}/hopper_histories",
6062     "title": "Gets contact hopper histories",
6063     "examples": [
6064       {
6065         "title": "Example usage:",
6066         "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_histories -v -u {name}:{password} -X GET",
6067         "type": "json"
6068       }
6069     ],
6070     "name": "GetHopperHistories",
6071     "group": "Cm_Contacts",
6072     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6073     "version": "0.0.0",
6074     "filename": "server/api/cmContact/index.js",
6075     "groupTitle": "Cm_Contacts"
6076   },
6077   {
6078     "type": "get",
6079     "url": "/api/cm/contacts/{id}/hoppers",
6080     "title": "Gets contact hoppers",
6081     "examples": [
6082       {
6083         "title": "Example usage:",
6084         "content": "curl https://{domain}/api/cm/contacts/{id}/hoppers -v -u {name}:{password} -X GET",
6085         "type": "json"
6086       }
6087     ],
6088     "name": "GetHoppers",
6089     "group": "Cm_Contacts",
6090     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6091     "version": "0.0.0",
6092     "filename": "server/api/cmContact/index.js",
6093     "groupTitle": "Cm_Contacts"
6094   },
6095   {
6096     "type": "post",
6097     "url": "/api/cm/contacts/create_many",
6098     "title": "Create Contacts",
6099     "examples": [
6100       {
6101         "title": "Example usage:",
6102         "content": "curl https://{domain}/api/cm/contacts/create_many -d '[{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",
6103         "type": "json"
6104       }
6105     ],
6106     "name": "bulkCreate",
6107     "group": "Cm_Contacts",
6108     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6109     "version": "0.0.0",
6110     "filename": "server/api/cmContact/index.js",
6111     "groupTitle": "Cm_Contacts"
6112   },
6113   {
6114     "type": "post",
6115     "url": "/api/cm/contacts",
6116     "title": "Create Contact",
6117     "examples": [
6118       {
6119         "title": "Example usage:",
6120         "content": "curl https://{domain}/api/cm/contacts -d '{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}' -v -u {name}:{password} -X POST",
6121         "type": "json"
6122       }
6123     ],
6124     "name": "create",
6125     "group": "Cm_Contacts",
6126     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6127     "version": "0.0.0",
6128     "filename": "server/api/cmContact/index.js",
6129     "groupTitle": "Cm_Contacts"
6130   },
6131   {
6132     "type": "get",
6133     "url": "/api/cm/contacts/{id}/journey",
6134     "title": "Gets customer journey",
6135     "examples": [
6136       {
6137         "title": "Example usage:",
6138         "content": "curl https://{domain}/api/cm/contacts/{id}/journey -v -u {name}:{password}  -X GET",
6139         "type": "json"
6140       }
6141     ],
6142     "name": "getJourney",
6143     "group": "Cm_Contacts",
6144     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6145     "version": "0.0.0",
6146     "filename": "server/api/cmContact/index.js",
6147     "groupTitle": "Cm_Contacts"
6148   },
6149   {
6150     "type": "get",
6151     "url": "/api/cm/contacts/{id}/jscripty_sessions",
6152     "title": "Gets contact hopper blacks",
6153     "examples": [
6154       {
6155         "title": "Example usage:",
6156         "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_black -v -u {name}:{password}  -X GET",
6157         "type": "json"
6158       }
6159     ],
6160     "name": "getJscriptySessions",
6161     "group": "Cm_Contacts",
6162     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6163     "version": "0.0.0",
6164     "filename": "server/api/cmContact/index.js",
6165     "groupTitle": "Cm_Contacts"
6166   },
6167   {
6168     "type": "get",
6169     "url": "/api/cm/contacts/{id}/tags",
6170     "title": "Gets configurations tags",
6171     "examples": [
6172       {
6173         "title": "Example usage:",
6174         "content": "curl https://{domain}/api/cm/contacts/{id}/tags -v -u {name}:{password} -X GET",
6175         "type": "json"
6176       }
6177     ],
6178     "name": "getTags",
6179     "group": "Cm_Contacts",
6180     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6181     "version": "0.0.0",
6182     "filename": "server/api/cmContact/index.js",
6183     "groupTitle": "Cm_Contacts"
6184   },
6185   {
6186     "type": "post",
6187     "url": "/api/cm/contacts/merge",
6188     "title": "Merge Contact",
6189     "examples": [
6190       {
6191         "title": "Example usage:",
6192         "content": "curl https://{domain}/api/cm/contacts/merge -d '{\"from\": 1, \"to\": 2}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6193         "type": "json"
6194       }
6195     ],
6196     "name": "merge",
6197     "group": "Cm_Contacts",
6198     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6199     "version": "0.0.0",
6200     "filename": "server/api/cmContact/index.js",
6201     "groupTitle": "Cm_Contacts"
6202   },
6203   {
6204     "type": "post",
6205     "url": "/api/cm/contacts/{id}/tags",
6206     "title": "Sets new tags",
6207     "examples": [
6208       {
6209         "title": "Example usage:",
6210         "content": "curl https://{domain}/api/cm/contacts/{id}/tags -d '{\"ids\": [1,12]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6211         "type": "json"
6212       }
6213     ],
6214     "name": "setTags",
6215     "group": "Cm_Contacts",
6216     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6217     "version": "0.0.0",
6218     "filename": "server/api/cmContact/index.js",
6219     "groupTitle": "Cm_Contacts"
6220   },
6221   {
6222     "type": "get",
6223     "url": "/api/cm/contacts/{id}",
6224     "title": "Gets a single Contact",
6225     "examples": [
6226       {
6227         "title": "Example usage:",
6228         "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X GET",
6229         "type": "json"
6230       }
6231     ],
6232     "name": "show",
6233     "group": "Cm_Contacts",
6234     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6235     "version": "0.0.0",
6236     "filename": "server/api/cmContact/index.js",
6237     "groupTitle": "Cm_Contacts"
6238   },
6239   {
6240     "type": "put",
6241     "url": "/api/cm/contacts/{id}",
6242     "title": "Update a single Contact",
6243     "examples": [
6244       {
6245         "title": "Example usage:",
6246         "content": "curl https://{domain}/api/cm/contacts/{id} -d '{\"firstName\": \"John\", \"lastName\": \"Doe\"}' -v -u {name}:{password} -X PUT",
6247         "type": "json"
6248       }
6249     ],
6250     "name": "update",
6251     "group": "Cm_Contacts",
6252     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6253     "version": "0.0.0",
6254     "filename": "server/api/cmContact/index.js",
6255     "groupTitle": "Cm_Contacts"
6256   },
6257   {
6258     "type": "delete",
6259     "url": "/api/cm/custom_fields/{id}",
6260     "title": "Deletes a Custom Field",
6261     "examples": [
6262       {
6263         "title": "Example usage:",
6264         "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password} -X DELETE",
6265         "type": "json"
6266       }
6267     ],
6268     "name": "DeleteCustom_Fields",
6269     "group": "Cm_Custom_Fields",
6270     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6271     "version": "0.0.0",
6272     "filename": "server/api/cmCustomField/index.js",
6273     "groupTitle": "Cm_Custom_Fields"
6274   },
6275   {
6276     "type": "get",
6277     "url": "/api/cm/custom_fields",
6278     "title": "Gets a list of Custom Fields",
6279     "examples": [
6280       {
6281         "title": "Example usage:",
6282         "content": "curl https://{domain}/api/cm/custom_fields -v -u {name}:{password}",
6283         "type": "json"
6284       }
6285     ],
6286     "name": "GetCustom_Fields",
6287     "group": "Cm_Custom_Fields",
6288     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6289     "version": "0.0.0",
6290     "filename": "server/api/cmCustomField/index.js",
6291     "groupTitle": "Cm_Custom_Fields"
6292   },
6293   {
6294     "type": "get",
6295     "url": "/api/cm/custom_fields/{id}",
6296     "title": "Gets a single Custom Field",
6297     "examples": [
6298       {
6299         "title": "Example usage:",
6300         "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password}",
6301         "type": "json"
6302       }
6303     ],
6304     "name": "ShowCustom_Fields",
6305     "group": "Cm_Custom_Fields",
6306     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6307     "version": "0.0.0",
6308     "filename": "server/api/cmCustomField/index.js",
6309     "groupTitle": "Cm_Custom_Fields"
6310   },
6311   {
6312     "type": "put",
6313     "url": "/api/cm/custom_fields/{id}",
6314     "title": "Update an existing Custom Field",
6315     "examples": [
6316       {
6317         "title": "Example usage:",
6318         "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",
6319         "type": "json"
6320       }
6321     ],
6322     "name": "updateCustom_Fields",
6323     "group": "Cm_Custom_Fields",
6324     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6325     "version": "0.0.0",
6326     "filename": "server/api/cmCustomField/index.js",
6327     "groupTitle": "Cm_Custom_Fields"
6328   },
6329   {
6330     "type": "post",
6331     "url": "/api/cm/hopper",
6332     "title": "Creates a new Hopper",
6333     "examples": [
6334       {
6335         "title": "Example usage:",
6336         "content": "curl https://{domain}/api/cm/hopper -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
6337         "type": "json"
6338       }
6339     ],
6340     "name": "CreateHopper",
6341     "group": "Cm_Hopper",
6342     "parameter": {
6343       "fields": {
6344         "Body": [
6345           {
6346             "group": "Body",
6347             "type": "String",
6348             "optional": false,
6349             "field": "phone",
6350             "description": ""
6351           },
6352           {
6353             "group": "Body",
6354             "type": "Boolean",
6355             "optional": true,
6356             "field": "active",
6357             "description": ""
6358           },
6359           {
6360             "group": "Body",
6361             "type": "String",
6362             "optional": true,
6363             "field": "scheduledat",
6364             "description": ""
6365           },
6366           {
6367             "group": "Body",
6368             "type": "Integer",
6369             "optional": true,
6370             "field": "countbusyretry",
6371             "description": ""
6372           },
6373           {
6374             "group": "Body",
6375             "type": "Integer",
6376             "optional": true,
6377             "field": "countcongestionretry",
6378             "description": ""
6379           },
6380           {
6381             "group": "Body",
6382             "type": "Integer",
6383             "optional": true,
6384             "field": "countnoanswerretry",
6385             "description": ""
6386           },
6387           {
6388             "group": "Body",
6389             "type": "Boolean",
6390             "optional": true,
6391             "field": "callback",
6392             "description": ""
6393           },
6394           {
6395             "group": "Body",
6396             "type": "String",
6397             "optional": true,
6398             "field": "callbackuniqueid",
6399             "description": ""
6400           },
6401           {
6402             "group": "Body",
6403             "type": "String",
6404             "optional": true,
6405             "field": "callbackat",
6406             "description": ""
6407           },
6408           {
6409             "group": "Body",
6410             "type": "Integer",
6411             "optional": true,
6412             "field": "priority",
6413             "description": ""
6414           },
6415           {
6416             "group": "Body",
6417             "type": "Boolean",
6418             "optional": true,
6419             "field": "recallme",
6420             "description": ""
6421           },
6422           {
6423             "group": "Body",
6424             "type": "Integer",
6425             "optional": true,
6426             "field": "ContactId",
6427             "description": ""
6428           },
6429           {
6430             "group": "Body",
6431             "type": "Integer",
6432             "optional": true,
6433             "field": "ListId",
6434             "description": ""
6435           },
6436           {
6437             "group": "Body",
6438             "type": "Integer",
6439             "optional": true,
6440             "field": "UserId",
6441             "description": ""
6442           },
6443           {
6444             "group": "Body",
6445             "type": "Integer",
6446             "optional": true,
6447             "field": "VoiceQueueId",
6448             "description": ""
6449           },
6450           {
6451             "group": "Body",
6452             "type": "Integer",
6453             "optional": true,
6454             "field": "CampaignId",
6455             "description": ""
6456           },
6457           {
6458             "group": "Body",
6459             "type": "Integer",
6460             "optional": true,
6461             "field": "countnosuchnumberretry",
6462             "description": ""
6463           },
6464           {
6465             "group": "Body",
6466             "type": "Integer",
6467             "optional": true,
6468             "field": "countdropretry",
6469             "description": ""
6470           },
6471           {
6472             "group": "Body",
6473             "type": "Integer",
6474             "optional": true,
6475             "field": "countabandonedretry",
6476             "description": ""
6477           },
6478           {
6479             "group": "Body",
6480             "type": "Integer",
6481             "optional": true,
6482             "field": "countmachineretry",
6483             "description": ""
6484           },
6485           {
6486             "group": "Body",
6487             "type": "Integer",
6488             "optional": true,
6489             "field": "countagentrejectretry",
6490             "description": ""
6491           }
6492         ]
6493       }
6494     },
6495     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6496     "version": "0.0.0",
6497     "filename": "server/api/cmHopper/index.js",
6498     "groupTitle": "Cm_Hopper"
6499   },
6500   {
6501     "type": "get",
6502     "url": "/api/cm/hopper/describe",
6503     "title": "Gets table info about Hopper",
6504     "examples": [
6505       {
6506         "title": "Example usage:",
6507         "content": "curl https://{domain}/api/cm/hopper/describe -v -u {name}:{password}",
6508         "type": "json"
6509       }
6510     ],
6511     "name": "DescribeHopper",
6512     "group": "Cm_Hopper",
6513     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6514     "version": "0.0.0",
6515     "filename": "server/api/cmHopper/index.js",
6516     "groupTitle": "Cm_Hopper"
6517   },
6518   {
6519     "type": "get",
6520     "url": "/api/cm/hopper",
6521     "title": "Gets a list of Hopper",
6522     "examples": [
6523       {
6524         "title": "Example usage:",
6525         "content": "curl https://{domain}/api/cm/hopper -v -u {name}:{password}",
6526         "type": "json"
6527       }
6528     ],
6529     "name": "GetHopper",
6530     "group": "Cm_Hopper",
6531     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6532     "version": "0.0.0",
6533     "filename": "server/api/cmHopper/index.js",
6534     "groupTitle": "Cm_Hopper"
6535   },
6536   {
6537     "type": "get",
6538     "url": "/api/cm/hopper/{id}",
6539     "title": "Gets a single Hopper",
6540     "examples": [
6541       {
6542         "title": "Example usage:",
6543         "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password}",
6544         "type": "json"
6545       }
6546     ],
6547     "name": "ShowHopper",
6548     "group": "Cm_Hopper",
6549     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6550     "version": "0.0.0",
6551     "filename": "server/api/cmHopper/index.js",
6552     "groupTitle": "Cm_Hopper"
6553   },
6554   {
6555     "type": "delete",
6556     "url": "/api/cm/hopper_black/{id}",
6557     "title": "Deletes a Hopper Black",
6558     "examples": [
6559       {
6560         "title": "Example usage:",
6561         "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password} -X DELETE",
6562         "type": "json"
6563       }
6564     ],
6565     "name": "DeleteHopper_Black",
6566     "group": "Cm_Hopper_Black",
6567     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6568     "version": "0.0.0",
6569     "filename": "server/api/cmHopperBlack/index.js",
6570     "groupTitle": "Cm_Hopper_Black"
6571   },
6572   {
6573     "type": "get",
6574     "url": "/api/cm/hopper_black/describe",
6575     "title": "Gets table info about Hopper Black",
6576     "examples": [
6577       {
6578         "title": "Example usage:",
6579         "content": "curl https://{domain}/api/cm/hopper_black/describe -v -u {name}:{password}",
6580         "type": "json"
6581       }
6582     ],
6583     "name": "DescribeHopper_Black",
6584     "group": "Cm_Hopper_Black",
6585     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6586     "version": "0.0.0",
6587     "filename": "server/api/cmHopperBlack/index.js",
6588     "groupTitle": "Cm_Hopper_Black"
6589   },
6590   {
6591     "type": "get",
6592     "url": "/api/cm/hopper_black",
6593     "title": "Gets a list of Hopper Black",
6594     "examples": [
6595       {
6596         "title": "Example usage:",
6597         "content": "curl https://{domain}/api/cm/hopper_black -v -u {name}:{password}",
6598         "type": "json"
6599       }
6600     ],
6601     "name": "GetHopper_Black",
6602     "group": "Cm_Hopper_Black",
6603     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6604     "version": "0.0.0",
6605     "filename": "server/api/cmHopperBlack/index.js",
6606     "groupTitle": "Cm_Hopper_Black"
6607   },
6608   {
6609     "type": "get",
6610     "url": "/api/cm/hopper_black/{id}",
6611     "title": "Gets a single Hopper Black",
6612     "examples": [
6613       {
6614         "title": "Example usage:",
6615         "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password}",
6616         "type": "json"
6617       }
6618     ],
6619     "name": "ShowHopper_Black",
6620     "group": "Cm_Hopper_Black",
6621     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6622     "version": "0.0.0",
6623     "filename": "server/api/cmHopperBlack/index.js",
6624     "groupTitle": "Cm_Hopper_Black"
6625   },
6626   {
6627     "type": "put",
6628     "url": "/api/cm/hopper_black/{id}",
6629     "title": "Update an existing Hopper Black",
6630     "examples": [
6631       {
6632         "title": "Example usage:",
6633         "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",
6634         "type": "json"
6635       }
6636     ],
6637     "name": "updateHopper_Black",
6638     "group": "Cm_Hopper_Black",
6639     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6640     "version": "0.0.0",
6641     "filename": "server/api/cmHopperBlack/index.js",
6642     "groupTitle": "Cm_Hopper_Black"
6643   },
6644   {
6645     "type": "post",
6646     "url": "/api/cm/hopper_final/checkContactHopper",
6647     "title": "Check if contact is in hopper",
6648     "examples": [
6649       {
6650         "title": "Example usage:",
6651         "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",
6652         "type": "json"
6653       }
6654     ],
6655     "name": "/checkContactHopper",
6656     "group": "Cm_Hopper_Final",
6657     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6658     "version": "0.0.0",
6659     "filename": "server/api/cmHopperFinal/index.js",
6660     "groupTitle": "Cm_Hopper_Final"
6661   },
6662   {
6663     "type": "get",
6664     "url": "/api/cm/hopper_final/describe",
6665     "title": "Gets table info about HopperFinal",
6666     "examples": [
6667       {
6668         "title": "Example usage:",
6669         "content": "curl https://{domain}/api/cm/hopper_final/describe -v -u {name}:{password}",
6670         "type": "json"
6671       }
6672     ],
6673     "name": "DescribeHopperFinal",
6674     "group": "Cm_Hopper_Final",
6675     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6676     "version": "0.0.0",
6677     "filename": "server/api/cmHopperFinal/index.js",
6678     "groupTitle": "Cm_Hopper_Final"
6679   },
6680   {
6681     "type": "get",
6682     "url": "/api/cm/hopper_final",
6683     "title": "Gets a list of HopperFinal",
6684     "examples": [
6685       {
6686         "title": "Example usage:",
6687         "content": "curl https://{domain}/api/cm/hopper_final -v -u {name}:{password}",
6688         "type": "json"
6689       }
6690     ],
6691     "name": "GetHopperFinal",
6692     "group": "Cm_Hopper_Final",
6693     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6694     "version": "0.0.0",
6695     "filename": "server/api/cmHopperFinal/index.js",
6696     "groupTitle": "Cm_Hopper_Final"
6697   },
6698   {
6699     "type": "get",
6700     "url": "/api/cm/hopper_final/{id}",
6701     "title": "Gets a single HopperFinal",
6702     "examples": [
6703       {
6704         "title": "Example usage:",
6705         "content": "curl https://{domain}/api/cm/hopper_final/{id} -v -u {name}:{password}",
6706         "type": "json"
6707       }
6708     ],
6709     "name": "ShowHopperFinal",
6710     "group": "Cm_Hopper_Final",
6711     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6712     "version": "0.0.0",
6713     "filename": "server/api/cmHopperFinal/index.js",
6714     "groupTitle": "Cm_Hopper_Final"
6715   },
6716   {
6717     "type": "get",
6718     "url": "/api/cm/hopper_final/campaign/countAttributes/{id}",
6719     "title": "Return number contacts for attributes",
6720     "examples": [
6721       {
6722         "title": "Example usage:",
6723         "content": "curl https://{domain}/api/hopper_final/campaign/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
6724         "type": "json"
6725       }
6726     ],
6727     "name": "countContactsIvrCampaignHopperFinal",
6728     "group": "Cm_Hopper_Final",
6729     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6730     "version": "0.0.0",
6731     "filename": "server/api/cmHopperFinal/index.js",
6732     "groupTitle": "Cm_Hopper_Final"
6733   },
6734   {
6735     "type": "get",
6736     "url": "/api/cm/hopper_final/voice/queue/countAttributes/{id}",
6737     "title": "Return number contacts for attributes",
6738     "examples": [
6739       {
6740         "title": "Example usage:",
6741         "content": "curl https://{domain}/api/hopper_final/voice/queue/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
6742         "type": "json"
6743       }
6744     ],
6745     "name": "countContactsQueueCampaignHopperFinal",
6746     "group": "Cm_Hopper_Final",
6747     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6748     "version": "0.0.0",
6749     "filename": "server/api/cmHopperFinal/index.js",
6750     "groupTitle": "Cm_Hopper_Final"
6751   },
6752   {
6753     "type": "post",
6754     "url": "/api/cm/hopper_final/campaign/{id}",
6755     "title": "Move contacts in hopper",
6756     "examples": [
6757       {
6758         "title": "Example usage:",
6759         "content": "curl https://{domain}/api/hopper_final/campaign/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6760         "type": "json"
6761       }
6762     ],
6763     "name": "moveContactsIvrCampaignHopperFinal",
6764     "group": "Cm_Hopper_Final",
6765     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6766     "version": "0.0.0",
6767     "filename": "server/api/cmHopperFinal/index.js",
6768     "groupTitle": "Cm_Hopper_Final"
6769   },
6770   {
6771     "type": "post",
6772     "url": "/api/cm/hopper_final/voice/queue/{id}",
6773     "title": "Move contacts in hopper",
6774     "examples": [
6775       {
6776         "title": "Example usage:",
6777         "content": "curl https://{domain}/api/hopper_final/voice/queue/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password}",
6778         "type": "json"
6779       }
6780     ],
6781     "name": "moveContactsQueueCampaignHopperFinal",
6782     "group": "Cm_Hopper_Final",
6783     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6784     "version": "0.0.0",
6785     "filename": "server/api/cmHopperFinal/index.js",
6786     "groupTitle": "Cm_Hopper_Final"
6787   },
6788   {
6789     "type": "put",
6790     "url": "/api/cm/hopper_final/{id}",
6791     "title": "Update a single hopper final",
6792     "examples": [
6793       {
6794         "title": "Example usage:",
6795         "content": "curl https://{domain}/api/hopper_final/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
6796         "type": "json"
6797       }
6798     ],
6799     "name": "update",
6800     "group": "Cm_Hopper_Final",
6801     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6802     "version": "0.0.0",
6803     "filename": "server/api/cmHopperFinal/index.js",
6804     "groupTitle": "Cm_Hopper_Final"
6805   },
6806   {
6807     "type": "post",
6808     "url": "/api/cm/hopper_history",
6809     "title": "Creates a new HopperHistory",
6810     "examples": [
6811       {
6812         "title": "Example usage:",
6813         "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",
6814         "type": "json"
6815       }
6816     ],
6817     "name": "CreateHopperHistory",
6818     "group": "Cm_Hopper_History",
6819     "parameter": {
6820       "fields": {
6821         "Body": [
6822           {
6823             "group": "Body",
6824             "type": "Integer",
6825             "optional": true,
6826             "field": "state",
6827             "description": ""
6828           },
6829           {
6830             "group": "Body",
6831             "type": "String",
6832             "optional": true,
6833             "field": "statedesc",
6834             "description": ""
6835           },
6836           {
6837             "group": "Body",
6838             "type": "String",
6839             "optional": true,
6840             "field": "scheduledat",
6841             "description": ""
6842           },
6843           {
6844             "group": "Body",
6845             "type": "Integer",
6846             "optional": true,
6847             "field": "countbusyretry",
6848             "description": ""
6849           },
6850           {
6851             "group": "Body",
6852             "type": "Integer",
6853             "optional": true,
6854             "field": "countcongestionretry",
6855             "description": ""
6856           },
6857           {
6858             "group": "Body",
6859             "type": "Integer",
6860             "optional": true,
6861             "field": "countnoanswerretry",
6862             "description": ""
6863           },
6864           {
6865             "group": "Body",
6866             "type": "Integer",
6867             "optional": true,
6868             "field": "countglobal",
6869             "description": ""
6870           },
6871           {
6872             "group": "Body",
6873             "type": "String",
6874             "optional": true,
6875             "field": "uniqueid",
6876             "description": ""
6877           },
6878           {
6879             "group": "Body",
6880             "type": "String",
6881             "optional": true,
6882             "field": "originatecalleridnum",
6883             "description": ""
6884           },
6885           {
6886             "group": "Body",
6887             "type": "String",
6888             "optional": true,
6889             "field": "originatecalleridname",
6890             "description": ""
6891           },
6892           {
6893             "group": "Body",
6894             "type": "String",
6895             "optional": true,
6896             "field": "calleridnum",
6897             "description": ""
6898           },
6899           {
6900             "group": "Body",
6901             "type": "String",
6902             "optional": true,
6903             "field": "calleridname",
6904             "description": ""
6905           },
6906           {
6907             "group": "Body",
6908             "type": "String",
6909             "optional": true,
6910             "field": "starttime",
6911             "description": ""
6912           },
6913           {
6914             "group": "Body",
6915             "type": "String",
6916             "optional": true,
6917             "field": "responsetime",
6918             "description": ""
6919           },
6920           {
6921             "group": "Body",
6922             "type": "String",
6923             "optional": true,
6924             "field": "answertime",
6925             "description": ""
6926           },
6927           {
6928             "group": "Body",
6929             "type": "String",
6930             "optional": true,
6931             "field": "droptime",
6932             "description": ""
6933           },
6934           {
6935             "group": "Body",
6936             "type": "String",
6937             "optional": true,
6938             "field": "endtime",
6939             "description": ""
6940           },
6941           {
6942             "group": "Body",
6943             "type": "Integer",
6944             "optional": true,
6945             "field": "ringtime",
6946             "description": ""
6947           },
6948           {
6949             "group": "Body",
6950             "type": "Integer",
6951             "optional": true,
6952             "field": "holdtime",
6953             "description": ""
6954           },
6955           {
6956             "group": "Body",
6957             "type": "Integer",
6958             "optional": true,
6959             "field": "talktime",
6960             "description": ""
6961           },
6962           {
6963             "group": "Body",
6964             "type": "Integer",
6965             "optional": true,
6966             "field": "followuptime",
6967             "description": ""
6968           },
6969           {
6970             "group": "Body",
6971             "type": "String",
6972             "optional": true,
6973             "field": "dropreason",
6974             "description": ""
6975           },
6976           {
6977             "group": "Body",
6978             "type": "String",
6979             "optional": true,
6980             "field": "campaign",
6981             "description": ""
6982           },
6983           {
6984             "group": "Body",
6985             "type": "String",
6986             "optional": true,
6987             "field": "campaigntype",
6988             "description": ""
6989           },
6990           {
6991             "group": "Body",
6992             "type": "String",
6993             "optional": true,
6994             "field": "membername",
6995             "description": ""
6996           },
6997           {
6998             "group": "Body",
6999             "type": "String",
7000             "optional": true,
7001             "field": "reason",
7002             "description": ""
7003           },
7004           {
7005             "group": "Body",
7006             "type": "Boolean",
7007             "optional": true,
7008             "field": "amd",
7009             "description": ""
7010           },
7011           {
7012             "group": "Body",
7013             "type": "Boolean",
7014             "optional": true,
7015             "field": "fax",
7016             "description": ""
7017           },
7018           {
7019             "group": "Body",
7020             "type": "Boolean",
7021             "optional": true,
7022             "field": "callback",
7023             "description": ""
7024           },
7025           {
7026             "group": "Body",
7027             "type": "String",
7028             "optional": true,
7029             "field": "callbackuniqueid",
7030             "description": ""
7031           },
7032           {
7033             "group": "Body",
7034             "type": "String",
7035             "optional": true,
7036             "field": "callbackat",
7037             "description": ""
7038           },
7039           {
7040             "group": "Body",
7041             "type": "Boolean",
7042             "optional": true,
7043             "field": "recallme",
7044             "description": ""
7045           },
7046           {
7047             "group": "Body",
7048             "type": "String",
7049             "optional": true,
7050             "field": "editedat",
7051             "description": ""
7052           },
7053           {
7054             "group": "Body",
7055             "type": "Boolean",
7056             "optional": true,
7057             "field": "edited",
7058             "description": ""
7059           },
7060           {
7061             "group": "Body",
7062             "type": "Integer",
7063             "optional": true,
7064             "field": "countnosuchnumberretry",
7065             "description": ""
7066           },
7067           {
7068             "group": "Body",
7069             "type": "Integer",
7070             "optional": true,
7071             "field": "countdropretry",
7072             "description": ""
7073           },
7074           {
7075             "group": "Body",
7076             "type": "Integer",
7077             "optional": true,
7078             "field": "countabandonedretry",
7079             "description": ""
7080           },
7081           {
7082             "group": "Body",
7083             "type": "Integer",
7084             "optional": true,
7085             "field": "countmachineretry",
7086             "description": ""
7087           },
7088           {
7089             "group": "Body",
7090             "type": "Integer",
7091             "optional": true,
7092             "field": "countagentrejectretry",
7093             "description": ""
7094           }
7095         ]
7096       }
7097     },
7098     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7099     "version": "0.0.0",
7100     "filename": "server/api/cmHopperHistory/index.js",
7101     "groupTitle": "Cm_Hopper_History"
7102   },
7103   {
7104     "type": "get",
7105     "url": "/api/cm/hopper_history/describe",
7106     "title": "Gets table info about HopperHistory",
7107     "examples": [
7108       {
7109         "title": "Example usage:",
7110         "content": "curl https://{domain}/api/cm/hopper_history/describe -v -u {name}:{password}",
7111         "type": "json"
7112       }
7113     ],
7114     "name": "DescribeHopperHistory",
7115     "group": "Cm_Hopper_History",
7116     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7117     "version": "0.0.0",
7118     "filename": "server/api/cmHopperHistory/index.js",
7119     "groupTitle": "Cm_Hopper_History"
7120   },
7121   {
7122     "type": "get",
7123     "url": "/api/cm/hopper_history",
7124     "title": "Gets a list of HopperHistory",
7125     "examples": [
7126       {
7127         "title": "Example usage:",
7128         "content": "curl https://{domain}/api/cm/hopper_history -v -u {name}:{password}",
7129         "type": "json"
7130       }
7131     ],
7132     "name": "GetHopperHistory",
7133     "group": "Cm_Hopper_History",
7134     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
7135     "version": "0.0.0",
7136     "filename": "server/api/cmHopperHistory/index.js",
7137     "groupTitle": "Cm_Hopper_History"
7138   },
7139   {
7140     "type": "get",
7141     "url": "/api/cm/hopper_history/{id}",
7142     "title": "Gets a single HopperHistory",
7143     "examples": [
7144       {
7145         "title": "Example usage:",
7146         "content": "curl https://{domain}/api/cm/hopper_history/{id} -v -u {name}:{password}",
7147         "type": "json"
7148       }
7149     ],
7150     "name": "ShowHopperHistory",
7151     "group": "Cm_Hopper_History",
7152     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7153     "version": "0.0.0",
7154     "filename": "server/api/cmHopperHistory/index.js",
7155     "groupTitle": "Cm_Hopper_History"
7156   },
7157   {
7158     "type": "put",
7159     "url": "/api/cm/hopper_history/{id}",
7160     "title": "Update a single hopper history",
7161     "examples": [
7162       {
7163         "title": "Example usage:",
7164         "content": "curl https://{domain}/api/hopper_history/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
7165         "type": "json"
7166       }
7167     ],
7168     "name": "update",
7169     "group": "Cm_Hopper_History",
7170     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7171     "version": "0.0.0",
7172     "filename": "server/api/cmHopperHistory/index.js",
7173     "groupTitle": "Cm_Hopper_History"
7174   },
7175   {
7176     "type": "delete",
7177     "url": "/api/cm/hopper/{id}",
7178     "title": "Delete Hopper",
7179     "examples": [
7180       {
7181         "title": "Example usage:",
7182         "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password} -X DELETE",
7183         "type": "json"
7184       }
7185     ],
7186     "name": "destroy",
7187     "group": "Cm_Hopper",
7188     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7189     "version": "0.0.0",
7190     "filename": "server/api/cmHopper/index.js",
7191     "groupTitle": "Cm_Hopper"
7192   },
7193   {
7194     "type": "get",
7195     "url": "/api/cm/hopper/opencontacts",
7196     "title": "Gets Open Contacts",
7197     "examples": [
7198       {
7199         "title": "Example usage:",
7200         "content": "curl https://{domain}/api/cm/hopper/opencontacts -v -u {name}:{password} -X GET",
7201         "type": "json"
7202       }
7203     ],
7204     "name": "getOpenContacts",
7205     "group": "Cm_Hopper",
7206     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7207     "version": "0.0.0",
7208     "filename": "server/api/cmHopper/index.js",
7209     "groupTitle": "Cm_Hopper"
7210   },
7211   {
7212     "type": "post",
7213     "url": "/api/cm/hopper/preview",
7214     "title": "Gets Preview Dialer Contacts",
7215     "examples": [
7216       {
7217         "title": "Example usage:",
7218         "content": "curl https://{domain}/api/cm/hopper/preview -d '{\"hopperIds\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
7219         "type": "json"
7220       }
7221     ],
7222     "name": "getPreview",
7223     "group": "Cm_Hopper",
7224     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7225     "version": "0.0.0",
7226     "filename": "server/api/cmHopper/index.js",
7227     "groupTitle": "Cm_Hopper"
7228   },
7229   {
7230     "type": "put",
7231     "url": "/api/cm/hopper/{id}",
7232     "title": "Update an existing Hopper",
7233     "examples": [
7234       {
7235         "title": "Example usage:",
7236         "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",
7237         "type": "json"
7238       }
7239     ],
7240     "name": "updateHopper",
7241     "group": "Cm_Hopper",
7242     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7243     "version": "0.0.0",
7244     "filename": "server/api/cmHopper/index.js",
7245     "groupTitle": "Cm_Hopper"
7246   },
7247   {
7248     "type": "post",
7249     "url": "/api/cm/lists",
7250     "title": "Creates a new List",
7251     "examples": [
7252       {
7253         "title": "Example usage:",
7254         "content": "curl https://{domain}/api/cm/lists -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7255         "type": "json"
7256       }
7257     ],
7258     "name": "CreateLists",
7259     "group": "Cm_Lists",
7260     "parameter": {
7261       "fields": {
7262         "Body": [
7263           {
7264             "group": "Body",
7265             "type": "String",
7266             "optional": false,
7267             "field": "name",
7268             "description": ""
7269           },
7270           {
7271             "group": "Body",
7272             "type": "String",
7273             "optional": true,
7274             "field": "description",
7275             "description": ""
7276           },
7277           {
7278             "group": "Body",
7279             "type": "String",
7280             "optional": true,
7281             "field": "dialPrefix",
7282             "description": ""
7283           }
7284         ]
7285       }
7286     },
7287     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7288     "version": "0.0.0",
7289     "filename": "server/api/cmList/index.js",
7290     "groupTitle": "Cm_Lists"
7291   },
7292   {
7293     "type": "delete",
7294     "url": "/api/cm/lists/{id}",
7295     "title": "Deletes a List",
7296     "examples": [
7297       {
7298         "title": "Example usage:",
7299         "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password} -X DELETE",
7300         "type": "json"
7301       }
7302     ],
7303     "name": "DeleteLists",
7304     "group": "Cm_Lists",
7305     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7306     "version": "0.0.0",
7307     "filename": "server/api/cmList/index.js",
7308     "groupTitle": "Cm_Lists"
7309   },
7310   {
7311     "type": "get",
7312     "url": "/api/cm/lists/describe",
7313     "title": "Gets table info about Lists",
7314     "examples": [
7315       {
7316         "title": "Example usage:",
7317         "content": "curl https://{domain}/api/cm/lists/describe -v -u {name}:{password}",
7318         "type": "json"
7319       }
7320     ],
7321     "name": "DescribeLists",
7322     "group": "Cm_Lists",
7323     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7324     "version": "0.0.0",
7325     "filename": "server/api/cmList/index.js",
7326     "groupTitle": "Cm_Lists"
7327   },
7328   {
7329     "type": "get",
7330     "url": "/api/cm/lists/{id}/users",
7331     "title": "Gets agents from list",
7332     "examples": [
7333       {
7334         "title": "Example usage:",
7335         "content": "curl https://{domain}/api/cm/lists/{id}/users -v -u {name}:{password} -X GET",
7336         "type": "json"
7337       }
7338     ],
7339     "name": "GetAgents",
7340     "group": "Cm_Lists",
7341     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7342     "version": "0.0.0",
7343     "filename": "server/api/cmList/index.js",
7344     "groupTitle": "Cm_Lists"
7345   },
7346   {
7347     "type": "get",
7348     "url": "/api/cm/lists",
7349     "title": "Gets a list of Lists",
7350     "examples": [
7351       {
7352         "title": "Example usage:",
7353         "content": "curl https://{domain}/api/cm/lists -v -u {name}:{password}",
7354         "type": "json"
7355       }
7356     ],
7357     "name": "GetLists",
7358     "group": "Cm_Lists",
7359     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
7360     "version": "0.0.0",
7361     "filename": "server/api/cmList/index.js",
7362     "groupTitle": "Cm_Lists"
7363   },
7364   {
7365     "type": "delete",
7366     "url": "/api/cm/lists/{id}/users",
7367     "title": "Removes agents from a list",
7368     "examples": [
7369       {
7370         "title": "Example usage:",
7371         "content": "curl https://{domain}/api/cm/lists/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
7372         "type": "json"
7373       }
7374     ],
7375     "name": "RemoveAgents",
7376     "group": "Cm_Lists",
7377     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7378     "version": "0.0.0",
7379     "filename": "server/api/cmList/index.js",
7380     "groupTitle": "Cm_Lists"
7381   },
7382   {
7383     "type": "delete",
7384     "url": "/api/cm/lists/{id}/dispositions",
7385     "title": "Removes dispositions from account",
7386     "examples": [
7387       {
7388         "title": "Example usage:",
7389         "content": "curl https://{domain}/api/cm/lists/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
7390         "type": "json"
7391       }
7392     ],
7393     "name": "RemoveDispositions",
7394     "group": "Cm_Lists",
7395     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7396     "version": "0.0.0",
7397     "filename": "server/api/cmList/index.js",
7398     "groupTitle": "Cm_Lists"
7399   },
7400   {
7401     "type": "get",
7402     "url": "/api/cm/lists/{id}",
7403     "title": "Gets a single List",
7404     "examples": [
7405       {
7406         "title": "Example usage:",
7407         "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password}",
7408         "type": "json"
7409       }
7410     ],
7411     "name": "ShowLists",
7412     "group": "Cm_Lists",
7413     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7414     "version": "0.0.0",
7415     "filename": "server/api/cmList/index.js",
7416     "groupTitle": "Cm_Lists"
7417   },
7418   {
7419     "type": "post",
7420     "url": "/api/cm/lists/{id}/users",
7421     "title": "Adds agents to a list",
7422     "examples": [
7423       {
7424         "title": "Example usage:",
7425         "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",
7426         "type": "json"
7427       }
7428     ],
7429     "name": "addAgents",
7430     "group": "Cm_Lists",
7431     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7432     "version": "0.0.0",
7433     "filename": "server/api/cmList/index.js",
7434     "groupTitle": "Cm_Lists"
7435   },
7436   {
7437     "type": "post",
7438     "url": "/api/cm/lists/{id}/contacts",
7439     "title": "Creates new contacts",
7440     "examples": [
7441       {
7442         "title": "Example usage:",
7443         "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",
7444         "type": "json"
7445       }
7446     ],
7447     "name": "addContacts",
7448     "group": "Cm_Lists",
7449     "parameter": {
7450       "fields": {
7451         "Body": [
7452           {
7453             "group": "Body",
7454             "type": "String",
7455             "optional": false,
7456             "field": "firstName",
7457             "description": ""
7458           },
7459           {
7460             "group": "Body",
7461             "type": "String",
7462             "optional": true,
7463             "field": "lastName",
7464             "description": ""
7465           },
7466           {
7467             "group": "Body",
7468             "type": "String",
7469             "optional": true,
7470             "field": "street",
7471             "description": ""
7472           },
7473           {
7474             "group": "Body",
7475             "type": "String",
7476             "optional": true,
7477             "field": "postalCode",
7478             "description": ""
7479           },
7480           {
7481             "group": "Body",
7482             "type": "String",
7483             "optional": true,
7484             "field": "city",
7485             "description": ""
7486           },
7487           {
7488             "group": "Body",
7489             "type": "String",
7490             "optional": true,
7491             "field": "country",
7492             "description": ""
7493           },
7494           {
7495             "group": "Body",
7496             "type": "String",
7497             "optional": true,
7498             "field": "dateOfBirth",
7499             "description": ""
7500           },
7501           {
7502             "group": "Body",
7503             "type": "Text",
7504             "optional": true,
7505             "field": "description",
7506             "description": ""
7507           },
7508           {
7509             "group": "Body",
7510             "type": "String",
7511             "optional": true,
7512             "field": "phone",
7513             "description": ""
7514           },
7515           {
7516             "group": "Body",
7517             "type": "String",
7518             "optional": true,
7519             "field": "mobile",
7520             "description": ""
7521           },
7522           {
7523             "group": "Body",
7524             "type": "String",
7525             "optional": true,
7526             "field": "fax",
7527             "description": ""
7528           },
7529           {
7530             "group": "Body",
7531             "type": "String",
7532             "optional": true,
7533             "field": "email",
7534             "description": ""
7535           },
7536           {
7537             "group": "Body",
7538             "type": "String",
7539             "optional": true,
7540             "field": "url",
7541             "description": ""
7542           },
7543           {
7544             "group": "Body",
7545             "type": "String",
7546             "optional": true,
7547             "field": "facebook",
7548             "description": ""
7549           },
7550           {
7551             "group": "Body",
7552             "type": "String",
7553             "optional": true,
7554             "field": "fb_data",
7555             "description": ""
7556           },
7557           {
7558             "group": "Body",
7559             "type": "String",
7560             "optional": true,
7561             "field": "twitter",
7562             "description": ""
7563           },
7564           {
7565             "group": "Body",
7566             "type": "String",
7567             "optional": true,
7568             "field": "skype",
7569             "description": ""
7570           },
7571           {
7572             "group": "Body",
7573             "type": "String",
7574             "optional": true,
7575             "field": "teams",
7576             "description": ""
7577           },
7578           {
7579             "group": "Body",
7580             "type": "String",
7581             "optional": true,
7582             "field": "viber",
7583             "description": ""
7584           },
7585           {
7586             "group": "Body",
7587             "type": "String",
7588             "optional": true,
7589             "field": "line",
7590             "description": ""
7591           },
7592           {
7593             "group": "Body",
7594             "type": "String",
7595             "optional": true,
7596             "field": "wechat",
7597             "description": ""
7598           },
7599           {
7600             "group": "Body",
7601             "type": "String",
7602             "optional": true,
7603             "field": "telegram",
7604             "description": ""
7605           },
7606           {
7607             "group": "Body",
7608             "type": "Integer",
7609             "optional": true,
7610             "field": "UserId",
7611             "description": ""
7612           },
7613           {
7614             "group": "Body",
7615             "type": "Integer",
7616             "optional": true,
7617             "field": "priority",
7618             "description": ""
7619           },
7620           {
7621             "group": "Body",
7622             "type": "String",
7623             "optional": true,
7624             "field": "scheduledat",
7625             "description": ""
7626           }
7627         ]
7628       }
7629     },
7630     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7631     "version": "0.0.0",
7632     "filename": "server/api/cmList/index.js",
7633     "groupTitle": "Cm_Lists"
7634   },
7635   {
7636     "type": "post",
7637     "url": "/api/cm/lists/{id}/fields",
7638     "title": "Creates a new custom field",
7639     "examples": [
7640       {
7641         "title": "Example usage:",
7642         "content": "curl https://{domain}/api/cm/lists/{id}/fields -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7643         "type": "json"
7644       }
7645     ],
7646     "name": "addCustomField",
7647     "group": "Cm_Lists",
7648     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7649     "version": "0.0.0",
7650     "filename": "server/api/cmList/index.js",
7651     "groupTitle": "Cm_Lists"
7652   },
7653   {
7654     "type": "post",
7655     "url": "/api/cm/lists/{id}/dispositions",
7656     "title": "Creates new disposition",
7657     "examples": [
7658       {
7659         "title": "Example usage:",
7660         "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7661         "type": "json"
7662       }
7663     ],
7664     "name": "addDisposition",
7665     "group": "Cm_Lists",
7666     "parameter": {
7667       "fields": {
7668         "Body": [
7669           {
7670             "group": "Body",
7671             "type": "String",
7672             "optional": false,
7673             "field": "name",
7674             "description": ""
7675           },
7676           {
7677             "group": "Body",
7678             "type": "String",
7679             "allowedValues": [
7680               "\"first\"",
7681               "\"second\"",
7682               "\"third\""
7683             ],
7684             "optional": false,
7685             "field": "level",
7686             "description": ""
7687           },
7688           {
7689             "group": "Body",
7690             "type": "String",
7691             "optional": true,
7692             "field": "description",
7693             "description": ""
7694           }
7695         ]
7696       }
7697     },
7698     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7699     "version": "0.0.0",
7700     "filename": "server/api/cmList/index.js",
7701     "groupTitle": "Cm_Lists"
7702   },
7703   {
7704     "type": "get",
7705     "url": "/api/cm/lists/{id}/contacts",
7706     "title": "Gets List Contacts",
7707     "examples": [
7708       {
7709         "title": "Example usage:",
7710         "content": "curl https://{domain}/api/cm/lists/{id}/contacts -v -u {name}:{password} -X GET",
7711         "type": "json"
7712       }
7713     ],
7714     "name": "getContacts",
7715     "group": "Cm_Lists",
7716     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7717     "version": "0.0.0",
7718     "filename": "server/api/cmList/index.js",
7719     "groupTitle": "Cm_Lists"
7720   },
7721   {
7722     "type": "get",
7723     "url": "/api/cm/lists/{id}/fields",
7724     "title": "Gets Custom Fields",
7725     "examples": [
7726       {
7727         "title": "Example usage:",
7728         "content": "curl https://{domain}/api/cm/lists/{id}/fields -v -u {name}:{password} -X GET",
7729         "type": "json"
7730       }
7731     ],
7732     "name": "getCustomFields",
7733     "group": "Cm_Lists",
7734     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7735     "version": "0.0.0",
7736     "filename": "server/api/cmList/index.js",
7737     "groupTitle": "Cm_Lists"
7738   },
7739   {
7740     "type": "get",
7741     "url": "/api/cm/lists/{id}/dispositions",
7742     "title": "Gets list dispositions",
7743     "examples": [
7744       {
7745         "title": "Example usage:",
7746         "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -v -u {name}:{password} -X GET",
7747         "type": "json"
7748       }
7749     ],
7750     "name": "getDispositions",
7751     "group": "Cm_Lists",
7752     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7753     "version": "0.0.0",
7754     "filename": "server/api/cmList/index.js",
7755     "groupTitle": "Cm_Lists"
7756   },
7757   {
7758     "type": "get",
7759     "url": "/api/cm/lists/{id}/contacts/csv",
7760     "title": "Gets CSV List Contacts",
7761     "examples": [
7762       {
7763         "title": "Example usage:",
7764         "content": "curl https://{domain}/api/cm/lists/{id}/contacts/csv -v -u {name}:{password} -X GET",
7765         "type": "json"
7766       }
7767     ],
7768     "name": "grunt",
7769     "group": "Cm_Lists",
7770     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7771     "version": "0.0.0",
7772     "filename": "server/api/cmList/index.js",
7773     "groupTitle": "Cm_Lists"
7774   },
7775   {
7776     "type": "put",
7777     "url": "/api/cm/lists/{id}",
7778     "title": "Update an existing List",
7779     "examples": [
7780       {
7781         "title": "Example usage:",
7782         "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",
7783         "type": "json"
7784       }
7785     ],
7786     "name": "updateLists",
7787     "group": "Cm_Lists",
7788     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7789     "version": "0.0.0",
7790     "filename": "server/api/cmList/index.js",
7791     "groupTitle": "Cm_Lists"
7792   },
7793   {
7794     "type": "post",
7795     "url": "/api/cm/contacts/upload/:id",
7796     "title": "Import new contacts by csv",
7797     "examples": [
7798       {
7799         "title": "Example usage:",
7800         "content": "curl https://{domain}/api/cm/contacts/upload/:id -v -u {name}:{password} -X POST",
7801         "type": "json"
7802       }
7803     ],
7804     "name": "import",
7805     "group": "Cm_contacts",
7806     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7807     "version": "0.0.0",
7808     "filename": "server/api/cmContact/index.js",
7809     "groupTitle": "Cm_contacts"
7810   },
7811   {
7812     "type": "post",
7813     "url": "/api/cm/contacts/upload",
7814     "title": "Upload csv",
7815     "examples": [
7816       {
7817         "title": "Example usage:",
7818         "content": "curl https://{domain}/api/cm/contacts/upload -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
7819         "type": "json"
7820       }
7821     ],
7822     "name": "upload",
7823     "group": "Cm_contacts",
7824     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7825     "version": "0.0.0",
7826     "filename": "server/api/cmContact/index.js",
7827     "groupTitle": "Cm_contacts"
7828   },
7829   {
7830     "type": "post",
7831     "url": "/api/cm/contacts/csv",
7832     "title": "Create new contacts by csv",
7833     "examples": [
7834       {
7835         "title": "Example usage:",
7836         "content": "curl https://{domain}/api/cm/contacts/csv -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
7837         "type": "json"
7838       }
7839     ],
7840     "name": "uploadCsv",
7841     "group": "Cm_contacts",
7842     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7843     "version": "0.0.0",
7844     "filename": "server/api/cmContact/index.js",
7845     "groupTitle": "Cm_contacts"
7846   },
7847   {
7848     "type": "delete",
7849     "url": "/api/conditions/{id}",
7850     "title": "Deletes a Condition",
7851     "examples": [
7852       {
7853         "title": "Example usage:",
7854         "content": "curl https://{domain}/api/conditions/{id} -v -u {name}:{password} -X DELETE",
7855         "type": "json"
7856       }
7857     ],
7858     "name": "DeleteConditions",
7859     "group": "Conditions",
7860     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7861     "version": "0.0.0",
7862     "filename": "server/api/condition/index.js",
7863     "groupTitle": "Conditions"
7864   },
7865   {
7866     "type": "put",
7867     "url": "/api/conditions/{id}",
7868     "title": "Update an existing Condition",
7869     "examples": [
7870       {
7871         "title": "Example usage:",
7872         "content": "curl https://{domain}/api/conditions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
7873         "type": "json"
7874       }
7875     ],
7876     "name": "updateConditions",
7877     "group": "Conditions",
7878     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7879     "version": "0.0.0",
7880     "filename": "server/api/condition/index.js",
7881     "groupTitle": "Conditions"
7882   },
7883   {
7884     "type": "post",
7885     "url": "/api/cm/custom_field",
7886     "title": "Create a new custom field",
7887     "examples": [
7888       {
7889         "title": "Example usage:",
7890         "content": "curl https://{domain}/api/cm/custom_field  -d '{\"name\": \"mycf\", \"type\": \"text\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7891         "type": "json"
7892       }
7893     ],
7894     "name": "CreateCustomField",
7895     "group": "Custom_Fields",
7896     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7897     "version": "0.0.0",
7898     "filename": "server/api/cmCustomField/index.js",
7899     "groupTitle": "Custom_Fields"
7900   },
7901   {
7902     "type": "post",
7903     "url": "/api/dashboards/items",
7904     "title": "Create dasboard item",
7905     "examples": [
7906       {
7907         "title": "Example usage:",
7908         "content": "curl https://{domain}/api/dashboards/items \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
7909         "type": "json"
7910       }
7911     ],
7912     "name": "Create",
7913     "group": "Dashboard_Items",
7914     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7915     "version": "0.0.0",
7916     "filename": "server/api/dashboardItem/index.js",
7917     "groupTitle": "Dashboard_Items"
7918   },
7919   {
7920     "type": "delete",
7921     "url": "/api/dashboards/items/{id}",
7922     "title": "Deletes a Dashboard Item",
7923     "examples": [
7924       {
7925         "title": "Example usage:",
7926         "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X DELETE",
7927         "type": "json"
7928       }
7929     ],
7930     "name": "DeleteDashboard_Items",
7931     "group": "Dashboard_Items",
7932     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7933     "version": "0.0.0",
7934     "filename": "server/api/dashboardItem/index.js",
7935     "groupTitle": "Dashboard_Items"
7936   },
7937   {
7938     "type": "get",
7939     "url": "/api/dashboards/items/{id}",
7940     "title": "Gets a single Dashboard Item",
7941     "examples": [
7942       {
7943         "title": "Example usage:",
7944         "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password}",
7945         "type": "json"
7946       }
7947     ],
7948     "name": "ShowDashboard_Items",
7949     "group": "Dashboard_Items",
7950     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7951     "version": "0.0.0",
7952     "filename": "server/api/dashboardItem/index.js",
7953     "groupTitle": "Dashboard_Items"
7954   },
7955   {
7956     "type": "put",
7957     "url": "/api/dashboards/items/{id}",
7958     "title": "Update an existing item",
7959     "examples": [
7960       {
7961         "title": "Example usage:",
7962         "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X PUT",
7963         "type": "json"
7964       }
7965     ],
7966     "name": "Update",
7967     "group": "Dashboard_Items",
7968     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7969     "version": "0.0.0",
7970     "filename": "server/api/dashboardItem/index.js",
7971     "groupTitle": "Dashboard_Items"
7972   },
7973   {
7974     "type": "post",
7975     "url": "/api/dashboards/clone",
7976     "title": "Clone an existing Dashboard",
7977     "examples": [
7978       {
7979         "title": "Example usage:",
7980         "content": "curl https://{domain}/api/dashboards/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7981         "type": "json"
7982       }
7983     ],
7984     "name": "CloneDashboards",
7985     "group": "Dashboards",
7986     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7987     "version": "0.0.0",
7988     "filename": "server/api/dashboard/index.js",
7989     "groupTitle": "Dashboards"
7990   },
7991   {
7992     "type": "post",
7993     "url": "/api/dashboards",
7994     "title": "Creates a new Dashboard",
7995     "examples": [
7996       {
7997         "title": "Example usage:",
7998         "content": "curl https://{domain}/api/dashboards -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7999         "type": "json"
8000       }
8001     ],
8002     "name": "CreateDashboards",
8003     "group": "Dashboards",
8004     "parameter": {
8005       "fields": {
8006         "Body": [
8007           {
8008             "group": "Body",
8009             "type": "String",
8010             "optional": false,
8011             "field": "name",
8012             "description": ""
8013           },
8014           {
8015             "group": "Body",
8016             "type": "String",
8017             "optional": true,
8018             "field": "description",
8019             "description": ""
8020           }
8021         ]
8022       }
8023     },
8024     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8025     "version": "0.0.0",
8026     "filename": "server/api/dashboard/index.js",
8027     "groupTitle": "Dashboards"
8028   },
8029   {
8030     "type": "delete",
8031     "url": "/api/dashboards/{id}",
8032     "title": "Deletes a Dashboard",
8033     "examples": [
8034       {
8035         "title": "Example usage:",
8036         "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password} -X DELETE",
8037         "type": "json"
8038       }
8039     ],
8040     "name": "DeleteDashboards",
8041     "group": "Dashboards",
8042     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8043     "version": "0.0.0",
8044     "filename": "server/api/dashboard/index.js",
8045     "groupTitle": "Dashboards"
8046   },
8047   {
8048     "type": "get",
8049     "url": "/api/dashboards",
8050     "title": "Gets a list of Dashboards",
8051     "examples": [
8052       {
8053         "title": "Example usage:",
8054         "content": "curl https://{domain}/api/dashboards -v -u {name}:{password}",
8055         "type": "json"
8056       }
8057     ],
8058     "name": "GetDashboards",
8059     "group": "Dashboards",
8060     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8061     "version": "0.0.0",
8062     "filename": "server/api/dashboard/index.js",
8063     "groupTitle": "Dashboards"
8064   },
8065   {
8066     "type": "get",
8067     "url": "/api/dashboards/{id}",
8068     "title": "Gets a single Dashboard",
8069     "examples": [
8070       {
8071         "title": "Example usage:",
8072         "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password}",
8073         "type": "json"
8074       }
8075     ],
8076     "name": "ShowDashboards",
8077     "group": "Dashboards",
8078     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8079     "version": "0.0.0",
8080     "filename": "server/api/dashboard/index.js",
8081     "groupTitle": "Dashboards"
8082   },
8083   {
8084     "type": "post",
8085     "url": "/api/dashboards/{id}/items",
8086     "title": "Creates new item",
8087     "examples": [
8088       {
8089         "title": "Example usage:",
8090         "content": "curl https://{domain}/api/dashboards/{id}/items -d '{\"type\": \"counter\", \"...\": \"...\"}]' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
8091         "type": "json"
8092       }
8093     ],
8094     "name": "addItem",
8095     "group": "Dashboards",
8096     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8097     "version": "0.0.0",
8098     "filename": "server/api/dashboard/index.js",
8099     "groupTitle": "Dashboards"
8100   },
8101   {
8102     "type": "get",
8103     "url": "/api/dashboards/{id}/items",
8104     "title": "Gets items",
8105     "examples": [
8106       {
8107         "title": "Example usage:",
8108         "content": "curl https://{domain}/api/dashboards/{id}/items -v -u {name}:{password} -X GET",
8109         "type": "json"
8110       }
8111     ],
8112     "name": "getItems",
8113     "group": "Dashboards",
8114     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8115     "version": "0.0.0",
8116     "filename": "server/api/dashboard/index.js",
8117     "groupTitle": "Dashboards"
8118   },
8119   {
8120     "type": "put",
8121     "url": "/api/dashboards/{id}",
8122     "title": "Update an existing Dashboard",
8123     "examples": [
8124       {
8125         "title": "Example usage:",
8126         "content": "curl https://{domain}/api/dashboards/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8127         "type": "json"
8128       }
8129     ],
8130     "name": "updateDashboards",
8131     "group": "Dashboards",
8132     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8133     "version": "0.0.0",
8134     "filename": "server/api/dashboard/index.js",
8135     "groupTitle": "Dashboards"
8136   },
8137   {
8138     "type": "post",
8139     "url": "/api/integrations/desk/accounts",
8140     "title": "Creates a new Desk Account",
8141     "examples": [
8142       {
8143         "title": "Example usage:",
8144         "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",
8145         "type": "json"
8146       }
8147     ],
8148     "name": "CreateDesk_Accounts",
8149     "group": "Desk_Accounts",
8150     "parameter": {
8151       "fields": {
8152         "Body": [
8153           {
8154             "group": "Body",
8155             "type": "String",
8156             "optional": true,
8157             "field": "name",
8158             "description": ""
8159           },
8160           {
8161             "group": "Body",
8162             "type": "String",
8163             "optional": true,
8164             "field": "description",
8165             "description": ""
8166           },
8167           {
8168             "group": "Body",
8169             "type": "String",
8170             "optional": true,
8171             "field": "username",
8172             "description": ""
8173           },
8174           {
8175             "group": "Body",
8176             "type": "String",
8177             "optional": true,
8178             "field": "remoteUri",
8179             "description": ""
8180           },
8181           {
8182             "group": "Body",
8183             "type": "String",
8184             "allowedValues": [
8185               "\"basic\""
8186             ],
8187             "optional": true,
8188             "field": "authType",
8189             "description": ""
8190           },
8191           {
8192             "group": "Body",
8193             "type": "String",
8194             "optional": true,
8195             "field": "password",
8196             "description": ""
8197           },
8198           {
8199             "group": "Body",
8200             "type": "String",
8201             "optional": true,
8202             "field": "consumerKey",
8203             "description": ""
8204           },
8205           {
8206             "group": "Body",
8207             "type": "String",
8208             "optional": true,
8209             "field": "consumerSecret",
8210             "description": ""
8211           },
8212           {
8213             "group": "Body",
8214             "type": "String",
8215             "optional": true,
8216             "field": "token",
8217             "description": ""
8218           },
8219           {
8220             "group": "Body",
8221             "type": "String",
8222             "optional": true,
8223             "field": "tokenSecret",
8224             "description": ""
8225           },
8226           {
8227             "group": "Body",
8228             "type": "String",
8229             "optional": false,
8230             "field": "serverUrl",
8231             "description": ""
8232           },
8233           {
8234             "group": "Body",
8235             "type": "String",
8236             "allowedValues": [
8237               "\"integrationTab\"",
8238               "\"newTab\""
8239             ],
8240             "optional": true,
8241             "field": "type",
8242             "description": ""
8243           }
8244         ]
8245       }
8246     },
8247     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8248     "version": "0.0.0",
8249     "filename": "server/api/intDeskAccount/index.js",
8250     "groupTitle": "Desk_Accounts"
8251   },
8252   {
8253     "type": "delete",
8254     "url": "/api/integrations/desk/accounts/{id}",
8255     "title": "Deletes a Desk Account",
8256     "examples": [
8257       {
8258         "title": "Example usage:",
8259         "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password} -X DELETE",
8260         "type": "json"
8261       }
8262     ],
8263     "name": "DeleteDesk_Accounts",
8264     "group": "Desk_Accounts",
8265     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8266     "version": "0.0.0",
8267     "filename": "server/api/intDeskAccount/index.js",
8268     "groupTitle": "Desk_Accounts"
8269   },
8270   {
8271     "type": "get",
8272     "url": "/api/integrations/desk/accounts",
8273     "title": "Gets a list of Desk Accounts",
8274     "examples": [
8275       {
8276         "title": "Example usage:",
8277         "content": "curl https://{domain}/api/integrations/desk/accounts -v -u {name}:{password}",
8278         "type": "json"
8279       }
8280     ],
8281     "name": "GetDesk_Accounts",
8282     "group": "Desk_Accounts",
8283     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8284     "version": "0.0.0",
8285     "filename": "server/api/intDeskAccount/index.js",
8286     "groupTitle": "Desk_Accounts"
8287   },
8288   {
8289     "type": "get",
8290     "url": "/api/integrations/desk/accounts/{id}",
8291     "title": "Gets a single Desk Account",
8292     "examples": [
8293       {
8294         "title": "Example usage:",
8295         "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password}",
8296         "type": "json"
8297       }
8298     ],
8299     "name": "ShowDesk_Accounts",
8300     "group": "Desk_Accounts",
8301     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8302     "version": "0.0.0",
8303     "filename": "server/api/intDeskAccount/index.js",
8304     "groupTitle": "Desk_Accounts"
8305   },
8306   {
8307     "type": "post",
8308     "url": "/api/integrations/desk/accounts/{id}/configurations",
8309     "title": "Creates new configuration",
8310     "examples": [
8311       {
8312         "title": "Example usage:",
8313         "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",
8314         "type": "json"
8315       }
8316     ],
8317     "name": "addConfiguration",
8318     "group": "Desk_Accounts",
8319     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8320     "version": "0.0.0",
8321     "filename": "server/api/intDeskAccount/index.js",
8322     "groupTitle": "Desk_Accounts"
8323   },
8324   {
8325     "type": "get",
8326     "url": "/api/integrations/desk/accounts/{id}/configurations",
8327     "title": "Gets account configurations",
8328     "examples": [
8329       {
8330         "title": "Example usage:",
8331         "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
8332         "type": "json"
8333       }
8334     ],
8335     "name": "getConfigurations",
8336     "group": "Desk_Accounts",
8337     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8338     "version": "0.0.0",
8339     "filename": "server/api/intDeskAccount/index.js",
8340     "groupTitle": "Desk_Accounts"
8341   },
8342   {
8343     "type": "get",
8344     "url": "/api/integrations/desk/accounts/{id}/fields",
8345     "title": "Gets account fields",
8346     "examples": [
8347       {
8348         "title": "Example usage:",
8349         "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/fields -v -u {name}:{password} -X GET",
8350         "type": "json"
8351       }
8352     ],
8353     "name": "getFields",
8354     "group": "Desk_Accounts",
8355     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8356     "version": "0.0.0",
8357     "filename": "server/api/intDeskAccount/index.js",
8358     "groupTitle": "Desk_Accounts"
8359   },
8360   {
8361     "type": "put",
8362     "url": "/api/integrations/desk/accounts/{id}",
8363     "title": "Update an existing Desk Account",
8364     "examples": [
8365       {
8366         "title": "Example usage:",
8367         "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",
8368         "type": "json"
8369       }
8370     ],
8371     "name": "updateDesk_Accounts",
8372     "group": "Desk_Accounts",
8373     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8374     "version": "0.0.0",
8375     "filename": "server/api/intDeskAccount/index.js",
8376     "groupTitle": "Desk_Accounts"
8377   },
8378   {
8379     "type": "post",
8380     "url": "/api/integrations/desk/configurations",
8381     "title": "Creates a new Desk Configuration",
8382     "examples": [
8383       {
8384         "title": "Example usage:",
8385         "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",
8386         "type": "json"
8387       }
8388     ],
8389     "name": "CreateDesk_Configurations",
8390     "group": "Desk_Configurations",
8391     "parameter": {
8392       "fields": {
8393         "Body": [
8394           {
8395             "group": "Body",
8396             "type": "String",
8397             "optional": true,
8398             "field": "name",
8399             "description": ""
8400           },
8401           {
8402             "group": "Body",
8403             "type": "String",
8404             "optional": true,
8405             "field": "description",
8406             "description": ""
8407           }
8408         ]
8409       }
8410     },
8411     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8412     "version": "0.0.0",
8413     "filename": "server/api/intDeskConfiguration/index.js",
8414     "groupTitle": "Desk_Configurations"
8415   },
8416   {
8417     "type": "delete",
8418     "url": "/api/integrations/desk/configurations/{id}",
8419     "title": "Deletes a Desk Configuration",
8420     "examples": [
8421       {
8422         "title": "Example usage:",
8423         "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password} -X DELETE",
8424         "type": "json"
8425       }
8426     ],
8427     "name": "DeleteDesk_Configurations",
8428     "group": "Desk_Configurations",
8429     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8430     "version": "0.0.0",
8431     "filename": "server/api/intDeskConfiguration/index.js",
8432     "groupTitle": "Desk_Configurations"
8433   },
8434   {
8435     "type": "get",
8436     "url": "/api/integrations/desk/configurations",
8437     "title": "Gets a list of Desk Configurations",
8438     "examples": [
8439       {
8440         "title": "Example usage:",
8441         "content": "curl https://{domain}/api/integrations/desk/configurations -v -u {name}:{password}",
8442         "type": "json"
8443       }
8444     ],
8445     "name": "GetDesk_Configurations",
8446     "group": "Desk_Configurations",
8447     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8448     "version": "0.0.0",
8449     "filename": "server/api/intDeskConfiguration/index.js",
8450     "groupTitle": "Desk_Configurations"
8451   },
8452   {
8453     "type": "get",
8454     "url": "/api/integrations/desk/configurations/{id}",
8455     "title": "Gets a single Desk Configuration",
8456     "examples": [
8457       {
8458         "title": "Example usage:",
8459         "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password}",
8460         "type": "json"
8461       }
8462     ],
8463     "name": "ShowDesk_Configurations",
8464     "group": "Desk_Configurations",
8465     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8466     "version": "0.0.0",
8467     "filename": "server/api/intDeskConfiguration/index.js",
8468     "groupTitle": "Desk_Configurations"
8469   },
8470   {
8471     "type": "get",
8472     "url": "/api/integrations/desk/configurations/{id}/descriptions",
8473     "title": "Gets configurations descriptions",
8474     "examples": [
8475       {
8476         "title": "Example usage:",
8477         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
8478         "type": "json"
8479       }
8480     ],
8481     "name": "getDescriptions",
8482     "group": "Desk_Configurations",
8483     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8484     "version": "0.0.0",
8485     "filename": "server/api/intDeskConfiguration/index.js",
8486     "groupTitle": "Desk_Configurations"
8487   },
8488   {
8489     "type": "get",
8490     "url": "/api/integrations/desk/configurations/{id}/fields",
8491     "title": "Gets configurations fields",
8492     "examples": [
8493       {
8494         "title": "Example usage:",
8495         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/fields -v -u {name}:{password} -X GET",
8496         "type": "json"
8497       }
8498     ],
8499     "name": "getFields",
8500     "group": "Desk_Configurations",
8501     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8502     "version": "0.0.0",
8503     "filename": "server/api/intDeskConfiguration/index.js",
8504     "groupTitle": "Desk_Configurations"
8505   },
8506   {
8507     "type": "get",
8508     "url": "/api/integrations/desk/configurations/{id}/subjects",
8509     "title": "Gets configurations subjects",
8510     "examples": [
8511       {
8512         "title": "Example usage:",
8513         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
8514         "type": "json"
8515       }
8516     ],
8517     "name": "getSubjects",
8518     "group": "Desk_Configurations",
8519     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8520     "version": "0.0.0",
8521     "filename": "server/api/intDeskConfiguration/index.js",
8522     "groupTitle": "Desk_Configurations"
8523   },
8524   {
8525     "type": "get",
8526     "url": "/api/integrations/desk/configurations/{id}/tags",
8527     "title": "Gets configurations tags",
8528     "examples": [
8529       {
8530         "title": "Example usage:",
8531         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/tags -v -u {name}:{password} -X GET",
8532         "type": "json"
8533       }
8534     ],
8535     "name": "getTags",
8536     "group": "Desk_Configurations",
8537     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8538     "version": "0.0.0",
8539     "filename": "server/api/intDeskConfiguration/index.js",
8540     "groupTitle": "Desk_Configurations"
8541   },
8542   {
8543     "type": "post",
8544     "url": "/api/integrations/desk/configurations/{id}/tags",
8545     "title": "Sets new tags",
8546     "examples": [
8547       {
8548         "title": "Example usage:",
8549         "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",
8550         "type": "json"
8551       }
8552     ],
8553     "name": "setTags",
8554     "group": "Desk_Configurations",
8555     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8556     "version": "0.0.0",
8557     "filename": "server/api/intDeskConfiguration/index.js",
8558     "groupTitle": "Desk_Configurations"
8559   },
8560   {
8561     "type": "put",
8562     "url": "/api/integrations/desk/configurations/{id}",
8563     "title": "Update an existing Desk Configuration",
8564     "examples": [
8565       {
8566         "title": "Example usage:",
8567         "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",
8568         "type": "json"
8569       }
8570     ],
8571     "name": "updateDesk_Configurations",
8572     "group": "Desk_Configurations",
8573     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8574     "version": "0.0.0",
8575     "filename": "server/api/intDeskConfiguration/index.js",
8576     "groupTitle": "Desk_Configurations"
8577   },
8578   {
8579     "type": "post",
8580     "url": "/api/integrations/desk/fields",
8581     "title": "Creates a new Desk Field",
8582     "examples": [
8583       {
8584         "title": "Example usage:",
8585         "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",
8586         "type": "json"
8587       }
8588     ],
8589     "name": "CreateDesk_Fields",
8590     "group": "Desk_Fields",
8591     "parameter": {
8592       "fields": {
8593         "Body": [
8594           {
8595             "group": "Body",
8596             "type": "String",
8597             "allowedValues": [
8598               "\"string\"",
8599               "\"variable\"",
8600               "\"customVariable\"",
8601               "\"keyValue\"",
8602               "\"picklist\""
8603             ],
8604             "optional": true,
8605             "field": "type",
8606             "description": ""
8607           },
8608           {
8609             "group": "Body",
8610             "type": "String",
8611             "optional": true,
8612             "field": "content",
8613             "description": ""
8614           },
8615           {
8616             "group": "Body",
8617             "type": "String",
8618             "optional": true,
8619             "field": "key",
8620             "description": ""
8621           },
8622           {
8623             "group": "Body",
8624             "type": "String",
8625             "allowedValues": [
8626               "\"string\"",
8627               "\"variable\"",
8628               "\"customVariable\""
8629             ],
8630             "optional": true,
8631             "field": "keyType",
8632             "description": ""
8633           },
8634           {
8635             "group": "Body",
8636             "type": "String",
8637             "optional": true,
8638             "field": "keyContent",
8639             "description": ""
8640           },
8641           {
8642             "group": "Body",
8643             "type": "String",
8644             "optional": true,
8645             "field": "idField",
8646             "description": ""
8647           },
8648           {
8649             "group": "Body",
8650             "type": "String",
8651             "optional": true,
8652             "field": "nameField",
8653             "description": ""
8654           },
8655           {
8656             "group": "Body",
8657             "type": "Boolean",
8658             "optional": true,
8659             "field": "customField",
8660             "description": ""
8661           },
8662           {
8663             "group": "Body",
8664             "type": "String",
8665             "optional": true,
8666             "field": "variableName",
8667             "description": ""
8668           }
8669         ]
8670       }
8671     },
8672     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8673     "version": "0.0.0",
8674     "filename": "server/api/intDeskField/index.js",
8675     "groupTitle": "Desk_Fields"
8676   },
8677   {
8678     "type": "delete",
8679     "url": "/api/integrations/desk/fields/{id}",
8680     "title": "Deletes a Desk Field",
8681     "examples": [
8682       {
8683         "title": "Example usage:",
8684         "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password} -X DELETE",
8685         "type": "json"
8686       }
8687     ],
8688     "name": "DeleteDesk_Fields",
8689     "group": "Desk_Fields",
8690     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8691     "version": "0.0.0",
8692     "filename": "server/api/intDeskField/index.js",
8693     "groupTitle": "Desk_Fields"
8694   },
8695   {
8696     "type": "get",
8697     "url": "/api/integrations/desk/fields",
8698     "title": "Gets a list of Desk Fields",
8699     "examples": [
8700       {
8701         "title": "Example usage:",
8702         "content": "curl https://{domain}/api/integrations/desk/fields -v -u {name}:{password}",
8703         "type": "json"
8704       }
8705     ],
8706     "name": "GetDesk_Fields",
8707     "group": "Desk_Fields",
8708     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8709     "version": "0.0.0",
8710     "filename": "server/api/intDeskField/index.js",
8711     "groupTitle": "Desk_Fields"
8712   },
8713   {
8714     "type": "get",
8715     "url": "/api/integrations/desk/fields/{id}",
8716     "title": "Gets a single Desk Field",
8717     "examples": [
8718       {
8719         "title": "Example usage:",
8720         "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password}",
8721         "type": "json"
8722       }
8723     ],
8724     "name": "ShowDesk_Fields",
8725     "group": "Desk_Fields",
8726     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8727     "version": "0.0.0",
8728     "filename": "server/api/intDeskField/index.js",
8729     "groupTitle": "Desk_Fields"
8730   },
8731   {
8732     "type": "put",
8733     "url": "/api/integrations/desk/fields/{id}",
8734     "title": "Update an existing Desk Field",
8735     "examples": [
8736       {
8737         "title": "Example usage:",
8738         "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",
8739         "type": "json"
8740       }
8741     ],
8742     "name": "updateDesk_Fields",
8743     "group": "Desk_Fields",
8744     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/intDeskField/index.js",
8747     "groupTitle": "Desk_Fields"
8748   },
8749   {
8750     "type": "post",
8751     "url": "/api/dispositions",
8752     "title": "Creates a new Disposition",
8753     "examples": [
8754       {
8755         "title": "Example usage:",
8756         "content": "curl https://{domain}/api/dispositions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8757         "type": "json"
8758       }
8759     ],
8760     "name": "CreateDispositions",
8761     "group": "Dispositions",
8762     "parameter": {
8763       "fields": {
8764         "Body": [
8765           {
8766             "group": "Body",
8767             "type": "String",
8768             "optional": false,
8769             "field": "name",
8770             "description": ""
8771           },
8772           {
8773             "group": "Body",
8774             "type": "String",
8775             "allowedValues": [
8776               "\"first\"",
8777               "\"second\"",
8778               "\"third\""
8779             ],
8780             "optional": false,
8781             "field": "level",
8782             "description": ""
8783           },
8784           {
8785             "group": "Body",
8786             "type": "String",
8787             "optional": true,
8788             "field": "description",
8789             "description": ""
8790           }
8791         ]
8792       }
8793     },
8794     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8795     "version": "0.0.0",
8796     "filename": "server/api/disposition/index.js",
8797     "groupTitle": "Dispositions"
8798   },
8799   {
8800     "type": "delete",
8801     "url": "/api/dispositions/{id}",
8802     "title": "Deletes a Disposition",
8803     "examples": [
8804       {
8805         "title": "Example usage:",
8806         "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password} -X DELETE",
8807         "type": "json"
8808       }
8809     ],
8810     "name": "DeleteDispositions",
8811     "group": "Dispositions",
8812     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8813     "version": "0.0.0",
8814     "filename": "server/api/disposition/index.js",
8815     "groupTitle": "Dispositions"
8816   },
8817   {
8818     "type": "get",
8819     "url": "/api/dispositions",
8820     "title": "Gets a list of Dispositions",
8821     "examples": [
8822       {
8823         "title": "Example usage:",
8824         "content": "curl https://{domain}/api/dispositions -v -u {name}:{password}",
8825         "type": "json"
8826       }
8827     ],
8828     "name": "GetDispositions",
8829     "group": "Dispositions",
8830     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8831     "version": "0.0.0",
8832     "filename": "server/api/disposition/index.js",
8833     "groupTitle": "Dispositions"
8834   },
8835   {
8836     "type": "get",
8837     "url": "/api/dispositions/{id}",
8838     "title": "Gets a single Disposition",
8839     "examples": [
8840       {
8841         "title": "Example usage:",
8842         "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password}",
8843         "type": "json"
8844       }
8845     ],
8846     "name": "ShowDispositions",
8847     "group": "Dispositions",
8848     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8849     "version": "0.0.0",
8850     "filename": "server/api/disposition/index.js",
8851     "groupTitle": "Dispositions"
8852   },
8853   {
8854     "type": "put",
8855     "url": "/api/dispositions/{id}",
8856     "title": "Update an existing Disposition",
8857     "examples": [
8858       {
8859         "title": "Example usage:",
8860         "content": "curl https://{domain}/api/dispositions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8861         "type": "json"
8862       }
8863     ],
8864     "name": "updateDispositions",
8865     "group": "Dispositions",
8866     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8867     "version": "0.0.0",
8868     "filename": "server/api/disposition/index.js",
8869     "groupTitle": "Dispositions"
8870   },
8871   {
8872     "type": "post",
8873     "url": "/api/integrations/dynamics365/accounts",
8874     "title": "Creates a new Dynamics365 Account",
8875     "examples": [
8876       {
8877         "title": "Example usage:",
8878         "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",
8879         "type": "json"
8880       }
8881     ],
8882     "name": "CreateDynamics365_Accounts",
8883     "group": "Dynamics365_Accounts",
8884     "parameter": {
8885       "fields": {
8886         "Body": [
8887           {
8888             "group": "Body",
8889             "type": "String",
8890             "optional": true,
8891             "field": "name",
8892             "description": ""
8893           },
8894           {
8895             "group": "Body",
8896             "type": "String",
8897             "optional": true,
8898             "field": "username",
8899             "description": ""
8900           },
8901           {
8902             "group": "Body",
8903             "type": "String",
8904             "optional": true,
8905             "field": "password",
8906             "description": ""
8907           },
8908           {
8909             "group": "Body",
8910             "type": "String",
8911             "optional": true,
8912             "field": "remoteUri",
8913             "description": ""
8914           },
8915           {
8916             "group": "Body",
8917             "type": "String",
8918             "optional": true,
8919             "field": "tenantId",
8920             "description": ""
8921           },
8922           {
8923             "group": "Body",
8924             "type": "String",
8925             "optional": true,
8926             "field": "clientId",
8927             "description": ""
8928           },
8929           {
8930             "group": "Body",
8931             "type": "String",
8932             "optional": true,
8933             "field": "clientSecret",
8934             "description": ""
8935           },
8936           {
8937             "group": "Body",
8938             "type": "String",
8939             "optional": false,
8940             "field": "serverUrl",
8941             "description": ""
8942           },
8943           {
8944             "group": "Body",
8945             "type": "String",
8946             "optional": true,
8947             "field": "description",
8948             "description": ""
8949           }
8950         ]
8951       }
8952     },
8953     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8954     "version": "0.0.0",
8955     "filename": "server/api/intDynamics365Account/index.js",
8956     "groupTitle": "Dynamics365_Accounts"
8957   },
8958   {
8959     "type": "delete",
8960     "url": "/api/integrations/dynamics365/accounts/{id}",
8961     "title": "Deletes a Dynamics365 Account",
8962     "examples": [
8963       {
8964         "title": "Example usage:",
8965         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password} -X DELETE",
8966         "type": "json"
8967       }
8968     ],
8969     "name": "DeleteDynamics365_Accounts",
8970     "group": "Dynamics365_Accounts",
8971     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8972     "version": "0.0.0",
8973     "filename": "server/api/intDynamics365Account/index.js",
8974     "groupTitle": "Dynamics365_Accounts"
8975   },
8976   {
8977     "type": "get",
8978     "url": "/api/integrations/dynamics365/accounts",
8979     "title": "Gets a list of Dynamics365 Accounts",
8980     "examples": [
8981       {
8982         "title": "Example usage:",
8983         "content": "curl https://{domain}/api/integrations/dynamics365/accounts -v -u {name}:{password}",
8984         "type": "json"
8985       }
8986     ],
8987     "name": "GetDynamics365_Accounts",
8988     "group": "Dynamics365_Accounts",
8989     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8990     "version": "0.0.0",
8991     "filename": "server/api/intDynamics365Account/index.js",
8992     "groupTitle": "Dynamics365_Accounts"
8993   },
8994   {
8995     "type": "get",
8996     "url": "/api/integrations/dynamics365/accounts/{id}",
8997     "title": "Gets a single Dynamics365 Account",
8998     "examples": [
8999       {
9000         "title": "Example usage:",
9001         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password}",
9002         "type": "json"
9003       }
9004     ],
9005     "name": "ShowDynamics365_Accounts",
9006     "group": "Dynamics365_Accounts",
9007     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9008     "version": "0.0.0",
9009     "filename": "server/api/intDynamics365Account/index.js",
9010     "groupTitle": "Dynamics365_Accounts"
9011   },
9012   {
9013     "type": "post",
9014     "url": "/api/integrations/dynamics365/accounts/{id}/configurations",
9015     "title": "Creates new configuration",
9016     "examples": [
9017       {
9018         "title": "Example usage:",
9019         "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",
9020         "type": "json"
9021       }
9022     ],
9023     "name": "addConfiguration",
9024     "group": "Dynamics365_Accounts",
9025     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9026     "version": "0.0.0",
9027     "filename": "server/api/intDynamics365Account/index.js",
9028     "groupTitle": "Dynamics365_Accounts"
9029   },
9030   {
9031     "type": "get",
9032     "url": "/api/integrations/dynamics365/accounts/{id}/configurations",
9033     "title": "Gets account configurations",
9034     "examples": [
9035       {
9036         "title": "Example usage:",
9037         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/configurations -v -u {name}:{password} -X GET",
9038         "type": "json"
9039       }
9040     ],
9041     "name": "getConfigurations",
9042     "group": "Dynamics365_Accounts",
9043     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9044     "version": "0.0.0",
9045     "filename": "server/api/intDynamics365Account/index.js",
9046     "groupTitle": "Dynamics365_Accounts"
9047   },
9048   {
9049     "type": "get",
9050     "url": "/api/integrations/dynamics365/accounts/{id}/fields",
9051     "title": "Gets account fields",
9052     "examples": [
9053       {
9054         "title": "Example usage:",
9055         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/fields -v -u {name}:{password} -X GET",
9056         "type": "json"
9057       }
9058     ],
9059     "name": "getFields",
9060     "group": "Dynamics365_Accounts",
9061     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9062     "version": "0.0.0",
9063     "filename": "server/api/intDynamics365Account/index.js",
9064     "groupTitle": "Dynamics365_Accounts"
9065   },
9066   {
9067     "type": "put",
9068     "url": "/api/integrations/dynamics365/accounts/{id}",
9069     "title": "Update an existing Dynamics365 Account",
9070     "examples": [
9071       {
9072         "title": "Example usage:",
9073         "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",
9074         "type": "json"
9075       }
9076     ],
9077     "name": "updateDynamics365_Accounts",
9078     "group": "Dynamics365_Accounts",
9079     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9080     "version": "0.0.0",
9081     "filename": "server/api/intDynamics365Account/index.js",
9082     "groupTitle": "Dynamics365_Accounts"
9083   },
9084   {
9085     "type": "post",
9086     "url": "/api/integrations/dynamics365/configurations",
9087     "title": "Creates a new Dynamics365 Configuration",
9088     "examples": [
9089       {
9090         "title": "Example usage:",
9091         "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",
9092         "type": "json"
9093       }
9094     ],
9095     "name": "CreateDynamics365_Configurations",
9096     "group": "Dynamics365_Configurations",
9097     "parameter": {
9098       "fields": {
9099         "Body": [
9100           {
9101             "group": "Body",
9102             "type": "String",
9103             "optional": true,
9104             "field": "name",
9105             "description": ""
9106           },
9107           {
9108             "group": "Body",
9109             "type": "String",
9110             "optional": true,
9111             "field": "description",
9112             "description": ""
9113           },
9114           {
9115             "group": "Body",
9116             "type": "String",
9117             "allowedValues": [
9118               "\"incident\"",
9119               "\"phonecall\""
9120             ],
9121             "optional": true,
9122             "field": "ticketType",
9123             "description": ""
9124           }
9125         ]
9126       }
9127     },
9128     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9129     "version": "0.0.0",
9130     "filename": "server/api/intDynamics365Configuration/index.js",
9131     "groupTitle": "Dynamics365_Configurations"
9132   },
9133   {
9134     "type": "delete",
9135     "url": "/api/integrations/dynamics365/configurations/{id}",
9136     "title": "Deletes a Dynamics365 Configuration",
9137     "examples": [
9138       {
9139         "title": "Example usage:",
9140         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password} -X DELETE",
9141         "type": "json"
9142       }
9143     ],
9144     "name": "DeleteDynamics365_Configurations",
9145     "group": "Dynamics365_Configurations",
9146     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9147     "version": "0.0.0",
9148     "filename": "server/api/intDynamics365Configuration/index.js",
9149     "groupTitle": "Dynamics365_Configurations"
9150   },
9151   {
9152     "type": "get",
9153     "url": "/api/integrations/dynamics365/configurations",
9154     "title": "Gets a list of Dynamics365 Configurations",
9155     "examples": [
9156       {
9157         "title": "Example usage:",
9158         "content": "curl https://{domain}/api/integrations/dynamics365/configurations -v -u {name}:{password}",
9159         "type": "json"
9160       }
9161     ],
9162     "name": "GetDynamics365_Configurations",
9163     "group": "Dynamics365_Configurations",
9164     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9165     "version": "0.0.0",
9166     "filename": "server/api/intDynamics365Configuration/index.js",
9167     "groupTitle": "Dynamics365_Configurations"
9168   },
9169   {
9170     "type": "get",
9171     "url": "/api/integrations/dynamics365/configurations/{id}",
9172     "title": "Gets a single Dynamics365 Configuration",
9173     "examples": [
9174       {
9175         "title": "Example usage:",
9176         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password}",
9177         "type": "json"
9178       }
9179     ],
9180     "name": "ShowDynamics365_Configurations",
9181     "group": "Dynamics365_Configurations",
9182     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9183     "version": "0.0.0",
9184     "filename": "server/api/intDynamics365Configuration/index.js",
9185     "groupTitle": "Dynamics365_Configurations"
9186   },
9187   {
9188     "type": "get",
9189     "url": "/api/integrations/dynamics365/configurations/{id}/descriptions",
9190     "title": "Gets configurations descriptions",
9191     "examples": [
9192       {
9193         "title": "Example usage:",
9194         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
9195         "type": "json"
9196       }
9197     ],
9198     "name": "getDescriptions",
9199     "group": "Dynamics365_Configurations",
9200     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9201     "version": "0.0.0",
9202     "filename": "server/api/intDynamics365Configuration/index.js",
9203     "groupTitle": "Dynamics365_Configurations"
9204   },
9205   {
9206     "type": "get",
9207     "url": "/api/integrations/dynamics365/configurations/{id}/fields",
9208     "title": "Gets configurations fields",
9209     "examples": [
9210       {
9211         "title": "Example usage:",
9212         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
9213         "type": "json"
9214       }
9215     ],
9216     "name": "getFields",
9217     "group": "Dynamics365_Configurations",
9218     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9219     "version": "0.0.0",
9220     "filename": "server/api/intDynamics365Configuration/index.js",
9221     "groupTitle": "Dynamics365_Configurations"
9222   },
9223   {
9224     "type": "get",
9225     "url": "/api/integrations/zoho/configurations/{id}/subjects",
9226     "title": "Gets configurations subjects",
9227     "examples": [
9228       {
9229         "title": "Example usage:",
9230         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/subjects -v -u {name}:{password} -X GET",
9231         "type": "json"
9232       }
9233     ],
9234     "name": "getSubjects",
9235     "group": "Dynamics365_Configurations",
9236     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9237     "version": "0.0.0",
9238     "filename": "server/api/intDynamics365Configuration/index.js",
9239     "groupTitle": "Dynamics365_Configurations"
9240   },
9241   {
9242     "type": "put",
9243     "url": "/api/integrations/dynamics365/configurations/{id}",
9244     "title": "Update an existing Dynamics365 Configuration",
9245     "examples": [
9246       {
9247         "title": "Example usage:",
9248         "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",
9249         "type": "json"
9250       }
9251     ],
9252     "name": "updateDynamics365_Configurations",
9253     "group": "Dynamics365_Configurations",
9254     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9255     "version": "0.0.0",
9256     "filename": "server/api/intDynamics365Configuration/index.js",
9257     "groupTitle": "Dynamics365_Configurations"
9258   },
9259   {
9260     "type": "post",
9261     "url": "/api/integrations/dynamics365/fields",
9262     "title": "Creates a new Dynamics365 Field",
9263     "examples": [
9264       {
9265         "title": "Example usage:",
9266         "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",
9267         "type": "json"
9268       }
9269     ],
9270     "name": "CreateDynamics365_Fields",
9271     "group": "Dynamics365_Fields",
9272     "parameter": {
9273       "fields": {
9274         "Body": [
9275           {
9276             "group": "Body",
9277             "type": "String",
9278             "allowedValues": [
9279               "\"string\"",
9280               "\"variable\"",
9281               "\"customVariable\"",
9282               "\"keyValue\"",
9283               "\"picklist\""
9284             ],
9285             "optional": true,
9286             "field": "type",
9287             "description": ""
9288           },
9289           {
9290             "group": "Body",
9291             "type": "String",
9292             "optional": true,
9293             "field": "content",
9294             "description": ""
9295           },
9296           {
9297             "group": "Body",
9298             "type": "String",
9299             "optional": true,
9300             "field": "key",
9301             "description": ""
9302           },
9303           {
9304             "group": "Body",
9305             "type": "String",
9306             "allowedValues": [
9307               "\"string\"",
9308               "\"variable\"",
9309               "\"customVariable\""
9310             ],
9311             "optional": true,
9312             "field": "keyType",
9313             "description": ""
9314           },
9315           {
9316             "group": "Body",
9317             "type": "String",
9318             "optional": true,
9319             "field": "keyContent",
9320             "description": ""
9321           },
9322           {
9323             "group": "Body",
9324             "type": "String",
9325             "optional": true,
9326             "field": "idField",
9327             "description": ""
9328           },
9329           {
9330             "group": "Body",
9331             "type": "String",
9332             "optional": true,
9333             "field": "nameField",
9334             "description": ""
9335           },
9336           {
9337             "group": "Body",
9338             "type": "Boolean",
9339             "optional": true,
9340             "field": "customField",
9341             "description": ""
9342           },
9343           {
9344             "group": "Body",
9345             "type": "String",
9346             "optional": true,
9347             "field": "variableName",
9348             "description": ""
9349           }
9350         ]
9351       }
9352     },
9353     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9354     "version": "0.0.0",
9355     "filename": "server/api/intDynamics365Field/index.js",
9356     "groupTitle": "Dynamics365_Fields"
9357   },
9358   {
9359     "type": "delete",
9360     "url": "/api/integrations/dynamics365/fields/{id}",
9361     "title": "Deletes a Dynamics365 Field",
9362     "examples": [
9363       {
9364         "title": "Example usage:",
9365         "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password} -X DELETE",
9366         "type": "json"
9367       }
9368     ],
9369     "name": "DeleteDynamics365_Fields",
9370     "group": "Dynamics365_Fields",
9371     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9372     "version": "0.0.0",
9373     "filename": "server/api/intDynamics365Field/index.js",
9374     "groupTitle": "Dynamics365_Fields"
9375   },
9376   {
9377     "type": "get",
9378     "url": "/api/integrations/dynamics365/fields",
9379     "title": "Gets a list of Dynamics365 Fields",
9380     "examples": [
9381       {
9382         "title": "Example usage:",
9383         "content": "curl https://{domain}/api/integrations/dynamics365/fields -v -u {name}:{password}",
9384         "type": "json"
9385       }
9386     ],
9387     "name": "GetDynamics365_Fields",
9388     "group": "Dynamics365_Fields",
9389     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9390     "version": "0.0.0",
9391     "filename": "server/api/intDynamics365Field/index.js",
9392     "groupTitle": "Dynamics365_Fields"
9393   },
9394   {
9395     "type": "get",
9396     "url": "/api/integrations/dynamics365/fields/{id}",
9397     "title": "Gets a single Dynamics365 Field",
9398     "examples": [
9399       {
9400         "title": "Example usage:",
9401         "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password}",
9402         "type": "json"
9403       }
9404     ],
9405     "name": "ShowDynamics365_Fields",
9406     "group": "Dynamics365_Fields",
9407     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9408     "version": "0.0.0",
9409     "filename": "server/api/intDynamics365Field/index.js",
9410     "groupTitle": "Dynamics365_Fields"
9411   },
9412   {
9413     "type": "put",
9414     "url": "/api/integrations/dynamics365/fields/{id}",
9415     "title": "Update an existing Dynamics365 Field",
9416     "examples": [
9417       {
9418         "title": "Example usage:",
9419         "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",
9420         "type": "json"
9421       }
9422     ],
9423     "name": "updateDynamics365_Fields",
9424     "group": "Dynamics365_Fields",
9425     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9426     "version": "0.0.0",
9427     "filename": "server/api/intDynamics365Field/index.js",
9428     "groupTitle": "Dynamics365_Fields"
9429   },
9430   {
9431     "type": "post",
9432     "url": "/api/fax/accounts/{id}/users",
9433     "title": "Add agents to a fax account",
9434     "examples": [
9435       {
9436         "title": "Example usage:",
9437         "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",
9438         "type": "json"
9439       }
9440     ],
9441     "name": "AddAgents",
9442     "group": "Fax_Accounts",
9443     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9444     "version": "0.0.0",
9445     "filename": "server/api/faxAccount/index.js",
9446     "groupTitle": "Fax_Accounts"
9447   },
9448   {
9449     "type": "post",
9450     "url": "/api/fax/accounts",
9451     "title": "Creates a new Account",
9452     "examples": [
9453       {
9454         "title": "Example usage:",
9455         "content": "curl https://{domain}/api/fax/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
9456         "type": "json"
9457       }
9458     ],
9459     "name": "CreateAccounts",
9460     "group": "Fax_Accounts",
9461     "parameter": {
9462       "fields": {
9463         "Body": [
9464           {
9465             "group": "Body",
9466             "type": "String",
9467             "optional": false,
9468             "field": "name",
9469             "description": ""
9470           },
9471           {
9472             "group": "Body",
9473             "type": "String",
9474             "optional": true,
9475             "field": "description",
9476             "description": ""
9477           },
9478           {
9479             "group": "Body",
9480             "type": "String",
9481             "allowedValues": [
9482               "\"yes\"",
9483               "\"no\""
9484             ],
9485             "optional": true,
9486             "field": "ecm",
9487             "description": ""
9488           },
9489           {
9490             "group": "Body",
9491             "type": "String",
9492             "optional": true,
9493             "field": "headerinfo",
9494             "description": ""
9495           },
9496           {
9497             "group": "Body",
9498             "type": "String",
9499             "optional": true,
9500             "field": "localstationid",
9501             "description": ""
9502           },
9503           {
9504             "group": "Body",
9505             "type": "String",
9506             "allowedValues": [
9507               "\"2400\"",
9508               "\"4800\"",
9509               "\"7200\"",
9510               "\"9600\"",
9511               "\"12000\"",
9512               "\"14400\""
9513             ],
9514             "optional": true,
9515             "field": "minrate",
9516             "description": ""
9517           },
9518           {
9519             "group": "Body",
9520             "type": "String",
9521             "allowedValues": [
9522               "\"2400\"",
9523               "\"4800\"",
9524               "\"7200\"",
9525               "\"9600\"",
9526               "\"12000\"",
9527               "\"14400\""
9528             ],
9529             "optional": true,
9530             "field": "maxrate",
9531             "description": ""
9532           },
9533           {
9534             "group": "Body",
9535             "type": "String",
9536             "optional": true,
9537             "field": "modem",
9538             "description": ""
9539           },
9540           {
9541             "group": "Body",
9542             "type": "String",
9543             "optional": true,
9544             "field": "gateway",
9545             "description": ""
9546           },
9547           {
9548             "group": "Body",
9549             "type": "String",
9550             "optional": true,
9551             "field": "faxdetect",
9552             "description": ""
9553           },
9554           {
9555             "group": "Body",
9556             "type": "Integer",
9557             "optional": true,
9558             "field": "t38timeout",
9559             "description": ""
9560           },
9561           {
9562             "group": "Body",
9563             "type": "String",
9564             "allowedValues": [
9565               "\"SIP\"",
9566               "\"IAX\"",
9567               "\"DADHI\"",
9568               "\"KHOMP\""
9569             ],
9570             "optional": true,
9571             "field": "tech",
9572             "description": ""
9573           },
9574           {
9575             "group": "Body",
9576             "type": "String",
9577             "optional": false,
9578             "field": "key",
9579             "description": ""
9580           },
9581           {
9582             "group": "Body",
9583             "type": "Text",
9584             "optional": true,
9585             "field": "notificationTemplate",
9586             "description": ""
9587           },
9588           {
9589             "group": "Body",
9590             "type": "Boolean",
9591             "optional": true,
9592             "field": "notificationSound",
9593             "description": ""
9594           },
9595           {
9596             "group": "Body",
9597             "type": "Boolean",
9598             "optional": true,
9599             "field": "notificationShake",
9600             "description": ""
9601           },
9602           {
9603             "group": "Body",
9604             "type": "Integer",
9605             "optional": true,
9606             "field": "waitForTheAssignedAgent",
9607             "description": ""
9608           },
9609           {
9610             "group": "Body",
9611             "type": "Boolean",
9612             "optional": true,
9613             "field": "queueTransfer",
9614             "description": ""
9615           },
9616           {
9617             "group": "Body",
9618             "type": "Integer",
9619             "optional": true,
9620             "field": "queueTransferTimeout",
9621             "description": ""
9622           },
9623           {
9624             "group": "Body",
9625             "type": "Boolean",
9626             "optional": true,
9627             "field": "agentTransfer",
9628             "description": ""
9629           },
9630           {
9631             "group": "Body",
9632             "type": "Integer",
9633             "optional": true,
9634             "field": "agentTransferTimeout",
9635             "description": ""
9636           },
9637           {
9638             "group": "Body",
9639             "type": "Integer",
9640             "optional": true,
9641             "field": "mandatoryDispositionPauseId",
9642             "description": "<p>Status to put when mandatory disposition is enabled</p>"
9643           },
9644           {
9645             "group": "Body",
9646             "type": "Boolean",
9647             "optional": true,
9648             "field": "mandatoryDisposition",
9649             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
9650           }
9651         ]
9652       }
9653     },
9654     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9655     "version": "0.0.0",
9656     "filename": "server/api/faxAccount/index.js",
9657     "groupTitle": "Fax_Accounts"
9658   },
9659   {
9660     "type": "delete",
9661     "url": "/api/fax/accounts/{id}",
9662     "title": "Deletes a Account",
9663     "examples": [
9664       {
9665         "title": "Example usage:",
9666         "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password} -X DELETE",
9667         "type": "json"
9668       }
9669     ],
9670     "name": "DeleteAccounts",
9671     "group": "Fax_Accounts",
9672     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9673     "version": "0.0.0",
9674     "filename": "server/api/faxAccount/index.js",
9675     "groupTitle": "Fax_Accounts"
9676   },
9677   {
9678     "type": "get",
9679     "url": "/api/fax/accounts/describe",
9680     "title": "Gets table info about Accounts",
9681     "examples": [
9682       {
9683         "title": "Example usage:",
9684         "content": "curl https://{domain}/api/fax/accounts/describe -v -u {name}:{password}",
9685         "type": "json"
9686       }
9687     ],
9688     "name": "DescribeAccounts",
9689     "group": "Fax_Accounts",
9690     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9691     "version": "0.0.0",
9692     "filename": "server/api/faxAccount/index.js",
9693     "groupTitle": "Fax_Accounts"
9694   },
9695   {
9696     "type": "get",
9697     "url": "/api/fax/accounts",
9698     "title": "Gets a list of Accounts",
9699     "examples": [
9700       {
9701         "title": "Example usage:",
9702         "content": "curl https://{domain}/api/fax/accounts -v -u {name}:{password}",
9703         "type": "json"
9704       }
9705     ],
9706     "name": "GetAccounts",
9707     "group": "Fax_Accounts",
9708     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9709     "version": "0.0.0",
9710     "filename": "server/api/faxAccount/index.js",
9711     "groupTitle": "Fax_Accounts"
9712   },
9713   {
9714     "type": "get",
9715     "url": "/api/fax/accounts/{id}/users",
9716     "title": "Gets agents from fax account",
9717     "examples": [
9718       {
9719         "title": "Example usage:",
9720         "content": "curl https://{domain}/api/fax/accounts/{id}/users -v -u {name}:{password} -X GET",
9721         "type": "json"
9722       }
9723     ],
9724     "name": "GetAgents",
9725     "group": "Fax_Accounts",
9726     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9727     "version": "0.0.0",
9728     "filename": "server/api/faxAccount/index.js",
9729     "groupTitle": "Fax_Accounts"
9730   },
9731   {
9732     "type": "delete",
9733     "url": "/api/fax/accounts/{id}/users",
9734     "title": "Removes agents from a fax account",
9735     "examples": [
9736       {
9737         "title": "Example usage:",
9738         "content": "curl https://{domain}/api/fax/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9739         "type": "json"
9740       }
9741     ],
9742     "name": "RemoveAgents",
9743     "group": "Fax_Accounts",
9744     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9745     "version": "0.0.0",
9746     "filename": "server/api/faxAccount/index.js",
9747     "groupTitle": "Fax_Accounts"
9748   },
9749   {
9750     "type": "delete",
9751     "url": "/api/fax/accounts/{id}/canned_answers",
9752     "title": "Removes canned answers from account",
9753     "examples": [
9754       {
9755         "title": "Example usage:",
9756         "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9757         "type": "json"
9758       }
9759     ],
9760     "name": "RemoveAnswers",
9761     "group": "Fax_Accounts",
9762     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9763     "version": "0.0.0",
9764     "filename": "server/api/faxAccount/index.js",
9765     "groupTitle": "Fax_Accounts"
9766   },
9767   {
9768     "type": "delete",
9769     "url": "/api/fax/accounts/{id}/dispositions",
9770     "title": "Removes dispositions from account",
9771     "examples": [
9772       {
9773         "title": "Example usage:",
9774         "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9775         "type": "json"
9776       }
9777     ],
9778     "name": "RemoveDispositions",
9779     "group": "Fax_Accounts",
9780     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9781     "version": "0.0.0",
9782     "filename": "server/api/faxAccount/index.js",
9783     "groupTitle": "Fax_Accounts"
9784   },
9785   {
9786     "type": "get",
9787     "url": "/api/fax/accounts/{id}",
9788     "title": "Gets a single Account",
9789     "examples": [
9790       {
9791         "title": "Example usage:",
9792         "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password}",
9793         "type": "json"
9794       }
9795     ],
9796     "name": "ShowAccounts",
9797     "group": "Fax_Accounts",
9798     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9799     "version": "0.0.0",
9800     "filename": "server/api/faxAccount/index.js",
9801     "groupTitle": "Fax_Accounts"
9802   },
9803   {
9804     "type": "post",
9805     "url": "/api/fax/accounts/{id}/canned_answers",
9806     "title": "Creates new canned answer",
9807     "examples": [
9808       {
9809         "title": "Example usage:",
9810         "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",
9811         "type": "json"
9812       }
9813     ],
9814     "name": "addAnswer",
9815     "group": "Fax_Accounts",
9816     "parameter": {
9817       "fields": {
9818         "Body": [
9819           {
9820             "group": "Body",
9821             "type": "String",
9822             "optional": false,
9823             "field": "key",
9824             "description": ""
9825           },
9826           {
9827             "group": "Body",
9828             "type": "Text",
9829             "optional": false,
9830             "field": "value",
9831             "description": ""
9832           },
9833           {
9834             "group": "Body",
9835             "type": "String",
9836             "optional": true,
9837             "field": "description",
9838             "description": ""
9839           },
9840           {
9841             "group": "Body",
9842             "type": "Virtual",
9843             "optional": true,
9844             "field": "name",
9845             "description": ""
9846           }
9847         ]
9848       }
9849     },
9850     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9851     "version": "0.0.0",
9852     "filename": "server/api/faxAccount/index.js",
9853     "groupTitle": "Fax_Accounts"
9854   },
9855   {
9856     "type": "post",
9857     "url": "/api/fax/accounts/{id}/applications",
9858     "title": "Creates new applications",
9859     "examples": [
9860       {
9861         "title": "Example usage:",
9862         "content": "curl https://{domain}/api/fax/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9863         "type": "json"
9864       }
9865     ],
9866     "name": "addApplications",
9867     "group": "Fax_Accounts",
9868     "parameter": {
9869       "fields": {
9870         "Body": [
9871           {
9872             "group": "Body",
9873             "type": "Integer",
9874             "optional": false,
9875             "field": "priority",
9876             "description": ""
9877           },
9878           {
9879             "group": "Body",
9880             "type": "String",
9881             "optional": false,
9882             "field": "app",
9883             "description": ""
9884           },
9885           {
9886             "group": "Body",
9887             "type": "Text",
9888             "optional": true,
9889             "field": "appdata",
9890             "description": ""
9891           },
9892           {
9893             "group": "Body",
9894             "type": "String",
9895             "optional": true,
9896             "field": "description",
9897             "description": ""
9898           },
9899           {
9900             "group": "Body",
9901             "type": "String",
9902             "optional": true,
9903             "field": "interval",
9904             "description": ""
9905           }
9906         ]
9907       }
9908     },
9909     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9910     "version": "0.0.0",
9911     "filename": "server/api/faxAccount/index.js",
9912     "groupTitle": "Fax_Accounts"
9913   },
9914   {
9915     "type": "post",
9916     "url": "/api/fax/accounts/addaccountapplications",
9917     "title": "Creates new account and applications",
9918     "examples": [
9919       {
9920         "title": "Example usage:",
9921         "content": "curl https://{domain}/api/fax/accounts/addaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9922         "type": "json"
9923       }
9924     ],
9925     "name": "addApplications",
9926     "group": "Fax_Accounts",
9927     "parameter": {
9928       "fields": {
9929         "Body": [
9930           {
9931             "group": "Body",
9932             "type": "Integer",
9933             "optional": false,
9934             "field": "priority",
9935             "description": ""
9936           },
9937           {
9938             "group": "Body",
9939             "type": "String",
9940             "optional": false,
9941             "field": "app",
9942             "description": ""
9943           },
9944           {
9945             "group": "Body",
9946             "type": "Text",
9947             "optional": true,
9948             "field": "appdata",
9949             "description": ""
9950           },
9951           {
9952             "group": "Body",
9953             "type": "String",
9954             "optional": true,
9955             "field": "description",
9956             "description": ""
9957           },
9958           {
9959             "group": "Body",
9960             "type": "String",
9961             "optional": true,
9962             "field": "interval",
9963             "description": ""
9964           }
9965         ]
9966       }
9967     },
9968     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9969     "version": "0.0.0",
9970     "filename": "server/api/faxAccount/index.js",
9971     "groupTitle": "Fax_Accounts"
9972   },
9973   {
9974     "type": "post",
9975     "url": "/api/fax/accounts/{id}/dispositions",
9976     "title": "Creates new disposition",
9977     "examples": [
9978       {
9979         "title": "Example usage:",
9980         "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9981         "type": "json"
9982       }
9983     ],
9984     "name": "addDisposition",
9985     "group": "Fax_Accounts",
9986     "parameter": {
9987       "fields": {
9988         "Body": [
9989           {
9990             "group": "Body",
9991             "type": "String",
9992             "optional": false,
9993             "field": "name",
9994             "description": ""
9995           },
9996           {
9997             "group": "Body",
9998             "type": "String",
9999             "allowedValues": [
10000               "\"first\"",
10001               "\"second\"",
10002               "\"third\""
10003             ],
10004             "optional": false,
10005             "field": "level",
10006             "description": ""
10007           },
10008           {
10009             "group": "Body",
10010             "type": "String",
10011             "optional": true,
10012             "field": "description",
10013             "description": ""
10014           }
10015         ]
10016       }
10017     },
10018     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10019     "version": "0.0.0",
10020     "filename": "server/api/faxAccount/index.js",
10021     "groupTitle": "Fax_Accounts"
10022   },
10023   {
10024     "type": "post",
10025     "url": "/api/fax/accounts/{id}/interactions",
10026     "title": "Creates new interactions",
10027     "examples": [
10028       {
10029         "title": "Example usage:",
10030         "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",
10031         "type": "json"
10032       }
10033     ],
10034     "name": "addInteraction",
10035     "group": "Fax_Accounts",
10036     "parameter": {
10037       "fields": {
10038         "Body": [
10039           {
10040             "group": "Body",
10041             "type": "Boolean",
10042             "optional": true,
10043             "field": "closed",
10044             "description": ""
10045           },
10046           {
10047             "group": "Body",
10048             "type": "String",
10049             "optional": true,
10050             "field": "closedAt",
10051             "description": ""
10052           },
10053           {
10054             "group": "Body",
10055             "type": "String",
10056             "optional": true,
10057             "field": "disposition",
10058             "description": ""
10059           },
10060           {
10061             "group": "Body",
10062             "type": "String",
10063             "optional": true,
10064             "field": "secondDisposition",
10065             "description": ""
10066           },
10067           {
10068             "group": "Body",
10069             "type": "String",
10070             "optional": true,
10071             "field": "thirdDisposition",
10072             "description": ""
10073           },
10074           {
10075             "group": "Body",
10076             "type": "String",
10077             "optional": true,
10078             "field": "note",
10079             "description": ""
10080           },
10081           {
10082             "group": "Body",
10083             "type": "String",
10084             "optional": true,
10085             "field": "read1stAt",
10086             "description": ""
10087           },
10088           {
10089             "group": "Body",
10090             "type": "String",
10091             "optional": true,
10092             "field": "fax",
10093             "description": ""
10094           },
10095           {
10096             "group": "Body",
10097             "type": "String",
10098             "allowedValues": [
10099               "\"in\"",
10100               "\"out\""
10101             ],
10102             "optional": false,
10103             "field": "firstMsgDirection",
10104             "description": ""
10105           },
10106           {
10107             "group": "Body",
10108             "type": "String",
10109             "optional": true,
10110             "field": "lastMsgAt",
10111             "description": ""
10112           },
10113           {
10114             "group": "Body",
10115             "type": "String",
10116             "allowedValues": [
10117               "\"in\"",
10118               "\"out\""
10119             ],
10120             "optional": false,
10121             "field": "lastMsgDirection",
10122             "description": ""
10123           }
10124         ]
10125       }
10126     },
10127     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10128     "version": "0.0.0",
10129     "filename": "server/api/faxAccount/index.js",
10130     "groupTitle": "Fax_Accounts"
10131   },
10132   {
10133     "type": "get",
10134     "url": "/api/fax/accounts/{id}/canned_answers",
10135     "title": "Gets account canned answers",
10136     "examples": [
10137       {
10138         "title": "Example usage:",
10139         "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
10140         "type": "json"
10141       }
10142     ],
10143     "name": "getAnswers",
10144     "group": "Fax_Accounts",
10145     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10146     "version": "0.0.0",
10147     "filename": "server/api/faxAccount/index.js",
10148     "groupTitle": "Fax_Accounts"
10149   },
10150   {
10151     "type": "get",
10152     "url": "/api/fax/accounts/{id}/applications",
10153     "title": "Gets account pplications",
10154     "examples": [
10155       {
10156         "title": "Example usage:",
10157         "content": "curl https://{domain}/api/fax/accounts/{id}/applications -v -u {name}:{password} -X GET",
10158         "type": "json"
10159       }
10160     ],
10161     "name": "getApplications",
10162     "group": "Fax_Accounts",
10163     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10164     "version": "0.0.0",
10165     "filename": "server/api/faxAccount/index.js",
10166     "groupTitle": "Fax_Accounts"
10167   },
10168   {
10169     "type": "get",
10170     "url": "/api/fax/accounts/{id}/dispositions",
10171     "title": "Gets account dispositions",
10172     "examples": [
10173       {
10174         "title": "Example usage:",
10175         "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
10176         "type": "json"
10177       }
10178     ],
10179     "name": "getDispositions",
10180     "group": "Fax_Accounts",
10181     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10182     "version": "0.0.0",
10183     "filename": "server/api/faxAccount/index.js",
10184     "groupTitle": "Fax_Accounts"
10185   },
10186   {
10187     "type": "get",
10188     "url": "/api/fax/accounts/{id}/interactions",
10189     "title": "Gets account interactions",
10190     "examples": [
10191       {
10192         "title": "Example usage:",
10193         "content": "curl https://{domain}/api/fax/accounts/{id}/interactions -v -u {name}:{password} -X GET",
10194         "type": "json"
10195       }
10196     ],
10197     "name": "getInteraction",
10198     "group": "Fax_Accounts",
10199     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10200     "version": "0.0.0",
10201     "filename": "server/api/faxAccount/index.js",
10202     "groupTitle": "Fax_Accounts"
10203   },
10204   {
10205     "type": "get",
10206     "url": "/api/fax/accounts/{id}/messages",
10207     "title": "Gets account messages",
10208     "examples": [
10209       {
10210         "title": "Example usage:",
10211         "content": "curl https://{domain}/api/fax/accounts/{id}/messages -v -u {name}:{password} -X GET",
10212         "type": "json"
10213       }
10214     ],
10215     "name": "getMessages",
10216     "group": "Fax_Accounts",
10217     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10218     "version": "0.0.0",
10219     "filename": "server/api/faxAccount/index.js",
10220     "groupTitle": "Fax_Accounts"
10221   },
10222   {
10223     "type": "post",
10224     "url": "/api/fax/accounts/{id}/send",
10225     "title": "Send new fax",
10226     "examples": [
10227       {
10228         "title": "Example usage:",
10229         "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",
10230         "type": "json"
10231       }
10232     ],
10233     "name": "sendFax",
10234     "group": "Fax_Accounts",
10235     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10236     "version": "0.0.0",
10237     "filename": "server/api/faxAccount/index.js",
10238     "groupTitle": "Fax_Accounts"
10239   },
10240   {
10241     "type": "put",
10242     "url": "/api/fax/accounts/{id}",
10243     "title": "Update an existing Account",
10244     "examples": [
10245       {
10246         "title": "Example usage:",
10247         "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",
10248         "type": "json"
10249       }
10250     ],
10251     "name": "updateAccounts",
10252     "group": "Fax_Accounts",
10253     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10254     "version": "0.0.0",
10255     "filename": "server/api/faxAccount/index.js",
10256     "groupTitle": "Fax_Accounts"
10257   },
10258   {
10259     "type": "post",
10260     "url": "/api/fax/accounts/updateaccountapplications",
10261     "title": "Update account and applications",
10262     "examples": [
10263       {
10264         "title": "Example usage:",
10265         "content": "curl https://{domain}/api/fax/accounts/updateaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10266         "type": "json"
10267       }
10268     ],
10269     "name": "updateApplications",
10270     "group": "Fax_Accounts",
10271     "parameter": {
10272       "fields": {
10273         "Body": [
10274           {
10275             "group": "Body",
10276             "type": "Integer",
10277             "optional": false,
10278             "field": "priority",
10279             "description": ""
10280           },
10281           {
10282             "group": "Body",
10283             "type": "String",
10284             "optional": false,
10285             "field": "app",
10286             "description": ""
10287           },
10288           {
10289             "group": "Body",
10290             "type": "Text",
10291             "optional": true,
10292             "field": "appdata",
10293             "description": ""
10294           },
10295           {
10296             "group": "Body",
10297             "type": "String",
10298             "optional": true,
10299             "field": "description",
10300             "description": ""
10301           },
10302           {
10303             "group": "Body",
10304             "type": "String",
10305             "optional": true,
10306             "field": "interval",
10307             "description": ""
10308           }
10309         ]
10310       }
10311     },
10312     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10313     "version": "0.0.0",
10314     "filename": "server/api/faxAccount/index.js",
10315     "groupTitle": "Fax_Accounts"
10316   },
10317   {
10318     "type": "post",
10319     "url": "/api/fax/applications",
10320     "title": "Creates a new Application",
10321     "examples": [
10322       {
10323         "title": "Example usage:",
10324         "content": "curl https://{domain}/api/fax/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
10325         "type": "json"
10326       }
10327     ],
10328     "name": "CreateApplications",
10329     "group": "Fax_Applications",
10330     "parameter": {
10331       "fields": {
10332         "Body": [
10333           {
10334             "group": "Body",
10335             "type": "Integer",
10336             "optional": false,
10337             "field": "priority",
10338             "description": ""
10339           },
10340           {
10341             "group": "Body",
10342             "type": "String",
10343             "optional": false,
10344             "field": "app",
10345             "description": ""
10346           },
10347           {
10348             "group": "Body",
10349             "type": "Text",
10350             "optional": true,
10351             "field": "appdata",
10352             "description": ""
10353           },
10354           {
10355             "group": "Body",
10356             "type": "String",
10357             "optional": true,
10358             "field": "description",
10359             "description": ""
10360           },
10361           {
10362             "group": "Body",
10363             "type": "String",
10364             "optional": true,
10365             "field": "interval",
10366             "description": ""
10367           }
10368         ]
10369       }
10370     },
10371     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10372     "version": "0.0.0",
10373     "filename": "server/api/faxApplication/index.js",
10374     "groupTitle": "Fax_Applications"
10375   },
10376   {
10377     "type": "delete",
10378     "url": "/api/fax/applications/{id}",
10379     "title": "Deletes a Application",
10380     "examples": [
10381       {
10382         "title": "Example usage:",
10383         "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password} -X DELETE",
10384         "type": "json"
10385       }
10386     ],
10387     "name": "DeleteApplications",
10388     "group": "Fax_Applications",
10389     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10390     "version": "0.0.0",
10391     "filename": "server/api/faxApplication/index.js",
10392     "groupTitle": "Fax_Applications"
10393   },
10394   {
10395     "type": "get",
10396     "url": "/api/fax/applications",
10397     "title": "Gets a list of Applications",
10398     "examples": [
10399       {
10400         "title": "Example usage:",
10401         "content": "curl https://{domain}/api/fax/applications -v -u {name}:{password}",
10402         "type": "json"
10403       }
10404     ],
10405     "name": "GetApplications",
10406     "group": "Fax_Applications",
10407     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10408     "version": "0.0.0",
10409     "filename": "server/api/faxApplication/index.js",
10410     "groupTitle": "Fax_Applications"
10411   },
10412   {
10413     "type": "get",
10414     "url": "/api/fax/applications/{id}",
10415     "title": "Gets a single Application",
10416     "examples": [
10417       {
10418         "title": "Example usage:",
10419         "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password}",
10420         "type": "json"
10421       }
10422     ],
10423     "name": "ShowApplications",
10424     "group": "Fax_Applications",
10425     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10426     "version": "0.0.0",
10427     "filename": "server/api/faxApplication/index.js",
10428     "groupTitle": "Fax_Applications"
10429   },
10430   {
10431     "type": "put",
10432     "url": "/api/fax/applications/{id}",
10433     "title": "Update an existing Application",
10434     "examples": [
10435       {
10436         "title": "Example usage:",
10437         "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",
10438         "type": "json"
10439       }
10440     ],
10441     "name": "updateApplications",
10442     "group": "Fax_Applications",
10443     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10444     "version": "0.0.0",
10445     "filename": "server/api/faxApplication/index.js",
10446     "groupTitle": "Fax_Applications"
10447   },
10448   {
10449     "type": "post",
10450     "url": "/api/fax/interactions/{id}/tags",
10451     "title": "Add tags to the interaction",
10452     "examples": [
10453       {
10454         "title": "Example usage:",
10455         "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",
10456         "type": "json"
10457       }
10458     ],
10459     "name": "AddTags",
10460     "group": "Fax_Interactions",
10461     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10462     "version": "0.0.0",
10463     "filename": "server/api/faxInteraction/index.js",
10464     "groupTitle": "Fax_Interactions"
10465   },
10466   {
10467     "type": "post",
10468     "url": "/api/fax/interactions",
10469     "title": "Creates a new Interaction",
10470     "examples": [
10471       {
10472         "title": "Example usage:",
10473         "content": "curl https://{domain}/api/fax/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
10474         "type": "json"
10475       }
10476     ],
10477     "name": "CreateInteractions",
10478     "group": "Fax_Interactions",
10479     "parameter": {
10480       "fields": {
10481         "Body": [
10482           {
10483             "group": "Body",
10484             "type": "Boolean",
10485             "optional": true,
10486             "field": "closed",
10487             "description": ""
10488           },
10489           {
10490             "group": "Body",
10491             "type": "String",
10492             "optional": true,
10493             "field": "closedAt",
10494             "description": ""
10495           },
10496           {
10497             "group": "Body",
10498             "type": "String",
10499             "optional": true,
10500             "field": "disposition",
10501             "description": ""
10502           },
10503           {
10504             "group": "Body",
10505             "type": "String",
10506             "optional": true,
10507             "field": "secondDisposition",
10508             "description": ""
10509           },
10510           {
10511             "group": "Body",
10512             "type": "String",
10513             "optional": true,
10514             "field": "thirdDisposition",
10515             "description": ""
10516           },
10517           {
10518             "group": "Body",
10519             "type": "String",
10520             "optional": true,
10521             "field": "note",
10522             "description": ""
10523           },
10524           {
10525             "group": "Body",
10526             "type": "String",
10527             "optional": true,
10528             "field": "read1stAt",
10529             "description": ""
10530           },
10531           {
10532             "group": "Body",
10533             "type": "String",
10534             "optional": true,
10535             "field": "fax",
10536             "description": ""
10537           },
10538           {
10539             "group": "Body",
10540             "type": "String",
10541             "allowedValues": [
10542               "\"in\"",
10543               "\"out\""
10544             ],
10545             "optional": false,
10546             "field": "firstMsgDirection",
10547             "description": ""
10548           },
10549           {
10550             "group": "Body",
10551             "type": "String",
10552             "optional": true,
10553             "field": "lastMsgAt",
10554             "description": ""
10555           },
10556           {
10557             "group": "Body",
10558             "type": "String",
10559             "allowedValues": [
10560               "\"in\"",
10561               "\"out\""
10562             ],
10563             "optional": false,
10564             "field": "lastMsgDirection",
10565             "description": ""
10566           }
10567         ]
10568       }
10569     },
10570     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10571     "version": "0.0.0",
10572     "filename": "server/api/faxInteraction/index.js",
10573     "groupTitle": "Fax_Interactions"
10574   },
10575   {
10576     "type": "delete",
10577     "url": "/api/fax/interactions/{id}",
10578     "title": "Deletes a Interaction",
10579     "examples": [
10580       {
10581         "title": "Example usage:",
10582         "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password} -X DELETE",
10583         "type": "json"
10584       }
10585     ],
10586     "name": "DeleteInteractions",
10587     "group": "Fax_Interactions",
10588     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10589     "version": "0.0.0",
10590     "filename": "server/api/faxInteraction/index.js",
10591     "groupTitle": "Fax_Interactions"
10592   },
10593   {
10594     "type": "get",
10595     "url": "/api/fax/interactions/describe",
10596     "title": "Gets table info about Interactions",
10597     "examples": [
10598       {
10599         "title": "Example usage:",
10600         "content": "curl https://{domain}/api/fax/interactions/describe -v -u {name}:{password}",
10601         "type": "json"
10602       }
10603     ],
10604     "name": "DescribeInteractions",
10605     "group": "Fax_Interactions",
10606     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10607     "version": "0.0.0",
10608     "filename": "server/api/faxInteraction/index.js",
10609     "groupTitle": "Fax_Interactions"
10610   },
10611   {
10612     "type": "get",
10613     "url": "/api/fax/interactions",
10614     "title": "Gets a list of Interactions",
10615     "examples": [
10616       {
10617         "title": "Example usage:",
10618         "content": "curl https://{domain}/api/fax/interactions -v -u {name}:{password}",
10619         "type": "json"
10620       }
10621     ],
10622     "name": "GetInteractions",
10623     "group": "Fax_Interactions",
10624     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10625     "version": "0.0.0",
10626     "filename": "server/api/faxInteraction/index.js",
10627     "groupTitle": "Fax_Interactions"
10628   },
10629   {
10630     "type": "delete",
10631     "url": "/api/fax/interactions/{id}/tags",
10632     "title": "Removes tags from interaction",
10633     "examples": [
10634       {
10635         "title": "Example usage:",
10636         "content": "curl https://{domain}/api/fax/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
10637         "type": "json"
10638       }
10639     ],
10640     "name": "RemoveTags",
10641     "group": "Fax_Interactions",
10642     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10643     "version": "0.0.0",
10644     "filename": "server/api/faxInteraction/index.js",
10645     "groupTitle": "Fax_Interactions"
10646   },
10647   {
10648     "type": "get",
10649     "url": "/api/fax/interactions/{id}",
10650     "title": "Gets a single Interaction",
10651     "examples": [
10652       {
10653         "title": "Example usage:",
10654         "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password}",
10655         "type": "json"
10656       }
10657     ],
10658     "name": "ShowInteractions",
10659     "group": "Fax_Interactions",
10660     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10661     "version": "0.0.0",
10662     "filename": "server/api/faxInteraction/index.js",
10663     "groupTitle": "Fax_Interactions"
10664   },
10665   {
10666     "type": "post",
10667     "url": "/api/fax/interactions/{id}/messages",
10668     "title": "Creates new messages",
10669     "examples": [
10670       {
10671         "title": "Example usage:",
10672         "content": "curl https://{domain}/api/fax/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10673         "type": "json"
10674       }
10675     ],
10676     "name": "addMessage",
10677     "group": "Fax_Interactions",
10678     "parameter": {
10679       "fields": {
10680         "Body": [
10681           {
10682             "group": "Body",
10683             "type": "Text",
10684             "optional": false,
10685             "field": "body",
10686             "description": ""
10687           },
10688           {
10689             "group": "Body",
10690             "type": "Boolean",
10691             "optional": true,
10692             "field": "read",
10693             "description": ""
10694           },
10695           {
10696             "group": "Body",
10697             "type": "String",
10698             "allowedValues": [
10699               "\"in\"",
10700               "\"out\""
10701             ],
10702             "optional": false,
10703             "field": "direction",
10704             "description": ""
10705           },
10706           {
10707             "group": "Body",
10708             "type": "Text",
10709             "optional": true,
10710             "field": "failMessage",
10711             "description": ""
10712           },
10713           {
10714             "group": "Body",
10715             "type": "String",
10716             "optional": true,
10717             "field": "readAt",
10718             "description": ""
10719           }
10720         ]
10721       }
10722     },
10723     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10724     "version": "0.0.0",
10725     "filename": "server/api/faxInteraction/index.js",
10726     "groupTitle": "Fax_Interactions"
10727   },
10728   {
10729     "type": "get",
10730     "url": "/api/fax/interactions/{id}/download",
10731     "title": "Get interactions",
10732     "examples": [
10733       {
10734         "title": "Example usage:",
10735         "content": "curl https://{domain}/api/fax/interactions/{id}/download -v -u {name}:{password} -X GET",
10736         "type": "json"
10737       }
10738     ],
10739     "name": "download",
10740     "group": "Fax_Interactions",
10741     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10742     "version": "0.0.0",
10743     "filename": "server/api/faxInteraction/index.js",
10744     "groupTitle": "Fax_Interactions"
10745   },
10746   {
10747     "type": "get",
10748     "url": "/api/fax/interactions/{id}/messages",
10749     "title": "Gets interaction messages",
10750     "examples": [
10751       {
10752         "title": "Example usage:",
10753         "content": "curl https://{domain}/api/fax/interactions/{id}/messages -v -u {name}:{password} -X GET",
10754         "type": "json"
10755       }
10756     ],
10757     "name": "getMessages",
10758     "group": "Fax_Interactions",
10759     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10760     "version": "0.0.0",
10761     "filename": "server/api/faxInteraction/index.js",
10762     "groupTitle": "Fax_Interactions"
10763   },
10764   {
10765     "type": "put",
10766     "url": "/api/fax/interactions/{id}",
10767     "title": "Update an existing Interaction",
10768     "examples": [
10769       {
10770         "title": "Example usage:",
10771         "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",
10772         "type": "json"
10773       }
10774     ],
10775     "name": "updateInteractions",
10776     "group": "Fax_Interactions",
10777     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10778     "version": "0.0.0",
10779     "filename": "server/api/faxInteraction/index.js",
10780     "groupTitle": "Fax_Interactions"
10781   },
10782   {
10783     "type": "get",
10784     "url": "/api/fax/messages/{id}/download",
10785     "title": "Get message",
10786     "examples": [
10787       {
10788         "title": "Example usage:",
10789         "content": "curl https://{domain}/api/fax/messages/{id}/download -v -u {name}:{password} -X GET",
10790         "type": "json"
10791       }
10792     ],
10793     "name": "download",
10794     "group": "Fax_Message",
10795     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10796     "version": "0.0.0",
10797     "filename": "server/api/faxMessage/index.js",
10798     "groupTitle": "Fax_Message"
10799   },
10800   {
10801     "type": "delete",
10802     "url": "/api/fax/messages/{id}",
10803     "title": "Deletes a Message",
10804     "examples": [
10805       {
10806         "title": "Example usage:",
10807         "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password} -X DELETE",
10808         "type": "json"
10809       }
10810     ],
10811     "name": "DeleteMessages",
10812     "group": "Fax_Messages",
10813     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10814     "version": "0.0.0",
10815     "filename": "server/api/faxMessage/index.js",
10816     "groupTitle": "Fax_Messages"
10817   },
10818   {
10819     "type": "get",
10820     "url": "/api/fax/messages/describe",
10821     "title": "Gets table info about Messages",
10822     "examples": [
10823       {
10824         "title": "Example usage:",
10825         "content": "curl https://{domain}/api/fax/messages/describe -v -u {name}:{password}",
10826         "type": "json"
10827       }
10828     ],
10829     "name": "DescribeMessages",
10830     "group": "Fax_Messages",
10831     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10832     "version": "0.0.0",
10833     "filename": "server/api/faxMessage/index.js",
10834     "groupTitle": "Fax_Messages"
10835   },
10836   {
10837     "type": "get",
10838     "url": "/api/fax/messages",
10839     "title": "Gets a list of Messages",
10840     "examples": [
10841       {
10842         "title": "Example usage:",
10843         "content": "curl https://{domain}/api/fax/messages -v -u {name}:{password}",
10844         "type": "json"
10845       }
10846     ],
10847     "name": "GetMessages",
10848     "group": "Fax_Messages",
10849     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10850     "version": "0.0.0",
10851     "filename": "server/api/faxMessage/index.js",
10852     "groupTitle": "Fax_Messages"
10853   },
10854   {
10855     "type": "get",
10856     "url": "/api/fax/messages/{id}",
10857     "title": "Gets a single Message",
10858     "examples": [
10859       {
10860         "title": "Example usage:",
10861         "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password}",
10862         "type": "json"
10863       }
10864     ],
10865     "name": "ShowMessages",
10866     "group": "Fax_Messages",
10867     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10868     "version": "0.0.0",
10869     "filename": "server/api/faxMessage/index.js",
10870     "groupTitle": "Fax_Messages"
10871   },
10872   {
10873     "type": "put",
10874     "url": "/api/fax/messages/{id}/accept",
10875     "title": "Accepts message",
10876     "examples": [
10877       {
10878         "title": "Example usage:",
10879         "content": "curl https://{domain}/api/fax/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
10880         "type": "json"
10881       }
10882     ],
10883     "name": "acceptMessage",
10884     "group": "Fax_Messages",
10885     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10886     "version": "0.0.0",
10887     "filename": "server/api/faxMessage/index.js",
10888     "groupTitle": "Fax_Messages"
10889   },
10890   {
10891     "type": "post",
10892     "url": "/api/fax/messages",
10893     "title": "Create message and send Fax",
10894     "examples": [
10895       {
10896         "title": "Example usage:",
10897         "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
10898         "type": "json"
10899       }
10900     ],
10901     "name": "rejectMessage",
10902     "group": "Fax_Messages",
10903     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10904     "version": "0.0.0",
10905     "filename": "server/api/faxMessage/index.js",
10906     "groupTitle": "Fax_Messages"
10907   },
10908   {
10909     "type": "put",
10910     "url": "/api/fax/messages/{id}/reject",
10911     "title": "Rejects message",
10912     "examples": [
10913       {
10914         "title": "Example usage:",
10915         "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
10916         "type": "json"
10917       }
10918     ],
10919     "name": "rejectMessage",
10920     "group": "Fax_Messages",
10921     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10922     "version": "0.0.0",
10923     "filename": "server/api/faxMessage/index.js",
10924     "groupTitle": "Fax_Messages"
10925   },
10926   {
10927     "type": "put",
10928     "url": "/api/fax/messages/{id}",
10929     "title": "Update an existing Message",
10930     "examples": [
10931       {
10932         "title": "Example usage:",
10933         "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",
10934         "type": "json"
10935       }
10936     ],
10937     "name": "updateMessages",
10938     "group": "Fax_Messages",
10939     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10940     "version": "0.0.0",
10941     "filename": "server/api/faxMessage/index.js",
10942     "groupTitle": "Fax_Messages"
10943   },
10944   {
10945     "type": "post",
10946     "url": "/api/fax/reports/queue",
10947     "title": "Creates a new Fax Queue Report",
10948     "examples": [
10949       {
10950         "title": "Example usage:",
10951         "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",
10952         "type": "json"
10953       }
10954     ],
10955     "name": "CreateFax_Queue_Reports",
10956     "group": "Fax_Queue_Reports",
10957     "parameter": {
10958       "fields": {
10959         "Body": [
10960           {
10961             "group": "Body",
10962             "type": "String",
10963             "optional": false,
10964             "field": "uniqueid",
10965             "description": ""
10966           },
10967           {
10968             "group": "Body",
10969             "type": "String",
10970             "optional": true,
10971             "field": "from",
10972             "description": ""
10973           },
10974           {
10975             "group": "Body",
10976             "type": "String",
10977             "optional": true,
10978             "field": "joinAt",
10979             "description": ""
10980           },
10981           {
10982             "group": "Body",
10983             "type": "String",
10984             "optional": true,
10985             "field": "leaveAt",
10986             "description": ""
10987           },
10988           {
10989             "group": "Body",
10990             "type": "String",
10991             "optional": true,
10992             "field": "acceptAt",
10993             "description": ""
10994           },
10995           {
10996             "group": "Body",
10997             "type": "String",
10998             "optional": true,
10999             "field": "exitAt",
11000             "description": ""
11001           },
11002           {
11003             "group": "Body",
11004             "type": "String",
11005             "optional": true,
11006             "field": "reason",
11007             "description": ""
11008           }
11009         ]
11010       }
11011     },
11012     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11013     "version": "0.0.0",
11014     "filename": "server/api/faxQueueReport/index.js",
11015     "groupTitle": "Fax_Queue_Reports"
11016   },
11017   {
11018     "type": "delete",
11019     "url": "/api/fax/reports/queue/{id}",
11020     "title": "Deletes a Fax Queue Report",
11021     "examples": [
11022       {
11023         "title": "Example usage:",
11024         "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password} -X DELETE",
11025         "type": "json"
11026       }
11027     ],
11028     "name": "DeleteFax_Queue_Reports",
11029     "group": "Fax_Queue_Reports",
11030     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11031     "version": "0.0.0",
11032     "filename": "server/api/faxQueueReport/index.js",
11033     "groupTitle": "Fax_Queue_Reports"
11034   },
11035   {
11036     "type": "get",
11037     "url": "/api/fax/reports/queue/describe",
11038     "title": "Gets table info about Fax Queue Reports",
11039     "examples": [
11040       {
11041         "title": "Example usage:",
11042         "content": "curl https://{domain}/api/fax/reports/queue/describe -v -u {name}:{password}",
11043         "type": "json"
11044       }
11045     ],
11046     "name": "DescribeFax_Queue_Reports",
11047     "group": "Fax_Queue_Reports",
11048     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11049     "version": "0.0.0",
11050     "filename": "server/api/faxQueueReport/index.js",
11051     "groupTitle": "Fax_Queue_Reports"
11052   },
11053   {
11054     "type": "get",
11055     "url": "/api/fax/reports/queue",
11056     "title": "Gets a list of Fax Queue Reports",
11057     "examples": [
11058       {
11059         "title": "Example usage:",
11060         "content": "curl https://{domain}/api/fax/reports/queue -v -u {name}:{password}",
11061         "type": "json"
11062       }
11063     ],
11064     "name": "GetFax_Queue_Reports",
11065     "group": "Fax_Queue_Reports",
11066     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11067     "version": "0.0.0",
11068     "filename": "server/api/faxQueueReport/index.js",
11069     "groupTitle": "Fax_Queue_Reports"
11070   },
11071   {
11072     "type": "get",
11073     "url": "/api/fax/reports/queue/{id}",
11074     "title": "Gets a single Fax Queue Report",
11075     "examples": [
11076       {
11077         "title": "Example usage:",
11078         "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password}",
11079         "type": "json"
11080       }
11081     ],
11082     "name": "ShowFax_Queue_Reports",
11083     "group": "Fax_Queue_Reports",
11084     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11085     "version": "0.0.0",
11086     "filename": "server/api/faxQueueReport/index.js",
11087     "groupTitle": "Fax_Queue_Reports"
11088   },
11089   {
11090     "type": "put",
11091     "url": "/api/fax/reports/queue/{id}",
11092     "title": "Update an existing Fax Queue Report",
11093     "examples": [
11094       {
11095         "title": "Example usage:",
11096         "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",
11097         "type": "json"
11098       }
11099     ],
11100     "name": "updateFax_Queue_Reports",
11101     "group": "Fax_Queue_Reports",
11102     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11103     "version": "0.0.0",
11104     "filename": "server/api/faxQueueReport/index.js",
11105     "groupTitle": "Fax_Queue_Reports"
11106   },
11107   {
11108     "type": "post",
11109     "url": "/api/fax/queues/{id}/users",
11110     "title": "Add agents to a queue",
11111     "examples": [
11112       {
11113         "title": "Example usage:",
11114         "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",
11115         "type": "json"
11116       }
11117     ],
11118     "name": "AddAgents",
11119     "group": "Fax_Queues",
11120     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11121     "version": "0.0.0",
11122     "filename": "server/api/faxQueue/index.js",
11123     "groupTitle": "Fax_Queues"
11124   },
11125   {
11126     "type": "post",
11127     "url": "/api/fax/queues/{id}/teams",
11128     "title": "Add teams to a queue",
11129     "examples": [
11130       {
11131         "title": "Example usage:",
11132         "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",
11133         "type": "json"
11134       }
11135     ],
11136     "name": "AddTeams",
11137     "group": "Fax_Queues",
11138     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11139     "version": "0.0.0",
11140     "filename": "server/api/faxQueue/index.js",
11141     "groupTitle": "Fax_Queues"
11142   },
11143   {
11144     "type": "post",
11145     "url": "/api/fax/queues",
11146     "title": "Creates a new Queue",
11147     "examples": [
11148       {
11149         "title": "Example usage:",
11150         "content": "curl https://{domain}/api/fax/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
11151         "type": "json"
11152       }
11153     ],
11154     "name": "CreateQueues",
11155     "group": "Fax_Queues",
11156     "parameter": {
11157       "fields": {
11158         "Body": [
11159           {
11160             "group": "Body",
11161             "type": "String",
11162             "optional": false,
11163             "field": "name",
11164             "description": ""
11165           },
11166           {
11167             "group": "Body",
11168             "type": "String",
11169             "optional": true,
11170             "field": "description",
11171             "description": ""
11172           },
11173           {
11174             "group": "Body",
11175             "type": "Integer",
11176             "optional": false,
11177             "field": "timeout",
11178             "description": ""
11179           },
11180           {
11181             "group": "Body",
11182             "type": "String",
11183             "allowedValues": [
11184               "\"rrmemory\"",
11185               "\"beepall\"",
11186               "\"roundrobin\""
11187             ],
11188             "optional": false,
11189             "field": "strategy",
11190             "description": ""
11191           },
11192           {
11193             "group": "Body",
11194             "type": "Integer",
11195             "optional": true,
11196             "field": "lastAgent",
11197             "description": ""
11198           }
11199         ]
11200       }
11201     },
11202     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11203     "version": "0.0.0",
11204     "filename": "server/api/faxQueue/index.js",
11205     "groupTitle": "Fax_Queues"
11206   },
11207   {
11208     "type": "delete",
11209     "url": "/api/fax/queues/{id}",
11210     "title": "Deletes a Queue",
11211     "examples": [
11212       {
11213         "title": "Example usage:",
11214         "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password} -X DELETE",
11215         "type": "json"
11216       }
11217     ],
11218     "name": "DeleteQueues",
11219     "group": "Fax_Queues",
11220     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11221     "version": "0.0.0",
11222     "filename": "server/api/faxQueue/index.js",
11223     "groupTitle": "Fax_Queues"
11224   },
11225   {
11226     "type": "get",
11227     "url": "/api/fax/queues/describe",
11228     "title": "Gets table info about Queues",
11229     "examples": [
11230       {
11231         "title": "Example usage:",
11232         "content": "curl https://{domain}/api/fax/queues/describe -v -u {name}:{password}",
11233         "type": "json"
11234       }
11235     ],
11236     "name": "DescribeQueues",
11237     "group": "Fax_Queues",
11238     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11239     "version": "0.0.0",
11240     "filename": "server/api/faxQueue/index.js",
11241     "groupTitle": "Fax_Queues"
11242   },
11243   {
11244     "type": "get",
11245     "url": "/api/fax/queues/{id}/users",
11246     "title": "Gets queue agents",
11247     "examples": [
11248       {
11249         "title": "Example usage:",
11250         "content": "curl https://{domain}/api/fax/queues/{id}/users -v -u {name}:{password} -X POST",
11251         "type": "json"
11252       }
11253     ],
11254     "name": "GetAgents",
11255     "group": "Fax_Queues",
11256     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11257     "version": "0.0.0",
11258     "filename": "server/api/faxQueue/index.js",
11259     "groupTitle": "Fax_Queues"
11260   },
11261   {
11262     "type": "get",
11263     "url": "/api/fax/queues/{id}/members",
11264     "title": "GetMembers",
11265     "examples": [
11266       {
11267         "title": "Example usage:",
11268         "content": "curl https://{domain}/api/fax/queues/{id}/members  -v -u {name}:{password}",
11269         "type": "json"
11270       }
11271     ],
11272     "name": "GetMembers",
11273     "group": "Fax_Queues",
11274     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11275     "version": "0.0.0",
11276     "filename": "server/api/faxQueue/index.js",
11277     "groupTitle": "Fax_Queues"
11278   },
11279   {
11280     "type": "get",
11281     "url": "/api/fax/queues",
11282     "title": "Gets a list of Queues",
11283     "examples": [
11284       {
11285         "title": "Example usage:",
11286         "content": "curl https://{domain}/api/fax/queues -v -u {name}:{password}",
11287         "type": "json"
11288       }
11289     ],
11290     "name": "GetQueues",
11291     "group": "Fax_Queues",
11292     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11293     "version": "0.0.0",
11294     "filename": "server/api/faxQueue/index.js",
11295     "groupTitle": "Fax_Queues"
11296   },
11297   {
11298     "type": "get",
11299     "url": "/api/fax/queues/{id}/teams",
11300     "title": "Gets queues list",
11301     "examples": [
11302       {
11303         "title": "Example usage:",
11304         "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password}",
11305         "type": "json"
11306       }
11307     ],
11308     "name": "GetTeams",
11309     "group": "Fax_Queues",
11310     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11311     "version": "0.0.0",
11312     "filename": "server/api/faxQueue/index.js",
11313     "groupTitle": "Fax_Queues"
11314   },
11315   {
11316     "type": "delete",
11317     "url": "/api/fax/queues/{id}/users",
11318     "title": "Removes agents from a queue",
11319     "examples": [
11320       {
11321         "title": "Example usage:",
11322         "content": "curl https://{domain}/api/fax/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
11323         "type": "json"
11324       }
11325     ],
11326     "name": "RemoveAgents",
11327     "group": "Fax_Queues",
11328     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11329     "version": "0.0.0",
11330     "filename": "server/api/faxQueue/index.js",
11331     "groupTitle": "Fax_Queues"
11332   },
11333   {
11334     "type": "get",
11335     "url": "/api/fax/queues/{id}",
11336     "title": "Gets a single Queue",
11337     "examples": [
11338       {
11339         "title": "Example usage:",
11340         "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password}",
11341         "type": "json"
11342       }
11343     ],
11344     "name": "ShowQueues",
11345     "group": "Fax_Queues",
11346     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11347     "version": "0.0.0",
11348     "filename": "server/api/faxQueue/index.js",
11349     "groupTitle": "Fax_Queues"
11350   },
11351   {
11352     "type": "put",
11353     "url": "/api/fax/queues/{id}",
11354     "title": "Update an existing Queue",
11355     "examples": [
11356       {
11357         "title": "Example usage:",
11358         "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",
11359         "type": "json"
11360       }
11361     ],
11362     "name": "updateQueues",
11363     "group": "Fax_Queues",
11364     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11365     "version": "0.0.0",
11366     "filename": "server/api/faxQueue/index.js",
11367     "groupTitle": "Fax_Queues"
11368   },
11369   {
11370     "type": "post",
11371     "url": "/api/fax/reports/transfer",
11372     "title": "Creates a new Fax Transfer Report",
11373     "examples": [
11374       {
11375         "title": "Example usage:",
11376         "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",
11377         "type": "json"
11378       }
11379     ],
11380     "name": "CreateFax_Transfer_Reports",
11381     "group": "Fax_Transfer_Reports",
11382     "parameter": {
11383       "fields": {
11384         "Body": [
11385           {
11386             "group": "Body",
11387             "type": "String",
11388             "optional": false,
11389             "field": "uniqueid",
11390             "description": ""
11391           },
11392           {
11393             "group": "Body",
11394             "type": "String",
11395             "allowedValues": [
11396               "\"account\"",
11397               "\"agent\"",
11398               "\"queue\""
11399             ],
11400             "optional": false,
11401             "field": "type",
11402             "description": ""
11403           },
11404           {
11405             "group": "Body",
11406             "type": "String",
11407             "optional": false,
11408             "field": "transferredAt",
11409             "description": ""
11410           }
11411         ]
11412       }
11413     },
11414     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11415     "version": "0.0.0",
11416     "filename": "server/api/faxTransferReport/index.js",
11417     "groupTitle": "Fax_Transfer_Reports"
11418   },
11419   {
11420     "type": "delete",
11421     "url": "/api/fax/reports/transfer/{id}",
11422     "title": "Deletes a Fax Transfer Report",
11423     "examples": [
11424       {
11425         "title": "Example usage:",
11426         "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
11427         "type": "json"
11428       }
11429     ],
11430     "name": "DeleteFax_Transfer_Reports",
11431     "group": "Fax_Transfer_Reports",
11432     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11433     "version": "0.0.0",
11434     "filename": "server/api/faxTransferReport/index.js",
11435     "groupTitle": "Fax_Transfer_Reports"
11436   },
11437   {
11438     "type": "get",
11439     "url": "/api/fax/reports/transfer/describe",
11440     "title": "Gets table info about Fax Transfer Reports",
11441     "examples": [
11442       {
11443         "title": "Example usage:",
11444         "content": "curl https://{domain}/api/fax/reports/transfer/describe -v -u {name}:{password}",
11445         "type": "json"
11446       }
11447     ],
11448     "name": "DescribeFax_Transfer_Reports",
11449     "group": "Fax_Transfer_Reports",
11450     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11451     "version": "0.0.0",
11452     "filename": "server/api/faxTransferReport/index.js",
11453     "groupTitle": "Fax_Transfer_Reports"
11454   },
11455   {
11456     "type": "get",
11457     "url": "/api/fax/reports/transfer",
11458     "title": "Gets a list of Fax Transfer Reports",
11459     "examples": [
11460       {
11461         "title": "Example usage:",
11462         "content": "curl https://{domain}/api/fax/reports/transfer -v -u {name}:{password}",
11463         "type": "json"
11464       }
11465     ],
11466     "name": "GetFax_Transfer_Reports",
11467     "group": "Fax_Transfer_Reports",
11468     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11469     "version": "0.0.0",
11470     "filename": "server/api/faxTransferReport/index.js",
11471     "groupTitle": "Fax_Transfer_Reports"
11472   },
11473   {
11474     "type": "get",
11475     "url": "/api/fax/reports/transfer/{id}",
11476     "title": "Gets a single Fax Transfer Report",
11477     "examples": [
11478       {
11479         "title": "Example usage:",
11480         "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password}",
11481         "type": "json"
11482       }
11483     ],
11484     "name": "ShowFax_Transfer_Reports",
11485     "group": "Fax_Transfer_Reports",
11486     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11487     "version": "0.0.0",
11488     "filename": "server/api/faxTransferReport/index.js",
11489     "groupTitle": "Fax_Transfer_Reports"
11490   },
11491   {
11492     "type": "put",
11493     "url": "/api/fax/reports/transfer/{id}",
11494     "title": "Update an existing Fax Transfer Report",
11495     "examples": [
11496       {
11497         "title": "Example usage:",
11498         "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",
11499         "type": "json"
11500       }
11501     ],
11502     "name": "updateFax_Transfer_Reports",
11503     "group": "Fax_Transfer_Reports",
11504     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11505     "version": "0.0.0",
11506     "filename": "server/api/faxTransferReport/index.js",
11507     "groupTitle": "Fax_Transfer_Reports"
11508   },
11509   {
11510     "type": "post",
11511     "url": "/api/integrations/freshdesk/accounts",
11512     "title": "Creates a new Freshdesk Account",
11513     "examples": [
11514       {
11515         "title": "Example usage:",
11516         "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",
11517         "type": "json"
11518       }
11519     ],
11520     "name": "CreateFreshdesk_Accounts",
11521     "group": "Freshdesk_Accounts",
11522     "parameter": {
11523       "fields": {
11524         "Body": [
11525           {
11526             "group": "Body",
11527             "type": "String",
11528             "optional": true,
11529             "field": "name",
11530             "description": ""
11531           },
11532           {
11533             "group": "Body",
11534             "type": "String",
11535             "optional": true,
11536             "field": "description",
11537             "description": ""
11538           },
11539           {
11540             "group": "Body",
11541             "type": "String",
11542             "optional": true,
11543             "field": "username",
11544             "description": ""
11545           },
11546           {
11547             "group": "Body",
11548             "type": "String",
11549             "optional": true,
11550             "field": "apiKey",
11551             "description": ""
11552           },
11553           {
11554             "group": "Body",
11555             "type": "String",
11556             "optional": true,
11557             "field": "remoteUri",
11558             "description": ""
11559           },
11560           {
11561             "group": "Body",
11562             "type": "String",
11563             "optional": false,
11564             "field": "serverUrl",
11565             "description": ""
11566           }
11567         ]
11568       }
11569     },
11570     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11571     "version": "0.0.0",
11572     "filename": "server/api/intFreshdeskAccount/index.js",
11573     "groupTitle": "Freshdesk_Accounts"
11574   },
11575   {
11576     "type": "delete",
11577     "url": "/api/integrations/freshdesk/accounts/{id}",
11578     "title": "Deletes a Freshdesk Account",
11579     "examples": [
11580       {
11581         "title": "Example usage:",
11582         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password} -X DELETE",
11583         "type": "json"
11584       }
11585     ],
11586     "name": "DeleteFreshdesk_Accounts",
11587     "group": "Freshdesk_Accounts",
11588     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11589     "version": "0.0.0",
11590     "filename": "server/api/intFreshdeskAccount/index.js",
11591     "groupTitle": "Freshdesk_Accounts"
11592   },
11593   {
11594     "type": "get",
11595     "url": "/api/integrations/freshdesk/accounts",
11596     "title": "Gets a list of Freshdesk Accounts",
11597     "examples": [
11598       {
11599         "title": "Example usage:",
11600         "content": "curl https://{domain}/api/integrations/freshdesk/accounts -v -u {name}:{password}",
11601         "type": "json"
11602       }
11603     ],
11604     "name": "GetFreshdesk_Accounts",
11605     "group": "Freshdesk_Accounts",
11606     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11607     "version": "0.0.0",
11608     "filename": "server/api/intFreshdeskAccount/index.js",
11609     "groupTitle": "Freshdesk_Accounts"
11610   },
11611   {
11612     "type": "get",
11613     "url": "/api/integrations/freshdesk/accounts/{id}",
11614     "title": "Gets a single Freshdesk Account",
11615     "examples": [
11616       {
11617         "title": "Example usage:",
11618         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password}",
11619         "type": "json"
11620       }
11621     ],
11622     "name": "ShowFreshdesk_Accounts",
11623     "group": "Freshdesk_Accounts",
11624     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11625     "version": "0.0.0",
11626     "filename": "server/api/intFreshdeskAccount/index.js",
11627     "groupTitle": "Freshdesk_Accounts"
11628   },
11629   {
11630     "type": "post",
11631     "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
11632     "title": "Creates new configuration",
11633     "examples": [
11634       {
11635         "title": "Example usage:",
11636         "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",
11637         "type": "json"
11638       }
11639     ],
11640     "name": "addConfiguration",
11641     "group": "Freshdesk_Accounts",
11642     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11643     "version": "0.0.0",
11644     "filename": "server/api/intFreshdeskAccount/index.js",
11645     "groupTitle": "Freshdesk_Accounts"
11646   },
11647   {
11648     "type": "get",
11649     "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
11650     "title": "Gets account configurations",
11651     "examples": [
11652       {
11653         "title": "Example usage:",
11654         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
11655         "type": "json"
11656       }
11657     ],
11658     "name": "getConfigurations",
11659     "group": "Freshdesk_Accounts",
11660     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11661     "version": "0.0.0",
11662     "filename": "server/api/intFreshdeskAccount/index.js",
11663     "groupTitle": "Freshdesk_Accounts"
11664   },
11665   {
11666     "type": "get",
11667     "url": "/api/integrations/freshdesk/accounts/{id}/fields",
11668     "title": "Gets account fields",
11669     "examples": [
11670       {
11671         "title": "Example usage:",
11672         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
11673         "type": "json"
11674       }
11675     ],
11676     "name": "getFields",
11677     "group": "Freshdesk_Accounts",
11678     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11679     "version": "0.0.0",
11680     "filename": "server/api/intFreshdeskAccount/index.js",
11681     "groupTitle": "Freshdesk_Accounts"
11682   },
11683   {
11684     "type": "put",
11685     "url": "/api/integrations/freshdesk/accounts/{id}",
11686     "title": "Update an existing Freshdesk Account",
11687     "examples": [
11688       {
11689         "title": "Example usage:",
11690         "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",
11691         "type": "json"
11692       }
11693     ],
11694     "name": "updateFreshdesk_Accounts",
11695     "group": "Freshdesk_Accounts",
11696     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11697     "version": "0.0.0",
11698     "filename": "server/api/intFreshdeskAccount/index.js",
11699     "groupTitle": "Freshdesk_Accounts"
11700   },
11701   {
11702     "type": "post",
11703     "url": "/api/integrations/freshdesk/configurations",
11704     "title": "Creates a new Freshdesk Configuration",
11705     "examples": [
11706       {
11707         "title": "Example usage:",
11708         "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",
11709         "type": "json"
11710       }
11711     ],
11712     "name": "CreateFreshdesk_Configurations",
11713     "group": "Freshdesk_Configurations",
11714     "parameter": {
11715       "fields": {
11716         "Body": [
11717           {
11718             "group": "Body",
11719             "type": "String",
11720             "optional": true,
11721             "field": "name",
11722             "description": ""
11723           },
11724           {
11725             "group": "Body",
11726             "type": "String",
11727             "optional": true,
11728             "field": "description",
11729             "description": ""
11730           }
11731         ]
11732       }
11733     },
11734     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11735     "version": "0.0.0",
11736     "filename": "server/api/intFreshdeskConfiguration/index.js",
11737     "groupTitle": "Freshdesk_Configurations"
11738   },
11739   {
11740     "type": "delete",
11741     "url": "/api/integrations/freshdesk/configurations/{id}",
11742     "title": "Deletes a Freshdesk Configuration",
11743     "examples": [
11744       {
11745         "title": "Example usage:",
11746         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password} -X DELETE",
11747         "type": "json"
11748       }
11749     ],
11750     "name": "DeleteFreshdesk_Configurations",
11751     "group": "Freshdesk_Configurations",
11752     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11753     "version": "0.0.0",
11754     "filename": "server/api/intFreshdeskConfiguration/index.js",
11755     "groupTitle": "Freshdesk_Configurations"
11756   },
11757   {
11758     "type": "get",
11759     "url": "/api/integrations/freshdesk/configurations",
11760     "title": "Gets a list of Freshdesk Configurations",
11761     "examples": [
11762       {
11763         "title": "Example usage:",
11764         "content": "curl https://{domain}/api/integrations/freshdesk/configurations -v -u {name}:{password}",
11765         "type": "json"
11766       }
11767     ],
11768     "name": "GetFreshdesk_Configurations",
11769     "group": "Freshdesk_Configurations",
11770     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11771     "version": "0.0.0",
11772     "filename": "server/api/intFreshdeskConfiguration/index.js",
11773     "groupTitle": "Freshdesk_Configurations"
11774   },
11775   {
11776     "type": "get",
11777     "url": "/api/integrations/freshdesk/configurations/{id}",
11778     "title": "Gets a single Freshdesk Configuration",
11779     "examples": [
11780       {
11781         "title": "Example usage:",
11782         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password}",
11783         "type": "json"
11784       }
11785     ],
11786     "name": "ShowFreshdesk_Configurations",
11787     "group": "Freshdesk_Configurations",
11788     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11789     "version": "0.0.0",
11790     "filename": "server/api/intFreshdeskConfiguration/index.js",
11791     "groupTitle": "Freshdesk_Configurations"
11792   },
11793   {
11794     "type": "get",
11795     "url": "/api/integrations/freshdesk/configurations/{id}/descriptions",
11796     "title": "Gets configurations descriptions",
11797     "examples": [
11798       {
11799         "title": "Example usage:",
11800         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
11801         "type": "json"
11802       }
11803     ],
11804     "name": "getDescriptions",
11805     "group": "Freshdesk_Configurations",
11806     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11807     "version": "0.0.0",
11808     "filename": "server/api/intFreshdeskConfiguration/index.js",
11809     "groupTitle": "Freshdesk_Configurations"
11810   },
11811   {
11812     "type": "get",
11813     "url": "/api/integrations/freshdesk/configurations/{id}/fields",
11814     "title": "Gets configurations fields",
11815     "examples": [
11816       {
11817         "title": "Example usage:",
11818         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
11819         "type": "json"
11820       }
11821     ],
11822     "name": "getFields",
11823     "group": "Freshdesk_Configurations",
11824     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11825     "version": "0.0.0",
11826     "filename": "server/api/intFreshdeskConfiguration/index.js",
11827     "groupTitle": "Freshdesk_Configurations"
11828   },
11829   {
11830     "type": "get",
11831     "url": "/api/integrations/freshdesk/configurations/{id}/subjects",
11832     "title": "Gets configurations subjects",
11833     "examples": [
11834       {
11835         "title": "Example usage:",
11836         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
11837         "type": "json"
11838       }
11839     ],
11840     "name": "getSubjects",
11841     "group": "Freshdesk_Configurations",
11842     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11843     "version": "0.0.0",
11844     "filename": "server/api/intFreshdeskConfiguration/index.js",
11845     "groupTitle": "Freshdesk_Configurations"
11846   },
11847   {
11848     "type": "get",
11849     "url": "/api/integrations/freshdesk/configurations/{id}/tags",
11850     "title": "Gets configurations tags",
11851     "examples": [
11852       {
11853         "title": "Example usage:",
11854         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
11855         "type": "json"
11856       }
11857     ],
11858     "name": "getTags",
11859     "group": "Freshdesk_Configurations",
11860     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11861     "version": "0.0.0",
11862     "filename": "server/api/intFreshdeskConfiguration/index.js",
11863     "groupTitle": "Freshdesk_Configurations"
11864   },
11865   {
11866     "type": "post",
11867     "url": "/api/integrations/freshdesk/configurations/{id}/tags",
11868     "title": "Sets new tags",
11869     "examples": [
11870       {
11871         "title": "Example usage:",
11872         "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",
11873         "type": "json"
11874       }
11875     ],
11876     "name": "setTags",
11877     "group": "Freshdesk_Configurations",
11878     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11879     "version": "0.0.0",
11880     "filename": "server/api/intFreshdeskConfiguration/index.js",
11881     "groupTitle": "Freshdesk_Configurations"
11882   },
11883   {
11884     "type": "put",
11885     "url": "/api/integrations/freshdesk/configurations/{id}",
11886     "title": "Update an existing Freshdesk Configuration",
11887     "examples": [
11888       {
11889         "title": "Example usage:",
11890         "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",
11891         "type": "json"
11892       }
11893     ],
11894     "name": "updateFreshdesk_Configurations",
11895     "group": "Freshdesk_Configurations",
11896     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11897     "version": "0.0.0",
11898     "filename": "server/api/intFreshdeskConfiguration/index.js",
11899     "groupTitle": "Freshdesk_Configurations"
11900   },
11901   {
11902     "type": "post",
11903     "url": "/api/integrations/freshdesk/fields",
11904     "title": "Creates a new Freshdesk Field",
11905     "examples": [
11906       {
11907         "title": "Example usage:",
11908         "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",
11909         "type": "json"
11910       }
11911     ],
11912     "name": "CreateFreshdesk_Fields",
11913     "group": "Freshdesk_Fields",
11914     "parameter": {
11915       "fields": {
11916         "Body": [
11917           {
11918             "group": "Body",
11919             "type": "String",
11920             "allowedValues": [
11921               "\"string\"",
11922               "\"variable\"",
11923               "\"customVariable\"",
11924               "\"keyValue\"",
11925               "\"picklist\""
11926             ],
11927             "optional": true,
11928             "field": "type",
11929             "description": ""
11930           },
11931           {
11932             "group": "Body",
11933             "type": "String",
11934             "optional": true,
11935             "field": "content",
11936             "description": ""
11937           },
11938           {
11939             "group": "Body",
11940             "type": "String",
11941             "optional": true,
11942             "field": "key",
11943             "description": ""
11944           },
11945           {
11946             "group": "Body",
11947             "type": "String",
11948             "allowedValues": [
11949               "\"string\"",
11950               "\"variable\"",
11951               "\"customVariable\""
11952             ],
11953             "optional": true,
11954             "field": "keyType",
11955             "description": ""
11956           },
11957           {
11958             "group": "Body",
11959             "type": "String",
11960             "optional": true,
11961             "field": "keyContent",
11962             "description": ""
11963           },
11964           {
11965             "group": "Body",
11966             "type": "String",
11967             "optional": true,
11968             "field": "idField",
11969             "description": ""
11970           },
11971           {
11972             "group": "Body",
11973             "type": "String",
11974             "optional": true,
11975             "field": "nameField",
11976             "description": ""
11977           },
11978           {
11979             "group": "Body",
11980             "type": "Boolean",
11981             "optional": true,
11982             "field": "customField",
11983             "description": ""
11984           },
11985           {
11986             "group": "Body",
11987             "type": "String",
11988             "optional": true,
11989             "field": "variableName",
11990             "description": ""
11991           }
11992         ]
11993       }
11994     },
11995     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11996     "version": "0.0.0",
11997     "filename": "server/api/intFreshdeskField/index.js",
11998     "groupTitle": "Freshdesk_Fields"
11999   },
12000   {
12001     "type": "delete",
12002     "url": "/api/integrations/freshdesk/fields/{id}",
12003     "title": "Deletes a Freshdesk Field",
12004     "examples": [
12005       {
12006         "title": "Example usage:",
12007         "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password} -X DELETE",
12008         "type": "json"
12009       }
12010     ],
12011     "name": "DeleteFreshdesk_Fields",
12012     "group": "Freshdesk_Fields",
12013     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12014     "version": "0.0.0",
12015     "filename": "server/api/intFreshdeskField/index.js",
12016     "groupTitle": "Freshdesk_Fields"
12017   },
12018   {
12019     "type": "get",
12020     "url": "/api/integrations/freshdesk/fields",
12021     "title": "Gets a list of Freshdesk Fields",
12022     "examples": [
12023       {
12024         "title": "Example usage:",
12025         "content": "curl https://{domain}/api/integrations/freshdesk/fields -v -u {name}:{password}",
12026         "type": "json"
12027       }
12028     ],
12029     "name": "GetFreshdesk_Fields",
12030     "group": "Freshdesk_Fields",
12031     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12032     "version": "0.0.0",
12033     "filename": "server/api/intFreshdeskField/index.js",
12034     "groupTitle": "Freshdesk_Fields"
12035   },
12036   {
12037     "type": "get",
12038     "url": "/api/integrations/freshdesk/fields/{id}",
12039     "title": "Gets a single Freshdesk Field",
12040     "examples": [
12041       {
12042         "title": "Example usage:",
12043         "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password}",
12044         "type": "json"
12045       }
12046     ],
12047     "name": "ShowFreshdesk_Fields",
12048     "group": "Freshdesk_Fields",
12049     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12050     "version": "0.0.0",
12051     "filename": "server/api/intFreshdeskField/index.js",
12052     "groupTitle": "Freshdesk_Fields"
12053   },
12054   {
12055     "type": "put",
12056     "url": "/api/integrations/freshdesk/fields/{id}",
12057     "title": "Update an existing Freshdesk Field",
12058     "examples": [
12059       {
12060         "title": "Example usage:",
12061         "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",
12062         "type": "json"
12063       }
12064     ],
12065     "name": "updateFreshdesk_Fields",
12066     "group": "Freshdesk_Fields",
12067     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12068     "version": "0.0.0",
12069     "filename": "server/api/intFreshdeskField/index.js",
12070     "groupTitle": "Freshdesk_Fields"
12071   },
12072   {
12073     "type": "post",
12074     "url": "/api/integrations/freshsales/accounts",
12075     "title": "Creates a new Freshsales Account",
12076     "examples": [
12077       {
12078         "title": "Example usage:",
12079         "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",
12080         "type": "json"
12081       }
12082     ],
12083     "name": "CreateFreshsales_Accounts",
12084     "group": "Freshsales_Accounts",
12085     "parameter": {
12086       "fields": {
12087         "Body": [
12088           {
12089             "group": "Body",
12090             "type": "String",
12091             "optional": true,
12092             "field": "name",
12093             "description": ""
12094           },
12095           {
12096             "group": "Body",
12097             "type": "String",
12098             "optional": true,
12099             "field": "description",
12100             "description": ""
12101           },
12102           {
12103             "group": "Body",
12104             "type": "String",
12105             "optional": true,
12106             "field": "username",
12107             "description": ""
12108           },
12109           {
12110             "group": "Body",
12111             "type": "String",
12112             "optional": true,
12113             "field": "apiKey",
12114             "description": ""
12115           },
12116           {
12117             "group": "Body",
12118             "type": "String",
12119             "optional": true,
12120             "field": "remoteUri",
12121             "description": ""
12122           },
12123           {
12124             "group": "Body",
12125             "type": "String",
12126             "optional": false,
12127             "field": "serverUrl",
12128             "description": ""
12129           }
12130         ]
12131       }
12132     },
12133     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12134     "version": "0.0.0",
12135     "filename": "server/api/intFreshsalesAccount/index.js",
12136     "groupTitle": "Freshsales_Accounts"
12137   },
12138   {
12139     "type": "delete",
12140     "url": "/api/integrations/freshsales/accounts/{id}",
12141     "title": "Deletes a Freshsales Account",
12142     "examples": [
12143       {
12144         "title": "Example usage:",
12145         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password} -X DELETE",
12146         "type": "json"
12147       }
12148     ],
12149     "name": "DeleteFreshsales_Accounts",
12150     "group": "Freshsales_Accounts",
12151     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12152     "version": "0.0.0",
12153     "filename": "server/api/intFreshsalesAccount/index.js",
12154     "groupTitle": "Freshsales_Accounts"
12155   },
12156   {
12157     "type": "get",
12158     "url": "/api/integrations/freshsales/accounts",
12159     "title": "Gets a list of Freshsales Accounts",
12160     "examples": [
12161       {
12162         "title": "Example usage:",
12163         "content": "curl https://{domain}/api/integrations/freshsales/accounts -v -u {name}:{password}",
12164         "type": "json"
12165       }
12166     ],
12167     "name": "GetFreshsales_Accounts",
12168     "group": "Freshsales_Accounts",
12169     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12170     "version": "0.0.0",
12171     "filename": "server/api/intFreshsalesAccount/index.js",
12172     "groupTitle": "Freshsales_Accounts"
12173   },
12174   {
12175     "type": "get",
12176     "url": "/api/integrations/freshsales/accounts/{id}",
12177     "title": "Gets a single Freshsales Account",
12178     "examples": [
12179       {
12180         "title": "Example usage:",
12181         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password}",
12182         "type": "json"
12183       }
12184     ],
12185     "name": "ShowFreshsales_Accounts",
12186     "group": "Freshsales_Accounts",
12187     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12188     "version": "0.0.0",
12189     "filename": "server/api/intFreshsalesAccount/index.js",
12190     "groupTitle": "Freshsales_Accounts"
12191   },
12192   {
12193     "type": "post",
12194     "url": "/api/integrations/freshsales/accounts/{id}/configurations",
12195     "title": "Creates new configuration",
12196     "examples": [
12197       {
12198         "title": "Example usage:",
12199         "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",
12200         "type": "json"
12201       }
12202     ],
12203     "name": "addConfiguration",
12204     "group": "Freshsales_Accounts",
12205     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12206     "version": "0.0.0",
12207     "filename": "server/api/intFreshsalesAccount/index.js",
12208     "groupTitle": "Freshsales_Accounts"
12209   },
12210   {
12211     "type": "get",
12212     "url": "/api/integrations/freshsales/accounts/{id}/configurations",
12213     "title": "Gets account configurations",
12214     "examples": [
12215       {
12216         "title": "Example usage:",
12217         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/configurations -v -u {name}:{password} -X GET",
12218         "type": "json"
12219       }
12220     ],
12221     "name": "getConfigurations",
12222     "group": "Freshsales_Accounts",
12223     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12224     "version": "0.0.0",
12225     "filename": "server/api/intFreshsalesAccount/index.js",
12226     "groupTitle": "Freshsales_Accounts"
12227   },
12228   {
12229     "type": "get",
12230     "url": "/api/integrations/freshsales/accounts/{id}/fields",
12231     "title": "Gets account fields",
12232     "examples": [
12233       {
12234         "title": "Example usage:",
12235         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/fields -v -u {name}:{password} -X GET",
12236         "type": "json"
12237       }
12238     ],
12239     "name": "getFields",
12240     "group": "Freshsales_Accounts",
12241     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12242     "version": "0.0.0",
12243     "filename": "server/api/intFreshsalesAccount/index.js",
12244     "groupTitle": "Freshsales_Accounts"
12245   },
12246   {
12247     "type": "put",
12248     "url": "/api/integrations/freshsales/accounts/{id}",
12249     "title": "Update an existing Freshsales Account",
12250     "examples": [
12251       {
12252         "title": "Example usage:",
12253         "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",
12254         "type": "json"
12255       }
12256     ],
12257     "name": "updateFreshsales_Accounts",
12258     "group": "Freshsales_Accounts",
12259     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12260     "version": "0.0.0",
12261     "filename": "server/api/intFreshsalesAccount/index.js",
12262     "groupTitle": "Freshsales_Accounts"
12263   },
12264   {
12265     "type": "post",
12266     "url": "/api/integrations/freshsales/configurations",
12267     "title": "Creates a new Freshsales Configuration",
12268     "examples": [
12269       {
12270         "title": "Example usage:",
12271         "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",
12272         "type": "json"
12273       }
12274     ],
12275     "name": "CreateFreshsales_Configurations",
12276     "group": "Freshsales_Configurations",
12277     "parameter": {
12278       "fields": {
12279         "Body": [
12280           {
12281             "group": "Body",
12282             "type": "String",
12283             "optional": true,
12284             "field": "name",
12285             "description": ""
12286           },
12287           {
12288             "group": "Body",
12289             "type": "String",
12290             "optional": true,
12291             "field": "description",
12292             "description": ""
12293           }
12294         ]
12295       }
12296     },
12297     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12298     "version": "0.0.0",
12299     "filename": "server/api/intFreshsalesConfiguration/index.js",
12300     "groupTitle": "Freshsales_Configurations"
12301   },
12302   {
12303     "type": "delete",
12304     "url": "/api/integrations/freshsales/configurations/{id}",
12305     "title": "Deletes a Freshsales Configuration",
12306     "examples": [
12307       {
12308         "title": "Example usage:",
12309         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password} -X DELETE",
12310         "type": "json"
12311       }
12312     ],
12313     "name": "DeleteFreshsales_Configurations",
12314     "group": "Freshsales_Configurations",
12315     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12316     "version": "0.0.0",
12317     "filename": "server/api/intFreshsalesConfiguration/index.js",
12318     "groupTitle": "Freshsales_Configurations"
12319   },
12320   {
12321     "type": "get",
12322     "url": "/api/integrations/freshsales/configurations",
12323     "title": "Gets a list of Freshsales Configurations",
12324     "examples": [
12325       {
12326         "title": "Example usage:",
12327         "content": "curl https://{domain}/api/integrations/freshsales/configurations -v -u {name}:{password}",
12328         "type": "json"
12329       }
12330     ],
12331     "name": "GetFreshsales_Configurations",
12332     "group": "Freshsales_Configurations",
12333     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12334     "version": "0.0.0",
12335     "filename": "server/api/intFreshsalesConfiguration/index.js",
12336     "groupTitle": "Freshsales_Configurations"
12337   },
12338   {
12339     "type": "get",
12340     "url": "/api/integrations/freshsales/configurations/{id}",
12341     "title": "Gets a single Freshsales Configuration",
12342     "examples": [
12343       {
12344         "title": "Example usage:",
12345         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password}",
12346         "type": "json"
12347       }
12348     ],
12349     "name": "ShowFreshsales_Configurations",
12350     "group": "Freshsales_Configurations",
12351     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12352     "version": "0.0.0",
12353     "filename": "server/api/intFreshsalesConfiguration/index.js",
12354     "groupTitle": "Freshsales_Configurations"
12355   },
12356   {
12357     "type": "get",
12358     "url": "/api/integrations/freshsales/configurations/{id}/descriptions",
12359     "title": "Gets configurations descriptions",
12360     "examples": [
12361       {
12362         "title": "Example usage:",
12363         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
12364         "type": "json"
12365       }
12366     ],
12367     "name": "getDescriptions",
12368     "group": "Freshsales_Configurations",
12369     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12370     "version": "0.0.0",
12371     "filename": "server/api/intFreshsalesConfiguration/index.js",
12372     "groupTitle": "Freshsales_Configurations"
12373   },
12374   {
12375     "type": "get",
12376     "url": "/api/integrations/freshsales/configurations/{id}/fields",
12377     "title": "Gets configurations fields",
12378     "examples": [
12379       {
12380         "title": "Example usage:",
12381         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/fields -v -u {name}:{password} -X GET",
12382         "type": "json"
12383       }
12384     ],
12385     "name": "getFields",
12386     "group": "Freshsales_Configurations",
12387     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12388     "version": "0.0.0",
12389     "filename": "server/api/intFreshsalesConfiguration/index.js",
12390     "groupTitle": "Freshsales_Configurations"
12391   },
12392   {
12393     "type": "get",
12394     "url": "/api/integrations/freshsales/configurations/{id}/subjects",
12395     "title": "Gets configurations subjects",
12396     "examples": [
12397       {
12398         "title": "Example usage:",
12399         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/subjects -v -u {name}:{password} -X GET",
12400         "type": "json"
12401       }
12402     ],
12403     "name": "getSubjects",
12404     "group": "Freshsales_Configurations",
12405     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12406     "version": "0.0.0",
12407     "filename": "server/api/intFreshsalesConfiguration/index.js",
12408     "groupTitle": "Freshsales_Configurations"
12409   },
12410   {
12411     "type": "put",
12412     "url": "/api/integrations/freshsales/configurations/{id}",
12413     "title": "Update an existing Freshsales Configuration",
12414     "examples": [
12415       {
12416         "title": "Example usage:",
12417         "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",
12418         "type": "json"
12419       }
12420     ],
12421     "name": "updateFreshsales_Configurations",
12422     "group": "Freshsales_Configurations",
12423     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12424     "version": "0.0.0",
12425     "filename": "server/api/intFreshsalesConfiguration/index.js",
12426     "groupTitle": "Freshsales_Configurations"
12427   },
12428   {
12429     "type": "post",
12430     "url": "/api/integrations/freshsales/fields",
12431     "title": "Creates a new Freshsales Field",
12432     "examples": [
12433       {
12434         "title": "Example usage:",
12435         "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",
12436         "type": "json"
12437       }
12438     ],
12439     "name": "CreateFreshsales_Fields",
12440     "group": "Freshsales_Fields",
12441     "parameter": {
12442       "fields": {
12443         "Body": [
12444           {
12445             "group": "Body",
12446             "type": "String",
12447             "allowedValues": [
12448               "\"string\"",
12449               "\"variable\"",
12450               "\"customVariable\"",
12451               "\"keyValue\"",
12452               "\"picklist\""
12453             ],
12454             "optional": true,
12455             "field": "type",
12456             "description": ""
12457           },
12458           {
12459             "group": "Body",
12460             "type": "String",
12461             "optional": true,
12462             "field": "content",
12463             "description": ""
12464           },
12465           {
12466             "group": "Body",
12467             "type": "String",
12468             "optional": true,
12469             "field": "key",
12470             "description": ""
12471           },
12472           {
12473             "group": "Body",
12474             "type": "String",
12475             "allowedValues": [
12476               "\"string\"",
12477               "\"variable\"",
12478               "\"customVariable\""
12479             ],
12480             "optional": true,
12481             "field": "keyType",
12482             "description": ""
12483           },
12484           {
12485             "group": "Body",
12486             "type": "String",
12487             "optional": true,
12488             "field": "keyContent",
12489             "description": ""
12490           },
12491           {
12492             "group": "Body",
12493             "type": "String",
12494             "optional": true,
12495             "field": "idField",
12496             "description": ""
12497           },
12498           {
12499             "group": "Body",
12500             "type": "String",
12501             "optional": true,
12502             "field": "nameField",
12503             "description": ""
12504           },
12505           {
12506             "group": "Body",
12507             "type": "Boolean",
12508             "optional": true,
12509             "field": "customField",
12510             "description": ""
12511           },
12512           {
12513             "group": "Body",
12514             "type": "String",
12515             "optional": true,
12516             "field": "variableName",
12517             "description": ""
12518           }
12519         ]
12520       }
12521     },
12522     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12523     "version": "0.0.0",
12524     "filename": "server/api/intFreshsalesField/index.js",
12525     "groupTitle": "Freshsales_Fields"
12526   },
12527   {
12528     "type": "delete",
12529     "url": "/api/integrations/freshsales/fields/{id}",
12530     "title": "Deletes a Freshsales Field",
12531     "examples": [
12532       {
12533         "title": "Example usage:",
12534         "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password} -X DELETE",
12535         "type": "json"
12536       }
12537     ],
12538     "name": "DeleteFreshsales_Fields",
12539     "group": "Freshsales_Fields",
12540     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12541     "version": "0.0.0",
12542     "filename": "server/api/intFreshsalesField/index.js",
12543     "groupTitle": "Freshsales_Fields"
12544   },
12545   {
12546     "type": "get",
12547     "url": "/api/integrations/freshsales/fields",
12548     "title": "Gets a list of Freshsales Fields",
12549     "examples": [
12550       {
12551         "title": "Example usage:",
12552         "content": "curl https://{domain}/api/integrations/freshsales/fields -v -u {name}:{password}",
12553         "type": "json"
12554       }
12555     ],
12556     "name": "GetFreshsales_Fields",
12557     "group": "Freshsales_Fields",
12558     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12559     "version": "0.0.0",
12560     "filename": "server/api/intFreshsalesField/index.js",
12561     "groupTitle": "Freshsales_Fields"
12562   },
12563   {
12564     "type": "get",
12565     "url": "/api/integrations/freshsales/fields/{id}",
12566     "title": "Gets a single Freshsales Field",
12567     "examples": [
12568       {
12569         "title": "Example usage:",
12570         "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password}",
12571         "type": "json"
12572       }
12573     ],
12574     "name": "ShowFreshsales_Fields",
12575     "group": "Freshsales_Fields",
12576     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12577     "version": "0.0.0",
12578     "filename": "server/api/intFreshsalesField/index.js",
12579     "groupTitle": "Freshsales_Fields"
12580   },
12581   {
12582     "type": "put",
12583     "url": "/api/integrations/freshsales/fields/{id}",
12584     "title": "Update an existing Freshsales Field",
12585     "examples": [
12586       {
12587         "title": "Example usage:",
12588         "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",
12589         "type": "json"
12590       }
12591     ],
12592     "name": "updateFreshsales_Fields",
12593     "group": "Freshsales_Fields",
12594     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12595     "version": "0.0.0",
12596     "filename": "server/api/intFreshsalesField/index.js",
12597     "groupTitle": "Freshsales_Fields"
12598   },
12599   {
12600     "type": "post",
12601     "url": "/api/campaigns/{id}/blacklists",
12602     "title": "Add blacklists to an IVR campaign",
12603     "examples": [
12604       {
12605         "title": "Example usage:",
12606         "content": "curl https://{domain}/api/campaigns/{id}/blacklists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
12607         "type": "json"
12608       }
12609     ],
12610     "name": "AddBlackLists",
12611     "group": "IVR_Campaigns",
12612     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12613     "version": "0.0.0",
12614     "filename": "server/api/campaign/index.js",
12615     "groupTitle": "IVR_Campaigns"
12616   },
12617   {
12618     "type": "post",
12619     "url": "/api/campaigns/{id}/lists",
12620     "title": "Add lists to an IVR campaign",
12621     "examples": [
12622       {
12623         "title": "Example usage:",
12624         "content": "curl https://{domain}/api/campaigns/{id}/lists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
12625         "type": "json"
12626       }
12627     ],
12628     "name": "AddLists",
12629     "group": "IVR_Campaigns",
12630     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12631     "version": "0.0.0",
12632     "filename": "server/api/campaign/index.js",
12633     "groupTitle": "IVR_Campaigns"
12634   },
12635   {
12636     "type": "post",
12637     "url": "/api/campaigns/clone",
12638     "title": "Clone an existing IVR Campaign",
12639     "examples": [
12640       {
12641         "title": "Example usage:",
12642         "content": "curl https://{domain}/api/campaigns/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12643         "type": "json"
12644       }
12645     ],
12646     "name": "CloneIVR_Campaigns",
12647     "group": "IVR_Campaigns",
12648     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12649     "version": "0.0.0",
12650     "filename": "server/api/campaign/index.js",
12651     "groupTitle": "IVR_Campaigns"
12652   },
12653   {
12654     "type": "post",
12655     "url": "/api/campaigns",
12656     "title": "Creates a new IVR Campaign",
12657     "examples": [
12658       {
12659         "title": "Example usage:",
12660         "content": "curl https://{domain}/api/campaigns -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12661         "type": "json"
12662       }
12663     ],
12664     "name": "CreateIVR_Campaigns",
12665     "group": "IVR_Campaigns",
12666     "parameter": {
12667       "fields": {
12668         "Body": [
12669           {
12670             "group": "Body",
12671             "type": "String",
12672             "optional": false,
12673             "field": "name",
12674             "description": ""
12675           },
12676           {
12677             "group": "Body",
12678             "type": "String",
12679             "allowedValues": [
12680               "\"ivr\""
12681             ],
12682             "optional": false,
12683             "field": "type",
12684             "description": ""
12685           },
12686           {
12687             "group": "Body",
12688             "type": "String",
12689             "optional": true,
12690             "field": "description",
12691             "description": ""
12692           },
12693           {
12694             "group": "Body",
12695             "type": "Boolean",
12696             "optional": true,
12697             "field": "active",
12698             "description": "<p>Active/Disactive Campaign</p>"
12699           },
12700           {
12701             "group": "Body",
12702             "type": "Integer",
12703             "optional": true,
12704             "field": "limitCalls",
12705             "description": "<p>Max 200 calls.</p>"
12706           },
12707           {
12708             "group": "Body",
12709             "type": "String",
12710             "optional": true,
12711             "field": "dialOriginateCallerIdName",
12712             "description": ""
12713           },
12714           {
12715             "group": "Body",
12716             "type": "String",
12717             "optional": true,
12718             "field": "dialOriginateCallerIdNumber",
12719             "description": ""
12720           },
12721           {
12722             "group": "Body",
12723             "type": "Integer",
12724             "optional": true,
12725             "field": "dialOriginateTimeout",
12726             "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
12727           },
12728           {
12729             "group": "Body",
12730             "type": "Integer",
12731             "optional": true,
12732             "field": "dialCongestionMaxRetry",
12733             "description": "<p>#Congestion Retry (min:1, max:999)</p>"
12734           },
12735           {
12736             "group": "Body",
12737             "type": "Integer",
12738             "optional": true,
12739             "field": "dialCongestionRetryFrequency",
12740             "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
12741           },
12742           {
12743             "group": "Body",
12744             "type": "Integer",
12745             "optional": true,
12746             "field": "dialBusyMaxRetry",
12747             "description": "<p>#Busy Retry (min:1, max:999)</p>"
12748           },
12749           {
12750             "group": "Body",
12751             "type": "Integer",
12752             "optional": true,
12753             "field": "dialBusyRetryFrequency",
12754             "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
12755           },
12756           {
12757             "group": "Body",
12758             "type": "Integer",
12759             "optional": true,
12760             "field": "dialNoAnswerMaxRetry",
12761             "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
12762           },
12763           {
12764             "group": "Body",
12765             "type": "Integer",
12766             "optional": true,
12767             "field": "dialNoAnswerRetryFrequency",
12768             "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
12769           },
12770           {
12771             "group": "Body",
12772             "type": "Integer",
12773             "optional": true,
12774             "field": "dialGlobalMaxRetry",
12775             "description": "<p>#Global Max Retry (min:1, max:999)</p>"
12776           },
12777           {
12778             "group": "Body",
12779             "type": "String",
12780             "optional": true,
12781             "field": "dialTimezone",
12782             "description": ""
12783           },
12784           {
12785             "group": "Body",
12786             "type": "String",
12787             "optional": true,
12788             "field": "dialGlobalInterval",
12789             "description": ""
12790           },
12791           {
12792             "group": "Body",
12793             "type": "String",
12794             "allowedValues": [
12795               "\"always\"",
12796               "\"never\"",
12797               "\"onlyIfOpen\""
12798             ],
12799             "optional": true,
12800             "field": "dialCheckDuplicateType",
12801             "description": ""
12802           },
12803           {
12804             "group": "Body",
12805             "type": "Boolean",
12806             "optional": true,
12807             "field": "dialAMDActive",
12808             "description": "<p>Active/Disactive AMD</p>"
12809           },
12810           {
12811             "group": "Body",
12812             "type": "Integer",
12813             "optional": true,
12814             "field": "dialAMDInitialSilence",
12815             "description": "<p>#AMD Initial Silence</p>"
12816           },
12817           {
12818             "group": "Body",
12819             "type": "Integer",
12820             "optional": true,
12821             "field": "dialAMDGreeting",
12822             "description": "<p>#AMD Greeting</p>"
12823           },
12824           {
12825             "group": "Body",
12826             "type": "Integer",
12827             "optional": true,
12828             "field": "dialAMDAfterGreetingSilence",
12829             "description": "<p>#AMD After Greeting Silence</p>"
12830           },
12831           {
12832             "group": "Body",
12833             "type": "Integer",
12834             "optional": true,
12835             "field": "dialAMDTotalAnalysisTime",
12836             "description": "<p>#AMD Total Analysis Time</p>"
12837           },
12838           {
12839             "group": "Body",
12840             "type": "Integer",
12841             "optional": true,
12842             "field": "dialAMDMinWordLength",
12843             "description": "<p>#AMD Min Word Length</p>"
12844           },
12845           {
12846             "group": "Body",
12847             "type": "Integer",
12848             "optional": true,
12849             "field": "dialAMDBetweenWordsSilence",
12850             "description": "<p>#AMD Between Words Silence</p>"
12851           },
12852           {
12853             "group": "Body",
12854             "type": "Integer",
12855             "optional": true,
12856             "field": "dialAMDMaximumNumberOfWords",
12857             "description": "<p>#AMD Maximum Number Of Words</p>"
12858           },
12859           {
12860             "group": "Body",
12861             "type": "Integer",
12862             "optional": true,
12863             "field": "dialAMDSilenceThreshold",
12864             "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
12865           },
12866           {
12867             "group": "Body",
12868             "type": "Integer",
12869             "optional": true,
12870             "field": "dialAMDMaximumWordLength",
12871             "description": "<p>#AMD Maximum Word Length</p>"
12872           },
12873           {
12874             "group": "Body",
12875             "type": "String",
12876             "allowedValues": [
12877               "\"DESC\"",
12878               "\"ASC\""
12879             ],
12880             "optional": true,
12881             "field": "dialOrderByScheduledAt",
12882             "description": ""
12883           },
12884           {
12885             "group": "Body",
12886             "type": "String",
12887             "optional": true,
12888             "field": "dialPrefix",
12889             "description": ""
12890           },
12891           {
12892             "group": "Body",
12893             "type": "Integer",
12894             "optional": true,
12895             "field": "dialRandomLastDigitCallerIdNumber",
12896             "description": "<p>Random Last Digit (min:1, max:15)</p>"
12897           },
12898           {
12899             "group": "Body",
12900             "type": "Integer",
12901             "optional": true,
12902             "field": "dialCutDigit",
12903             "description": "<p>Cut Digit (min:1, max:15)</p>"
12904           },
12905           {
12906             "group": "Body",
12907             "type": "Integer",
12908             "optional": true,
12909             "field": "dialNoSuchNumberMaxRetry",
12910             "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
12911           },
12912           {
12913             "group": "Body",
12914             "type": "Integer",
12915             "optional": true,
12916             "field": "dialNoSuchNumberRetryFrequency",
12917             "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
12918           },
12919           {
12920             "group": "Body",
12921             "type": "Integer",
12922             "optional": true,
12923             "field": "dialDropMaxRetry",
12924             "description": "<p>#Drop Retry (min:1, max:999)</p>"
12925           },
12926           {
12927             "group": "Body",
12928             "type": "Integer",
12929             "optional": true,
12930             "field": "dialDropRetryFrequency",
12931             "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
12932           },
12933           {
12934             "group": "Body",
12935             "type": "Integer",
12936             "optional": true,
12937             "field": "dialAbandonedMaxRetry",
12938             "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
12939           },
12940           {
12941             "group": "Body",
12942             "type": "Integer",
12943             "optional": true,
12944             "field": "dialAbandonedRetryFrequency",
12945             "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
12946           },
12947           {
12948             "group": "Body",
12949             "type": "Integer",
12950             "optional": true,
12951             "field": "dialMachineMaxRetry",
12952             "description": "<p>#Machine Retry (min:1, max:999)</p>"
12953           },
12954           {
12955             "group": "Body",
12956             "type": "Integer",
12957             "optional": true,
12958             "field": "dialMachineRetryFrequency",
12959             "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
12960           },
12961           {
12962             "group": "Body",
12963             "type": "Integer",
12964             "optional": true,
12965             "field": "dialAgentRejectMaxRetry",
12966             "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
12967           },
12968           {
12969             "group": "Body",
12970             "type": "Integer",
12971             "optional": true,
12972             "field": "dialAgentRejectRetryFrequency",
12973             "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
12974           }
12975         ]
12976       }
12977     },
12978     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12979     "version": "0.0.0",
12980     "filename": "server/api/campaign/index.js",
12981     "groupTitle": "IVR_Campaigns"
12982   },
12983   {
12984     "type": "delete",
12985     "url": "/api/campaigns/{id}",
12986     "title": "Deletes a IVR Campaign",
12987     "examples": [
12988       {
12989         "title": "Example usage:",
12990         "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password} -X DELETE",
12991         "type": "json"
12992       }
12993     ],
12994     "name": "DeleteIVR_Campaigns",
12995     "group": "IVR_Campaigns",
12996     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12997     "version": "0.0.0",
12998     "filename": "server/api/campaign/index.js",
12999     "groupTitle": "IVR_Campaigns"
13000   },
13001   {
13002     "type": "get",
13003     "url": "/api/campaigns/{id}/blacklists",
13004     "title": "Get IVR campaign blacklists",
13005     "examples": [
13006       {
13007         "title": "Example usage:",
13008         "content": "curl https://{domain}/api/campaigns/{id}/blacklists -v -u {name}:{password} -X GET",
13009         "type": "json"
13010       }
13011     ],
13012     "name": "GetBlackLists",
13013     "group": "IVR_Campaigns",
13014     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13015     "version": "0.0.0",
13016     "filename": "server/api/campaign/index.js",
13017     "groupTitle": "IVR_Campaigns"
13018   },
13019   {
13020     "type": "get",
13021     "url": "/api/campaigns/{id}/finals",
13022     "title": "Gets IVR campaign hopper finals",
13023     "examples": [
13024       {
13025         "title": "Example usage:",
13026         "content": "curl https://{domain}/api/campaigns/{id}/hopper_finals -v -u {name}:{password}  -X GET",
13027         "type": "json"
13028       }
13029     ],
13030     "name": "GetHopperFinals",
13031     "group": "IVR_Campaigns",
13032     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13033     "version": "0.0.0",
13034     "filename": "server/api/campaign/index.js",
13035     "groupTitle": "IVR_Campaigns"
13036   },
13037   {
13038     "type": "get",
13039     "url": "/api/campaigns/{id}/hopper_histories",
13040     "title": "Gets IVR campaign hopper histories",
13041     "examples": [
13042       {
13043         "title": "Example usage:",
13044         "content": "curl https://{domain}/api/campaigns/{id}/hopper_histories -v -u {name}:{password} -X GET",
13045         "type": "json"
13046       }
13047     ],
13048     "name": "GetHopperHistories",
13049     "group": "IVR_Campaigns",
13050     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13051     "version": "0.0.0",
13052     "filename": "server/api/campaign/index.js",
13053     "groupTitle": "IVR_Campaigns"
13054   },
13055   {
13056     "type": "get",
13057     "url": "/api/campaigns/{id}/hoppers",
13058     "title": "Gets IVR campaign hoppers",
13059     "examples": [
13060       {
13061         "title": "Example usage:",
13062         "content": "curl https://{domain}/api/campaigns/{id}/hoppers -v -u {name}:{password} -X GET",
13063         "type": "json"
13064       }
13065     ],
13066     "name": "GetHoppers",
13067     "group": "IVR_Campaigns",
13068     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13069     "version": "0.0.0",
13070     "filename": "server/api/campaign/index.js",
13071     "groupTitle": "IVR_Campaigns"
13072   },
13073   {
13074     "type": "get",
13075     "url": "/api/campaigns",
13076     "title": "Gets a list of IVR Campaigns",
13077     "examples": [
13078       {
13079         "title": "Example usage:",
13080         "content": "curl https://{domain}/api/campaigns -v -u {name}:{password}",
13081         "type": "json"
13082       }
13083     ],
13084     "name": "GetIVR_Campaigns",
13085     "group": "IVR_Campaigns",
13086     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13087     "version": "0.0.0",
13088     "filename": "server/api/campaign/index.js",
13089     "groupTitle": "IVR_Campaigns"
13090   },
13091   {
13092     "type": "get",
13093     "url": "/api/campaigns/{id}/lists",
13094     "title": "Get IVR campaign lists",
13095     "examples": [
13096       {
13097         "title": "Example usage:",
13098         "content": "curl https://{domain}/api/campaigns/{id}/lists -v -u {name}:{password} -X GET",
13099         "type": "json"
13100       }
13101     ],
13102     "name": "GetLists",
13103     "group": "IVR_Campaigns",
13104     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13105     "version": "0.0.0",
13106     "filename": "server/api/campaign/index.js",
13107     "groupTitle": "IVR_Campaigns"
13108   },
13109   {
13110     "type": "delete",
13111     "url": "/api/campaigns/{id}/blacklists",
13112     "title": "Remove blacklists from an IVR Campaign",
13113     "examples": [
13114       {
13115         "title": "Example usage:",
13116         "content": "curl https://{domain}/api/campaigns/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
13117         "type": "json"
13118       }
13119     ],
13120     "name": "RemoveBlackLists",
13121     "group": "IVR_Campaigns",
13122     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13123     "version": "0.0.0",
13124     "filename": "server/api/campaign/index.js",
13125     "groupTitle": "IVR_Campaigns"
13126   },
13127   {
13128     "type": "delete",
13129     "url": "/api/campaigns/{id}/lists",
13130     "title": "Remove lists from an IVR Campaign",
13131     "examples": [
13132       {
13133         "title": "Example usage:",
13134         "content": "curl https://{domain}/api/campaigns/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
13135         "type": "json"
13136       }
13137     ],
13138     "name": "RemoveLists",
13139     "group": "IVR_Campaigns",
13140     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13141     "version": "0.0.0",
13142     "filename": "server/api/campaign/index.js",
13143     "groupTitle": "IVR_Campaigns"
13144   },
13145   {
13146     "type": "get",
13147     "url": "/api/campaigns/{id}",
13148     "title": "Gets a single IVR Campaign",
13149     "examples": [
13150       {
13151         "title": "Example usage:",
13152         "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password}",
13153         "type": "json"
13154       }
13155     ],
13156     "name": "ShowIVR_Campaigns",
13157     "group": "IVR_Campaigns",
13158     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13159     "version": "0.0.0",
13160     "filename": "server/api/campaign/index.js",
13161     "groupTitle": "IVR_Campaigns"
13162   },
13163   {
13164     "type": "get",
13165     "url": "/api/campaigns/{id}/blacks",
13166     "title": "Gets IVR campaign hopper blacks",
13167     "examples": [
13168       {
13169         "title": "Example usage:",
13170         "content": "curl https://{domain}/api/campaigns/{id}/hopper_black -v -u {name}:{password}  -X GET",
13171         "type": "json"
13172       }
13173     ],
13174     "name": "getHopperBlacks",
13175     "group": "IVR_Campaigns",
13176     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13177     "version": "0.0.0",
13178     "filename": "server/api/campaign/index.js",
13179     "groupTitle": "IVR_Campaigns"
13180   },
13181   {
13182     "type": "put",
13183     "url": "/api/campaigns/{id}",
13184     "title": "Update an existing IVR Campaign",
13185     "examples": [
13186       {
13187         "title": "Example usage:",
13188         "content": "curl https://{domain}/api/campaigns/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
13189         "type": "json"
13190       }
13191     ],
13192     "name": "updateIVR_Campaigns",
13193     "group": "IVR_Campaigns",
13194     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13195     "version": "0.0.0",
13196     "filename": "server/api/campaign/index.js",
13197     "groupTitle": "IVR_Campaigns"
13198   },
13199   {
13200     "type": "post",
13201     "url": "/api/integrations/reports",
13202     "title": "Creates a new Integration Report",
13203     "examples": [
13204       {
13205         "title": "Example usage:",
13206         "content": "curl https://{domain}/api/integrations/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13207         "type": "json"
13208       }
13209     ],
13210     "name": "CreateIntegration_Reports",
13211     "group": "Integration_Reports",
13212     "parameter": {
13213       "fields": {
13214         "Body": [
13215           {
13216             "group": "Body",
13217             "type": "String",
13218             "optional": true,
13219             "field": "integration",
13220             "description": ""
13221           },
13222           {
13223             "group": "Body",
13224             "type": "String",
13225             "optional": true,
13226             "field": "eventChannel",
13227             "description": ""
13228           },
13229           {
13230             "group": "Body",
13231             "type": "String",
13232             "optional": true,
13233             "field": "exitStatus",
13234             "description": ""
13235           },
13236           {
13237             "group": "Body",
13238             "type": "String",
13239             "optional": true,
13240             "field": "ticketId",
13241             "description": ""
13242           },
13243           {
13244             "group": "Body",
13245             "type": "Integer",
13246             "optional": true,
13247             "field": "integrationId",
13248             "description": ""
13249           },
13250           {
13251             "group": "Body",
13252             "type": "String",
13253             "optional": true,
13254             "field": "contacts",
13255             "description": ""
13256           },
13257           {
13258             "group": "Body",
13259             "type": "String",
13260             "optional": true,
13261             "field": "uniqueid",
13262             "description": ""
13263           },
13264           {
13265             "group": "Body",
13266             "type": "String",
13267             "optional": true,
13268             "field": "calleridnum",
13269             "description": ""
13270           },
13271           {
13272             "group": "Body",
13273             "type": "String",
13274             "optional": true,
13275             "field": "calleridname",
13276             "description": ""
13277           },
13278           {
13279             "group": "Body",
13280             "type": "String",
13281             "optional": true,
13282             "field": "queue",
13283             "description": ""
13284           },
13285           {
13286             "group": "Body",
13287             "type": "String",
13288             "optional": true,
13289             "field": "interface",
13290             "description": ""
13291           },
13292           {
13293             "group": "Body",
13294             "type": "String",
13295             "optional": true,
13296             "field": "membername",
13297             "description": ""
13298           },
13299           {
13300             "group": "Body",
13301             "type": "String",
13302             "optional": true,
13303             "field": "agentcalledAt",
13304             "description": ""
13305           },
13306           {
13307             "group": "Body",
13308             "type": "String",
13309             "optional": true,
13310             "field": "agentconnectAt",
13311             "description": ""
13312           },
13313           {
13314             "group": "Body",
13315             "type": "Integer",
13316             "optional": true,
13317             "field": "holdtime",
13318             "description": ""
13319           },
13320           {
13321             "group": "Body",
13322             "type": "Boolean",
13323             "optional": true,
13324             "field": "agentcomplete",
13325             "description": ""
13326           },
13327           {
13328             "group": "Body",
13329             "type": "String",
13330             "optional": true,
13331             "field": "agentcompleteAt",
13332             "description": ""
13333           },
13334           {
13335             "group": "Body",
13336             "type": "Integer",
13337             "optional": true,
13338             "field": "talktime",
13339             "description": ""
13340           },
13341           {
13342             "group": "Body",
13343             "type": "Boolean",
13344             "optional": true,
13345             "field": "agentacw",
13346             "description": ""
13347           },
13348           {
13349             "group": "Body",
13350             "type": "Integer",
13351             "optional": true,
13352             "field": "acwtime",
13353             "description": ""
13354           },
13355           {
13356             "group": "Body",
13357             "type": "String",
13358             "optional": true,
13359             "field": "reason",
13360             "description": ""
13361           },
13362           {
13363             "group": "Body",
13364             "type": "Boolean",
13365             "optional": true,
13366             "field": "agentringnoanswer",
13367             "description": ""
13368           },
13369           {
13370             "group": "Body",
13371             "type": "String",
13372             "optional": true,
13373             "field": "agentringnoanswerAt",
13374             "description": ""
13375           },
13376           {
13377             "group": "Body",
13378             "type": "Boolean",
13379             "optional": true,
13380             "field": "agentdump",
13381             "description": ""
13382           },
13383           {
13384             "group": "Body",
13385             "type": "String",
13386             "optional": true,
13387             "field": "agentdumpAt",
13388             "description": ""
13389           },
13390           {
13391             "group": "Body",
13392             "type": "String",
13393             "optional": true,
13394             "field": "lastevent",
13395             "description": ""
13396           },
13397           {
13398             "group": "Body",
13399             "type": "String",
13400             "optional": true,
13401             "field": "channel",
13402             "description": ""
13403           },
13404           {
13405             "group": "Body",
13406             "type": "Integer",
13407             "optional": true,
13408             "field": "channelstate",
13409             "description": ""
13410           },
13411           {
13412             "group": "Body",
13413             "type": "String",
13414             "optional": true,
13415             "field": "channelstatedesc",
13416             "description": ""
13417           },
13418           {
13419             "group": "Body",
13420             "type": "String",
13421             "optional": true,
13422             "field": "connectedlinenum",
13423             "description": ""
13424           },
13425           {
13426             "group": "Body",
13427             "type": "String",
13428             "optional": true,
13429             "field": "connectedlinename",
13430             "description": ""
13431           },
13432           {
13433             "group": "Body",
13434             "type": "String",
13435             "optional": true,
13436             "field": "language",
13437             "description": ""
13438           },
13439           {
13440             "group": "Body",
13441             "type": "String",
13442             "optional": true,
13443             "field": "accountcode",
13444             "description": ""
13445           },
13446           {
13447             "group": "Body",
13448             "type": "String",
13449             "optional": true,
13450             "field": "context",
13451             "description": ""
13452           },
13453           {
13454             "group": "Body",
13455             "type": "String",
13456             "optional": true,
13457             "field": "exten",
13458             "description": ""
13459           },
13460           {
13461             "group": "Body",
13462             "type": "String",
13463             "optional": true,
13464             "field": "priority",
13465             "description": ""
13466           },
13467           {
13468             "group": "Body",
13469             "type": "String",
13470             "optional": true,
13471             "field": "destchannel",
13472             "description": ""
13473           },
13474           {
13475             "group": "Body",
13476             "type": "Integer",
13477             "optional": true,
13478             "field": "destchannelstate",
13479             "description": ""
13480           },
13481           {
13482             "group": "Body",
13483             "type": "String",
13484             "optional": true,
13485             "field": "destchannelstatedesc",
13486             "description": ""
13487           },
13488           {
13489             "group": "Body",
13490             "type": "String",
13491             "optional": true,
13492             "field": "destcalleridnum",
13493             "description": ""
13494           },
13495           {
13496             "group": "Body",
13497             "type": "String",
13498             "optional": true,
13499             "field": "destcalleridname",
13500             "description": ""
13501           },
13502           {
13503             "group": "Body",
13504             "type": "String",
13505             "optional": true,
13506             "field": "destconnectedlinenum",
13507             "description": ""
13508           },
13509           {
13510             "group": "Body",
13511             "type": "String",
13512             "optional": true,
13513             "field": "destconnectedlinename",
13514             "description": ""
13515           },
13516           {
13517             "group": "Body",
13518             "type": "String",
13519             "optional": true,
13520             "field": "destlanguage",
13521             "description": ""
13522           },
13523           {
13524             "group": "Body",
13525             "type": "String",
13526             "optional": true,
13527             "field": "destaccountcode",
13528             "description": ""
13529           },
13530           {
13531             "group": "Body",
13532             "type": "String",
13533             "optional": true,
13534             "field": "destcontext",
13535             "description": ""
13536           },
13537           {
13538             "group": "Body",
13539             "type": "String",
13540             "optional": true,
13541             "field": "destexten",
13542             "description": ""
13543           },
13544           {
13545             "group": "Body",
13546             "type": "String",
13547             "optional": true,
13548             "field": "destpriority",
13549             "description": ""
13550           },
13551           {
13552             "group": "Body",
13553             "type": "String",
13554             "optional": true,
13555             "field": "destuniqueid",
13556             "description": ""
13557           },
13558           {
13559             "group": "Body",
13560             "type": "String",
13561             "optional": true,
13562             "field": "messageId",
13563             "description": ""
13564           },
13565           {
13566             "group": "Body",
13567             "type": "String",
13568             "optional": true,
13569             "field": "inReplyTo",
13570             "description": ""
13571           },
13572           {
13573             "group": "Body",
13574             "type": "String",
13575             "optional": true,
13576             "field": "subject",
13577             "description": ""
13578           },
13579           {
13580             "group": "Body",
13581             "type": "String",
13582             "optional": true,
13583             "field": "from",
13584             "description": ""
13585           },
13586           {
13587             "group": "Body",
13588             "type": "String",
13589             "optional": true,
13590             "field": "to",
13591             "description": ""
13592           },
13593           {
13594             "group": "Body",
13595             "type": "String",
13596             "optional": true,
13597             "field": "cc",
13598             "description": ""
13599           },
13600           {
13601             "group": "Body",
13602             "type": "Text",
13603             "optional": true,
13604             "field": "attachment",
13605             "description": ""
13606           },
13607           {
13608             "group": "Body",
13609             "type": "Text",
13610             "optional": true,
13611             "field": "html",
13612             "description": ""
13613           },
13614           {
13615             "group": "Body",
13616             "type": "Text",
13617             "optional": true,
13618             "field": "text",
13619             "description": ""
13620           },
13621           {
13622             "group": "Body",
13623             "type": "String",
13624             "allowedValues": [
13625               "\"SENT\"",
13626               "\"SENDING\"",
13627               "\"RECEIVED\"",
13628               "\"FAILED\""
13629             ],
13630             "optional": true,
13631             "field": "status",
13632             "description": ""
13633           },
13634           {
13635             "group": "Body",
13636             "type": "String",
13637             "optional": true,
13638             "field": "url",
13639             "description": ""
13640           },
13641           {
13642             "group": "Body",
13643             "type": "String",
13644             "optional": true,
13645             "field": "app",
13646             "description": ""
13647           },
13648           {
13649             "group": "Body",
13650             "type": "String",
13651             "optional": true,
13652             "field": "appdata",
13653             "description": ""
13654           },
13655           {
13656             "group": "Body",
13657             "type": "Integer",
13658             "optional": true,
13659             "field": "projectId",
13660             "description": ""
13661           }
13662         ]
13663       }
13664     },
13665     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13666     "version": "0.0.0",
13667     "filename": "server/api/integrationReport/index.js",
13668     "groupTitle": "Integration_Reports"
13669   },
13670   {
13671     "type": "delete",
13672     "url": "/api/integrations/reports/{id}",
13673     "title": "Deletes a Integration Report",
13674     "examples": [
13675       {
13676         "title": "Example usage:",
13677         "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password} -X DELETE",
13678         "type": "json"
13679       }
13680     ],
13681     "name": "DeleteIntegration_Reports",
13682     "group": "Integration_Reports",
13683     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13684     "version": "0.0.0",
13685     "filename": "server/api/integrationReport/index.js",
13686     "groupTitle": "Integration_Reports"
13687   },
13688   {
13689     "type": "get",
13690     "url": "/api/integrations/reports/describe",
13691     "title": "Gets table info about Integration Reports",
13692     "examples": [
13693       {
13694         "title": "Example usage:",
13695         "content": "curl https://{domain}/api/integrations/reports/describe -v -u {name}:{password}",
13696         "type": "json"
13697       }
13698     ],
13699     "name": "DescribeIntegration_Reports",
13700     "group": "Integration_Reports",
13701     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13702     "version": "0.0.0",
13703     "filename": "server/api/integrationReport/index.js",
13704     "groupTitle": "Integration_Reports"
13705   },
13706   {
13707     "type": "get",
13708     "url": "/api/integrations/reports",
13709     "title": "Gets a list of Integration Reports",
13710     "examples": [
13711       {
13712         "title": "Example usage:",
13713         "content": "curl https://{domain}/api/integrations/reports -v -u {name}:{password}",
13714         "type": "json"
13715       }
13716     ],
13717     "name": "GetIntegration_Reports",
13718     "group": "Integration_Reports",
13719     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13720     "version": "0.0.0",
13721     "filename": "server/api/integrationReport/index.js",
13722     "groupTitle": "Integration_Reports"
13723   },
13724   {
13725     "type": "get",
13726     "url": "/api/integrations/reports/{id}",
13727     "title": "Gets a single Integration Report",
13728     "examples": [
13729       {
13730         "title": "Example usage:",
13731         "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password}",
13732         "type": "json"
13733       }
13734     ],
13735     "name": "ShowIntegration_Reports",
13736     "group": "Integration_Reports",
13737     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13738     "version": "0.0.0",
13739     "filename": "server/api/integrationReport/index.js",
13740     "groupTitle": "Integration_Reports"
13741   },
13742   {
13743     "type": "put",
13744     "url": "/api/integrations/reports/{id}",
13745     "title": "Update an existing Integration Report",
13746     "examples": [
13747       {
13748         "title": "Example usage:",
13749         "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",
13750         "type": "json"
13751       }
13752     ],
13753     "name": "updateIntegration_Reports",
13754     "group": "Integration_Reports",
13755     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13756     "version": "0.0.0",
13757     "filename": "server/api/integrationReport/index.js",
13758     "groupTitle": "Integration_Reports"
13759   },
13760   {
13761     "type": "post",
13762     "url": "/api/intervals",
13763     "title": "Creates a new Interval",
13764     "examples": [
13765       {
13766         "title": "Example usage:",
13767         "content": "curl https://{domain}/api/intervals -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13768         "type": "json"
13769       }
13770     ],
13771     "name": "CreateIntervals",
13772     "group": "Intervals",
13773     "parameter": {
13774       "fields": {
13775         "Body": [
13776           {
13777             "group": "Body",
13778             "type": "String",
13779             "optional": true,
13780             "field": "name",
13781             "description": ""
13782           },
13783           {
13784             "group": "Body",
13785             "type": "String",
13786             "optional": true,
13787             "field": "description",
13788             "description": ""
13789           },
13790           {
13791             "group": "Body",
13792             "type": "String",
13793             "optional": true,
13794             "field": "interval",
13795             "description": ""
13796           }
13797         ]
13798       }
13799     },
13800     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13801     "version": "0.0.0",
13802     "filename": "server/api/interval/index.js",
13803     "groupTitle": "Intervals"
13804   },
13805   {
13806     "type": "delete",
13807     "url": "/api/intervals/{id}",
13808     "title": "Deletes a Interval",
13809     "examples": [
13810       {
13811         "title": "Example usage:",
13812         "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password} -X DELETE",
13813         "type": "json"
13814       }
13815     ],
13816     "name": "DeleteIntervals",
13817     "group": "Intervals",
13818     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13819     "version": "0.0.0",
13820     "filename": "server/api/interval/index.js",
13821     "groupTitle": "Intervals"
13822   },
13823   {
13824     "type": "get",
13825     "url": "/api/intervals",
13826     "title": "Gets a list of Intervals",
13827     "examples": [
13828       {
13829         "title": "Example usage:",
13830         "content": "curl https://{domain}/api/intervals -v -u {name}:{password}",
13831         "type": "json"
13832       }
13833     ],
13834     "name": "GetIntervals",
13835     "group": "Intervals",
13836     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13837     "version": "0.0.0",
13838     "filename": "server/api/interval/index.js",
13839     "groupTitle": "Intervals"
13840   },
13841   {
13842     "type": "get",
13843     "url": "/api/intervals/{id}",
13844     "title": "Gets a single Interval",
13845     "examples": [
13846       {
13847         "title": "Example usage:",
13848         "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password}",
13849         "type": "json"
13850       }
13851     ],
13852     "name": "ShowIntervals",
13853     "group": "Intervals",
13854     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13855     "version": "0.0.0",
13856     "filename": "server/api/interval/index.js",
13857     "groupTitle": "Intervals"
13858   },
13859   {
13860     "type": "post",
13861     "url": "/api/intervals/{id}/sub_intervals",
13862     "title": "Creates a new sub interval",
13863     "examples": [
13864       {
13865         "title": "Example usage:",
13866         "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",
13867         "type": "json"
13868       }
13869     ],
13870     "name": "addInterval",
13871     "group": "Intervals",
13872     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13873     "version": "0.0.0",
13874     "filename": "server/api/interval/index.js",
13875     "groupTitle": "Intervals"
13876   },
13877   {
13878     "type": "post",
13879     "url": "/api/intervals/{id}/sub_intervals/create_many",
13880     "title": "Create new sub intervals set",
13881     "examples": [
13882       {
13883         "title": "Example usage:",
13884         "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
13885         "type": "json"
13886       }
13887     ],
13888     "name": "addIntervals",
13889     "group": "Intervals",
13890     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13891     "version": "0.0.0",
13892     "filename": "server/api/interval/index.js",
13893     "groupTitle": "Intervals"
13894   },
13895   {
13896     "type": "get",
13897     "url": "/api/intervals/{id}/sub_intervals",
13898     "title": "Get sub intervals set",
13899     "examples": [
13900       {
13901         "title": "Example usage:",
13902         "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -v -u {name}:{password} -X GET",
13903         "type": "json"
13904       }
13905     ],
13906     "name": "getIntervals",
13907     "group": "Intervals",
13908     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13909     "version": "0.0.0",
13910     "filename": "server/api/interval/index.js",
13911     "groupTitle": "Intervals"
13912   },
13913   {
13914     "type": "put",
13915     "url": "/api/intervals/{id}",
13916     "title": "Update an existing Interval",
13917     "examples": [
13918       {
13919         "title": "Example usage:",
13920         "content": "curl https://{domain}/api/intervals/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
13921         "type": "json"
13922       }
13923     ],
13924     "name": "updateIntervals",
13925     "group": "Intervals",
13926     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13927     "version": "0.0.0",
13928     "filename": "server/api/interval/index.js",
13929     "groupTitle": "Intervals"
13930   },
13931   {
13932     "type": "post",
13933     "url": "/api/jira",
13934     "title": "Creates a new issue",
13935     "examples": [
13936       {
13937         "title": "Example usage:",
13938         "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}",
13939         "type": "json"
13940       }
13941     ],
13942     "name": "Creates_Issue",
13943     "group": "Issue",
13944     "parameter": {
13945       "fields": {
13946         "Body": [
13947           {
13948             "group": "Body",
13949             "type": "String",
13950             "allowedValues": [
13951               "\"Bug\""
13952             ],
13953             "optional": true,
13954             "field": "issuetype",
13955             "description": ""
13956           },
13957           {
13958             "group": "Body",
13959             "type": "String",
13960             "optional": false,
13961             "field": "summary",
13962             "description": ""
13963           },
13964           {
13965             "group": "Body",
13966             "type": "String",
13967             "optional": false,
13968             "field": "description",
13969             "description": ""
13970           }
13971         ]
13972       }
13973     },
13974     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13975     "version": "0.0.0",
13976     "filename": "server/api/jira/index.js",
13977     "groupTitle": "Issue"
13978   },
13979   {
13980     "type": "post",
13981     "url": "/api/jscripty/answers/reports",
13982     "title": "Creates a new Report",
13983     "examples": [
13984       {
13985         "title": "Example usage:",
13986         "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",
13987         "type": "json"
13988       }
13989     ],
13990     "name": "CreateReports",
13991     "group": "JscriptyAnswerReport",
13992     "parameter": {
13993       "fields": {
13994         "Body": [
13995           {
13996             "group": "Body",
13997             "type": "Text",
13998             "optional": true,
13999             "field": "question",
14000             "description": ""
14001           },
14002           {
14003             "group": "Body",
14004             "type": "Text",
14005             "optional": true,
14006             "field": "answer",
14007             "description": ""
14008           },
14009           {
14010             "group": "Body",
14011             "type": "String",
14012             "optional": true,
14013             "field": "membername",
14014             "description": ""
14015           },
14016           {
14017             "group": "Body",
14018             "type": "String",
14019             "optional": true,
14020             "field": "projectname",
14021             "description": ""
14022           },
14023           {
14024             "group": "Body",
14025             "type": "String",
14026             "optional": true,
14027             "field": "queue",
14028             "description": ""
14029           },
14030           {
14031             "group": "Body",
14032             "type": "String",
14033             "optional": true,
14034             "field": "uniqueid",
14035             "description": ""
14036           },
14037           {
14038             "group": "Body",
14039             "type": "String",
14040             "optional": true,
14041             "field": "calleridname",
14042             "description": ""
14043           },
14044           {
14045             "group": "Body",
14046             "type": "String",
14047             "optional": true,
14048             "field": "calleridnum",
14049             "description": ""
14050           },
14051           {
14052             "group": "Body",
14053             "type": "String",
14054             "optional": true,
14055             "field": "questionId",
14056             "description": ""
14057           }
14058         ]
14059       }
14060     },
14061     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14062     "version": "0.0.0",
14063     "filename": "server/api/jscriptyAnswerReport/index.js",
14064     "groupTitle": "JscriptyAnswerReport"
14065   },
14066   {
14067     "type": "delete",
14068     "url": "/api/jscripty/answers/reports/{id}",
14069     "title": "Deletes a Report",
14070     "examples": [
14071       {
14072         "title": "Example usage:",
14073         "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password} -X DELETE",
14074         "type": "json"
14075       }
14076     ],
14077     "name": "DeleteReports",
14078     "group": "JscriptyAnswerReport",
14079     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14080     "version": "0.0.0",
14081     "filename": "server/api/jscriptyAnswerReport/index.js",
14082     "groupTitle": "JscriptyAnswerReport"
14083   },
14084   {
14085     "type": "get",
14086     "url": "/api/jscripty/answers/reports/describe",
14087     "title": "Gets table info about Reports",
14088     "examples": [
14089       {
14090         "title": "Example usage:",
14091         "content": "curl https://{domain}/api/jscripty/answers/reports/describe -v -u {name}:{password}",
14092         "type": "json"
14093       }
14094     ],
14095     "name": "DescribeReports",
14096     "group": "JscriptyAnswerReport",
14097     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14098     "version": "0.0.0",
14099     "filename": "server/api/jscriptyAnswerReport/index.js",
14100     "groupTitle": "JscriptyAnswerReport"
14101   },
14102   {
14103     "type": "get",
14104     "url": "/api/jscripty/answers/reports",
14105     "title": "Gets a list of Reports",
14106     "examples": [
14107       {
14108         "title": "Example usage:",
14109         "content": "curl https://{domain}/api/jscripty/answers/reports -v -u {name}:{password}",
14110         "type": "json"
14111       }
14112     ],
14113     "name": "GetReports",
14114     "group": "JscriptyAnswerReport",
14115     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14116     "version": "0.0.0",
14117     "filename": "server/api/jscriptyAnswerReport/index.js",
14118     "groupTitle": "JscriptyAnswerReport"
14119   },
14120   {
14121     "type": "get",
14122     "url": "/api/jscripty/answers/reports/{id}",
14123     "title": "Gets a single Report",
14124     "examples": [
14125       {
14126         "title": "Example usage:",
14127         "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password}",
14128         "type": "json"
14129       }
14130     ],
14131     "name": "ShowReports",
14132     "group": "JscriptyAnswerReport",
14133     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14134     "version": "0.0.0",
14135     "filename": "server/api/jscriptyAnswerReport/index.js",
14136     "groupTitle": "JscriptyAnswerReport"
14137   },
14138   {
14139     "type": "put",
14140     "url": "/api/jscripty/answers/reports/{id}",
14141     "title": "Update an existing Report",
14142     "examples": [
14143       {
14144         "title": "Example usage:",
14145         "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",
14146         "type": "json"
14147       }
14148     ],
14149     "name": "updateReports",
14150     "group": "JscriptyAnswerReport",
14151     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14152     "version": "0.0.0",
14153     "filename": "server/api/jscriptyAnswerReport/index.js",
14154     "groupTitle": "JscriptyAnswerReport"
14155   },
14156   {
14157     "type": "post",
14158     "url": "/api/jscripty/questions/reports",
14159     "title": "Creates a new Report",
14160     "examples": [
14161       {
14162         "title": "Example usage:",
14163         "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",
14164         "type": "json"
14165       }
14166     ],
14167     "name": "CreateReports",
14168     "group": "JscriptyQuestionReport",
14169     "parameter": {
14170       "fields": {
14171         "Body": [
14172           {
14173             "group": "Body",
14174             "type": "Text",
14175             "optional": true,
14176             "field": "question",
14177             "description": ""
14178           },
14179           {
14180             "group": "Body",
14181             "type": "Text",
14182             "optional": true,
14183             "field": "answer",
14184             "description": ""
14185           },
14186           {
14187             "group": "Body",
14188             "type": "String",
14189             "optional": true,
14190             "field": "membername",
14191             "description": ""
14192           },
14193           {
14194             "group": "Body",
14195             "type": "String",
14196             "optional": true,
14197             "field": "projectname",
14198             "description": ""
14199           },
14200           {
14201             "group": "Body",
14202             "type": "String",
14203             "optional": true,
14204             "field": "queue",
14205             "description": ""
14206           },
14207           {
14208             "group": "Body",
14209             "type": "String",
14210             "optional": true,
14211             "field": "uniqueid",
14212             "description": ""
14213           },
14214           {
14215             "group": "Body",
14216             "type": "String",
14217             "optional": true,
14218             "field": "calleridname",
14219             "description": ""
14220           },
14221           {
14222             "group": "Body",
14223             "type": "String",
14224             "optional": true,
14225             "field": "calleridnum",
14226             "description": ""
14227           },
14228           {
14229             "group": "Body",
14230             "type": "String",
14231             "optional": true,
14232             "field": "questionId",
14233             "description": ""
14234           }
14235         ]
14236       }
14237     },
14238     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14239     "version": "0.0.0",
14240     "filename": "server/api/jscriptyQuestionReport/index.js",
14241     "groupTitle": "JscriptyQuestionReport"
14242   },
14243   {
14244     "type": "delete",
14245     "url": "/api/jscripty/questions/reports/{id}",
14246     "title": "Deletes a Report",
14247     "examples": [
14248       {
14249         "title": "Example usage:",
14250         "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password} -X DELETE",
14251         "type": "json"
14252       }
14253     ],
14254     "name": "DeleteReports",
14255     "group": "JscriptyQuestionReport",
14256     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14257     "version": "0.0.0",
14258     "filename": "server/api/jscriptyQuestionReport/index.js",
14259     "groupTitle": "JscriptyQuestionReport"
14260   },
14261   {
14262     "type": "get",
14263     "url": "/api/jscripty/questions/reports/describe",
14264     "title": "Gets table info about Reports",
14265     "examples": [
14266       {
14267         "title": "Example usage:",
14268         "content": "curl https://{domain}/api/jscripty/questions/reports/describe -v -u {name}:{password}",
14269         "type": "json"
14270       }
14271     ],
14272     "name": "DescribeReports",
14273     "group": "JscriptyQuestionReport",
14274     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14275     "version": "0.0.0",
14276     "filename": "server/api/jscriptyQuestionReport/index.js",
14277     "groupTitle": "JscriptyQuestionReport"
14278   },
14279   {
14280     "type": "get",
14281     "url": "/api/jscripty/questions/reports",
14282     "title": "Gets a list of Reports",
14283     "examples": [
14284       {
14285         "title": "Example usage:",
14286         "content": "curl https://{domain}/api/jscripty/questions/reports -v -u {name}:{password}",
14287         "type": "json"
14288       }
14289     ],
14290     "name": "GetReports",
14291     "group": "JscriptyQuestionReport",
14292     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14293     "version": "0.0.0",
14294     "filename": "server/api/jscriptyQuestionReport/index.js",
14295     "groupTitle": "JscriptyQuestionReport"
14296   },
14297   {
14298     "type": "get",
14299     "url": "/api/jscripty/questions/reports/{id}",
14300     "title": "Gets a single Report",
14301     "examples": [
14302       {
14303         "title": "Example usage:",
14304         "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password}",
14305         "type": "json"
14306       }
14307     ],
14308     "name": "ShowReports",
14309     "group": "JscriptyQuestionReport",
14310     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14311     "version": "0.0.0",
14312     "filename": "server/api/jscriptyQuestionReport/index.js",
14313     "groupTitle": "JscriptyQuestionReport"
14314   },
14315   {
14316     "type": "put",
14317     "url": "/api/jscripty/questions/reports/{id}",
14318     "title": "Update an existing Report",
14319     "examples": [
14320       {
14321         "title": "Example usage:",
14322         "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",
14323         "type": "json"
14324       }
14325     ],
14326     "name": "updateReports",
14327     "group": "JscriptyQuestionReport",
14328     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14329     "version": "0.0.0",
14330     "filename": "server/api/jscriptyQuestionReport/index.js",
14331     "groupTitle": "JscriptyQuestionReport"
14332   },
14333   {
14334     "type": "post",
14335     "url": "/api/jscripty/sessions/reports",
14336     "title": "Creates a new Report",
14337     "examples": [
14338       {
14339         "title": "Example usage:",
14340         "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",
14341         "type": "json"
14342       }
14343     ],
14344     "name": "CreateReports",
14345     "group": "JscriptySessionReport",
14346     "parameter": {
14347       "fields": {
14348         "Body": [
14349           {
14350             "group": "Body",
14351             "type": "String",
14352             "optional": true,
14353             "field": "starttime",
14354             "description": ""
14355           },
14356           {
14357             "group": "Body",
14358             "type": "String",
14359             "optional": true,
14360             "field": "endtime",
14361             "description": ""
14362           },
14363           {
14364             "group": "Body",
14365             "type": "String",
14366             "optional": true,
14367             "field": "membername",
14368             "description": ""
14369           },
14370           {
14371             "group": "Body",
14372             "type": "String",
14373             "optional": true,
14374             "field": "projectname",
14375             "description": ""
14376           },
14377           {
14378             "group": "Body",
14379             "type": "String",
14380             "optional": true,
14381             "field": "queue",
14382             "description": ""
14383           },
14384           {
14385             "group": "Body",
14386             "type": "String",
14387             "optional": true,
14388             "field": "uniqueid",
14389             "description": ""
14390           },
14391           {
14392             "group": "Body",
14393             "type": "String",
14394             "optional": true,
14395             "field": "calleridname",
14396             "description": ""
14397           },
14398           {
14399             "group": "Body",
14400             "type": "String",
14401             "optional": true,
14402             "field": "calleridnum",
14403             "description": ""
14404           },
14405           {
14406             "group": "Body",
14407             "type": "Boolean",
14408             "optional": true,
14409             "field": "completed",
14410             "description": ""
14411           }
14412         ]
14413       }
14414     },
14415     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14416     "version": "0.0.0",
14417     "filename": "server/api/jscriptySessionReport/index.js",
14418     "groupTitle": "JscriptySessionReport"
14419   },
14420   {
14421     "type": "delete",
14422     "url": "/api/jscripty/sessions/reports/{id}",
14423     "title": "Deletes a Report",
14424     "examples": [
14425       {
14426         "title": "Example usage:",
14427         "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password} -X DELETE",
14428         "type": "json"
14429       }
14430     ],
14431     "name": "DeleteReports",
14432     "group": "JscriptySessionReport",
14433     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14434     "version": "0.0.0",
14435     "filename": "server/api/jscriptySessionReport/index.js",
14436     "groupTitle": "JscriptySessionReport"
14437   },
14438   {
14439     "type": "get",
14440     "url": "/api/jscripty/sessions/reports/describe",
14441     "title": "Gets table info about Reports",
14442     "examples": [
14443       {
14444         "title": "Example usage:",
14445         "content": "curl https://{domain}/api/jscripty/sessions/reports/describe -v -u {name}:{password}",
14446         "type": "json"
14447       }
14448     ],
14449     "name": "DescribeReports",
14450     "group": "JscriptySessionReport",
14451     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14452     "version": "0.0.0",
14453     "filename": "server/api/jscriptySessionReport/index.js",
14454     "groupTitle": "JscriptySessionReport"
14455   },
14456   {
14457     "type": "get",
14458     "url": "/api/jscripty/sessions/reports",
14459     "title": "Gets a list of Reports",
14460     "examples": [
14461       {
14462         "title": "Example usage:",
14463         "content": "curl https://{domain}/api/jscripty/sessions/reports -v -u {name}:{password}",
14464         "type": "json"
14465       }
14466     ],
14467     "name": "GetReports",
14468     "group": "JscriptySessionReport",
14469     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14470     "version": "0.0.0",
14471     "filename": "server/api/jscriptySessionReport/index.js",
14472     "groupTitle": "JscriptySessionReport"
14473   },
14474   {
14475     "type": "get",
14476     "url": "/api/jscripty/sessions/reports/{id}",
14477     "title": "Gets a single Report",
14478     "examples": [
14479       {
14480         "title": "Example usage:",
14481         "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password}",
14482         "type": "json"
14483       }
14484     ],
14485     "name": "ShowReports",
14486     "group": "JscriptySessionReport",
14487     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14488     "version": "0.0.0",
14489     "filename": "server/api/jscriptySessionReport/index.js",
14490     "groupTitle": "JscriptySessionReport"
14491   },
14492   {
14493     "type": "get",
14494     "url": "/api/jscripty/sessions/reports/{id}/questions",
14495     "title": "Gets Jscripty Session questions",
14496     "examples": [
14497       {
14498         "title": "Example usage:",
14499         "content": "curl https://{domain}/api/jscripty/sessions/reports/{id}/questions -v -u {name}:{password}  -X GET",
14500         "type": "json"
14501       }
14502     ],
14503     "name": "getQuestions",
14504     "group": "JscriptySessionReport",
14505     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14506     "version": "0.0.0",
14507     "filename": "server/api/jscriptySessionReport/index.js",
14508     "groupTitle": "JscriptySessionReport"
14509   },
14510   {
14511     "type": "put",
14512     "url": "/api/jscripty/sessions/reports/{id}",
14513     "title": "Update an existing Report",
14514     "examples": [
14515       {
14516         "title": "Example usage:",
14517         "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",
14518         "type": "json"
14519       }
14520     ],
14521     "name": "updateReports",
14522     "group": "JscriptySessionReport",
14523     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14524     "version": "0.0.0",
14525     "filename": "server/api/jscriptySessionReport/index.js",
14526     "groupTitle": "JscriptySessionReport"
14527   },
14528   {
14529     "type": "post",
14530     "url": "/api/jscripty/projects/clone",
14531     "title": "Clone an existing Project",
14532     "examples": [
14533       {
14534         "title": "Example usage:",
14535         "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",
14536         "type": "json"
14537       }
14538     ],
14539     "name": "CloneProjects",
14540     "group": "Jscripty_Projects",
14541     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14542     "version": "0.0.0",
14543     "filename": "server/api/jscriptyProject/index.js",
14544     "groupTitle": "Jscripty_Projects"
14545   },
14546   {
14547     "type": "post",
14548     "url": "/api/jscripty/projects",
14549     "title": "Creates a new Project",
14550     "examples": [
14551       {
14552         "title": "Example usage:",
14553         "content": "curl https://{domain}/api/jscripty/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
14554         "type": "json"
14555       }
14556     ],
14557     "name": "CreateProjects",
14558     "group": "Jscripty_Projects",
14559     "parameter": {
14560       "fields": {
14561         "Body": [
14562           {
14563             "group": "Body",
14564             "type": "String",
14565             "optional": true,
14566             "field": "name",
14567             "description": ""
14568           },
14569           {
14570             "group": "Body",
14571             "type": "String",
14572             "optional": true,
14573             "field": "description",
14574             "description": ""
14575           },
14576           {
14577             "group": "Body",
14578             "type": "Text",
14579             "optional": true,
14580             "field": "formData",
14581             "description": ""
14582           },
14583           {
14584             "group": "Body",
14585             "type": "Boolean",
14586             "optional": true,
14587             "field": "enableUncompleteSave",
14588             "description": ""
14589           },
14590           {
14591             "group": "Body",
14592             "type": "Boolean",
14593             "optional": true,
14594             "field": "sendUnpauseOnSubmit",
14595             "description": ""
14596           }
14597         ]
14598       }
14599     },
14600     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14601     "version": "0.0.0",
14602     "filename": "server/api/jscriptyProject/index.js",
14603     "groupTitle": "Jscripty_Projects"
14604   },
14605   {
14606     "type": "delete",
14607     "url": "/api/jscripty/projects/{id}",
14608     "title": "Deletes a Project",
14609     "examples": [
14610       {
14611         "title": "Example usage:",
14612         "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password} -X DELETE",
14613         "type": "json"
14614       }
14615     ],
14616     "name": "DeleteProjects",
14617     "group": "Jscripty_Projects",
14618     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14619     "version": "0.0.0",
14620     "filename": "server/api/jscriptyProject/index.js",
14621     "groupTitle": "Jscripty_Projects"
14622   },
14623   {
14624     "type": "get",
14625     "url": "/api/jscripty/projects",
14626     "title": "Gets a list of Projects",
14627     "examples": [
14628       {
14629         "title": "Example usage:",
14630         "content": "curl https://{domain}/api/jscripty/projects -v -u {name}:{password}",
14631         "type": "json"
14632       }
14633     ],
14634     "name": "GetProjects",
14635     "group": "Jscripty_Projects",
14636     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14637     "version": "0.0.0",
14638     "filename": "server/api/jscriptyProject/index.js",
14639     "groupTitle": "Jscripty_Projects"
14640   },
14641   {
14642     "type": "get",
14643     "url": "/api/jscripty/projects/{id}",
14644     "title": "Gets a single Project",
14645     "examples": [
14646       {
14647         "title": "Example usage:",
14648         "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password}",
14649         "type": "json"
14650       }
14651     ],
14652     "name": "ShowProjects",
14653     "group": "Jscripty_Projects",
14654     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14655     "version": "0.0.0",
14656     "filename": "server/api/jscriptyProject/index.js",
14657     "groupTitle": "Jscripty_Projects"
14658   },
14659   {
14660     "type": "get",
14661     "url": "/api/jscripty/projects/{id}/answers",
14662     "title": "Gets jscripty project answers",
14663     "examples": [
14664       {
14665         "title": "Example usage:",
14666         "content": "curl https://{domain}/api/jscripty/projects/{id}/answers -v -u {name}:{password}  -X GET",
14667         "type": "json"
14668       }
14669     ],
14670     "name": "getAnswers",
14671     "group": "Jscripty_Projects",
14672     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14673     "version": "0.0.0",
14674     "filename": "server/api/jscriptyProject/index.js",
14675     "groupTitle": "Jscripty_Projects"
14676   },
14677   {
14678     "type": "get",
14679     "url": "/api/jscripty/projects/{id}/sessions",
14680     "title": "Gets jscripty project sessions",
14681     "examples": [
14682       {
14683         "title": "Example usage:",
14684         "content": "curl https://{domain}/api/jscripty/projects/{id}/sessions -v -u {name}:{password}  -X GET",
14685         "type": "json"
14686       }
14687     ],
14688     "name": "getSessions",
14689     "group": "Jscripty_Projects",
14690     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14691     "version": "0.0.0",
14692     "filename": "server/api/jscriptyProject/index.js",
14693     "groupTitle": "Jscripty_Projects"
14694   },
14695   {
14696     "type": "get",
14697     "url": "/api/jscripty/projects/{id}/summary",
14698     "title": "Gets jscripty project summary",
14699     "examples": [
14700       {
14701         "title": "Example usage:",
14702         "content": "curl https://{domain}/api/jscripty/projects/{id}/summary -v -u {name}:{password}  -X GET",
14703         "type": "json"
14704       }
14705     ],
14706     "name": "getSummary",
14707     "group": "Jscripty_Projects",
14708     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14709     "version": "0.0.0",
14710     "filename": "server/api/jscriptyProject/index.js",
14711     "groupTitle": "Jscripty_Projects"
14712   },
14713   {
14714     "type": "put",
14715     "url": "/api/jscripty/projects/{id}",
14716     "title": "Update an existing Project",
14717     "examples": [
14718       {
14719         "title": "Example usage:",
14720         "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",
14721         "type": "json"
14722       }
14723     ],
14724     "name": "updateProjects",
14725     "group": "Jscripty_Projects",
14726     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14727     "version": "0.0.0",
14728     "filename": "server/api/jscriptyProject/index.js",
14729     "groupTitle": "Jscripty_Projects"
14730   },
14731   {
14732     "type": "get",
14733     "url": "/api/license",
14734     "title": "Gets License Info",
14735     "examples": [
14736       {
14737         "title": "Example usage:",
14738         "content": "curl https://{domain}/api/license -v -u {name}:{password} -X GET",
14739         "type": "json"
14740       }
14741     ],
14742     "name": "index",
14743     "group": "License",
14744     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14745     "version": "0.0.0",
14746     "filename": "server/api/license/index.js",
14747     "groupTitle": "License"
14748   },
14749   {
14750     "type": "put",
14751     "url": "/api/license/{id}",
14752     "title": "Update License Info",
14753     "examples": [
14754       {
14755         "title": "Example usage:",
14756         "content": "curl https://{domain}/api/license/{id} -v -u {name}:{password} -X PUT",
14757         "type": "json"
14758       }
14759     ],
14760     "name": "update",
14761     "group": "License",
14762     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14763     "version": "0.0.0",
14764     "filename": "server/api/license/index.js",
14765     "groupTitle": "License"
14766   },
14767   {
14768     "type": "post",
14769     "url": "/api/mail/accounts/{id}/users",
14770     "title": "Add agents to a mail account",
14771     "examples": [
14772       {
14773         "title": "Example usage:",
14774         "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",
14775         "type": "json"
14776       }
14777     ],
14778     "name": "AddAgents",
14779     "group": "Mail_Accounts",
14780     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14781     "version": "0.0.0",
14782     "filename": "server/api/mailAccount/index.js",
14783     "groupTitle": "Mail_Accounts"
14784   },
14785   {
14786     "type": "post",
14787     "url": "/api/mail/accounts/{id}/in_servers",
14788     "title": "Creates a new IMAP server",
14789     "examples": [
14790       {
14791         "title": "Example usage:",
14792         "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",
14793         "type": "json"
14794       }
14795     ],
14796     "name": "AddImap",
14797     "group": "Mail_Accounts",
14798     "parameter": {
14799       "fields": {
14800         "Body": [
14801           {
14802             "group": "Body",
14803             "type": "String",
14804             "optional": true,
14805             "field": "description",
14806             "description": ""
14807           },
14808           {
14809             "group": "Body",
14810             "type": "String",
14811             "optional": true,
14812             "field": "host",
14813             "description": ""
14814           },
14815           {
14816             "group": "Body",
14817             "type": "Boolean",
14818             "optional": true,
14819             "field": "authentication",
14820             "description": ""
14821           },
14822           {
14823             "group": "Body",
14824             "type": "String",
14825             "optional": true,
14826             "field": "user",
14827             "description": ""
14828           },
14829           {
14830             "group": "Body",
14831             "type": "String",
14832             "optional": true,
14833             "field": "password",
14834             "description": ""
14835           },
14836           {
14837             "group": "Body",
14838             "type": "Integer",
14839             "optional": true,
14840             "field": "port",
14841             "description": ""
14842           },
14843           {
14844             "group": "Body",
14845             "type": "Boolean",
14846             "optional": true,
14847             "field": "tls",
14848             "description": ""
14849           },
14850           {
14851             "group": "Body",
14852             "type": "String",
14853             "optional": true,
14854             "field": "mailbox",
14855             "description": ""
14856           },
14857           {
14858             "group": "Body",
14859             "type": "Integer",
14860             "optional": true,
14861             "field": "connTimeout",
14862             "description": ""
14863           },
14864           {
14865             "group": "Body",
14866             "type": "Integer",
14867             "optional": true,
14868             "field": "authTimeout",
14869             "description": ""
14870           },
14871           {
14872             "group": "Body",
14873             "type": "String",
14874             "optional": true,
14875             "field": "service",
14876             "description": ""
14877           }
14878         ]
14879       }
14880     },
14881     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14882     "version": "0.0.0",
14883     "filename": "server/api/mailAccount/index.js",
14884     "groupTitle": "Mail_Accounts"
14885   },
14886   {
14887     "type": "post",
14888     "url": "/api/mail/accounts/{id}/out_servers",
14889     "title": "Creates a new SMTP server",
14890     "examples": [
14891       {
14892         "title": "Example usage:",
14893         "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",
14894         "type": "json"
14895       }
14896     ],
14897     "name": "AddSmtp",
14898     "group": "Mail_Accounts",
14899     "parameter": {
14900       "fields": {
14901         "Body": [
14902           {
14903             "group": "Body",
14904             "type": "String",
14905             "optional": true,
14906             "field": "description",
14907             "description": ""
14908           },
14909           {
14910             "group": "Body",
14911             "type": "String",
14912             "optional": true,
14913             "field": "host",
14914             "description": ""
14915           },
14916           {
14917             "group": "Body",
14918             "type": "String",
14919             "optional": true,
14920             "field": "user",
14921             "description": ""
14922           },
14923           {
14924             "group": "Body",
14925             "type": "String",
14926             "optional": true,
14927             "field": "pass",
14928             "description": ""
14929           },
14930           {
14931             "group": "Body",
14932             "type": "Integer",
14933             "optional": true,
14934             "field": "port",
14935             "description": ""
14936           },
14937           {
14938             "group": "Body",
14939             "type": "Boolean",
14940             "optional": true,
14941             "field": "secure",
14942             "description": ""
14943           },
14944           {
14945             "group": "Body",
14946             "type": "String",
14947             "optional": true,
14948             "field": "service",
14949             "description": ""
14950           },
14951           {
14952             "group": "Body",
14953             "type": "Boolean",
14954             "optional": true,
14955             "field": "authentication",
14956             "description": ""
14957           }
14958         ]
14959       }
14960     },
14961     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14962     "version": "0.0.0",
14963     "filename": "server/api/mailAccount/index.js",
14964     "groupTitle": "Mail_Accounts"
14965   },
14966   {
14967     "type": "delete",
14968     "url": "/api/mail/accounts/{id}",
14969     "title": "Deletes a mail account",
14970     "examples": [
14971       {
14972         "title": "Example usage:",
14973         "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password} -X DELETE",
14974         "type": "json"
14975       }
14976     ],
14977     "name": "DeleteMailAccounts",
14978     "group": "Mail_Accounts",
14979     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14980     "version": "0.0.0",
14981     "filename": "server/api/mailAccount/index.js",
14982     "groupTitle": "Mail_Accounts"
14983   },
14984   {
14985     "type": "get",
14986     "url": "/api/mail/accounts/describe",
14987     "title": "Gets table info about Accounts",
14988     "examples": [
14989       {
14990         "title": "Example usage:",
14991         "content": "curl https://{domain}/api/mail/accounts/describe -v -u {name}:{password}",
14992         "type": "json"
14993       }
14994     ],
14995     "name": "DescribeAccounts",
14996     "group": "Mail_Accounts",
14997     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14998     "version": "0.0.0",
14999     "filename": "server/api/mailAccount/index.js",
15000     "groupTitle": "Mail_Accounts"
15001   },
15002   {
15003     "type": "get",
15004     "url": "/api/mail/accounts",
15005     "title": "Gets a list of Accounts",
15006     "examples": [
15007       {
15008         "title": "Example usage:",
15009         "content": "curl https://{domain}/api/mail/accounts -v -u {name}:{password}",
15010         "type": "json"
15011       }
15012     ],
15013     "name": "GetAccounts",
15014     "group": "Mail_Accounts",
15015     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
15016     "version": "0.0.0",
15017     "filename": "server/api/mailAccount/index.js",
15018     "groupTitle": "Mail_Accounts"
15019   },
15020   {
15021     "type": "get",
15022     "url": "/api/mail/accounts/{id}/users",
15023     "title": "Gets agents from mail account",
15024     "examples": [
15025       {
15026         "title": "Example usage:",
15027         "content": "curl https://{domain}/api/mail/accounts/{id}/users -v -u {name}:{password} -X GET",
15028         "type": "json"
15029       }
15030     ],
15031     "name": "GetAgents",
15032     "group": "Mail_Accounts",
15033     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15034     "version": "0.0.0",
15035     "filename": "server/api/mailAccount/index.js",
15036     "groupTitle": "Mail_Accounts"
15037   },
15038   {
15039     "type": "get",
15040     "url": "/api/mail/accounts/{id}/in_servers",
15041     "title": "Gets account IMAP server",
15042     "examples": [
15043       {
15044         "title": "Example usage:",
15045         "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X GET",
15046         "type": "json"
15047       }
15048     ],
15049     "name": "GetImap",
15050     "group": "Mail_Accounts",
15051     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15052     "version": "0.0.0",
15053     "filename": "server/api/mailAccount/index.js",
15054     "groupTitle": "Mail_Accounts"
15055   },
15056   {
15057     "type": "get",
15058     "url": "/api/mail/accounts/{id}/out_servers",
15059     "title": "Gets account SMTP server",
15060     "examples": [
15061       {
15062         "title": "Example usage:",
15063         "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X GET",
15064         "type": "json"
15065       }
15066     ],
15067     "name": "GetSmtp",
15068     "group": "Mail_Accounts",
15069     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15070     "version": "0.0.0",
15071     "filename": "server/api/mailAccount/index.js",
15072     "groupTitle": "Mail_Accounts"
15073   },
15074   {
15075     "type": "delete",
15076     "url": "/api/mail/accounts/{id}/users",
15077     "title": "Removes agents from a mail account",
15078     "examples": [
15079       {
15080         "title": "Example usage:",
15081         "content": "curl https://{domain}/api/mail/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15082         "type": "json"
15083       }
15084     ],
15085     "name": "RemoveAgents",
15086     "group": "Mail_Accounts",
15087     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15088     "version": "0.0.0",
15089     "filename": "server/api/mailAccount/index.js",
15090     "groupTitle": "Mail_Accounts"
15091   },
15092   {
15093     "type": "delete",
15094     "url": "/api/mail/accounts/{id}/canned_answers",
15095     "title": "Removes canned answers from account",
15096     "examples": [
15097       {
15098         "title": "Example usage:",
15099         "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15100         "type": "json"
15101       }
15102     ],
15103     "name": "RemoveAnswers",
15104     "group": "Mail_Accounts",
15105     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15106     "version": "0.0.0",
15107     "filename": "server/api/mailAccount/index.js",
15108     "groupTitle": "Mail_Accounts"
15109   },
15110   {
15111     "type": "delete",
15112     "url": "/api/mail/accounts/{id}/dispositions",
15113     "title": "Removes dispositions from account",
15114     "examples": [
15115       {
15116         "title": "Example usage:",
15117         "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15118         "type": "json"
15119       }
15120     ],
15121     "name": "RemoveDispositions",
15122     "group": "Mail_Accounts",
15123     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15124     "version": "0.0.0",
15125     "filename": "server/api/mailAccount/index.js",
15126     "groupTitle": "Mail_Accounts"
15127   },
15128   {
15129     "type": "delete",
15130     "url": "/api/mail/accounts/{id}/in_servers",
15131     "title": "Removes IMAP server from an account",
15132     "examples": [
15133       {
15134         "title": "Example usage:",
15135         "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X DELETE",
15136         "type": "json"
15137       }
15138     ],
15139     "name": "RemoveImmap",
15140     "group": "Mail_Accounts",
15141     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15142     "version": "0.0.0",
15143     "filename": "server/api/mailAccount/index.js",
15144     "groupTitle": "Mail_Accounts"
15145   },
15146   {
15147     "type": "delete",
15148     "url": "/api/mail/accounts/{id}/out_servers",
15149     "title": "Removes SMTP server from an account",
15150     "examples": [
15151       {
15152         "title": "Example usage:",
15153         "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X DELETE",
15154         "type": "json"
15155       }
15156     ],
15157     "name": "RemoveSmtp",
15158     "group": "Mail_Accounts",
15159     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15160     "version": "0.0.0",
15161     "filename": "server/api/mailAccount/index.js",
15162     "groupTitle": "Mail_Accounts"
15163   },
15164   {
15165     "type": "get",
15166     "url": "/api/mail/accounts/{id}",
15167     "title": "Gets a single Account",
15168     "examples": [
15169       {
15170         "title": "Example usage:",
15171         "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password}",
15172         "type": "json"
15173       }
15174     ],
15175     "name": "ShowAccounts",
15176     "group": "Mail_Accounts",
15177     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15178     "version": "0.0.0",
15179     "filename": "server/api/mailAccount/index.js",
15180     "groupTitle": "Mail_Accounts"
15181   },
15182   {
15183     "type": "post",
15184     "url": "/api/mail/accounts/{id}/canned_answers",
15185     "title": "Creates new canned answer",
15186     "examples": [
15187       {
15188         "title": "Example usage:",
15189         "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",
15190         "type": "json"
15191       }
15192     ],
15193     "name": "addAnswer",
15194     "group": "Mail_Accounts",
15195     "parameter": {
15196       "fields": {
15197         "Body": [
15198           {
15199             "group": "Body",
15200             "type": "String",
15201             "optional": false,
15202             "field": "key",
15203             "description": ""
15204           },
15205           {
15206             "group": "Body",
15207             "type": "Text",
15208             "optional": false,
15209             "field": "value",
15210             "description": ""
15211           },
15212           {
15213             "group": "Body",
15214             "type": "String",
15215             "optional": true,
15216             "field": "description",
15217             "description": ""
15218           },
15219           {
15220             "group": "Body",
15221             "type": "Virtual",
15222             "optional": true,
15223             "field": "name",
15224             "description": ""
15225           }
15226         ]
15227       }
15228     },
15229     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15230     "version": "0.0.0",
15231     "filename": "server/api/mailAccount/index.js",
15232     "groupTitle": "Mail_Accounts"
15233   },
15234   {
15235     "type": "post",
15236     "url": "/api/mail/accounts/{id}/applications",
15237     "title": "Creates new applications",
15238     "examples": [
15239       {
15240         "title": "Example usage:",
15241         "content": "curl https://{domain}/api/mail/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15242         "type": "json"
15243       }
15244     ],
15245     "name": "addApplications",
15246     "group": "Mail_Accounts",
15247     "parameter": {
15248       "fields": {
15249         "Body": [
15250           {
15251             "group": "Body",
15252             "type": "Integer",
15253             "optional": false,
15254             "field": "priority",
15255             "description": ""
15256           },
15257           {
15258             "group": "Body",
15259             "type": "String",
15260             "optional": false,
15261             "field": "app",
15262             "description": ""
15263           },
15264           {
15265             "group": "Body",
15266             "type": "Text",
15267             "optional": true,
15268             "field": "appdata",
15269             "description": ""
15270           },
15271           {
15272             "group": "Body",
15273             "type": "String",
15274             "optional": true,
15275             "field": "description",
15276             "description": ""
15277           },
15278           {
15279             "group": "Body",
15280             "type": "String",
15281             "optional": true,
15282             "field": "interval",
15283             "description": ""
15284           }
15285         ]
15286       }
15287     },
15288     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15289     "version": "0.0.0",
15290     "filename": "server/api/mailAccount/index.js",
15291     "groupTitle": "Mail_Accounts"
15292   },
15293   {
15294     "type": "post",
15295     "url": "/api/mail/accounts/{id}/dispositions",
15296     "title": "Creates new disposition",
15297     "examples": [
15298       {
15299         "title": "Example usage:",
15300         "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15301         "type": "json"
15302       }
15303     ],
15304     "name": "addDisposition",
15305     "group": "Mail_Accounts",
15306     "parameter": {
15307       "fields": {
15308         "Body": [
15309           {
15310             "group": "Body",
15311             "type": "String",
15312             "optional": false,
15313             "field": "name",
15314             "description": ""
15315           },
15316           {
15317             "group": "Body",
15318             "type": "String",
15319             "allowedValues": [
15320               "\"first\"",
15321               "\"second\"",
15322               "\"third\""
15323             ],
15324             "optional": false,
15325             "field": "level",
15326             "description": ""
15327           },
15328           {
15329             "group": "Body",
15330             "type": "String",
15331             "optional": true,
15332             "field": "description",
15333             "description": ""
15334           }
15335         ]
15336       }
15337     },
15338     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15339     "version": "0.0.0",
15340     "filename": "server/api/mailAccount/index.js",
15341     "groupTitle": "Mail_Accounts"
15342   },
15343   {
15344     "type": "post",
15345     "url": "/api/mail/accounts/{id}/interactions",
15346     "title": "Creates new interactions",
15347     "examples": [
15348       {
15349         "title": "Example usage:",
15350         "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",
15351         "type": "json"
15352       }
15353     ],
15354     "name": "addInteraction",
15355     "group": "Mail_Accounts",
15356     "parameter": {
15357       "fields": {
15358         "Body": [
15359           {
15360             "group": "Body",
15361             "type": "Boolean",
15362             "optional": true,
15363             "field": "closed",
15364             "description": ""
15365           },
15366           {
15367             "group": "Body",
15368             "type": "String",
15369             "optional": true,
15370             "field": "closedAt",
15371             "description": ""
15372           },
15373           {
15374             "group": "Body",
15375             "type": "String",
15376             "optional": true,
15377             "field": "disposition",
15378             "description": ""
15379           },
15380           {
15381             "group": "Body",
15382             "type": "String",
15383             "optional": true,
15384             "field": "secondDisposition",
15385             "description": ""
15386           },
15387           {
15388             "group": "Body",
15389             "type": "String",
15390             "optional": true,
15391             "field": "thirdDisposition",
15392             "description": ""
15393           },
15394           {
15395             "group": "Body",
15396             "type": "String",
15397             "optional": true,
15398             "field": "note",
15399             "description": ""
15400           },
15401           {
15402             "group": "Body",
15403             "type": "String",
15404             "optional": true,
15405             "field": "inReplyTo",
15406             "description": ""
15407           },
15408           {
15409             "group": "Body",
15410             "type": "String",
15411             "optional": true,
15412             "field": "to",
15413             "description": ""
15414           },
15415           {
15416             "group": "Body",
15417             "type": "Text",
15418             "optional": true,
15419             "field": "cc",
15420             "description": ""
15421           },
15422           {
15423             "group": "Body",
15424             "type": "Text",
15425             "optional": true,
15426             "field": "subject",
15427             "description": ""
15428           },
15429           {
15430             "group": "Body",
15431             "type": "Boolean",
15432             "optional": true,
15433             "field": "attach",
15434             "description": ""
15435           },
15436           {
15437             "group": "Body",
15438             "type": "String",
15439             "optional": true,
15440             "field": "read1stAt",
15441             "description": ""
15442           },
15443           {
15444             "group": "Body",
15445             "type": "String",
15446             "optional": true,
15447             "field": "substatus",
15448             "description": ""
15449           },
15450           {
15451             "group": "Body",
15452             "type": "String",
15453             "optional": true,
15454             "field": "substatusAt",
15455             "description": ""
15456           },
15457           {
15458             "group": "Body",
15459             "type": "String",
15460             "allowedValues": [
15461               "\"in\"",
15462               "\"out\""
15463             ],
15464             "optional": false,
15465             "field": "firstMsgDirection",
15466             "description": ""
15467           },
15468           {
15469             "group": "Body",
15470             "type": "String",
15471             "optional": true,
15472             "field": "lastMsgAt",
15473             "description": ""
15474           },
15475           {
15476             "group": "Body",
15477             "type": "String",
15478             "allowedValues": [
15479               "\"in\"",
15480               "\"out\""
15481             ],
15482             "optional": false,
15483             "field": "lastMsgDirection",
15484             "description": ""
15485           },
15486           {
15487             "group": "Body",
15488             "type": "Boolean",
15489             "optional": true,
15490             "field": "autoreplyExecuted",
15491             "description": ""
15492           }
15493         ]
15494       }
15495     },
15496     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15497     "version": "0.0.0",
15498     "filename": "server/api/mailAccount/index.js",
15499     "groupTitle": "Mail_Accounts"
15500   },
15501   {
15502     "type": "post",
15503     "url": "/api/mail/accounts",
15504     "title": "Create a mail account",
15505     "examples": [
15506       {
15507         "title": "Example usage:",
15508         "content": "curl https://{domain}/api/mail/accounts \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15509         "type": "json"
15510       }
15511     ],
15512     "name": "create",
15513     "group": "Mail_Accounts",
15514     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15515     "version": "0.0.0",
15516     "filename": "server/api/mailAccount/index.js",
15517     "groupTitle": "Mail_Accounts"
15518   },
15519   {
15520     "type": "get",
15521     "url": "/api/mail/accounts/{id}/canned_answers",
15522     "title": "Gets account canned answers",
15523     "examples": [
15524       {
15525         "title": "Example usage:",
15526         "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
15527         "type": "json"
15528       }
15529     ],
15530     "name": "getAnswers",
15531     "group": "Mail_Accounts",
15532     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15533     "version": "0.0.0",
15534     "filename": "server/api/mailAccount/index.js",
15535     "groupTitle": "Mail_Accounts"
15536   },
15537   {
15538     "type": "get",
15539     "url": "/api/mail/accounts/{id}/applications",
15540     "title": "Gets account applications",
15541     "examples": [
15542       {
15543         "title": "Example usage:",
15544         "content": "curl https://{domain}/api/mail/accounts/{id}/applications -v -u {name}:{password} -X GET",
15545         "type": "json"
15546       }
15547     ],
15548     "name": "getApplications",
15549     "group": "Mail_Accounts",
15550     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15551     "version": "0.0.0",
15552     "filename": "server/api/mailAccount/index.js",
15553     "groupTitle": "Mail_Accounts"
15554   },
15555   {
15556     "type": "get",
15557     "url": "/api/mail/accounts/{id}/dispositions",
15558     "title": "Gets account dispositions",
15559     "examples": [
15560       {
15561         "title": "Example usage:",
15562         "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
15563         "type": "json"
15564       }
15565     ],
15566     "name": "getDispositions",
15567     "group": "Mail_Accounts",
15568     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15569     "version": "0.0.0",
15570     "filename": "server/api/mailAccount/index.js",
15571     "groupTitle": "Mail_Accounts"
15572   },
15573   {
15574     "type": "get",
15575     "url": "/api/mail/accounts/{id}/interactions",
15576     "title": "Gets account interactions",
15577     "examples": [
15578       {
15579         "title": "Example usage:",
15580         "content": "curl https://{domain}/api/mail/accounts/{id}/interactions -v -u {name}:{password} -X GET",
15581         "type": "json"
15582       }
15583     ],
15584     "name": "getInteraction",
15585     "group": "Mail_Accounts",
15586     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15587     "version": "0.0.0",
15588     "filename": "server/api/mailAccount/index.js",
15589     "groupTitle": "Mail_Accounts"
15590   },
15591   {
15592     "type": "get",
15593     "url": "/api/mail/accounts/{id}/messages",
15594     "title": "Gets account messages",
15595     "examples": [
15596       {
15597         "title": "Example usage:",
15598         "content": "curl https://{domain}/api/mail/accounts/{id}/messages -v -u {name}:{password} -X GET",
15599         "type": "json"
15600       }
15601     ],
15602     "name": "getMessages",
15603     "group": "Mail_Accounts",
15604     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15605     "version": "0.0.0",
15606     "filename": "server/api/mailAccount/index.js",
15607     "groupTitle": "Mail_Accounts"
15608   },
15609   {
15610     "type": "post",
15611     "url": "/api/mail/accounts/{id}/send",
15612     "title": "Send new mail",
15613     "examples": [
15614       {
15615         "title": "Example usage:",
15616         "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",
15617         "type": "json"
15618       }
15619     ],
15620     "name": "sendMail",
15621     "group": "Mail_Accounts",
15622     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15623     "version": "0.0.0",
15624     "filename": "server/api/mailAccount/index.js",
15625     "groupTitle": "Mail_Accounts"
15626   },
15627   {
15628     "type": "put",
15629     "url": "/api/mail/accounts/{id}",
15630     "title": "Update an existing Account",
15631     "examples": [
15632       {
15633         "title": "Example usage:",
15634         "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",
15635         "type": "json"
15636       }
15637     ],
15638     "name": "updateAccounts",
15639     "group": "Mail_Accounts",
15640     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15641     "version": "0.0.0",
15642     "filename": "server/api/mailAccount/index.js",
15643     "groupTitle": "Mail_Accounts"
15644   },
15645   {
15646     "type": "get",
15647     "url": "/api/mail/accounts/{id}/verify",
15648     "title": "Verify mail account",
15649     "examples": [
15650       {
15651         "title": "Example usage:",
15652         "content": "curl https://{domain}/api/mail/accounts/{id}/verify -v -u {name}:{password} -X GET",
15653         "type": "json"
15654       }
15655     ],
15656     "name": "verifySmtp",
15657     "group": "Mail_Accounts",
15658     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15659     "version": "0.0.0",
15660     "filename": "server/api/mailAccount/index.js",
15661     "groupTitle": "Mail_Accounts"
15662   },
15663   {
15664     "type": "delete",
15665     "url": "/api/mail/applications/{id}",
15666     "title": "Deletes a Application",
15667     "examples": [
15668       {
15669         "title": "Example usage:",
15670         "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password} -X DELETE",
15671         "type": "json"
15672       }
15673     ],
15674     "name": "DeleteApplications",
15675     "group": "Mail_Applications",
15676     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15677     "version": "0.0.0",
15678     "filename": "server/api/mailApplication/index.js",
15679     "groupTitle": "Mail_Applications"
15680   },
15681   {
15682     "type": "get",
15683     "url": "/api/mail/applications/{id}",
15684     "title": "Gets a single Application",
15685     "examples": [
15686       {
15687         "title": "Example usage:",
15688         "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password}",
15689         "type": "json"
15690       }
15691     ],
15692     "name": "ShowApplications",
15693     "group": "Mail_Applications",
15694     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15695     "version": "0.0.0",
15696     "filename": "server/api/mailApplication/index.js",
15697     "groupTitle": "Mail_Applications"
15698   },
15699   {
15700     "type": "put",
15701     "url": "/api/mail/applications/{id}",
15702     "title": "Update an existing Application",
15703     "examples": [
15704       {
15705         "title": "Example usage:",
15706         "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",
15707         "type": "json"
15708       }
15709     ],
15710     "name": "updateApplications",
15711     "group": "Mail_Applications",
15712     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15713     "version": "0.0.0",
15714     "filename": "server/api/mailApplication/index.js",
15715     "groupTitle": "Mail_Applications"
15716   },
15717   {
15718     "type": "post",
15719     "url": "/api/mail/interactions/{id}/tags",
15720     "title": "Add tags to the interaction",
15721     "examples": [
15722       {
15723         "title": "Example usage:",
15724         "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",
15725         "type": "json"
15726       }
15727     ],
15728     "name": "AddTags",
15729     "group": "Mail_Interactions",
15730     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15731     "version": "0.0.0",
15732     "filename": "server/api/mailInteraction/index.js",
15733     "groupTitle": "Mail_Interactions"
15734   },
15735   {
15736     "type": "post",
15737     "url": "/api/mail/interactions",
15738     "title": "Creates a new Interaction",
15739     "examples": [
15740       {
15741         "title": "Example usage:",
15742         "content": "curl https://{domain}/api/mail/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
15743         "type": "json"
15744       }
15745     ],
15746     "name": "CreateInteractions",
15747     "group": "Mail_Interactions",
15748     "parameter": {
15749       "fields": {
15750         "Body": [
15751           {
15752             "group": "Body",
15753             "type": "Boolean",
15754             "optional": true,
15755             "field": "closed",
15756             "description": ""
15757           },
15758           {
15759             "group": "Body",
15760             "type": "String",
15761             "optional": true,
15762             "field": "closedAt",
15763             "description": ""
15764           },
15765           {
15766             "group": "Body",
15767             "type": "String",
15768             "optional": true,
15769             "field": "disposition",
15770             "description": ""
15771           },
15772           {
15773             "group": "Body",
15774             "type": "String",
15775             "optional": true,
15776             "field": "secondDisposition",
15777             "description": ""
15778           },
15779           {
15780             "group": "Body",
15781             "type": "String",
15782             "optional": true,
15783             "field": "thirdDisposition",
15784             "description": ""
15785           },
15786           {
15787             "group": "Body",
15788             "type": "String",
15789             "optional": true,
15790             "field": "note",
15791             "description": ""
15792           },
15793           {
15794             "group": "Body",
15795             "type": "String",
15796             "optional": true,
15797             "field": "inReplyTo",
15798             "description": ""
15799           },
15800           {
15801             "group": "Body",
15802             "type": "String",
15803             "optional": true,
15804             "field": "to",
15805             "description": ""
15806           },
15807           {
15808             "group": "Body",
15809             "type": "Text",
15810             "optional": true,
15811             "field": "cc",
15812             "description": ""
15813           },
15814           {
15815             "group": "Body",
15816             "type": "Text",
15817             "optional": true,
15818             "field": "subject",
15819             "description": ""
15820           },
15821           {
15822             "group": "Body",
15823             "type": "Boolean",
15824             "optional": true,
15825             "field": "attach",
15826             "description": ""
15827           },
15828           {
15829             "group": "Body",
15830             "type": "String",
15831             "optional": true,
15832             "field": "read1stAt",
15833             "description": ""
15834           },
15835           {
15836             "group": "Body",
15837             "type": "String",
15838             "optional": true,
15839             "field": "substatus",
15840             "description": ""
15841           },
15842           {
15843             "group": "Body",
15844             "type": "String",
15845             "optional": true,
15846             "field": "substatusAt",
15847             "description": ""
15848           },
15849           {
15850             "group": "Body",
15851             "type": "String",
15852             "allowedValues": [
15853               "\"in\"",
15854               "\"out\""
15855             ],
15856             "optional": false,
15857             "field": "firstMsgDirection",
15858             "description": ""
15859           },
15860           {
15861             "group": "Body",
15862             "type": "String",
15863             "optional": true,
15864             "field": "lastMsgAt",
15865             "description": ""
15866           },
15867           {
15868             "group": "Body",
15869             "type": "String",
15870             "allowedValues": [
15871               "\"in\"",
15872               "\"out\""
15873             ],
15874             "optional": false,
15875             "field": "lastMsgDirection",
15876             "description": ""
15877           },
15878           {
15879             "group": "Body",
15880             "type": "Boolean",
15881             "optional": true,
15882             "field": "autoreplyExecuted",
15883             "description": ""
15884           }
15885         ]
15886       }
15887     },
15888     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15889     "version": "0.0.0",
15890     "filename": "server/api/mailInteraction/index.js",
15891     "groupTitle": "Mail_Interactions"
15892   },
15893   {
15894     "type": "delete",
15895     "url": "/api/mail/interactions/{id}",
15896     "title": "Deletes a Interaction",
15897     "examples": [
15898       {
15899         "title": "Example usage:",
15900         "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password} -X DELETE",
15901         "type": "json"
15902       }
15903     ],
15904     "name": "DeleteInteractions",
15905     "group": "Mail_Interactions",
15906     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15907     "version": "0.0.0",
15908     "filename": "server/api/mailInteraction/index.js",
15909     "groupTitle": "Mail_Interactions"
15910   },
15911   {
15912     "type": "get",
15913     "url": "/api/mail/interactions/describe",
15914     "title": "Gets table info about Interactions",
15915     "examples": [
15916       {
15917         "title": "Example usage:",
15918         "content": "curl https://{domain}/api/mail/interactions/describe -v -u {name}:{password}",
15919         "type": "json"
15920       }
15921     ],
15922     "name": "DescribeInteractions",
15923     "group": "Mail_Interactions",
15924     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15925     "version": "0.0.0",
15926     "filename": "server/api/mailInteraction/index.js",
15927     "groupTitle": "Mail_Interactions"
15928   },
15929   {
15930     "type": "get",
15931     "url": "/api/mail/interactions",
15932     "title": "Gets a list of Interactions",
15933     "examples": [
15934       {
15935         "title": "Example usage:",
15936         "content": "curl https://{domain}/api/mail/interactions -v -u {name}:{password}",
15937         "type": "json"
15938       }
15939     ],
15940     "name": "GetInteractions",
15941     "group": "Mail_Interactions",
15942     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
15943     "version": "0.0.0",
15944     "filename": "server/api/mailInteraction/index.js",
15945     "groupTitle": "Mail_Interactions"
15946   },
15947   {
15948     "type": "delete",
15949     "url": "/api/mail/interactions/{id}/tags",
15950     "title": "Removes tags from interaction",
15951     "examples": [
15952       {
15953         "title": "Example usage:",
15954         "content": "curl https://{domain}/api/mail/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15955         "type": "json"
15956       }
15957     ],
15958     "name": "RemoveTags",
15959     "group": "Mail_Interactions",
15960     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15961     "version": "0.0.0",
15962     "filename": "server/api/mailInteraction/index.js",
15963     "groupTitle": "Mail_Interactions"
15964   },
15965   {
15966     "type": "get",
15967     "url": "/api/mail/interactions/{id}",
15968     "title": "Gets a single Interaction",
15969     "examples": [
15970       {
15971         "title": "Example usage:",
15972         "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password}",
15973         "type": "json"
15974       }
15975     ],
15976     "name": "ShowInteractions",
15977     "group": "Mail_Interactions",
15978     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15979     "version": "0.0.0",
15980     "filename": "server/api/mailInteraction/index.js",
15981     "groupTitle": "Mail_Interactions"
15982   },
15983   {
15984     "type": "post",
15985     "url": "/api/mail/interactions/{id}/messages",
15986     "title": "Creates new message",
15987     "examples": [
15988       {
15989         "title": "Example usage:",
15990         "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",
15991         "type": "json"
15992       }
15993     ],
15994     "name": "addMessage",
15995     "group": "Mail_Interactions",
15996     "parameter": {
15997       "fields": {
15998         "Body": [
15999           {
16000             "group": "Body",
16001             "type": "Text",
16002             "optional": false,
16003             "field": "body",
16004             "description": ""
16005           },
16006           {
16007             "group": "Body",
16008             "type": "Text",
16009             "optional": true,
16010             "field": "plainBody",
16011             "description": ""
16012           },
16013           {
16014             "group": "Body",
16015             "type": "Boolean",
16016             "optional": true,
16017             "field": "read",
16018             "description": ""
16019           },
16020           {
16021             "group": "Body",
16022             "type": "String",
16023             "allowedValues": [
16024               "\"in\"",
16025               "\"out\""
16026             ],
16027             "optional": false,
16028             "field": "direction",
16029             "description": ""
16030           },
16031           {
16032             "group": "Body",
16033             "type": "String",
16034             "optional": true,
16035             "field": "messageId",
16036             "description": ""
16037           },
16038           {
16039             "group": "Body",
16040             "type": "String",
16041             "optional": true,
16042             "field": "from",
16043             "description": ""
16044           },
16045           {
16046             "group": "Body",
16047             "type": "Text",
16048             "optional": true,
16049             "field": "to",
16050             "description": ""
16051           },
16052           {
16053             "group": "Body",
16054             "type": "Text",
16055             "optional": true,
16056             "field": "cc",
16057             "description": ""
16058           },
16059           {
16060             "group": "Body",
16061             "type": "Text",
16062             "optional": true,
16063             "field": "bcc",
16064             "description": ""
16065           },
16066           {
16067             "group": "Body",
16068             "type": "Text",
16069             "optional": true,
16070             "field": "subject",
16071             "description": ""
16072           },
16073           {
16074             "group": "Body",
16075             "type": "String",
16076             "optional": true,
16077             "field": "sentAt",
16078             "description": ""
16079           },
16080           {
16081             "group": "Body",
16082             "type": "Integer",
16083             "optional": true,
16084             "field": "attach",
16085             "description": ""
16086           },
16087           {
16088             "group": "Body",
16089             "type": "Boolean",
16090             "optional": true,
16091             "field": "secret",
16092             "description": ""
16093           },
16094           {
16095             "group": "Body",
16096             "type": "String",
16097             "optional": true,
16098             "field": "readAt",
16099             "description": ""
16100           },
16101           {
16102             "group": "Body",
16103             "type": "Text",
16104             "optional": true,
16105             "field": "originTo",
16106             "description": ""
16107           },
16108           {
16109             "group": "Body",
16110             "type": "Text",
16111             "optional": true,
16112             "field": "originCc",
16113             "description": ""
16114           },
16115           {
16116             "group": "Body",
16117             "type": "String",
16118             "allowedValues": [
16119               "\"Email\"",
16120               "\"Chat\""
16121             ],
16122             "optional": false,
16123             "field": "originChannel",
16124             "description": ""
16125           }
16126         ]
16127       }
16128     },
16129     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16130     "version": "0.0.0",
16131     "filename": "server/api/mailInteraction/index.js",
16132     "groupTitle": "Mail_Interactions"
16133   },
16134   {
16135     "type": "get",
16136     "url": "/api/mail/interactions/{id}/download",
16137     "title": "Gets interaction",
16138     "examples": [
16139       {
16140         "title": "Example usage:",
16141         "content": "curl https://{domain}/api/mail/interactions/{id}/download -v -u {name}:{password} -X GET",
16142         "type": "json"
16143       }
16144     ],
16145     "name": "download",
16146     "group": "Mail_Interactions",
16147     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16148     "version": "0.0.0",
16149     "filename": "server/api/mailInteraction/index.js",
16150     "groupTitle": "Mail_Interactions"
16151   },
16152   {
16153     "type": "get",
16154     "url": "/api/mail/interactions/{id}/messages",
16155     "title": "Gets interaction messages",
16156     "examples": [
16157       {
16158         "title": "Example usage:",
16159         "content": "curl https://{domain}/api/mail/interactions/{id}/messages -v -u {name}:{password} -X GET",
16160         "type": "json"
16161       }
16162     ],
16163     "name": "getMessages",
16164     "group": "Mail_Interactions",
16165     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16166     "version": "0.0.0",
16167     "filename": "server/api/mailInteraction/index.js",
16168     "groupTitle": "Mail_Interactions"
16169   },
16170   {
16171     "type": "put",
16172     "url": "/api/mail/interactions/{id}",
16173     "title": "Update an existing Interaction",
16174     "examples": [
16175       {
16176         "title": "Example usage:",
16177         "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",
16178         "type": "json"
16179       }
16180     ],
16181     "name": "updateInteractions",
16182     "group": "Mail_Interactions",
16183     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16184     "version": "0.0.0",
16185     "filename": "server/api/mailInteraction/index.js",
16186     "groupTitle": "Mail_Interactions"
16187   },
16188   {
16189     "type": "delete",
16190     "url": "/api/mail/messages/{id}",
16191     "title": "Deletes a Message",
16192     "examples": [
16193       {
16194         "title": "Example usage:",
16195         "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password} -X DELETE",
16196         "type": "json"
16197       }
16198     ],
16199     "name": "DeleteMessages",
16200     "group": "Mail_Messages",
16201     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16202     "version": "0.0.0",
16203     "filename": "server/api/mailMessage/index.js",
16204     "groupTitle": "Mail_Messages"
16205   },
16206   {
16207     "type": "get",
16208     "url": "/api/mail/messages/describe",
16209     "title": "Gets table info about Messages",
16210     "examples": [
16211       {
16212         "title": "Example usage:",
16213         "content": "curl https://{domain}/api/mail/messages/describe -v -u {name}:{password}",
16214         "type": "json"
16215       }
16216     ],
16217     "name": "DescribeMessages",
16218     "group": "Mail_Messages",
16219     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16220     "version": "0.0.0",
16221     "filename": "server/api/mailMessage/index.js",
16222     "groupTitle": "Mail_Messages"
16223   },
16224   {
16225     "type": "get",
16226     "url": "/api/mail/messages",
16227     "title": "Gets a list of Messages",
16228     "examples": [
16229       {
16230         "title": "Example usage:",
16231         "content": "curl https://{domain}/api/mail/messages -v -u {name}:{password}",
16232         "type": "json"
16233       }
16234     ],
16235     "name": "GetMessages",
16236     "group": "Mail_Messages",
16237     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16238     "version": "0.0.0",
16239     "filename": "server/api/mailMessage/index.js",
16240     "groupTitle": "Mail_Messages"
16241   },
16242   {
16243     "type": "get",
16244     "url": "/api/mail/messages/{id}",
16245     "title": "Gets a single Message",
16246     "examples": [
16247       {
16248         "title": "Example usage:",
16249         "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password}",
16250         "type": "json"
16251       }
16252     ],
16253     "name": "ShowMessages",
16254     "group": "Mail_Messages",
16255     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16256     "version": "0.0.0",
16257     "filename": "server/api/mailMessage/index.js",
16258     "groupTitle": "Mail_Messages"
16259   },
16260   {
16261     "type": "put",
16262     "url": "/api/mail/messages/{id}/accept",
16263     "title": "Accepts message",
16264     "examples": [
16265       {
16266         "title": "Example usage:",
16267         "content": "curl https://{domain}/api/mail/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
16268         "type": "json"
16269       }
16270     ],
16271     "name": "acceptMessage",
16272     "group": "Mail_Messages",
16273     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16274     "version": "0.0.0",
16275     "filename": "server/api/mailMessage/index.js",
16276     "groupTitle": "Mail_Messages"
16277   },
16278   {
16279     "type": "post",
16280     "url": "/api/mail/messages",
16281     "title": "Create a message",
16282     "examples": [
16283       {
16284         "title": "Example usage:",
16285         "content": "curl https://{domain}/api/mail/messages \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
16286         "type": "json"
16287       }
16288     ],
16289     "name": "createMessage",
16290     "group": "Mail_Messages",
16291     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16292     "version": "0.0.0",
16293     "filename": "server/api/mailMessage/index.js",
16294     "groupTitle": "Mail_Messages"
16295   },
16296   {
16297     "type": "get",
16298     "url": "/api/mail/messages/{id}/download",
16299     "title": "Gets message",
16300     "examples": [
16301       {
16302         "title": "Example usage:",
16303         "content": "curl https://{domain}/api/mail/messages/{id}/download -v -u {name}:{password} -X GET",
16304         "type": "json"
16305       }
16306     ],
16307     "name": "download",
16308     "group": "Mail_Messages",
16309     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16310     "version": "0.0.0",
16311     "filename": "server/api/mailMessage/index.js",
16312     "groupTitle": "Mail_Messages"
16313   },
16314   {
16315     "type": "put",
16316     "url": "/api/mail/messages/{id}/reject",
16317     "title": "Rejects message",
16318     "examples": [
16319       {
16320         "title": "Example usage:",
16321         "content": "curl https://{domain}/api/mail/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
16322         "type": "json"
16323       }
16324     ],
16325     "name": "rejectMessage",
16326     "group": "Mail_Messages",
16327     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16328     "version": "0.0.0",
16329     "filename": "server/api/mailMessage/index.js",
16330     "groupTitle": "Mail_Messages"
16331   },
16332   {
16333     "type": "put",
16334     "url": "/api/mail/messages/{id}",
16335     "title": "Update an existing Message",
16336     "examples": [
16337       {
16338         "title": "Example usage:",
16339         "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",
16340         "type": "json"
16341       }
16342     ],
16343     "name": "updateMessages",
16344     "group": "Mail_Messages",
16345     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16346     "version": "0.0.0",
16347     "filename": "server/api/mailMessage/index.js",
16348     "groupTitle": "Mail_Messages"
16349   },
16350   {
16351     "type": "post",
16352     "url": "/api/mail/reports/queue",
16353     "title": "Creates a new Mail Queue Report",
16354     "examples": [
16355       {
16356         "title": "Example usage:",
16357         "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",
16358         "type": "json"
16359       }
16360     ],
16361     "name": "CreateMail_Queue_Reports",
16362     "group": "Mail_Queue_Reports",
16363     "parameter": {
16364       "fields": {
16365         "Body": [
16366           {
16367             "group": "Body",
16368             "type": "String",
16369             "optional": false,
16370             "field": "uniqueid",
16371             "description": ""
16372           },
16373           {
16374             "group": "Body",
16375             "type": "String",
16376             "optional": true,
16377             "field": "from",
16378             "description": ""
16379           },
16380           {
16381             "group": "Body",
16382             "type": "String",
16383             "optional": true,
16384             "field": "joinAt",
16385             "description": ""
16386           },
16387           {
16388             "group": "Body",
16389             "type": "String",
16390             "optional": true,
16391             "field": "leaveAt",
16392             "description": ""
16393           },
16394           {
16395             "group": "Body",
16396             "type": "String",
16397             "optional": true,
16398             "field": "acceptAt",
16399             "description": ""
16400           },
16401           {
16402             "group": "Body",
16403             "type": "String",
16404             "optional": true,
16405             "field": "exitAt",
16406             "description": ""
16407           },
16408           {
16409             "group": "Body",
16410             "type": "String",
16411             "optional": true,
16412             "field": "reason",
16413             "description": ""
16414           }
16415         ]
16416       }
16417     },
16418     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16419     "version": "0.0.0",
16420     "filename": "server/api/mailQueueReport/index.js",
16421     "groupTitle": "Mail_Queue_Reports"
16422   },
16423   {
16424     "type": "delete",
16425     "url": "/api/mail/reports/queue/{id}",
16426     "title": "Deletes a Mail Queue Report",
16427     "examples": [
16428       {
16429         "title": "Example usage:",
16430         "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password} -X DELETE",
16431         "type": "json"
16432       }
16433     ],
16434     "name": "DeleteMail_Queue_Reports",
16435     "group": "Mail_Queue_Reports",
16436     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16437     "version": "0.0.0",
16438     "filename": "server/api/mailQueueReport/index.js",
16439     "groupTitle": "Mail_Queue_Reports"
16440   },
16441   {
16442     "type": "get",
16443     "url": "/api/mail/reports/queue/describe",
16444     "title": "Gets table info about Mail Queue Reports",
16445     "examples": [
16446       {
16447         "title": "Example usage:",
16448         "content": "curl https://{domain}/api/mail/reports/queue/describe -v -u {name}:{password}",
16449         "type": "json"
16450       }
16451     ],
16452     "name": "DescribeMail_Queue_Reports",
16453     "group": "Mail_Queue_Reports",
16454     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16455     "version": "0.0.0",
16456     "filename": "server/api/mailQueueReport/index.js",
16457     "groupTitle": "Mail_Queue_Reports"
16458   },
16459   {
16460     "type": "get",
16461     "url": "/api/mail/reports/queue",
16462     "title": "Gets a list of Mail Queue Reports",
16463     "examples": [
16464       {
16465         "title": "Example usage:",
16466         "content": "curl https://{domain}/api/mail/reports/queue -v -u {name}:{password}",
16467         "type": "json"
16468       }
16469     ],
16470     "name": "GetMail_Queue_Reports",
16471     "group": "Mail_Queue_Reports",
16472     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16473     "version": "0.0.0",
16474     "filename": "server/api/mailQueueReport/index.js",
16475     "groupTitle": "Mail_Queue_Reports"
16476   },
16477   {
16478     "type": "get",
16479     "url": "/api/mail/reports/queue/{id}",
16480     "title": "Gets a single Mail Queue Report",
16481     "examples": [
16482       {
16483         "title": "Example usage:",
16484         "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password}",
16485         "type": "json"
16486       }
16487     ],
16488     "name": "ShowMail_Queue_Reports",
16489     "group": "Mail_Queue_Reports",
16490     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16491     "version": "0.0.0",
16492     "filename": "server/api/mailQueueReport/index.js",
16493     "groupTitle": "Mail_Queue_Reports"
16494   },
16495   {
16496     "type": "put",
16497     "url": "/api/mail/reports/queue/{id}",
16498     "title": "Update an existing Mail Queue Report",
16499     "examples": [
16500       {
16501         "title": "Example usage:",
16502         "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",
16503         "type": "json"
16504       }
16505     ],
16506     "name": "updateMail_Queue_Reports",
16507     "group": "Mail_Queue_Reports",
16508     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16509     "version": "0.0.0",
16510     "filename": "server/api/mailQueueReport/index.js",
16511     "groupTitle": "Mail_Queue_Reports"
16512   },
16513   {
16514     "type": "post",
16515     "url": "/api/mail/queues/{id}/users",
16516     "title": "Add agents to a queue",
16517     "examples": [
16518       {
16519         "title": "Example usage:",
16520         "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",
16521         "type": "json"
16522       }
16523     ],
16524     "name": "AddAgents",
16525     "group": "Mail_Queues",
16526     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16527     "version": "0.0.0",
16528     "filename": "server/api/mailQueue/index.js",
16529     "groupTitle": "Mail_Queues"
16530   },
16531   {
16532     "type": "post",
16533     "url": "/api/mail/queues/{id}/teams",
16534     "title": "Add teams to a queue",
16535     "examples": [
16536       {
16537         "title": "Example usage:",
16538         "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",
16539         "type": "json"
16540       }
16541     ],
16542     "name": "AddTeams",
16543     "group": "Mail_Queues",
16544     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16545     "version": "0.0.0",
16546     "filename": "server/api/mailQueue/index.js",
16547     "groupTitle": "Mail_Queues"
16548   },
16549   {
16550     "type": "post",
16551     "url": "/api/mail/queues",
16552     "title": "Creates a new Queue",
16553     "examples": [
16554       {
16555         "title": "Example usage:",
16556         "content": "curl https://{domain}/api/mail/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
16557         "type": "json"
16558       }
16559     ],
16560     "name": "CreateQueues",
16561     "group": "Mail_Queues",
16562     "parameter": {
16563       "fields": {
16564         "Body": [
16565           {
16566             "group": "Body",
16567             "type": "String",
16568             "optional": true,
16569             "field": "name",
16570             "description": ""
16571           },
16572           {
16573             "group": "Body",
16574             "type": "String",
16575             "optional": true,
16576             "field": "description",
16577             "description": ""
16578           },
16579           {
16580             "group": "Body",
16581             "type": "Integer",
16582             "optional": true,
16583             "field": "timeout",
16584             "description": ""
16585           },
16586           {
16587             "group": "Body",
16588             "type": "String",
16589             "allowedValues": [
16590               "\"rrmemory\"",
16591               "\"beepall\"",
16592               "\"roundrobin\""
16593             ],
16594             "optional": true,
16595             "field": "strategy",
16596             "description": ""
16597           }
16598         ]
16599       }
16600     },
16601     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16602     "version": "0.0.0",
16603     "filename": "server/api/mailQueue/index.js",
16604     "groupTitle": "Mail_Queues"
16605   },
16606   {
16607     "type": "delete",
16608     "url": "/api/mail/queues/{id}",
16609     "title": "Deletes a Queue",
16610     "examples": [
16611       {
16612         "title": "Example usage:",
16613         "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password} -X DELETE",
16614         "type": "json"
16615       }
16616     ],
16617     "name": "DeleteQueues",
16618     "group": "Mail_Queues",
16619     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16620     "version": "0.0.0",
16621     "filename": "server/api/mailQueue/index.js",
16622     "groupTitle": "Mail_Queues"
16623   },
16624   {
16625     "type": "get",
16626     "url": "/api/mail/queues/describe",
16627     "title": "Gets table info about Queues",
16628     "examples": [
16629       {
16630         "title": "Example usage:",
16631         "content": "curl https://{domain}/api/mail/queues/describe -v -u {name}:{password}",
16632         "type": "json"
16633       }
16634     ],
16635     "name": "DescribeQueues",
16636     "group": "Mail_Queues",
16637     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16638     "version": "0.0.0",
16639     "filename": "server/api/mailQueue/index.js",
16640     "groupTitle": "Mail_Queues"
16641   },
16642   {
16643     "type": "get",
16644     "url": "/api/mail/queues/{id}/users",
16645     "title": "Gets queue agents",
16646     "examples": [
16647       {
16648         "title": "Example usage:",
16649         "content": "curl https://{domain}/api/mail/queues/{id}/users -v -u {name}:{password} -X POST",
16650         "type": "json"
16651       }
16652     ],
16653     "name": "GetAgents",
16654     "group": "Mail_Queues",
16655     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16656     "version": "0.0.0",
16657     "filename": "server/api/mailQueue/index.js",
16658     "groupTitle": "Mail_Queues"
16659   },
16660   {
16661     "type": "get",
16662     "url": "/api/mail/queues/{id}/members",
16663     "title": "GetMembers",
16664     "examples": [
16665       {
16666         "title": "Example usage:",
16667         "content": "curl https://{domain}/api/mail/queues/{id}/members  -v -u {name}:{password}",
16668         "type": "json"
16669       }
16670     ],
16671     "name": "GetMembers",
16672     "group": "Mail_Queues",
16673     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16674     "version": "0.0.0",
16675     "filename": "server/api/mailQueue/index.js",
16676     "groupTitle": "Mail_Queues"
16677   },
16678   {
16679     "type": "get",
16680     "url": "/api/mail/queues",
16681     "title": "Gets a list of Queues",
16682     "examples": [
16683       {
16684         "title": "Example usage:",
16685         "content": "curl https://{domain}/api/mail/queues -v -u {name}:{password}",
16686         "type": "json"
16687       }
16688     ],
16689     "name": "GetQueues",
16690     "group": "Mail_Queues",
16691     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16692     "version": "0.0.0",
16693     "filename": "server/api/mailQueue/index.js",
16694     "groupTitle": "Mail_Queues"
16695   },
16696   {
16697     "type": "get",
16698     "url": "/api/mail/queues/{id}/teams",
16699     "title": "Gets queues list",
16700     "examples": [
16701       {
16702         "title": "Example usage:",
16703         "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password}",
16704         "type": "json"
16705       }
16706     ],
16707     "name": "GetTeams",
16708     "group": "Mail_Queues",
16709     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16710     "version": "0.0.0",
16711     "filename": "server/api/mailQueue/index.js",
16712     "groupTitle": "Mail_Queues"
16713   },
16714   {
16715     "type": "delete",
16716     "url": "/api/mail/queues/{id}/users",
16717     "title": "Removes agents from a queue",
16718     "examples": [
16719       {
16720         "title": "Example usage:",
16721         "content": "curl https://{domain}/api/mail/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
16722         "type": "json"
16723       }
16724     ],
16725     "name": "RemoveAgents",
16726     "group": "Mail_Queues",
16727     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16728     "version": "0.0.0",
16729     "filename": "server/api/mailQueue/index.js",
16730     "groupTitle": "Mail_Queues"
16731   },
16732   {
16733     "type": "get",
16734     "url": "/api/mail/queues/{id}",
16735     "title": "Gets a single Queue",
16736     "examples": [
16737       {
16738         "title": "Example usage:",
16739         "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password}",
16740         "type": "json"
16741       }
16742     ],
16743     "name": "ShowQueues",
16744     "group": "Mail_Queues",
16745     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16746     "version": "0.0.0",
16747     "filename": "server/api/mailQueue/index.js",
16748     "groupTitle": "Mail_Queues"
16749   },
16750   {
16751     "type": "put",
16752     "url": "/api/mail/queues/{id}",
16753     "title": "Update an existing Queue",
16754     "examples": [
16755       {
16756         "title": "Example usage:",
16757         "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",
16758         "type": "json"
16759       }
16760     ],
16761     "name": "updateQueues",
16762     "group": "Mail_Queues",
16763     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16764     "version": "0.0.0",
16765     "filename": "server/api/mailQueue/index.js",
16766     "groupTitle": "Mail_Queues"
16767   },
16768   {
16769     "type": "post",
16770     "url": "/api/mail/out_servers",
16771     "title": "Creates a new SMTP",
16772     "examples": [
16773       {
16774         "title": "Example usage:",
16775         "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",
16776         "type": "json"
16777       }
16778     ],
16779     "name": "CreateSMTPs",
16780     "group": "Mail_SMTP",
16781     "parameter": {
16782       "fields": {
16783         "Body": [
16784           {
16785             "group": "Body",
16786             "type": "String",
16787             "optional": true,
16788             "field": "description",
16789             "description": ""
16790           },
16791           {
16792             "group": "Body",
16793             "type": "String",
16794             "optional": true,
16795             "field": "host",
16796             "description": ""
16797           },
16798           {
16799             "group": "Body",
16800             "type": "String",
16801             "optional": true,
16802             "field": "user",
16803             "description": ""
16804           },
16805           {
16806             "group": "Body",
16807             "type": "String",
16808             "optional": true,
16809             "field": "pass",
16810             "description": ""
16811           },
16812           {
16813             "group": "Body",
16814             "type": "Integer",
16815             "optional": true,
16816             "field": "port",
16817             "description": ""
16818           },
16819           {
16820             "group": "Body",
16821             "type": "Boolean",
16822             "optional": true,
16823             "field": "secure",
16824             "description": ""
16825           },
16826           {
16827             "group": "Body",
16828             "type": "String",
16829             "optional": true,
16830             "field": "service",
16831             "description": ""
16832           },
16833           {
16834             "group": "Body",
16835             "type": "Boolean",
16836             "optional": true,
16837             "field": "authentication",
16838             "description": ""
16839           }
16840         ]
16841       }
16842     },
16843     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16844     "version": "0.0.0",
16845     "filename": "server/api/mailServerOut/index.js",
16846     "groupTitle": "Mail_SMTP"
16847   },
16848   {
16849     "type": "delete",
16850     "url": "/api/mail/out_servers/{id}",
16851     "title": "Deletes a SMTP",
16852     "examples": [
16853       {
16854         "title": "Example usage:",
16855         "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password} -X DELETE",
16856         "type": "json"
16857       }
16858     ],
16859     "name": "DeleteSMTPs",
16860     "group": "Mail_SMTP",
16861     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16862     "version": "0.0.0",
16863     "filename": "server/api/mailServerOut/index.js",
16864     "groupTitle": "Mail_SMTP"
16865   },
16866   {
16867     "type": "get",
16868     "url": "/api/mail/out_servers",
16869     "title": "Gets a list of SMTPs",
16870     "examples": [
16871       {
16872         "title": "Example usage:",
16873         "content": "curl https://{domain}/api/mail/out_servers -v -u {name}:{password}",
16874         "type": "json"
16875       }
16876     ],
16877     "name": "GetSMTPs",
16878     "group": "Mail_SMTP",
16879     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16880     "version": "0.0.0",
16881     "filename": "server/api/mailServerOut/index.js",
16882     "groupTitle": "Mail_SMTP"
16883   },
16884   {
16885     "type": "get",
16886     "url": "/api/mail/out_servers/{id}",
16887     "title": "Gets a single SMTP",
16888     "examples": [
16889       {
16890         "title": "Example usage:",
16891         "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password}",
16892         "type": "json"
16893       }
16894     ],
16895     "name": "ShowSMTPs",
16896     "group": "Mail_SMTP",
16897     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16898     "version": "0.0.0",
16899     "filename": "server/api/mailServerOut/index.js",
16900     "groupTitle": "Mail_SMTP"
16901   },
16902   {
16903     "type": "put",
16904     "url": "/api/mail/out_servers/{id}",
16905     "title": "Update an existing SMTP",
16906     "examples": [
16907       {
16908         "title": "Example usage:",
16909         "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",
16910         "type": "json"
16911       }
16912     ],
16913     "name": "updateSMTPs",
16914     "group": "Mail_SMTP",
16915     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16916     "version": "0.0.0",
16917     "filename": "server/api/mailServerOut/index.js",
16918     "groupTitle": "Mail_SMTP"
16919   },
16920   {
16921     "type": "post",
16922     "url": "/api/mail/substatuses",
16923     "title": "Creates a new Queue",
16924     "examples": [
16925       {
16926         "title": "Example usage:",
16927         "content": "curl https://{domain}/api/mail/substatuses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
16928         "type": "json"
16929       }
16930     ],
16931     "name": "CreateSubstatuses",
16932     "group": "Mail_Substatuses",
16933     "parameter": {
16934       "fields": {
16935         "Body": [
16936           {
16937             "group": "Body",
16938             "type": "String",
16939             "optional": false,
16940             "field": "name",
16941             "description": ""
16942           },
16943           {
16944             "group": "Body",
16945             "type": "String",
16946             "optional": true,
16947             "field": "description",
16948             "description": ""
16949           }
16950         ]
16951       }
16952     },
16953     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16954     "version": "0.0.0",
16955     "filename": "server/api/mailSubstatus/index.js",
16956     "groupTitle": "Mail_Substatuses"
16957   },
16958   {
16959     "type": "delete",
16960     "url": "/api/mail/substatuses/{id}",
16961     "title": "Deletes a Queue",
16962     "examples": [
16963       {
16964         "title": "Example usage:",
16965         "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password} -X DELETE",
16966         "type": "json"
16967       }
16968     ],
16969     "name": "DeleteSubstatuses",
16970     "group": "Mail_Substatuses",
16971     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16972     "version": "0.0.0",
16973     "filename": "server/api/mailSubstatus/index.js",
16974     "groupTitle": "Mail_Substatuses"
16975   },
16976   {
16977     "type": "get",
16978     "url": "/api/mail/substatuses/describe",
16979     "title": "Gets table info about Substatuses",
16980     "examples": [
16981       {
16982         "title": "Example usage:",
16983         "content": "curl https://{domain}/api/mail/substatuses/describe -v -u {name}:{password}",
16984         "type": "json"
16985       }
16986     ],
16987     "name": "DescribeSubstatuses",
16988     "group": "Mail_Substatuses",
16989     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16990     "version": "0.0.0",
16991     "filename": "server/api/mailSubstatus/index.js",
16992     "groupTitle": "Mail_Substatuses"
16993   },
16994   {
16995     "type": "get",
16996     "url": "/api/mail/substatuses",
16997     "title": "Gets a list of Substatuses",
16998     "examples": [
16999       {
17000         "title": "Example usage:",
17001         "content": "curl https://{domain}/api/mail/substatuses -v -u {name}:{password}",
17002         "type": "json"
17003       }
17004     ],
17005     "name": "GetSubstatuses",
17006     "group": "Mail_Substatuses",
17007     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17008     "version": "0.0.0",
17009     "filename": "server/api/mailSubstatus/index.js",
17010     "groupTitle": "Mail_Substatuses"
17011   },
17012   {
17013     "type": "get",
17014     "url": "/api/mail/substatuses/{id}",
17015     "title": "Gets a single Queue",
17016     "examples": [
17017       {
17018         "title": "Example usage:",
17019         "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password}",
17020         "type": "json"
17021       }
17022     ],
17023     "name": "ShowSubstatuses",
17024     "group": "Mail_Substatuses",
17025     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17026     "version": "0.0.0",
17027     "filename": "server/api/mailSubstatus/index.js",
17028     "groupTitle": "Mail_Substatuses"
17029   },
17030   {
17031     "type": "put",
17032     "url": "/api/mail/substatuses/{id}",
17033     "title": "Update an existing Queue",
17034     "examples": [
17035       {
17036         "title": "Example usage:",
17037         "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",
17038         "type": "json"
17039       }
17040     ],
17041     "name": "updateSubstatuses",
17042     "group": "Mail_Substatuses",
17043     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/mailSubstatus/index.js",
17046     "groupTitle": "Mail_Substatuses"
17047   },
17048   {
17049     "type": "post",
17050     "url": "/api/mail/reports/transfer",
17051     "title": "Creates a new Mail Transfer Report",
17052     "examples": [
17053       {
17054         "title": "Example usage:",
17055         "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",
17056         "type": "json"
17057       }
17058     ],
17059     "name": "CreateMail_Transfer_Reports",
17060     "group": "Mail_Transfer_Reports",
17061     "parameter": {
17062       "fields": {
17063         "Body": [
17064           {
17065             "group": "Body",
17066             "type": "String",
17067             "optional": false,
17068             "field": "uniqueid",
17069             "description": ""
17070           },
17071           {
17072             "group": "Body",
17073             "type": "String",
17074             "allowedValues": [
17075               "\"account\"",
17076               "\"agent\"",
17077               "\"queue\""
17078             ],
17079             "optional": false,
17080             "field": "type",
17081             "description": ""
17082           },
17083           {
17084             "group": "Body",
17085             "type": "String",
17086             "optional": false,
17087             "field": "transferredAt",
17088             "description": ""
17089           }
17090         ]
17091       }
17092     },
17093     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17094     "version": "0.0.0",
17095     "filename": "server/api/mailTransferReport/index.js",
17096     "groupTitle": "Mail_Transfer_Reports"
17097   },
17098   {
17099     "type": "delete",
17100     "url": "/api/mail/reports/transfer/{id}",
17101     "title": "Deletes a Mail Transfer Report",
17102     "examples": [
17103       {
17104         "title": "Example usage:",
17105         "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
17106         "type": "json"
17107       }
17108     ],
17109     "name": "DeleteMail_Transfer_Reports",
17110     "group": "Mail_Transfer_Reports",
17111     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17112     "version": "0.0.0",
17113     "filename": "server/api/mailTransferReport/index.js",
17114     "groupTitle": "Mail_Transfer_Reports"
17115   },
17116   {
17117     "type": "get",
17118     "url": "/api/mail/reports/transfer/describe",
17119     "title": "Gets table info about Mail Transfer Reports",
17120     "examples": [
17121       {
17122         "title": "Example usage:",
17123         "content": "curl https://{domain}/api/mail/reports/transfer/describe -v -u {name}:{password}",
17124         "type": "json"
17125       }
17126     ],
17127     "name": "DescribeMail_Transfer_Reports",
17128     "group": "Mail_Transfer_Reports",
17129     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17130     "version": "0.0.0",
17131     "filename": "server/api/mailTransferReport/index.js",
17132     "groupTitle": "Mail_Transfer_Reports"
17133   },
17134   {
17135     "type": "get",
17136     "url": "/api/mail/reports/transfer",
17137     "title": "Gets a list of Mail Transfer Reports",
17138     "examples": [
17139       {
17140         "title": "Example usage:",
17141         "content": "curl https://{domain}/api/mail/reports/transfer -v -u {name}:{password}",
17142         "type": "json"
17143       }
17144     ],
17145     "name": "GetMail_Transfer_Reports",
17146     "group": "Mail_Transfer_Reports",
17147     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17148     "version": "0.0.0",
17149     "filename": "server/api/mailTransferReport/index.js",
17150     "groupTitle": "Mail_Transfer_Reports"
17151   },
17152   {
17153     "type": "get",
17154     "url": "/api/mail/reports/transfer/{id}",
17155     "title": "Gets a single Mail Transfer Report",
17156     "examples": [
17157       {
17158         "title": "Example usage:",
17159         "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password}",
17160         "type": "json"
17161       }
17162     ],
17163     "name": "ShowMail_Transfer_Reports",
17164     "group": "Mail_Transfer_Reports",
17165     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17166     "version": "0.0.0",
17167     "filename": "server/api/mailTransferReport/index.js",
17168     "groupTitle": "Mail_Transfer_Reports"
17169   },
17170   {
17171     "type": "put",
17172     "url": "/api/mail/reports/transfer/{id}",
17173     "title": "Update an existing Mail Transfer Report",
17174     "examples": [
17175       {
17176         "title": "Example usage:",
17177         "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",
17178         "type": "json"
17179       }
17180     ],
17181     "name": "updateMail_Transfer_Reports",
17182     "group": "Mail_Transfer_Reports",
17183     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17184     "version": "0.0.0",
17185     "filename": "server/api/mailTransferReport/index.js",
17186     "groupTitle": "Mail_Transfer_Reports"
17187   },
17188   {
17189     "type": "get",
17190     "url": "/api/members/reports/describe",
17191     "title": "Gets table info about Member Reports",
17192     "examples": [
17193       {
17194         "title": "Example usage:",
17195         "content": "curl https://{domain}/api/members/reports/describe -v -u {name}:{password}",
17196         "type": "json"
17197       }
17198     ],
17199     "name": "DescribeMember_Reports",
17200     "group": "Member_Reports",
17201     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17202     "version": "0.0.0",
17203     "filename": "server/api/memberReport/index.js",
17204     "groupTitle": "Member_Reports"
17205   },
17206   {
17207     "type": "get",
17208     "url": "/api/members/reports",
17209     "title": "Gets a list of Member Reports",
17210     "examples": [
17211       {
17212         "title": "Example usage:",
17213         "content": "curl https://{domain}/api/members/reports -v -u {name}:{password}",
17214         "type": "json"
17215       }
17216     ],
17217     "name": "GetMember_Reports",
17218     "group": "Member_Reports",
17219     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17220     "version": "0.0.0",
17221     "filename": "server/api/memberReport/index.js",
17222     "groupTitle": "Member_Reports"
17223   },
17224   {
17225     "type": "get",
17226     "url": "/api/members/reports/{id}",
17227     "title": "Gets a single Member Report",
17228     "examples": [
17229       {
17230         "title": "Example usage:",
17231         "content": "curl https://{domain}/api/members/reports/{id} -v -u {name}:{password}",
17232         "type": "json"
17233       }
17234     ],
17235     "name": "ShowMember_Reports",
17236     "group": "Member_Reports",
17237     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17238     "version": "0.0.0",
17239     "filename": "server/api/memberReport/index.js",
17240     "groupTitle": "Member_Reports"
17241   },
17242   {
17243     "type": "get",
17244     "url": "/api/migrations",
17245     "title": "Gets a list of Migrations",
17246     "examples": [
17247       {
17248         "title": "Example usage:",
17249         "content": "curl https://{domain}/api/migrations -v -u {name}:{password}",
17250         "type": "json"
17251       }
17252     ],
17253     "name": "GetMigrations",
17254     "group": "Migrations",
17255     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17256     "version": "0.0.0",
17257     "filename": "server/api/migration/index.js",
17258     "groupTitle": "Migrations"
17259   },
17260   {
17261     "type": "post",
17262     "url": "/api/voice/networks",
17263     "title": "Create a new network",
17264     "examples": [
17265       {
17266         "title": "Example usage:",
17267         "content": "curl https://{domain}/api/voice/networks -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17268         "type": "json"
17269       }
17270     ],
17271     "name": "Create",
17272     "group": "Networks",
17273     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17274     "version": "0.0.0",
17275     "filename": "server/api/network/index.js",
17276     "groupTitle": "Networks"
17277   },
17278   {
17279     "type": "delete",
17280     "url": "/api/voice/networks/{id}",
17281     "title": "Deletes a network",
17282     "examples": [
17283       {
17284         "title": "Example usage:",
17285         "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X DELETE",
17286         "type": "json"
17287       }
17288     ],
17289     "name": "Delete",
17290     "group": "Networks",
17291     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17292     "version": "0.0.0",
17293     "filename": "server/api/network/index.js",
17294     "groupTitle": "Networks"
17295   },
17296   {
17297     "type": "get",
17298     "url": "/api/networks",
17299     "title": "Gets a list of Networks",
17300     "examples": [
17301       {
17302         "title": "Example usage:",
17303         "content": "curl https://{domain}/api/networks -v -u {name}:{password}",
17304         "type": "json"
17305       }
17306     ],
17307     "name": "GetNetworks",
17308     "group": "Networks",
17309     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17310     "version": "0.0.0",
17311     "filename": "server/api/network/index.js",
17312     "groupTitle": "Networks"
17313   },
17314   {
17315     "type": "get",
17316     "url": "/api/networks/{id}",
17317     "title": "Gets a single Network",
17318     "examples": [
17319       {
17320         "title": "Example usage:",
17321         "content": "curl https://{domain}/api/networks/{id} -v -u {name}:{password}",
17322         "type": "json"
17323       }
17324     ],
17325     "name": "ShowNetworks",
17326     "group": "Networks",
17327     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17328     "version": "0.0.0",
17329     "filename": "server/api/network/index.js",
17330     "groupTitle": "Networks"
17331   },
17332   {
17333     "type": "put",
17334     "url": "/api/voice/networks/{id}",
17335     "title": "Update an existing network",
17336     "examples": [
17337       {
17338         "title": "Example usage:",
17339         "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X PUT",
17340         "type": "json"
17341       }
17342     ],
17343     "name": "Update",
17344     "group": "Networks",
17345     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17346     "version": "0.0.0",
17347     "filename": "server/api/network/index.js",
17348     "groupTitle": "Networks"
17349   },
17350   {
17351     "type": "post",
17352     "url": "/api/openchannel/accounts/{id}/users",
17353     "title": "Add agents to a openchannel account",
17354     "examples": [
17355       {
17356         "title": "Example usage:",
17357         "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",
17358         "type": "json"
17359       }
17360     ],
17361     "name": "AddAgents",
17362     "group": "Openchannel_Accounts",
17363     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17364     "version": "0.0.0",
17365     "filename": "server/api/openchannelAccount/index.js",
17366     "groupTitle": "Openchannel_Accounts"
17367   },
17368   {
17369     "type": "post",
17370     "url": "/api/openchannel/accounts",
17371     "title": "Creates a new Account",
17372     "examples": [
17373       {
17374         "title": "Example usage:",
17375         "content": "curl https://{domain}/api/openchannel/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17376         "type": "json"
17377       }
17378     ],
17379     "name": "CreateAccounts",
17380     "group": "Openchannel_Accounts",
17381     "parameter": {
17382       "fields": {
17383         "Body": [
17384           {
17385             "group": "Body",
17386             "type": "String",
17387             "optional": false,
17388             "field": "name",
17389             "description": ""
17390           },
17391           {
17392             "group": "Body",
17393             "type": "String",
17394             "optional": true,
17395             "field": "description",
17396             "description": ""
17397           },
17398           {
17399             "group": "Body",
17400             "type": "String",
17401             "optional": true,
17402             "field": "token",
17403             "description": ""
17404           },
17405           {
17406             "group": "Body",
17407             "type": "String",
17408             "optional": true,
17409             "field": "replyUri",
17410             "description": ""
17411           },
17412           {
17413             "group": "Body",
17414             "type": "String",
17415             "optional": false,
17416             "field": "key",
17417             "description": ""
17418           },
17419           {
17420             "group": "Body",
17421             "type": "Text",
17422             "optional": true,
17423             "field": "notificationTemplate",
17424             "description": ""
17425           },
17426           {
17427             "group": "Body",
17428             "type": "Boolean",
17429             "optional": true,
17430             "field": "notificationSound",
17431             "description": ""
17432           },
17433           {
17434             "group": "Body",
17435             "type": "Boolean",
17436             "optional": true,
17437             "field": "notificationShake",
17438             "description": ""
17439           },
17440           {
17441             "group": "Body",
17442             "type": "Integer",
17443             "optional": true,
17444             "field": "waitForTheAssignedAgent",
17445             "description": ""
17446           },
17447           {
17448             "group": "Body",
17449             "type": "String",
17450             "optional": true,
17451             "field": "mapKey",
17452             "description": ""
17453           },
17454           {
17455             "group": "Body",
17456             "type": "Boolean",
17457             "optional": true,
17458             "field": "queueTransfer",
17459             "description": ""
17460           },
17461           {
17462             "group": "Body",
17463             "type": "Integer",
17464             "optional": true,
17465             "field": "queueTransferTimeout",
17466             "description": ""
17467           },
17468           {
17469             "group": "Body",
17470             "type": "Boolean",
17471             "optional": true,
17472             "field": "agentTransfer",
17473             "description": ""
17474           },
17475           {
17476             "group": "Body",
17477             "type": "Integer",
17478             "optional": true,
17479             "field": "agentTransferTimeout",
17480             "description": ""
17481           },
17482           {
17483             "group": "Body",
17484             "type": "Integer",
17485             "optional": true,
17486             "field": "mandatoryDispositionPauseId",
17487             "description": "<p>Status to put when mandatory disposition is enabled</p>"
17488           },
17489           {
17490             "group": "Body",
17491             "type": "Boolean",
17492             "optional": true,
17493             "field": "mandatoryDisposition",
17494             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
17495           }
17496         ]
17497       }
17498     },
17499     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17500     "version": "0.0.0",
17501     "filename": "server/api/openchannelAccount/index.js",
17502     "groupTitle": "Openchannel_Accounts"
17503   },
17504   {
17505     "type": "delete",
17506     "url": "/api/openchannel/accounts/{id}",
17507     "title": "Deletes a Account",
17508     "examples": [
17509       {
17510         "title": "Example usage:",
17511         "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password} -X DELETE",
17512         "type": "json"
17513       }
17514     ],
17515     "name": "DeleteAccounts",
17516     "group": "Openchannel_Accounts",
17517     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17518     "version": "0.0.0",
17519     "filename": "server/api/openchannelAccount/index.js",
17520     "groupTitle": "Openchannel_Accounts"
17521   },
17522   {
17523     "type": "get",
17524     "url": "/api/openchannel/accounts/describe",
17525     "title": "Gets table info about Accounts",
17526     "examples": [
17527       {
17528         "title": "Example usage:",
17529         "content": "curl https://{domain}/api/openchannel/accounts/describe -v -u {name}:{password}",
17530         "type": "json"
17531       }
17532     ],
17533     "name": "DescribeAccounts",
17534     "group": "Openchannel_Accounts",
17535     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17536     "version": "0.0.0",
17537     "filename": "server/api/openchannelAccount/index.js",
17538     "groupTitle": "Openchannel_Accounts"
17539   },
17540   {
17541     "type": "get",
17542     "url": "/api/openchannel/accounts",
17543     "title": "Gets a list of Accounts",
17544     "examples": [
17545       {
17546         "title": "Example usage:",
17547         "content": "curl https://{domain}/api/openchannel/accounts -v -u {name}:{password}",
17548         "type": "json"
17549       }
17550     ],
17551     "name": "GetAccounts",
17552     "group": "Openchannel_Accounts",
17553     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17554     "version": "0.0.0",
17555     "filename": "server/api/openchannelAccount/index.js",
17556     "groupTitle": "Openchannel_Accounts"
17557   },
17558   {
17559     "type": "get",
17560     "url": "/api/openchannel/accounts/{id}/users",
17561     "title": "Gets agents from openchannel account",
17562     "examples": [
17563       {
17564         "title": "Example usage:",
17565         "content": "curl https://{domain}/api/openchannel/accounts/{id}/users -v -u {name}:{password} -X GET",
17566         "type": "json"
17567       }
17568     ],
17569     "name": "GetAgents",
17570     "group": "Openchannel_Accounts",
17571     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17572     "version": "0.0.0",
17573     "filename": "server/api/openchannelAccount/index.js",
17574     "groupTitle": "Openchannel_Accounts"
17575   },
17576   {
17577     "type": "delete",
17578     "url": "/api/openchannel/accounts/{id}/users",
17579     "title": "Removes agents from a openchannel account",
17580     "examples": [
17581       {
17582         "title": "Example usage:",
17583         "content": "curl https://{domain}/api/openchannel/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17584         "type": "json"
17585       }
17586     ],
17587     "name": "RemoveAgents",
17588     "group": "Openchannel_Accounts",
17589     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17590     "version": "0.0.0",
17591     "filename": "server/api/openchannelAccount/index.js",
17592     "groupTitle": "Openchannel_Accounts"
17593   },
17594   {
17595     "type": "delete",
17596     "url": "/api/openchannel/accounts/{id}/canned_answers",
17597     "title": "Removes canned answers from account",
17598     "examples": [
17599       {
17600         "title": "Example usage:",
17601         "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17602         "type": "json"
17603       }
17604     ],
17605     "name": "RemoveAnswers",
17606     "group": "Openchannel_Accounts",
17607     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17608     "version": "0.0.0",
17609     "filename": "server/api/openchannelAccount/index.js",
17610     "groupTitle": "Openchannel_Accounts"
17611   },
17612   {
17613     "type": "delete",
17614     "url": "/api/openchannel/accounts/{id}/dispositions",
17615     "title": "Removes dispositions from account",
17616     "examples": [
17617       {
17618         "title": "Example usage:",
17619         "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17620         "type": "json"
17621       }
17622     ],
17623     "name": "RemoveDispositions",
17624     "group": "Openchannel_Accounts",
17625     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17626     "version": "0.0.0",
17627     "filename": "server/api/openchannelAccount/index.js",
17628     "groupTitle": "Openchannel_Accounts"
17629   },
17630   {
17631     "type": "get",
17632     "url": "/api/openchannel/accounts/{id}",
17633     "title": "Gets a single Account",
17634     "examples": [
17635       {
17636         "title": "Example usage:",
17637         "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password}",
17638         "type": "json"
17639       }
17640     ],
17641     "name": "ShowAccounts",
17642     "group": "Openchannel_Accounts",
17643     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17644     "version": "0.0.0",
17645     "filename": "server/api/openchannelAccount/index.js",
17646     "groupTitle": "Openchannel_Accounts"
17647   },
17648   {
17649     "type": "post",
17650     "url": "/api/openchannel/accounts/{id}/canned_answers",
17651     "title": "Creates new canned answer",
17652     "examples": [
17653       {
17654         "title": "Example usage:",
17655         "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",
17656         "type": "json"
17657       }
17658     ],
17659     "name": "addAnswer",
17660     "group": "Openchannel_Accounts",
17661     "parameter": {
17662       "fields": {
17663         "Body": [
17664           {
17665             "group": "Body",
17666             "type": "String",
17667             "optional": false,
17668             "field": "key",
17669             "description": ""
17670           },
17671           {
17672             "group": "Body",
17673             "type": "Text",
17674             "optional": false,
17675             "field": "value",
17676             "description": ""
17677           },
17678           {
17679             "group": "Body",
17680             "type": "String",
17681             "optional": true,
17682             "field": "description",
17683             "description": ""
17684           },
17685           {
17686             "group": "Body",
17687             "type": "Virtual",
17688             "optional": true,
17689             "field": "name",
17690             "description": ""
17691           }
17692         ]
17693       }
17694     },
17695     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17696     "version": "0.0.0",
17697     "filename": "server/api/openchannelAccount/index.js",
17698     "groupTitle": "Openchannel_Accounts"
17699   },
17700   {
17701     "type": "post",
17702     "url": "/api/openchannel/accounts/{id}/applications",
17703     "title": "Creates new applications",
17704     "examples": [
17705       {
17706         "title": "Example usage:",
17707         "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17708         "type": "json"
17709       }
17710     ],
17711     "name": "addApplications",
17712     "group": "Openchannel_Accounts",
17713     "parameter": {
17714       "fields": {
17715         "Body": [
17716           {
17717             "group": "Body",
17718             "type": "Integer",
17719             "optional": false,
17720             "field": "priority",
17721             "description": ""
17722           },
17723           {
17724             "group": "Body",
17725             "type": "String",
17726             "optional": false,
17727             "field": "app",
17728             "description": ""
17729           },
17730           {
17731             "group": "Body",
17732             "type": "Text",
17733             "optional": true,
17734             "field": "appdata",
17735             "description": ""
17736           },
17737           {
17738             "group": "Body",
17739             "type": "String",
17740             "optional": true,
17741             "field": "description",
17742             "description": ""
17743           },
17744           {
17745             "group": "Body",
17746             "type": "String",
17747             "optional": true,
17748             "field": "interval",
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": "post",
17761     "url": "/api/openchannel/accounts/{id}/dispositions",
17762     "title": "Creates new disposition",
17763     "examples": [
17764       {
17765         "title": "Example usage:",
17766         "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17767         "type": "json"
17768       }
17769     ],
17770     "name": "addDisposition",
17771     "group": "Openchannel_Accounts",
17772     "parameter": {
17773       "fields": {
17774         "Body": [
17775           {
17776             "group": "Body",
17777             "type": "String",
17778             "optional": false,
17779             "field": "name",
17780             "description": ""
17781           },
17782           {
17783             "group": "Body",
17784             "type": "String",
17785             "allowedValues": [
17786               "\"first\"",
17787               "\"second\"",
17788               "\"third\""
17789             ],
17790             "optional": false,
17791             "field": "level",
17792             "description": ""
17793           },
17794           {
17795             "group": "Body",
17796             "type": "String",
17797             "optional": true,
17798             "field": "description",
17799             "description": ""
17800           }
17801         ]
17802       }
17803     },
17804     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17805     "version": "0.0.0",
17806     "filename": "server/api/openchannelAccount/index.js",
17807     "groupTitle": "Openchannel_Accounts"
17808   },
17809   {
17810     "type": "get",
17811     "url": "/api/openchannel/accounts/{id}/canned_answers",
17812     "title": "Gets account canned answers",
17813     "examples": [
17814       {
17815         "title": "Example usage:",
17816         "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
17817         "type": "json"
17818       }
17819     ],
17820     "name": "getAnswers",
17821     "group": "Openchannel_Accounts",
17822     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17823     "version": "0.0.0",
17824     "filename": "server/api/openchannelAccount/index.js",
17825     "groupTitle": "Openchannel_Accounts"
17826   },
17827   {
17828     "type": "get",
17829     "url": "/api/openchannel/accounts/{id}/applications",
17830     "title": "Gets account applications",
17831     "examples": [
17832       {
17833         "title": "Example usage:",
17834         "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -v -u {name}:{password} -X GET",
17835         "type": "json"
17836       }
17837     ],
17838     "name": "getApplications",
17839     "group": "Openchannel_Accounts",
17840     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17841     "version": "0.0.0",
17842     "filename": "server/api/openchannelAccount/index.js",
17843     "groupTitle": "Openchannel_Accounts"
17844   },
17845   {
17846     "type": "get",
17847     "url": "/api/openchannel/accounts/{id}/dispositions",
17848     "title": "Gets account dispositions",
17849     "examples": [
17850       {
17851         "title": "Example usage:",
17852         "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
17853         "type": "json"
17854       }
17855     ],
17856     "name": "getDispositions",
17857     "group": "Openchannel_Accounts",
17858     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17859     "version": "0.0.0",
17860     "filename": "server/api/openchannelAccount/index.js",
17861     "groupTitle": "Openchannel_Accounts"
17862   },
17863   {
17864     "type": "get",
17865     "url": "/api/openchannel/accounts/{id}/interactions",
17866     "title": "Gets Openchannel Account Interactions",
17867     "examples": [
17868       {
17869         "title": "Example usage:",
17870         "content": "curl https://{domain}/api/openchannel/accounts/{id}/interactions -v -u {name}:{password} -X GET",
17871         "type": "json"
17872       }
17873     ],
17874     "name": "getInteractions",
17875     "group": "Openchannel_Accounts",
17876     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17877     "version": "0.0.0",
17878     "filename": "server/api/openchannelAccount/index.js",
17879     "groupTitle": "Openchannel_Accounts"
17880   },
17881   {
17882     "type": "post",
17883     "url": "/api/openchannel/accounts/{id}/notify",
17884     "title": "Notify new message",
17885     "examples": [
17886       {
17887         "title": "Example usage:",
17888         "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",
17889         "type": "json"
17890       }
17891     ],
17892     "name": "notify",
17893     "group": "Openchannel_Accounts",
17894     "description": "<p>Motion 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>",
17895     "version": "0.0.0",
17896     "filename": "server/api/openchannelAccount/index.js",
17897     "groupTitle": "Openchannel_Accounts"
17898   },
17899   {
17900     "type": "post",
17901     "url": "/api/openchannel/accounts/{id}/send",
17902     "title": "Send new openchannel message",
17903     "examples": [
17904       {
17905         "title": "Example usage:",
17906         "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",
17907         "type": "json"
17908       }
17909     ],
17910     "name": "sendOpenchannel",
17911     "group": "Openchannel_Accounts",
17912     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17913     "version": "0.0.0",
17914     "filename": "server/api/openchannelAccount/index.js",
17915     "groupTitle": "Openchannel_Accounts"
17916   },
17917   {
17918     "type": "put",
17919     "url": "/api/openchannel/accounts/{id}",
17920     "title": "Update an existing Account",
17921     "examples": [
17922       {
17923         "title": "Example usage:",
17924         "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",
17925         "type": "json"
17926       }
17927     ],
17928     "name": "updateAccounts",
17929     "group": "Openchannel_Accounts",
17930     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17931     "version": "0.0.0",
17932     "filename": "server/api/openchannelAccount/index.js",
17933     "groupTitle": "Openchannel_Accounts"
17934   },
17935   {
17936     "type": "post",
17937     "url": "/api/openchannel/applications",
17938     "title": "Creates a new Application",
17939     "examples": [
17940       {
17941         "title": "Example usage:",
17942         "content": "curl https://{domain}/api/openchannel/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17943         "type": "json"
17944       }
17945     ],
17946     "name": "CreateApplications",
17947     "group": "Openchannel_Applications",
17948     "parameter": {
17949       "fields": {
17950         "Body": [
17951           {
17952             "group": "Body",
17953             "type": "Integer",
17954             "optional": false,
17955             "field": "priority",
17956             "description": ""
17957           },
17958           {
17959             "group": "Body",
17960             "type": "String",
17961             "optional": false,
17962             "field": "app",
17963             "description": ""
17964           },
17965           {
17966             "group": "Body",
17967             "type": "Text",
17968             "optional": true,
17969             "field": "appdata",
17970             "description": ""
17971           },
17972           {
17973             "group": "Body",
17974             "type": "String",
17975             "optional": true,
17976             "field": "description",
17977             "description": ""
17978           },
17979           {
17980             "group": "Body",
17981             "type": "String",
17982             "optional": true,
17983             "field": "interval",
17984             "description": ""
17985           }
17986         ]
17987       }
17988     },
17989     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17990     "version": "0.0.0",
17991     "filename": "server/api/openchannelApplication/index.js",
17992     "groupTitle": "Openchannel_Applications"
17993   },
17994   {
17995     "type": "delete",
17996     "url": "/api/openchannel/applications/{id}",
17997     "title": "Deletes a Application",
17998     "examples": [
17999       {
18000         "title": "Example usage:",
18001         "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password} -X DELETE",
18002         "type": "json"
18003       }
18004     ],
18005     "name": "DeleteApplications",
18006     "group": "Openchannel_Applications",
18007     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18008     "version": "0.0.0",
18009     "filename": "server/api/openchannelApplication/index.js",
18010     "groupTitle": "Openchannel_Applications"
18011   },
18012   {
18013     "type": "get",
18014     "url": "/api/openchannel/applications",
18015     "title": "Gets a list of Applications",
18016     "examples": [
18017       {
18018         "title": "Example usage:",
18019         "content": "curl https://{domain}/api/openchannel/applications -v -u {name}:{password}",
18020         "type": "json"
18021       }
18022     ],
18023     "name": "GetApplications",
18024     "group": "Openchannel_Applications",
18025     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18026     "version": "0.0.0",
18027     "filename": "server/api/openchannelApplication/index.js",
18028     "groupTitle": "Openchannel_Applications"
18029   },
18030   {
18031     "type": "get",
18032     "url": "/api/openchannel/applications/{id}",
18033     "title": "Gets a single Application",
18034     "examples": [
18035       {
18036         "title": "Example usage:",
18037         "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password}",
18038         "type": "json"
18039       }
18040     ],
18041     "name": "ShowApplications",
18042     "group": "Openchannel_Applications",
18043     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18044     "version": "0.0.0",
18045     "filename": "server/api/openchannelApplication/index.js",
18046     "groupTitle": "Openchannel_Applications"
18047   },
18048   {
18049     "type": "put",
18050     "url": "/api/openchannel/applications/{id}",
18051     "title": "Update an existing Application",
18052     "examples": [
18053       {
18054         "title": "Example usage:",
18055         "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",
18056         "type": "json"
18057       }
18058     ],
18059     "name": "updateApplications",
18060     "group": "Openchannel_Applications",
18061     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18062     "version": "0.0.0",
18063     "filename": "server/api/openchannelApplication/index.js",
18064     "groupTitle": "Openchannel_Applications"
18065   },
18066   {
18067     "type": "post",
18068     "url": "/api/openchannel/interactions/{id}/tags",
18069     "title": "Add tags to the interaction",
18070     "examples": [
18071       {
18072         "title": "Example usage:",
18073         "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",
18074         "type": "json"
18075       }
18076     ],
18077     "name": "AddTags",
18078     "group": "Openchannel_Interactions",
18079     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18080     "version": "0.0.0",
18081     "filename": "server/api/openchannelInteraction/index.js",
18082     "groupTitle": "Openchannel_Interactions"
18083   },
18084   {
18085     "type": "post",
18086     "url": "/api/openchannel/interactions",
18087     "title": "Creates a new Interaction",
18088     "examples": [
18089       {
18090         "title": "Example usage:",
18091         "content": "curl https://{domain}/api/openchannel/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18092         "type": "json"
18093       }
18094     ],
18095     "name": "CreateInteractions",
18096     "group": "Openchannel_Interactions",
18097     "parameter": {
18098       "fields": {
18099         "Body": [
18100           {
18101             "group": "Body",
18102             "type": "Boolean",
18103             "optional": true,
18104             "field": "closed",
18105             "description": ""
18106           },
18107           {
18108             "group": "Body",
18109             "type": "String",
18110             "optional": true,
18111             "field": "closedAt",
18112             "description": ""
18113           },
18114           {
18115             "group": "Body",
18116             "type": "String",
18117             "optional": true,
18118             "field": "disposition",
18119             "description": ""
18120           },
18121           {
18122             "group": "Body",
18123             "type": "String",
18124             "optional": true,
18125             "field": "secondDisposition",
18126             "description": ""
18127           },
18128           {
18129             "group": "Body",
18130             "type": "String",
18131             "optional": true,
18132             "field": "thirdDisposition",
18133             "description": ""
18134           },
18135           {
18136             "group": "Body",
18137             "type": "String",
18138             "optional": true,
18139             "field": "note",
18140             "description": ""
18141           },
18142           {
18143             "group": "Body",
18144             "type": "String",
18145             "optional": true,
18146             "field": "read1stAt",
18147             "description": ""
18148           },
18149           {
18150             "group": "Body",
18151             "type": "String",
18152             "optional": true,
18153             "field": "threadId",
18154             "description": ""
18155           },
18156           {
18157             "group": "Body",
18158             "type": "String",
18159             "optional": true,
18160             "field": "externalUrl",
18161             "description": ""
18162           },
18163           {
18164             "group": "Body",
18165             "type": "String",
18166             "optional": true,
18167             "field": "lastMsgAt",
18168             "description": ""
18169           },
18170           {
18171             "group": "Body",
18172             "type": "String",
18173             "allowedValues": [
18174               "\"in\"",
18175               "\"out\""
18176             ],
18177             "optional": false,
18178             "field": "lastMsgDirection",
18179             "description": ""
18180           },
18181           {
18182             "group": "Body",
18183             "type": "String",
18184             "optional": true,
18185             "field": "from",
18186             "description": ""
18187           },
18188           {
18189             "group": "Body",
18190             "type": "Boolean",
18191             "optional": true,
18192             "field": "autoreplyExecuted",
18193             "description": ""
18194           }
18195         ]
18196       }
18197     },
18198     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18199     "version": "0.0.0",
18200     "filename": "server/api/openchannelInteraction/index.js",
18201     "groupTitle": "Openchannel_Interactions"
18202   },
18203   {
18204     "type": "delete",
18205     "url": "/api/openchannel/interactions/{id}",
18206     "title": "Deletes a Interaction",
18207     "examples": [
18208       {
18209         "title": "Example usage:",
18210         "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password} -X DELETE",
18211         "type": "json"
18212       }
18213     ],
18214     "name": "DeleteInteractions",
18215     "group": "Openchannel_Interactions",
18216     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18217     "version": "0.0.0",
18218     "filename": "server/api/openchannelInteraction/index.js",
18219     "groupTitle": "Openchannel_Interactions"
18220   },
18221   {
18222     "type": "get",
18223     "url": "/api/openchannel/interactions/describe",
18224     "title": "Gets table info about Interactions",
18225     "examples": [
18226       {
18227         "title": "Example usage:",
18228         "content": "curl https://{domain}/api/openchannel/interactions/describe -v -u {name}:{password}",
18229         "type": "json"
18230       }
18231     ],
18232     "name": "DescribeInteractions",
18233     "group": "Openchannel_Interactions",
18234     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18235     "version": "0.0.0",
18236     "filename": "server/api/openchannelInteraction/index.js",
18237     "groupTitle": "Openchannel_Interactions"
18238   },
18239   {
18240     "type": "get",
18241     "url": "/api/openchannel/interactions",
18242     "title": "Gets a list of Interactions",
18243     "examples": [
18244       {
18245         "title": "Example usage:",
18246         "content": "curl https://{domain}/api/openchannel/interactions -v -u {name}:{password}",
18247         "type": "json"
18248       }
18249     ],
18250     "name": "GetInteractions",
18251     "group": "Openchannel_Interactions",
18252     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18253     "version": "0.0.0",
18254     "filename": "server/api/openchannelInteraction/index.js",
18255     "groupTitle": "Openchannel_Interactions"
18256   },
18257   {
18258     "type": "delete",
18259     "url": "/api/openchannel/interactions/{id}/tags",
18260     "title": "Removes tags from interaction",
18261     "examples": [
18262       {
18263         "title": "Example usage:",
18264         "content": "curl https://{domain}/api/openchannel/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
18265         "type": "json"
18266       }
18267     ],
18268     "name": "RemoveTags",
18269     "group": "Openchannel_Interactions",
18270     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18271     "version": "0.0.0",
18272     "filename": "server/api/openchannelInteraction/index.js",
18273     "groupTitle": "Openchannel_Interactions"
18274   },
18275   {
18276     "type": "get",
18277     "url": "/api/openchannel/interactions/{id}",
18278     "title": "Gets a single Interaction",
18279     "examples": [
18280       {
18281         "title": "Example usage:",
18282         "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password}",
18283         "type": "json"
18284       }
18285     ],
18286     "name": "ShowInteractions",
18287     "group": "Openchannel_Interactions",
18288     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18289     "version": "0.0.0",
18290     "filename": "server/api/openchannelInteraction/index.js",
18291     "groupTitle": "Openchannel_Interactions"
18292   },
18293   {
18294     "type": "post",
18295     "url": "/api/openchannel/interactions/{id}/messages",
18296     "title": "Creates new messages",
18297     "examples": [
18298       {
18299         "title": "Example usage:",
18300         "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
18301         "type": "json"
18302       }
18303     ],
18304     "name": "addMessage",
18305     "group": "Openchannel_Interactions",
18306     "parameter": {
18307       "fields": {
18308         "Body": [
18309           {
18310             "group": "Body",
18311             "type": "Text",
18312             "optional": false,
18313             "field": "body",
18314             "description": ""
18315           },
18316           {
18317             "group": "Body",
18318             "type": "Boolean",
18319             "optional": true,
18320             "field": "read",
18321             "description": ""
18322           },
18323           {
18324             "group": "Body",
18325             "type": "Boolean",
18326             "optional": true,
18327             "field": "secret",
18328             "description": ""
18329           },
18330           {
18331             "group": "Body",
18332             "type": "String",
18333             "allowedValues": [
18334               "\"in\"",
18335               "\"out\""
18336             ],
18337             "optional": false,
18338             "field": "direction",
18339             "description": ""
18340           },
18341           {
18342             "group": "Body",
18343             "type": "String",
18344             "optional": true,
18345             "field": "readAt",
18346             "description": ""
18347           },
18348           {
18349             "group": "Body",
18350             "type": "String",
18351             "optional": true,
18352             "field": "providerName",
18353             "description": ""
18354           },
18355           {
18356             "group": "Body",
18357             "type": "Text",
18358             "optional": true,
18359             "field": "providerResponse",
18360             "description": ""
18361           }
18362         ]
18363       }
18364     },
18365     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18366     "version": "0.0.0",
18367     "filename": "server/api/openchannelInteraction/index.js",
18368     "groupTitle": "Openchannel_Interactions"
18369   },
18370   {
18371     "type": "get",
18372     "url": "/api/openchannel/interactions/{id}/download",
18373     "title": "Gets interaction",
18374     "examples": [
18375       {
18376         "title": "Example usage:",
18377         "content": "curl https://{domain}/api/openchannel/interactions/{id}/download -v -u {name}:{password} -X GET",
18378         "type": "json"
18379       }
18380     ],
18381     "name": "download",
18382     "group": "Openchannel_Interactions",
18383     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18384     "version": "0.0.0",
18385     "filename": "server/api/openchannelInteraction/index.js",
18386     "groupTitle": "Openchannel_Interactions"
18387   },
18388   {
18389     "type": "get",
18390     "url": "/api/openchannel/interactions/{id}/messages",
18391     "title": "Gets interaction messages",
18392     "examples": [
18393       {
18394         "title": "Example usage:",
18395         "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -v -u {name}:{password} -X GET",
18396         "type": "json"
18397       }
18398     ],
18399     "name": "getMessages",
18400     "group": "Openchannel_Interactions",
18401     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18402     "version": "0.0.0",
18403     "filename": "server/api/openchannelInteraction/index.js",
18404     "groupTitle": "Openchannel_Interactions"
18405   },
18406   {
18407     "type": "put",
18408     "url": "/api/openchannel/interactions/{id}",
18409     "title": "Update an existing Interaction",
18410     "examples": [
18411       {
18412         "title": "Example usage:",
18413         "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",
18414         "type": "json"
18415       }
18416     ],
18417     "name": "updateInteractions",
18418     "group": "Openchannel_Interactions",
18419     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18420     "version": "0.0.0",
18421     "filename": "server/api/openchannelInteraction/index.js",
18422     "groupTitle": "Openchannel_Interactions"
18423   },
18424   {
18425     "type": "post",
18426     "url": "/api/openchannel/messages",
18427     "title": "Creates a new Message",
18428     "examples": [
18429       {
18430         "title": "Example usage:",
18431         "content": "curl https://{domain}/api/openchannel/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18432         "type": "json"
18433       }
18434     ],
18435     "name": "CreateMessages",
18436     "group": "Openchannel_Messages",
18437     "parameter": {
18438       "fields": {
18439         "Body": [
18440           {
18441             "group": "Body",
18442             "type": "Text",
18443             "optional": false,
18444             "field": "body",
18445             "description": ""
18446           },
18447           {
18448             "group": "Body",
18449             "type": "Boolean",
18450             "optional": true,
18451             "field": "read",
18452             "description": ""
18453           },
18454           {
18455             "group": "Body",
18456             "type": "Boolean",
18457             "optional": true,
18458             "field": "secret",
18459             "description": ""
18460           },
18461           {
18462             "group": "Body",
18463             "type": "String",
18464             "allowedValues": [
18465               "\"in\"",
18466               "\"out\""
18467             ],
18468             "optional": false,
18469             "field": "direction",
18470             "description": ""
18471           },
18472           {
18473             "group": "Body",
18474             "type": "String",
18475             "optional": true,
18476             "field": "readAt",
18477             "description": ""
18478           },
18479           {
18480             "group": "Body",
18481             "type": "String",
18482             "optional": true,
18483             "field": "providerName",
18484             "description": ""
18485           },
18486           {
18487             "group": "Body",
18488             "type": "Text",
18489             "optional": true,
18490             "field": "providerResponse",
18491             "description": ""
18492           }
18493         ]
18494       }
18495     },
18496     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18497     "version": "0.0.0",
18498     "filename": "server/api/openchannelMessage/index.js",
18499     "groupTitle": "Openchannel_Messages"
18500   },
18501   {
18502     "type": "delete",
18503     "url": "/api/openchannel/messages/{id}",
18504     "title": "Deletes a Message",
18505     "examples": [
18506       {
18507         "title": "Example usage:",
18508         "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password} -X DELETE",
18509         "type": "json"
18510       }
18511     ],
18512     "name": "DeleteMessages",
18513     "group": "Openchannel_Messages",
18514     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18515     "version": "0.0.0",
18516     "filename": "server/api/openchannelMessage/index.js",
18517     "groupTitle": "Openchannel_Messages"
18518   },
18519   {
18520     "type": "get",
18521     "url": "/api/openchannel/messages/describe",
18522     "title": "Gets table info about Messages",
18523     "examples": [
18524       {
18525         "title": "Example usage:",
18526         "content": "curl https://{domain}/api/openchannel/messages/describe -v -u {name}:{password}",
18527         "type": "json"
18528       }
18529     ],
18530     "name": "DescribeMessages",
18531     "group": "Openchannel_Messages",
18532     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18533     "version": "0.0.0",
18534     "filename": "server/api/openchannelMessage/index.js",
18535     "groupTitle": "Openchannel_Messages"
18536   },
18537   {
18538     "type": "get",
18539     "url": "/api/openchannel/messages",
18540     "title": "Gets a list of Messages",
18541     "examples": [
18542       {
18543         "title": "Example usage:",
18544         "content": "curl https://{domain}/api/openchannel/messages -v -u {name}:{password}",
18545         "type": "json"
18546       }
18547     ],
18548     "name": "GetMessages",
18549     "group": "Openchannel_Messages",
18550     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18551     "version": "0.0.0",
18552     "filename": "server/api/openchannelMessage/index.js",
18553     "groupTitle": "Openchannel_Messages"
18554   },
18555   {
18556     "type": "get",
18557     "url": "/api/openchannel/messages/{id}",
18558     "title": "Gets a single Message",
18559     "examples": [
18560       {
18561         "title": "Example usage:",
18562         "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password}",
18563         "type": "json"
18564       }
18565     ],
18566     "name": "ShowMessages",
18567     "group": "Openchannel_Messages",
18568     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18569     "version": "0.0.0",
18570     "filename": "server/api/openchannelMessage/index.js",
18571     "groupTitle": "Openchannel_Messages"
18572   },
18573   {
18574     "type": "put",
18575     "url": "/api/openchannel/messages/{id}/accept",
18576     "title": "Accepts message",
18577     "examples": [
18578       {
18579         "title": "Example usage:",
18580         "content": "curl https://{domain}/api/openchannel/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
18581         "type": "json"
18582       }
18583     ],
18584     "name": "acceptMessage",
18585     "group": "Openchannel_Messages",
18586     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18587     "version": "0.0.0",
18588     "filename": "server/api/openchannelMessage/index.js",
18589     "groupTitle": "Openchannel_Messages"
18590   },
18591   {
18592     "type": "put",
18593     "url": "/api/openchannel/messages/{id}/reject",
18594     "title": "Rejects message",
18595     "examples": [
18596       {
18597         "title": "Example usage:",
18598         "content": "curl https://{domain}/api/openchannel/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
18599         "type": "json"
18600       }
18601     ],
18602     "name": "rejectMessage",
18603     "group": "Openchannel_Messages",
18604     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18605     "version": "0.0.0",
18606     "filename": "server/api/openchannelMessage/index.js",
18607     "groupTitle": "Openchannel_Messages"
18608   },
18609   {
18610     "type": "put",
18611     "url": "/api/openchannel/messages/{id}",
18612     "title": "Update an existing Message",
18613     "examples": [
18614       {
18615         "title": "Example usage:",
18616         "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",
18617         "type": "json"
18618       }
18619     ],
18620     "name": "updateMessages",
18621     "group": "Openchannel_Messages",
18622     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18623     "version": "0.0.0",
18624     "filename": "server/api/openchannelMessage/index.js",
18625     "groupTitle": "Openchannel_Messages"
18626   },
18627   {
18628     "type": "post",
18629     "url": "/api/openchannel/reports/queue",
18630     "title": "Creates a new Openchannel Queue Report",
18631     "examples": [
18632       {
18633         "title": "Example usage:",
18634         "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",
18635         "type": "json"
18636       }
18637     ],
18638     "name": "CreateOpenchannel_Queue_Reports",
18639     "group": "Openchannel_Queue_Reports",
18640     "parameter": {
18641       "fields": {
18642         "Body": [
18643           {
18644             "group": "Body",
18645             "type": "String",
18646             "optional": false,
18647             "field": "uniqueid",
18648             "description": ""
18649           },
18650           {
18651             "group": "Body",
18652             "type": "String",
18653             "optional": true,
18654             "field": "from",
18655             "description": ""
18656           },
18657           {
18658             "group": "Body",
18659             "type": "String",
18660             "optional": true,
18661             "field": "joinAt",
18662             "description": ""
18663           },
18664           {
18665             "group": "Body",
18666             "type": "String",
18667             "optional": true,
18668             "field": "leaveAt",
18669             "description": ""
18670           },
18671           {
18672             "group": "Body",
18673             "type": "String",
18674             "optional": true,
18675             "field": "acceptAt",
18676             "description": ""
18677           },
18678           {
18679             "group": "Body",
18680             "type": "String",
18681             "optional": true,
18682             "field": "exitAt",
18683             "description": ""
18684           },
18685           {
18686             "group": "Body",
18687             "type": "String",
18688             "optional": true,
18689             "field": "reason",
18690             "description": ""
18691           }
18692         ]
18693       }
18694     },
18695     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18696     "version": "0.0.0",
18697     "filename": "server/api/openchannelQueueReport/index.js",
18698     "groupTitle": "Openchannel_Queue_Reports"
18699   },
18700   {
18701     "type": "delete",
18702     "url": "/api/openchannel/reports/queue/{id}",
18703     "title": "Deletes a Openchannel Queue Report",
18704     "examples": [
18705       {
18706         "title": "Example usage:",
18707         "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password} -X DELETE",
18708         "type": "json"
18709       }
18710     ],
18711     "name": "DeleteOpenchannel_Queue_Reports",
18712     "group": "Openchannel_Queue_Reports",
18713     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18714     "version": "0.0.0",
18715     "filename": "server/api/openchannelQueueReport/index.js",
18716     "groupTitle": "Openchannel_Queue_Reports"
18717   },
18718   {
18719     "type": "get",
18720     "url": "/api/openchannel/reports/queue/describe",
18721     "title": "Gets table info about Openchannel Queue Reports",
18722     "examples": [
18723       {
18724         "title": "Example usage:",
18725         "content": "curl https://{domain}/api/openchannel/reports/queue/describe -v -u {name}:{password}",
18726         "type": "json"
18727       }
18728     ],
18729     "name": "DescribeOpenchannel_Queue_Reports",
18730     "group": "Openchannel_Queue_Reports",
18731     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18732     "version": "0.0.0",
18733     "filename": "server/api/openchannelQueueReport/index.js",
18734     "groupTitle": "Openchannel_Queue_Reports"
18735   },
18736   {
18737     "type": "get",
18738     "url": "/api/openchannel/reports/queue",
18739     "title": "Gets a list of Openchannel Queue Reports",
18740     "examples": [
18741       {
18742         "title": "Example usage:",
18743         "content": "curl https://{domain}/api/openchannel/reports/queue -v -u {name}:{password}",
18744         "type": "json"
18745       }
18746     ],
18747     "name": "GetOpenchannel_Queue_Reports",
18748     "group": "Openchannel_Queue_Reports",
18749     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18750     "version": "0.0.0",
18751     "filename": "server/api/openchannelQueueReport/index.js",
18752     "groupTitle": "Openchannel_Queue_Reports"
18753   },
18754   {
18755     "type": "get",
18756     "url": "/api/openchannel/reports/queue/{id}",
18757     "title": "Gets a single Openchannel Queue Report",
18758     "examples": [
18759       {
18760         "title": "Example usage:",
18761         "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password}",
18762         "type": "json"
18763       }
18764     ],
18765     "name": "ShowOpenchannel_Queue_Reports",
18766     "group": "Openchannel_Queue_Reports",
18767     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18768     "version": "0.0.0",
18769     "filename": "server/api/openchannelQueueReport/index.js",
18770     "groupTitle": "Openchannel_Queue_Reports"
18771   },
18772   {
18773     "type": "put",
18774     "url": "/api/openchannel/reports/queue/{id}",
18775     "title": "Update an existing Openchannel Queue Report",
18776     "examples": [
18777       {
18778         "title": "Example usage:",
18779         "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",
18780         "type": "json"
18781       }
18782     ],
18783     "name": "updateOpenchannel_Queue_Reports",
18784     "group": "Openchannel_Queue_Reports",
18785     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18786     "version": "0.0.0",
18787     "filename": "server/api/openchannelQueueReport/index.js",
18788     "groupTitle": "Openchannel_Queue_Reports"
18789   },
18790   {
18791     "type": "post",
18792     "url": "/api/openchannel/queues/{id}/users",
18793     "title": "Add agents to a queue",
18794     "examples": [
18795       {
18796         "title": "Example usage:",
18797         "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",
18798         "type": "json"
18799       }
18800     ],
18801     "name": "AddAgents",
18802     "group": "Openchannel_Queues",
18803     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18804     "version": "0.0.0",
18805     "filename": "server/api/openchannelQueue/index.js",
18806     "groupTitle": "Openchannel_Queues"
18807   },
18808   {
18809     "type": "post",
18810     "url": "/api/openchannel/queues/{id}/teams",
18811     "title": "Add teams to a queue",
18812     "examples": [
18813       {
18814         "title": "Example usage:",
18815         "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",
18816         "type": "json"
18817       }
18818     ],
18819     "name": "AddTeams",
18820     "group": "Openchannel_Queues",
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": "post",
18828     "url": "/api/openchannel/queues",
18829     "title": "Creates a new Queue",
18830     "examples": [
18831       {
18832         "title": "Example usage:",
18833         "content": "curl https://{domain}/api/openchannel/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18834         "type": "json"
18835       }
18836     ],
18837     "name": "CreateQueues",
18838     "group": "Openchannel_Queues",
18839     "parameter": {
18840       "fields": {
18841         "Body": [
18842           {
18843             "group": "Body",
18844             "type": "String",
18845             "optional": true,
18846             "field": "name",
18847             "description": ""
18848           },
18849           {
18850             "group": "Body",
18851             "type": "String",
18852             "optional": true,
18853             "field": "description",
18854             "description": ""
18855           },
18856           {
18857             "group": "Body",
18858             "type": "Integer",
18859             "optional": true,
18860             "field": "timeout",
18861             "description": ""
18862           },
18863           {
18864             "group": "Body",
18865             "type": "String",
18866             "allowedValues": [
18867               "\"rrmemory\"",
18868               "\"beepall\"",
18869               "\"roundrobin\""
18870             ],
18871             "optional": true,
18872             "field": "strategy",
18873             "description": ""
18874           }
18875         ]
18876       }
18877     },
18878     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18879     "version": "0.0.0",
18880     "filename": "server/api/openchannelQueue/index.js",
18881     "groupTitle": "Openchannel_Queues"
18882   },
18883   {
18884     "type": "delete",
18885     "url": "/api/openchannel/queues/{id}",
18886     "title": "Deletes a Queue",
18887     "examples": [
18888       {
18889         "title": "Example usage:",
18890         "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password} -X DELETE",
18891         "type": "json"
18892       }
18893     ],
18894     "name": "DeleteQueues",
18895     "group": "Openchannel_Queues",
18896     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18897     "version": "0.0.0",
18898     "filename": "server/api/openchannelQueue/index.js",
18899     "groupTitle": "Openchannel_Queues"
18900   },
18901   {
18902     "type": "get",
18903     "url": "/api/openchannel/queues/describe",
18904     "title": "Gets table info about Queues",
18905     "examples": [
18906       {
18907         "title": "Example usage:",
18908         "content": "curl https://{domain}/api/openchannel/queues/describe -v -u {name}:{password}",
18909         "type": "json"
18910       }
18911     ],
18912     "name": "DescribeQueues",
18913     "group": "Openchannel_Queues",
18914     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18915     "version": "0.0.0",
18916     "filename": "server/api/openchannelQueue/index.js",
18917     "groupTitle": "Openchannel_Queues"
18918   },
18919   {
18920     "type": "get",
18921     "url": "/api/openchannel/queues/{id}/users",
18922     "title": "Gets queue agents",
18923     "examples": [
18924       {
18925         "title": "Example usage:",
18926         "content": "curl https://{domain}/api/openchannel/queues/{id}/users -v -u {name}:{password} -X POST",
18927         "type": "json"
18928       }
18929     ],
18930     "name": "GetAgents",
18931     "group": "Openchannel_Queues",
18932     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18933     "version": "0.0.0",
18934     "filename": "server/api/openchannelQueue/index.js",
18935     "groupTitle": "Openchannel_Queues"
18936   },
18937   {
18938     "type": "get",
18939     "url": "/api/openchannel/queues/{id}/members",
18940     "title": "GetMembers",
18941     "examples": [
18942       {
18943         "title": "Example usage:",
18944         "content": "curl https://{domain}/api/openchannel/queues/{id}/members  -v -u {name}:{password}",
18945         "type": "json"
18946       }
18947     ],
18948     "name": "GetMembers",
18949     "group": "Openchannel_Queues",
18950     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18951     "version": "0.0.0",
18952     "filename": "server/api/openchannelQueue/index.js",
18953     "groupTitle": "Openchannel_Queues"
18954   },
18955   {
18956     "type": "get",
18957     "url": "/api/openchannel/queues",
18958     "title": "Gets a list of Queues",
18959     "examples": [
18960       {
18961         "title": "Example usage:",
18962         "content": "curl https://{domain}/api/openchannel/queues -v -u {name}:{password}",
18963         "type": "json"
18964       }
18965     ],
18966     "name": "GetQueues",
18967     "group": "Openchannel_Queues",
18968     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18969     "version": "0.0.0",
18970     "filename": "server/api/openchannelQueue/index.js",
18971     "groupTitle": "Openchannel_Queues"
18972   },
18973   {
18974     "type": "get",
18975     "url": "/api/openchannel/queues/{id}/teams",
18976     "title": "Gets queues list",
18977     "examples": [
18978       {
18979         "title": "Example usage:",
18980         "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password}",
18981         "type": "json"
18982       }
18983     ],
18984     "name": "GetTeams",
18985     "group": "Openchannel_Queues",
18986     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18987     "version": "0.0.0",
18988     "filename": "server/api/openchannelQueue/index.js",
18989     "groupTitle": "Openchannel_Queues"
18990   },
18991   {
18992     "type": "delete",
18993     "url": "/api/openchannel/queues/{id}/users",
18994     "title": "Removes agents from a queue",
18995     "examples": [
18996       {
18997         "title": "Example usage:",
18998         "content": "curl https://{domain}/api/openchannel/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
18999         "type": "json"
19000       }
19001     ],
19002     "name": "RemoveAgents",
19003     "group": "Openchannel_Queues",
19004     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19005     "version": "0.0.0",
19006     "filename": "server/api/openchannelQueue/index.js",
19007     "groupTitle": "Openchannel_Queues"
19008   },
19009   {
19010     "type": "get",
19011     "url": "/api/openchannel/queues/{id}",
19012     "title": "Gets a single Queue",
19013     "examples": [
19014       {
19015         "title": "Example usage:",
19016         "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password}",
19017         "type": "json"
19018       }
19019     ],
19020     "name": "ShowQueues",
19021     "group": "Openchannel_Queues",
19022     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19023     "version": "0.0.0",
19024     "filename": "server/api/openchannelQueue/index.js",
19025     "groupTitle": "Openchannel_Queues"
19026   },
19027   {
19028     "type": "put",
19029     "url": "/api/openchannel/queues/{id}",
19030     "title": "Update an existing Queue",
19031     "examples": [
19032       {
19033         "title": "Example usage:",
19034         "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",
19035         "type": "json"
19036       }
19037     ],
19038     "name": "updateQueues",
19039     "group": "Openchannel_Queues",
19040     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19041     "version": "0.0.0",
19042     "filename": "server/api/openchannelQueue/index.js",
19043     "groupTitle": "Openchannel_Queues"
19044   },
19045   {
19046     "type": "post",
19047     "url": "/api/openchannel/reports/transfer",
19048     "title": "Creates a new Openchannel Transfer Report",
19049     "examples": [
19050       {
19051         "title": "Example usage:",
19052         "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",
19053         "type": "json"
19054       }
19055     ],
19056     "name": "CreateOpenchannel_Transfer_Reports",
19057     "group": "Openchannel_Transfer_Reports",
19058     "parameter": {
19059       "fields": {
19060         "Body": [
19061           {
19062             "group": "Body",
19063             "type": "String",
19064             "optional": false,
19065             "field": "uniqueid",
19066             "description": ""
19067           },
19068           {
19069             "group": "Body",
19070             "type": "String",
19071             "allowedValues": [
19072               "\"account\"",
19073               "\"agent\"",
19074               "\"queue\""
19075             ],
19076             "optional": false,
19077             "field": "type",
19078             "description": ""
19079           },
19080           {
19081             "group": "Body",
19082             "type": "String",
19083             "optional": false,
19084             "field": "transferredAt",
19085             "description": ""
19086           }
19087         ]
19088       }
19089     },
19090     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19091     "version": "0.0.0",
19092     "filename": "server/api/openchannelTransferReport/index.js",
19093     "groupTitle": "Openchannel_Transfer_Reports"
19094   },
19095   {
19096     "type": "delete",
19097     "url": "/api/openchannel/reports/transfer/{id}",
19098     "title": "Deletes a Openchannel Transfer Report",
19099     "examples": [
19100       {
19101         "title": "Example usage:",
19102         "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
19103         "type": "json"
19104       }
19105     ],
19106     "name": "DeleteOpenchannel_Transfer_Reports",
19107     "group": "Openchannel_Transfer_Reports",
19108     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19109     "version": "0.0.0",
19110     "filename": "server/api/openchannelTransferReport/index.js",
19111     "groupTitle": "Openchannel_Transfer_Reports"
19112   },
19113   {
19114     "type": "get",
19115     "url": "/api/openchannel/reports/transfer/describe",
19116     "title": "Gets table info about Openchannel Transfer Reports",
19117     "examples": [
19118       {
19119         "title": "Example usage:",
19120         "content": "curl https://{domain}/api/openchannel/reports/transfer/describe -v -u {name}:{password}",
19121         "type": "json"
19122       }
19123     ],
19124     "name": "DescribeOpenchannel_Transfer_Reports",
19125     "group": "Openchannel_Transfer_Reports",
19126     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19127     "version": "0.0.0",
19128     "filename": "server/api/openchannelTransferReport/index.js",
19129     "groupTitle": "Openchannel_Transfer_Reports"
19130   },
19131   {
19132     "type": "get",
19133     "url": "/api/openchannel/reports/transfer",
19134     "title": "Gets a list of Openchannel Transfer Reports",
19135     "examples": [
19136       {
19137         "title": "Example usage:",
19138         "content": "curl https://{domain}/api/openchannel/reports/transfer -v -u {name}:{password}",
19139         "type": "json"
19140       }
19141     ],
19142     "name": "GetOpenchannel_Transfer_Reports",
19143     "group": "Openchannel_Transfer_Reports",
19144     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19145     "version": "0.0.0",
19146     "filename": "server/api/openchannelTransferReport/index.js",
19147     "groupTitle": "Openchannel_Transfer_Reports"
19148   },
19149   {
19150     "type": "get",
19151     "url": "/api/openchannel/reports/transfer/{id}",
19152     "title": "Gets a single Openchannel Transfer Report",
19153     "examples": [
19154       {
19155         "title": "Example usage:",
19156         "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password}",
19157         "type": "json"
19158       }
19159     ],
19160     "name": "ShowOpenchannel_Transfer_Reports",
19161     "group": "Openchannel_Transfer_Reports",
19162     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19163     "version": "0.0.0",
19164     "filename": "server/api/openchannelTransferReport/index.js",
19165     "groupTitle": "Openchannel_Transfer_Reports"
19166   },
19167   {
19168     "type": "put",
19169     "url": "/api/openchannel/reports/transfer/{id}",
19170     "title": "Update an existing Openchannel Transfer Report",
19171     "examples": [
19172       {
19173         "title": "Example usage:",
19174         "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",
19175         "type": "json"
19176       }
19177     ],
19178     "name": "updateOpenchannel_Transfer_Reports",
19179     "group": "Openchannel_Transfer_Reports",
19180     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19181     "version": "0.0.0",
19182     "filename": "server/api/openchannelTransferReport/index.js",
19183     "groupTitle": "Openchannel_Transfer_Reports"
19184   },
19185   {
19186     "type": "post",
19187     "url": "/api/pauses",
19188     "title": "Creates a new Pause",
19189     "examples": [
19190       {
19191         "title": "Example usage:",
19192         "content": "curl https://{domain}/api/pauses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
19193         "type": "json"
19194       }
19195     ],
19196     "name": "CreatePauses",
19197     "group": "Pauses",
19198     "parameter": {
19199       "fields": {
19200         "Body": [
19201           {
19202             "group": "Body",
19203             "type": "String",
19204             "optional": false,
19205             "field": "name",
19206             "description": ""
19207           },
19208           {
19209             "group": "Body",
19210             "type": "String",
19211             "optional": true,
19212             "field": "description",
19213             "description": ""
19214           }
19215         ]
19216       }
19217     },
19218     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19219     "version": "0.0.0",
19220     "filename": "server/api/pause/index.js",
19221     "groupTitle": "Pauses"
19222   },
19223   {
19224     "type": "delete",
19225     "url": "/api/pauses/{id}",
19226     "title": "Deletes a Pause",
19227     "examples": [
19228       {
19229         "title": "Example usage:",
19230         "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password} -X DELETE",
19231         "type": "json"
19232       }
19233     ],
19234     "name": "DeletePauses",
19235     "group": "Pauses",
19236     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19237     "version": "0.0.0",
19238     "filename": "server/api/pause/index.js",
19239     "groupTitle": "Pauses"
19240   },
19241   {
19242     "type": "get",
19243     "url": "/api/pauses",
19244     "title": "Gets a list of Pauses",
19245     "examples": [
19246       {
19247         "title": "Example usage:",
19248         "content": "curl https://{domain}/api/pauses -v -u {name}:{password}",
19249         "type": "json"
19250       }
19251     ],
19252     "name": "GetPauses",
19253     "group": "Pauses",
19254     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19255     "version": "0.0.0",
19256     "filename": "server/api/pause/index.js",
19257     "groupTitle": "Pauses"
19258   },
19259   {
19260     "type": "get",
19261     "url": "/api/pauses/{id}",
19262     "title": "Gets a single Pause",
19263     "examples": [
19264       {
19265         "title": "Example usage:",
19266         "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password}",
19267         "type": "json"
19268       }
19269     ],
19270     "name": "ShowPauses",
19271     "group": "Pauses",
19272     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19273     "version": "0.0.0",
19274     "filename": "server/api/pause/index.js",
19275     "groupTitle": "Pauses"
19276   },
19277   {
19278     "type": "put",
19279     "url": "/api/pauses/{id}",
19280     "title": "Update an existing Pause",
19281     "examples": [
19282       {
19283         "title": "Example usage:",
19284         "content": "curl https://{domain}/api/pauses/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
19285         "type": "json"
19286       }
19287     ],
19288     "name": "updatePauses",
19289     "group": "Pauses",
19290     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19291     "version": "0.0.0",
19292     "filename": "server/api/pause/index.js",
19293     "groupTitle": "Pauses"
19294   },
19295   {
19296     "type": "get",
19297     "url": "/api/plugins",
19298     "title": "Gets a list of Plugins",
19299     "examples": [
19300       {
19301         "title": "Example usage:",
19302         "content": "curl https://{domain}/api/plugins -v -u {name}:{password}",
19303         "type": "json"
19304       }
19305     ],
19306     "name": "GetPlugins",
19307     "group": "Plugins",
19308     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19309     "version": "0.0.0",
19310     "filename": "server/api/plugin/index.js",
19311     "groupTitle": "Plugins"
19312   },
19313   {
19314     "type": "get",
19315     "url": "/api/plugins/{id}",
19316     "title": "Gets a single Plugin",
19317     "examples": [
19318       {
19319         "title": "Example usage:",
19320         "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password}",
19321         "type": "json"
19322       }
19323     ],
19324     "name": "ShowPlugins",
19325     "group": "Plugins",
19326     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19327     "version": "0.0.0",
19328     "filename": "server/api/plugin/index.js",
19329     "groupTitle": "Plugins"
19330   },
19331   {
19332     "type": "delete",
19333     "url": "/api/plugins/{id}",
19334     "title": "Delete a plugin",
19335     "examples": [
19336       {
19337         "title": "Example usage:",
19338         "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X DELETE",
19339         "type": "json"
19340       }
19341     ],
19342     "name": "destroyPlugin",
19343     "group": "Plugins",
19344     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19345     "version": "0.0.0",
19346     "filename": "server/api/plugin/index.js",
19347     "groupTitle": "Plugins"
19348   },
19349   {
19350     "type": "get",
19351     "url": "/api/plugins/{id}/download",
19352     "title": "Download plugin source code",
19353     "examples": [
19354       {
19355         "title": "Example usage:",
19356         "content": "curl https://{domain}/api/plugins/{id}/download -v -u {name}:{password} -X GET",
19357         "type": "json"
19358       }
19359     ],
19360     "name": "download",
19361     "group": "Plugins",
19362     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19363     "version": "0.0.0",
19364     "filename": "server/api/plugin/index.js",
19365     "groupTitle": "Plugins"
19366   },
19367   {
19368     "type": "put",
19369     "url": "/api/plugins/{id}",
19370     "title": "Update an existing plugin",
19371     "examples": [
19372       {
19373         "title": "Example usage:",
19374         "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X PUT",
19375         "type": "json"
19376       }
19377     ],
19378     "name": "updatePlugin",
19379     "group": "Plugins",
19380     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19381     "version": "0.0.0",
19382     "filename": "server/api/plugin/index.js",
19383     "groupTitle": "Plugins"
19384   },
19385   {
19386     "type": "post",
19387     "url": "/api/plugins",
19388     "title": "Upload new plugin",
19389     "examples": [
19390       {
19391         "title": "Example usage:",
19392         "content": "curl https://{domain}/api/plugins -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
19393         "type": "json"
19394       }
19395     ],
19396     "name": "uploadPlugin",
19397     "group": "Plugins",
19398     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19399     "version": "0.0.0",
19400     "filename": "server/api/plugin/index.js",
19401     "groupTitle": "Plugins"
19402   },
19403   {
19404     "type": "post",
19405     "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
19406     "title": "Redirect a plugin request to the specified path",
19407     "examples": [
19408       {
19409         "title": "Example usage:",
19410         "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -H 'Content-Type: application/json' -X POST",
19411         "type": "json"
19412       }
19413     ],
19414     "name": "webhookPlugin",
19415     "group": "Plugins",
19416     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19417     "version": "0.0.0",
19418     "filename": "server/api/plugin/index.js",
19419     "groupTitle": "Plugins"
19420   },
19421   {
19422     "type": "get",
19423     "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
19424     "title": "Redirect a plugin request to the specified path",
19425     "examples": [
19426       {
19427         "title": "Example usage:",
19428         "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -v -u {name}:{password} -X GET",
19429         "type": "json"
19430       }
19431     ],
19432     "name": "webhookPlugin",
19433     "group": "Plugins",
19434     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19435     "version": "0.0.0",
19436     "filename": "server/api/plugin/index.js",
19437     "groupTitle": "Plugins"
19438   },
19439   {
19440     "type": "delete",
19441     "url": "/api/pm2/{id}",
19442     "title": "Deletes an existing process",
19443     "examples": [
19444       {
19445         "title": "Example usage:",
19446         "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password} -X DELETE",
19447         "type": "json"
19448       }
19449     ],
19450     "name": "DeletePm2Process",
19451     "group": "Pm2",
19452     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19453     "version": "0.0.0",
19454     "filename": "server/api/pm2/index.js",
19455     "groupTitle": "Pm2"
19456   },
19457   {
19458     "type": "get",
19459     "url": "/api/pm2/{id}",
19460     "title": "Gets a single pm2 process",
19461     "examples": [
19462       {
19463         "title": "Example usage:",
19464         "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password}",
19465         "type": "json"
19466       }
19467     ],
19468     "name": "GetPm2Process",
19469     "group": "Pm2",
19470     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19471     "version": "0.0.0",
19472     "filename": "server/api/pm2/index.js",
19473     "groupTitle": "Pm2"
19474   },
19475   {
19476     "type": "get",
19477     "url": "/api/pm2",
19478     "title": "Gets pm2 processes",
19479     "examples": [
19480       {
19481         "title": "Example usage:",
19482         "content": "curl https://{domain}/api/pm2 -v -u {name}:{password}",
19483         "type": "json"
19484       }
19485     ],
19486     "name": "GetPm2Processes",
19487     "group": "Pm2",
19488     "description": "<p>Motion returns the pm2 processes list.</p>",
19489     "version": "0.0.0",
19490     "filename": "server/api/pm2/index.js",
19491     "groupTitle": "Pm2"
19492   },
19493   {
19494     "type": "post",
19495     "url": "/api/pm2",
19496     "title": "Start a single pm2 process",
19497     "examples": [
19498       {
19499         "title": "Example usage:",
19500         "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",
19501         "type": "json"
19502       }
19503     ],
19504     "name": "StartPm2Process",
19505     "group": "Pm2",
19506     "parameter": {
19507       "fields": {
19508         "Body": [
19509           {
19510             "group": "Body",
19511             "type": "String",
19512             "optional": false,
19513             "field": "name",
19514             "description": ""
19515           },
19516           {
19517             "group": "Body",
19518             "type": "String",
19519             "optional": false,
19520             "field": "script",
19521             "description": ""
19522           }
19523         ]
19524       }
19525     },
19526     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19527     "version": "0.0.0",
19528     "filename": "server/api/pm2/index.js",
19529     "groupTitle": "Pm2"
19530   },
19531   {
19532     "type": "put",
19533     "url": "/api/pm2/{id}",
19534     "title": "Update an existing process",
19535     "examples": [
19536       {
19537         "title": "Example usage:",
19538         "content": "curl https://{domain}/api/pm2/{id} -d '{\"status\": \"online\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
19539         "type": "json"
19540       }
19541     ],
19542     "name": "UpdatePm2Process",
19543     "group": "Pm2",
19544     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19545     "version": "0.0.0",
19546     "filename": "server/api/pm2/index.js",
19547     "groupTitle": "Pm2"
19548   },
19549   {
19550     "type": "get",
19551     "url": "/api/rpc/campaigns/",
19552     "title": "Gets a list of campaigns",
19553     "examples": [
19554       {
19555         "title": "Example usage:",
19556         "content": "curl https://{domain}/api/rpc/campaigns -v -u {name}:{password}",
19557         "type": "json"
19558       }
19559     ],
19560     "name": "Campaigns",
19561     "group": "RPC_Realtime",
19562     "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>",
19563     "version": "0.0.0",
19564     "filename": "server/api/rpc/index.js",
19565     "groupTitle": "RPC_Realtime"
19566   },
19567   {
19568     "type": "get",
19569     "url": "/api/rpc/fax/accounts",
19570     "title": "Gets a list of FaxAccounts",
19571     "examples": [
19572       {
19573         "title": "Example usage:",
19574         "content": "curl https://{domain}/api/rpc/fax/accounts -v -u {name}:{password}",
19575         "type": "json"
19576       }
19577     ],
19578     "name": "FaxAccounts",
19579     "group": "RPC_Realtime",
19580     "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>",
19581     "version": "0.0.0",
19582     "filename": "server/api/rpc/index.js",
19583     "groupTitle": "RPC_Realtime"
19584   },
19585   {
19586     "type": "put",
19587     "url": "/api/rpc/agents/:id/capacity",
19588     "title": "Sets agent capacity",
19589     "examples": [
19590       {
19591         "title": "Example usage:",
19592         "content": "curl https://{domain}/api/rpc/agents/:id/capacity -v -u {name}:{password}",
19593         "type": "json"
19594       }
19595     ],
19596     "name": "RTAgentCapacity",
19597     "group": "RPC_Realtime",
19598     "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>",
19599     "version": "0.0.0",
19600     "filename": "server/api/rpc/index.js",
19601     "groupTitle": "RPC_Realtime"
19602   },
19603   {
19604     "type": "get",
19605     "url": "/api/rpc/agents",
19606     "title": "Gets a list of RTAgents",
19607     "examples": [
19608       {
19609         "title": "Example usage:",
19610         "content": "curl https://{domain}/api/rpc/agents -v -u {name}:{password}",
19611         "type": "json"
19612       }
19613     ],
19614     "name": "RTAgents",
19615     "group": "RPC_Realtime",
19616     "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>",
19617     "version": "0.0.0",
19618     "filename": "server/api/rpc/index.js",
19619     "groupTitle": "RPC_Realtime"
19620   },
19621   {
19622     "type": "get",
19623     "url": "/api/rpc/chat/queues",
19624     "title": "Gets a list of RTChatQueues",
19625     "examples": [
19626       {
19627         "title": "Example usage:",
19628         "content": "curl https://{domain}/api/rpc/chat/queues -v -u {name}:{password}",
19629         "type": "json"
19630       }
19631     ],
19632     "name": "RTChatQueues",
19633     "group": "RPC_Realtime",
19634     "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>",
19635     "version": "0.0.0",
19636     "filename": "server/api/rpc/index.js",
19637     "groupTitle": "RPC_Realtime"
19638   },
19639   {
19640     "type": "get",
19641     "url": "/api/rpc/fax/queues",
19642     "title": "Gets a list of RTFaxQueues",
19643     "examples": [
19644       {
19645         "title": "Example usage:",
19646         "content": "curl https://{domain}/api/rpc/fax/queues -v -u {name}:{password}",
19647         "type": "json"
19648       }
19649     ],
19650     "name": "RTFaxQueues",
19651     "group": "RPC_Realtime",
19652     "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>",
19653     "version": "0.0.0",
19654     "filename": "server/api/rpc/index.js",
19655     "groupTitle": "RPC_Realtime"
19656   },
19657   {
19658     "type": "get",
19659     "url": "/api/rpc/mail/accounts",
19660     "title": "Gets a list of RTMailAccounts",
19661     "examples": [
19662       {
19663         "title": "Example usage:",
19664         "content": "curl https://{domain}/api/rpc/mail/accounts -v -u {name}:{password}",
19665         "type": "json"
19666       }
19667     ],
19668     "name": "RTMailAccounts",
19669     "group": "RPC_Realtime",
19670     "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>",
19671     "version": "0.0.0",
19672     "filename": "server/api/rpc/index.js",
19673     "groupTitle": "RPC_Realtime"
19674   },
19675   {
19676     "type": "get",
19677     "url": "/api/rpc/mail/queues",
19678     "title": "Gets a list of RTMailQueues",
19679     "examples": [
19680       {
19681         "title": "Example usage:",
19682         "content": "curl https://{domain}/api/rpc/mail/queues -v -u {name}:{password}",
19683         "type": "json"
19684       }
19685     ],
19686     "name": "RTMailQueues",
19687     "group": "RPC_Realtime",
19688     "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>",
19689     "version": "0.0.0",
19690     "filename": "server/api/rpc/index.js",
19691     "groupTitle": "RPC_Realtime"
19692   },
19693   {
19694     "type": "get",
19695     "url": "/api/rpc/openchannel/queues",
19696     "title": "Gets a list of RTOpenchannelQueues",
19697     "examples": [
19698       {
19699         "title": "Example usage:",
19700         "content": "curl https://{domain}/api/rpc/openchannel/queues -v -u {name}:{password}",
19701         "type": "json"
19702       }
19703     ],
19704     "name": "RTOpenchannelQueues",
19705     "group": "RPC_Realtime",
19706     "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>",
19707     "version": "0.0.0",
19708     "filename": "server/api/rpc/index.js",
19709     "groupTitle": "RPC_Realtime"
19710   },
19711   {
19712     "type": "get",
19713     "url": "/api/rpc/outbound/channels",
19714     "title": "Gets a list of RTOutboundChannels",
19715     "examples": [
19716       {
19717         "title": "Example usage:",
19718         "content": "curl https://{domain}/api/rpc/outbound/channels -v -u {name}:{password}",
19719         "type": "json"
19720       }
19721     ],
19722     "name": "RTOutboundChannels",
19723     "group": "RPC_Realtime",
19724     "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>",
19725     "version": "0.0.0",
19726     "filename": "server/api/rpc/index.js",
19727     "groupTitle": "RPC_Realtime"
19728   },
19729   {
19730     "type": "get",
19731     "url": "/api/rpc/sms/queues",
19732     "title": "Gets a list of RTSmsQueues",
19733     "examples": [
19734       {
19735         "title": "Example usage:",
19736         "content": "curl https://{domain}/api/rpc/sms/queues -v -u {name}:{password}",
19737         "type": "json"
19738       }
19739     ],
19740     "name": "RTSmsQueues",
19741     "group": "RPC_Realtime",
19742     "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>",
19743     "version": "0.0.0",
19744     "filename": "server/api/rpc/index.js",
19745     "groupTitle": "RPC_Realtime"
19746   },
19747   {
19748     "type": "get",
19749     "url": "/api/rpc/telephones",
19750     "title": "Gets a list of RTTelephones",
19751     "examples": [
19752       {
19753         "title": "Example usage:",
19754         "content": "curl https://{domain}/api/rpc/telephones -v -u {name}:{password}",
19755         "type": "json"
19756       }
19757     ],
19758     "name": "RTTelephones",
19759     "group": "RPC_Realtime",
19760     "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>",
19761     "version": "0.0.0",
19762     "filename": "server/api/rpc/index.js",
19763     "groupTitle": "RPC_Realtime"
19764   },
19765   {
19766     "type": "get",
19767     "url": "/api/rpc/trunks",
19768     "title": "Gets a list of RTTrunks",
19769     "examples": [
19770       {
19771         "title": "Example usage:",
19772         "content": "curl https://{domain}/api/rpc/trunks -v -u {name}:{password}",
19773         "type": "json"
19774       }
19775     ],
19776     "name": "RTTrunks",
19777     "group": "RPC_Realtime",
19778     "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>",
19779     "version": "0.0.0",
19780     "filename": "server/api/rpc/index.js",
19781     "groupTitle": "RPC_Realtime"
19782   },
19783   {
19784     "type": "get",
19785     "url": "/api/rpc/voice/channels",
19786     "title": "Gets a list of RTVoiceChannelMixMonitor",
19787     "examples": [
19788       {
19789         "title": "Example usage:",
19790         "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/mixmonitor -v -u {name}:{password}",
19791         "type": "json"
19792       }
19793     ],
19794     "name": "RTVoiceChannelMixMonitor",
19795     "group": "RPC_Realtime",
19796     "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>",
19797     "version": "0.0.0",
19798     "filename": "server/api/rpc/index.js",
19799     "groupTitle": "RPC_Realtime"
19800   },
19801   {
19802     "type": "get",
19803     "url": "/api/rpc/voice/channels",
19804     "title": "Gets a list of RTVoiceChannelStopMixMonitor",
19805     "examples": [
19806       {
19807         "title": "Example usage:",
19808         "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/stopmixmonitor -v -u {name}:{password}",
19809         "type": "json"
19810       }
19811     ],
19812     "name": "RTVoiceChannelStopMixMonitor",
19813     "group": "RPC_Realtime",
19814     "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>",
19815     "version": "0.0.0",
19816     "filename": "server/api/rpc/index.js",
19817     "groupTitle": "RPC_Realtime"
19818   },
19819   {
19820     "type": "get",
19821     "url": "/api/rpc/voice/channels",
19822     "title": "Gets a list of RTVoiceChannels",
19823     "examples": [
19824       {
19825         "title": "Example usage:",
19826         "content": "curl https://{domain}/api/rpc/voice/channels -v -u {name}:{password}",
19827         "type": "json"
19828       }
19829     ],
19830     "name": "RTVoiceChannels",
19831     "group": "RPC_Realtime",
19832     "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>",
19833     "version": "0.0.0",
19834     "filename": "server/api/rpc/index.js",
19835     "groupTitle": "RPC_Realtime"
19836   },
19837   {
19838     "type": "get",
19839     "url": "/api/rpc/voice/queues/channels/{uniqueid}",
19840     "title": "Gets a single RTVoiceQueueChannel",
19841     "examples": [
19842       {
19843         "title": "Example usage:",
19844         "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid} -v -u {name}:{password}",
19845         "type": "json"
19846       }
19847     ],
19848     "name": "RTVoiceQueueChannel",
19849     "group": "RPC_Realtime",
19850     "description": "<p>Motion will return a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19851     "version": "0.0.0",
19852     "filename": "server/api/rpc/index.js",
19853     "groupTitle": "RPC_Realtime"
19854   },
19855   {
19856     "type": "get",
19857     "url": "/api/rpc/voice/queues/channels/{uniqueid}/hangup",
19858     "title": "Hangup a single RTVoiceQueueChannel",
19859     "examples": [
19860       {
19861         "title": "Example usage:",
19862         "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/hangup -v -u {name}:{password}",
19863         "type": "json"
19864       }
19865     ],
19866     "name": "RTVoiceQueueChannelHangup",
19867     "group": "RPC_Realtime",
19868     "description": "<p>Motion will hangup a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19869     "version": "0.0.0",
19870     "filename": "server/api/rpc/index.js",
19871     "groupTitle": "RPC_Realtime"
19872   },
19873   {
19874     "type": "get",
19875     "url": "/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten}",
19876     "title": "Hangup a single RTVoiceQueueChannel",
19877     "examples": [
19878       {
19879         "title": "Example usage:",
19880         "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten} -v -u {name}:{password}",
19881         "type": "json"
19882       }
19883     ],
19884     "name": "RTVoiceQueueChannelRedirect",
19885     "group": "RPC_Realtime",
19886     "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>",
19887     "version": "0.0.0",
19888     "filename": "server/api/rpc/index.js",
19889     "groupTitle": "RPC_Realtime"
19890   },
19891   {
19892     "type": "get",
19893     "url": "/api/rpc/voice/queues/preview/{id}",
19894     "title": "Gets a single preview contact",
19895     "examples": [
19896       {
19897         "title": "Example usage:",
19898         "content": "curl https://{domain}/api/rpc/voice/queues/preview/{id} -v -u {name}:{password}",
19899         "type": "json"
19900       }
19901     ],
19902     "name": "RTVoiceQueuePreview",
19903     "group": "RPC_Realtime",
19904     "description": "<p>Motion will return a specific preview contact.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19905     "version": "0.0.0",
19906     "filename": "server/api/rpc/index.js",
19907     "groupTitle": "RPC_Realtime"
19908   },
19909   {
19910     "type": "get",
19911     "url": "/api/rpc/voice/queues",
19912     "title": "Gets a list of RTVoiceQueues",
19913     "examples": [
19914       {
19915         "title": "Example usage:",
19916         "content": "curl https://{domain}/api/rpc/voice/queues -v -u {name}:{password}",
19917         "type": "json"
19918       }
19919     ],
19920     "name": "RTVoiceQueues",
19921     "group": "RPC_Realtime",
19922     "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>",
19923     "version": "0.0.0",
19924     "filename": "server/api/rpc/index.js",
19925     "groupTitle": "RPC_Realtime"
19926   },
19927   {
19928     "type": "get",
19929     "url": "/api/rpc/outbound",
19930     "title": "Gets a list of RTOutbound",
19931     "examples": [
19932       {
19933         "title": "Example usage:",
19934         "content": "curl https://{domain}/api/rpc/outbound -v -u {name}:{password}",
19935         "type": "json"
19936       }
19937     ],
19938     "name": "RTVoiceQueues",
19939     "group": "RPC_Realtime",
19940     "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>",
19941     "version": "0.0.0",
19942     "filename": "server/api/rpc/index.js",
19943     "groupTitle": "RPC_Realtime"
19944   },
19945   {
19946     "type": "get",
19947     "url": "/api/rpc/voice/queues/channels",
19948     "title": "Gets a list of RTVoiceQueuesChannels",
19949     "examples": [
19950       {
19951         "title": "Example usage:",
19952         "content": "curl https://{domain}/api/rpc/voice/queues/channels -v -u {name}:{password}",
19953         "type": "json"
19954       }
19955     ],
19956     "name": "RTVoiceQueuesChannels",
19957     "group": "RPC_Realtime",
19958     "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>",
19959     "version": "0.0.0",
19960     "filename": "server/api/rpc/index.js",
19961     "groupTitle": "RPC_Realtime"
19962   },
19963   {
19964     "type": "get",
19965     "url": "/api/rpc/chat/queues/{id}",
19966     "title": "Gets a single RTChatQueue",
19967     "examples": [
19968       {
19969         "title": "Example usage:",
19970         "content": "curl https://{domain}/api/rpc/chat/queues/{id} -v -u {name}:{password}",
19971         "type": "json"
19972       }
19973     ],
19974     "name": "ShowRTChatQueues",
19975     "group": "RPC_Realtime",
19976     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19977     "version": "0.0.0",
19978     "filename": "server/api/rpc/index.js",
19979     "groupTitle": "RPC_Realtime"
19980   },
19981   {
19982     "type": "get",
19983     "url": "/api/rpc/fax/queues/{id}",
19984     "title": "Gets a single RTFaxQueue",
19985     "examples": [
19986       {
19987         "title": "Example usage:",
19988         "content": "curl https://{domain}/api/rpc/fax/queues/{id} -v -u {name}:{password}",
19989         "type": "json"
19990       }
19991     ],
19992     "name": "ShowRTFaxQueues",
19993     "group": "RPC_Realtime",
19994     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19995     "version": "0.0.0",
19996     "filename": "server/api/rpc/index.js",
19997     "groupTitle": "RPC_Realtime"
19998   },
19999   {
20000     "type": "get",
20001     "url": "/api/rpc/mail/queues/{id}",
20002     "title": "Gets a single RTMailQueue",
20003     "examples": [
20004       {
20005         "title": "Example usage:",
20006         "content": "curl https://{domain}/api/rpc/mail/queues/{id} -v -u {name}:{password}",
20007         "type": "json"
20008       }
20009     ],
20010     "name": "ShowRTMailQueues",
20011     "group": "RPC_Realtime",
20012     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20013     "version": "0.0.0",
20014     "filename": "server/api/rpc/index.js",
20015     "groupTitle": "RPC_Realtime"
20016   },
20017   {
20018     "type": "get",
20019     "url": "/api/rpc/openchannel/queues/{id}",
20020     "title": "Gets a single RTOpenchannelQueue",
20021     "examples": [
20022       {
20023         "title": "Example usage:",
20024         "content": "curl https://{domain}/api/rpc/openchannel/queues/{id} -v -u {name}:{password}",
20025         "type": "json"
20026       }
20027     ],
20028     "name": "ShowRTOpenchannelQueues",
20029     "group": "RPC_Realtime",
20030     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20031     "version": "0.0.0",
20032     "filename": "server/api/rpc/index.js",
20033     "groupTitle": "RPC_Realtime"
20034   },
20035   {
20036     "type": "get",
20037     "url": "/api/rpc/sms/queues/{id}",
20038     "title": "Gets a single RTSmsQueue",
20039     "examples": [
20040       {
20041         "title": "Example usage:",
20042         "content": "curl https://{domain}/api/rpc/sms/queues/{id} -v -u {name}:{password}",
20043         "type": "json"
20044       }
20045     ],
20046     "name": "ShowRTSmsQueues",
20047     "group": "RPC_Realtime",
20048     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20049     "version": "0.0.0",
20050     "filename": "server/api/rpc/index.js",
20051     "groupTitle": "RPC_Realtime"
20052   },
20053   {
20054     "type": "get",
20055     "url": "/api/rpc/voice/queues/{id}",
20056     "title": "Gets a single RTVoiceQueue",
20057     "examples": [
20058       {
20059         "title": "Example usage:",
20060         "content": "curl https://{domain}/api/rpc/voice/queues/{id} -v -u {name}:{password}",
20061         "type": "json"
20062       }
20063     ],
20064     "name": "ShowRTVoiceQueues",
20065     "group": "RPC_Realtime",
20066     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20067     "version": "0.0.0",
20068     "filename": "server/api/rpc/index.js",
20069     "groupTitle": "RPC_Realtime"
20070   },
20071   {
20072     "type": "put",
20073     "url": "/api/rpc/voice/{id}/queues",
20074     "title": "Updates a single VoiceQueue",
20075     "examples": [
20076       {
20077         "title": "Example usage:",
20078         "content": "curl https://{domain}/api/rpc/voice/queues/{id} -v -u {name}:{password}",
20079         "type": "json"
20080       }
20081     ],
20082     "name": "UpdateVoiceQueues",
20083     "group": "RPC_Realtime",
20084     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20085     "version": "0.0.0",
20086     "filename": "server/api/rpc/index.js",
20087     "groupTitle": "RPC_Realtime"
20088   },
20089   {
20090     "type": "post",
20091     "url": "/api/rpc/agents/:id/notify",
20092     "title": "Notify message to a specific agent",
20093     "examples": [
20094       {
20095         "title": "Example usage:",
20096         "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",
20097         "type": "json"
20098       }
20099     ],
20100     "name": "agentNotify",
20101     "group": "RPC_Realtime",
20102     "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>",
20103     "version": "0.0.0",
20104     "filename": "server/api/rpc/index.js",
20105     "groupTitle": "RPC_Realtime"
20106   },
20107   {
20108     "type": "post",
20109     "url": "/api/rpc/chat/queues/:id/notify",
20110     "title": "Notify message to a specific queue",
20111     "examples": [
20112       {
20113         "title": "Example usage:",
20114         "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",
20115         "type": "json"
20116       }
20117     ],
20118     "name": "chatQueueNotify",
20119     "group": "RPC_Realtime",
20120     "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>",
20121     "version": "0.0.0",
20122     "filename": "server/api/rpc/index.js",
20123     "groupTitle": "RPC_Realtime"
20124   },
20125   {
20126     "type": "get",
20127     "url": "/api/rpc/chat/queues/waitinginteractions",
20128     "title": "Gets a list of chatQueuesWaitingInteractions",
20129     "examples": [
20130       {
20131         "title": "Example usage:",
20132         "content": "curl https://{domain}/api/rpc/chat/queues/waitinginteractions -v -u {name}:{password}",
20133         "type": "json"
20134       }
20135     ],
20136     "name": "chatQueuesWaitingInteractions",
20137     "group": "RPC_Realtime",
20138     "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>",
20139     "version": "0.0.0",
20140     "filename": "server/api/rpc/index.js",
20141     "groupTitle": "RPC_Realtime"
20142   },
20143   {
20144     "type": "post",
20145     "url": "/api/rpc/fax/queues/:id/notify",
20146     "title": "Notify message to a specific queue",
20147     "examples": [
20148       {
20149         "title": "Example usage:",
20150         "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",
20151         "type": "json"
20152       }
20153     ],
20154     "name": "faxQueueNotify",
20155     "group": "RPC_Realtime",
20156     "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>",
20157     "version": "0.0.0",
20158     "filename": "server/api/rpc/index.js",
20159     "groupTitle": "RPC_Realtime"
20160   },
20161   {
20162     "type": "get",
20163     "url": "/api/rpc/fax/queues/waitinginteractions",
20164     "title": "Gets a list of faxQueuesWaitingInteractions",
20165     "examples": [
20166       {
20167         "title": "Example usage:",
20168         "content": "curl https://{domain}/api/rpc/fax/queues/waitinginteractions -v -u {name}:{password}",
20169         "type": "json"
20170       }
20171     ],
20172     "name": "faxQueuesWaitingInteractions",
20173     "group": "RPC_Realtime",
20174     "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>",
20175     "version": "0.0.0",
20176     "filename": "server/api/rpc/index.js",
20177     "groupTitle": "RPC_Realtime"
20178   },
20179   {
20180     "type": "post",
20181     "url": "/api/rpc/mail/queues/:id/notify",
20182     "title": "Notify message to a specific queue",
20183     "examples": [
20184       {
20185         "title": "Example usage:",
20186         "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",
20187         "type": "json"
20188       }
20189     ],
20190     "name": "mailQueueNotify",
20191     "group": "RPC_Realtime",
20192     "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>",
20193     "version": "0.0.0",
20194     "filename": "server/api/rpc/index.js",
20195     "groupTitle": "RPC_Realtime"
20196   },
20197   {
20198     "type": "get",
20199     "url": "/api/rpc/mail/queues/waitinginteractions",
20200     "title": "Gets a list of mailQueuesWaitingInteractions",
20201     "examples": [
20202       {
20203         "title": "Example usage:",
20204         "content": "curl https://{domain}/api/rpc/mail/queues/waitinginteractions -v -u {name}:{password}",
20205         "type": "json"
20206       }
20207     ],
20208     "name": "mailQueuesWaitingInteractions",
20209     "group": "RPC_Realtime",
20210     "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>",
20211     "version": "0.0.0",
20212     "filename": "server/api/rpc/index.js",
20213     "groupTitle": "RPC_Realtime"
20214   },
20215   {
20216     "type": "post",
20217     "url": "/api/rpc/openchannel/queues/:id/notify",
20218     "title": "Notify message to a specific queue",
20219     "examples": [
20220       {
20221         "title": "Example usage:",
20222         "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",
20223         "type": "json"
20224       }
20225     ],
20226     "name": "openchannelQueueNotify",
20227     "group": "RPC_Realtime",
20228     "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>",
20229     "version": "0.0.0",
20230     "filename": "server/api/rpc/index.js",
20231     "groupTitle": "RPC_Realtime"
20232   },
20233   {
20234     "type": "get",
20235     "url": "/api/rpc/openchannel/queues/:id/waitinginteractions",
20236     "title": "Gets a list of openchannelQueuesIdWaitingInteractions",
20237     "examples": [
20238       {
20239         "title": "Example usage:",
20240         "content": "curl https://{domain}/api/rpc/openchannel/queues/:id/waitinginteractions -v -u {name}:{password}",
20241         "type": "json"
20242       }
20243     ],
20244     "name": "openchannelQueuesIdWaitingInteractions",
20245     "group": "RPC_Realtime",
20246     "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>",
20247     "version": "0.0.0",
20248     "filename": "server/api/rpc/index.js",
20249     "groupTitle": "RPC_Realtime"
20250   },
20251   {
20252     "type": "get",
20253     "url": "/api/rpc/openchannel/queues/waitinginteractions",
20254     "title": "Gets a list of openchannelQueuesWaitingInteractions",
20255     "examples": [
20256       {
20257         "title": "Example usage:",
20258         "content": "curl https://{domain}/api/rpc/openchannel/queues/waitinginteractions -v -u {name}:{password}",
20259         "type": "json"
20260       }
20261     ],
20262     "name": "openchannelQueuesWaitingInteractions",
20263     "group": "RPC_Realtime",
20264     "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>",
20265     "version": "0.0.0",
20266     "filename": "server/api/rpc/index.js",
20267     "groupTitle": "RPC_Realtime"
20268   },
20269   {
20270     "type": "post",
20271     "url": "/api/rpc/sms/queues/:id/notify",
20272     "title": "Notify message to a specific queue",
20273     "examples": [
20274       {
20275         "title": "Example usage:",
20276         "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",
20277         "type": "json"
20278       }
20279     ],
20280     "name": "smsQueueNotify",
20281     "group": "RPC_Realtime",
20282     "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>",
20283     "version": "0.0.0",
20284     "filename": "server/api/rpc/index.js",
20285     "groupTitle": "RPC_Realtime"
20286   },
20287   {
20288     "type": "get",
20289     "url": "/api/rpc/sms/queues/waitinginteractions",
20290     "title": "Gets a list of smsQueuesWaitingInteractions",
20291     "examples": [
20292       {
20293         "title": "Example usage:",
20294         "content": "curl https://{domain}/api/rpc/sms/queues/waitinginteractions -v -u {name}:{password}",
20295         "type": "json"
20296       }
20297     ],
20298     "name": "smsQueuesWaitingInteractions",
20299     "group": "RPC_Realtime",
20300     "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>",
20301     "version": "0.0.0",
20302     "filename": "server/api/rpc/index.js",
20303     "groupTitle": "RPC_Realtime"
20304   },
20305   {
20306     "type": "get",
20307     "url": "/api/realtime/queues",
20308     "title": "Gets realtime queues info",
20309     "examples": [
20310       {
20311         "title": "Example usage:",
20312         "content": "curl https://{domain}/api/realtime/queues -v -u {name}:{password}  -X GET",
20313         "type": "json"
20314       }
20315     ],
20316     "name": "getQueues",
20317     "group": "Realtime",
20318     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20319     "version": "0.0.0",
20320     "filename": "server/api/realtime/index.js",
20321     "groupTitle": "Realtime"
20322   },
20323   {
20324     "type": "post",
20325     "url": "/api/integrations/salesforce/accounts",
20326     "title": "Creates a new Salesforce Account",
20327     "examples": [
20328       {
20329         "title": "Example usage:",
20330         "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",
20331         "type": "json"
20332       }
20333     ],
20334     "name": "CreateSalesforce_Accounts",
20335     "group": "Salesforce_Accounts",
20336     "parameter": {
20337       "fields": {
20338         "Body": [
20339           {
20340             "group": "Body",
20341             "type": "String",
20342             "optional": true,
20343             "field": "name",
20344             "description": ""
20345           },
20346           {
20347             "group": "Body",
20348             "type": "String",
20349             "optional": true,
20350             "field": "description",
20351             "description": ""
20352           },
20353           {
20354             "group": "Body",
20355             "type": "String",
20356             "optional": true,
20357             "field": "username",
20358             "description": ""
20359           },
20360           {
20361             "group": "Body",
20362             "type": "String",
20363             "optional": true,
20364             "field": "remoteUri",
20365             "description": ""
20366           },
20367           {
20368             "group": "Body",
20369             "type": "String",
20370             "optional": true,
20371             "field": "password",
20372             "description": ""
20373           },
20374           {
20375             "group": "Body",
20376             "type": "String",
20377             "optional": true,
20378             "field": "clientId",
20379             "description": ""
20380           },
20381           {
20382             "group": "Body",
20383             "type": "String",
20384             "optional": true,
20385             "field": "clientSecret",
20386             "description": ""
20387           },
20388           {
20389             "group": "Body",
20390             "type": "String",
20391             "optional": true,
20392             "field": "securityToken",
20393             "description": ""
20394           },
20395           {
20396             "group": "Body",
20397             "type": "String",
20398             "optional": false,
20399             "field": "serverUrl",
20400             "description": ""
20401           },
20402           {
20403             "group": "Body",
20404             "type": "String",
20405             "allowedValues": [
20406               "\"integrationTab\"",
20407               "\"newTab\""
20408             ],
20409             "optional": true,
20410             "field": "type",
20411             "description": ""
20412           }
20413         ]
20414       }
20415     },
20416     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20417     "version": "0.0.0",
20418     "filename": "server/api/intSalesforceAccount/index.js",
20419     "groupTitle": "Salesforce_Accounts"
20420   },
20421   {
20422     "type": "delete",
20423     "url": "/api/integrations/salesforce/accounts/{id}",
20424     "title": "Deletes a Salesforce Account",
20425     "examples": [
20426       {
20427         "title": "Example usage:",
20428         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password} -X DELETE",
20429         "type": "json"
20430       }
20431     ],
20432     "name": "DeleteSalesforce_Accounts",
20433     "group": "Salesforce_Accounts",
20434     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20435     "version": "0.0.0",
20436     "filename": "server/api/intSalesforceAccount/index.js",
20437     "groupTitle": "Salesforce_Accounts"
20438   },
20439   {
20440     "type": "get",
20441     "url": "/api/integrations/salesforce/accounts",
20442     "title": "Gets a list of Salesforce Accounts",
20443     "examples": [
20444       {
20445         "title": "Example usage:",
20446         "content": "curl https://{domain}/api/integrations/salesforce/accounts -v -u {name}:{password}",
20447         "type": "json"
20448       }
20449     ],
20450     "name": "GetSalesforce_Accounts",
20451     "group": "Salesforce_Accounts",
20452     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20453     "version": "0.0.0",
20454     "filename": "server/api/intSalesforceAccount/index.js",
20455     "groupTitle": "Salesforce_Accounts"
20456   },
20457   {
20458     "type": "get",
20459     "url": "/api/integrations/salesforce/accounts/{id}",
20460     "title": "Gets a single Salesforce Account",
20461     "examples": [
20462       {
20463         "title": "Example usage:",
20464         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password}",
20465         "type": "json"
20466       }
20467     ],
20468     "name": "ShowSalesforce_Accounts",
20469     "group": "Salesforce_Accounts",
20470     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20471     "version": "0.0.0",
20472     "filename": "server/api/intSalesforceAccount/index.js",
20473     "groupTitle": "Salesforce_Accounts"
20474   },
20475   {
20476     "type": "post",
20477     "url": "/api/integrations/salesforce/accounts/{id}/configurations",
20478     "title": "Creates new configuration",
20479     "examples": [
20480       {
20481         "title": "Example usage:",
20482         "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",
20483         "type": "json"
20484       }
20485     ],
20486     "name": "addConfiguration",
20487     "group": "Salesforce_Accounts",
20488     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20489     "version": "0.0.0",
20490     "filename": "server/api/intSalesforceAccount/index.js",
20491     "groupTitle": "Salesforce_Accounts"
20492   },
20493   {
20494     "type": "get",
20495     "url": "/api/integrations/salesforce/accounts/{id}/configurations",
20496     "title": "Gets account configurations",
20497     "examples": [
20498       {
20499         "title": "Example usage:",
20500         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/configurations -v -u {name}:{password} -X GET",
20501         "type": "json"
20502       }
20503     ],
20504     "name": "getConfigurations",
20505     "group": "Salesforce_Accounts",
20506     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20507     "version": "0.0.0",
20508     "filename": "server/api/intSalesforceAccount/index.js",
20509     "groupTitle": "Salesforce_Accounts"
20510   },
20511   {
20512     "type": "get",
20513     "url": "/api/integrations/salesforce/accounts/{id}/fields",
20514     "title": "Gets account fields",
20515     "examples": [
20516       {
20517         "title": "Example usage:",
20518         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/fields -v -u {name}:{password} -X GET",
20519         "type": "json"
20520       }
20521     ],
20522     "name": "getFields",
20523     "group": "Salesforce_Accounts",
20524     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20525     "version": "0.0.0",
20526     "filename": "server/api/intSalesforceAccount/index.js",
20527     "groupTitle": "Salesforce_Accounts"
20528   },
20529   {
20530     "type": "put",
20531     "url": "/api/integrations/salesforce/accounts/{id}",
20532     "title": "Update an existing Salesforce Account",
20533     "examples": [
20534       {
20535         "title": "Example usage:",
20536         "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",
20537         "type": "json"
20538       }
20539     ],
20540     "name": "updateSalesforce_Accounts",
20541     "group": "Salesforce_Accounts",
20542     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20543     "version": "0.0.0",
20544     "filename": "server/api/intSalesforceAccount/index.js",
20545     "groupTitle": "Salesforce_Accounts"
20546   },
20547   {
20548     "type": "post",
20549     "url": "/api/integrations/salesforce/configurations",
20550     "title": "Creates a new Salesforce Configuration",
20551     "examples": [
20552       {
20553         "title": "Example usage:",
20554         "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",
20555         "type": "json"
20556       }
20557     ],
20558     "name": "CreateSalesforce_Configurations",
20559     "group": "Salesforce_Configurations",
20560     "parameter": {
20561       "fields": {
20562         "Body": [
20563           {
20564             "group": "Body",
20565             "type": "String",
20566             "optional": true,
20567             "field": "name",
20568             "description": ""
20569           },
20570           {
20571             "group": "Body",
20572             "type": "String",
20573             "optional": true,
20574             "field": "description",
20575             "description": ""
20576           },
20577           {
20578             "group": "Body",
20579             "type": "String",
20580             "allowedValues": [
20581               "\"Task\"",
20582               "\"Case\""
20583             ],
20584             "optional": true,
20585             "field": "ticketType",
20586             "description": ""
20587           },
20588           {
20589             "group": "Body",
20590             "type": "String",
20591             "allowedValues": [
20592               "\"contact_lead\"",
20593               "\"contact\"",
20594               "\"lead\"",
20595               "\"account_contact_lead\"",
20596               "\"account\""
20597             ],
20598             "optional": true,
20599             "field": "moduleSearch",
20600             "description": ""
20601           },
20602           {
20603             "group": "Body",
20604             "type": "String",
20605             "allowedValues": [
20606               "\"nothing\"",
20607               "\"contact\"",
20608               "\"lead\"",
20609               "\"account\""
20610             ],
20611             "optional": true,
20612             "field": "moduleCreate",
20613             "description": ""
20614           },
20615           {
20616             "group": "Body",
20617             "type": "String",
20618             "optional": true,
20619             "field": "leadId",
20620             "description": ""
20621           },
20622           {
20623             "group": "Body",
20624             "type": "String",
20625             "optional": true,
20626             "field": "additionalSearchAccount",
20627             "description": ""
20628           },
20629           {
20630             "group": "Body",
20631             "type": "String",
20632             "optional": true,
20633             "field": "additionalSearchContact",
20634             "description": ""
20635           },
20636           {
20637             "group": "Body",
20638             "type": "String",
20639             "optional": true,
20640             "field": "additionalSearchLead",
20641             "description": ""
20642           }
20643         ]
20644       }
20645     },
20646     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20647     "version": "0.0.0",
20648     "filename": "server/api/intSalesforceConfiguration/index.js",
20649     "groupTitle": "Salesforce_Configurations"
20650   },
20651   {
20652     "type": "delete",
20653     "url": "/api/integrations/salesforce/configurations/{id}",
20654     "title": "Deletes a Salesforce Configuration",
20655     "examples": [
20656       {
20657         "title": "Example usage:",
20658         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password} -X DELETE",
20659         "type": "json"
20660       }
20661     ],
20662     "name": "DeleteSalesforce_Configurations",
20663     "group": "Salesforce_Configurations",
20664     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20665     "version": "0.0.0",
20666     "filename": "server/api/intSalesforceConfiguration/index.js",
20667     "groupTitle": "Salesforce_Configurations"
20668   },
20669   {
20670     "type": "get",
20671     "url": "/api/integrations/salesforce/configurations",
20672     "title": "Gets a list of Salesforce Configurations",
20673     "examples": [
20674       {
20675         "title": "Example usage:",
20676         "content": "curl https://{domain}/api/integrations/salesforce/configurations -v -u {name}:{password}",
20677         "type": "json"
20678       }
20679     ],
20680     "name": "GetSalesforce_Configurations",
20681     "group": "Salesforce_Configurations",
20682     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20683     "version": "0.0.0",
20684     "filename": "server/api/intSalesforceConfiguration/index.js",
20685     "groupTitle": "Salesforce_Configurations"
20686   },
20687   {
20688     "type": "get",
20689     "url": "/api/integrations/salesforce/configurations/{id}",
20690     "title": "Gets a single Salesforce Configuration",
20691     "examples": [
20692       {
20693         "title": "Example usage:",
20694         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password}",
20695         "type": "json"
20696       }
20697     ],
20698     "name": "ShowSalesforce_Configurations",
20699     "group": "Salesforce_Configurations",
20700     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20701     "version": "0.0.0",
20702     "filename": "server/api/intSalesforceConfiguration/index.js",
20703     "groupTitle": "Salesforce_Configurations"
20704   },
20705   {
20706     "type": "get",
20707     "url": "/api/integrations/salesforce/configurations/{id}/descriptions",
20708     "title": "Gets configurations descriptions",
20709     "examples": [
20710       {
20711         "title": "Example usage:",
20712         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
20713         "type": "json"
20714       }
20715     ],
20716     "name": "getDescriptions",
20717     "group": "Salesforce_Configurations",
20718     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20719     "version": "0.0.0",
20720     "filename": "server/api/intSalesforceConfiguration/index.js",
20721     "groupTitle": "Salesforce_Configurations"
20722   },
20723   {
20724     "type": "get",
20725     "url": "/api/integrations/salesforce/configurations/{id}/fields",
20726     "title": "Gets configurations fields",
20727     "examples": [
20728       {
20729         "title": "Example usage:",
20730         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/fields -v -u {name}:{password} -X GET",
20731         "type": "json"
20732       }
20733     ],
20734     "name": "getFields",
20735     "group": "Salesforce_Configurations",
20736     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20737     "version": "0.0.0",
20738     "filename": "server/api/intSalesforceConfiguration/index.js",
20739     "groupTitle": "Salesforce_Configurations"
20740   },
20741   {
20742     "type": "get",
20743     "url": "/api/integrations/salesforce/configurations/{id}/subjects",
20744     "title": "Gets configurations subjects",
20745     "examples": [
20746       {
20747         "title": "Example usage:",
20748         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/subjects -v -u {name}:{password} -X GET",
20749         "type": "json"
20750       }
20751     ],
20752     "name": "getSubjects",
20753     "group": "Salesforce_Configurations",
20754     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20755     "version": "0.0.0",
20756     "filename": "server/api/intSalesforceConfiguration/index.js",
20757     "groupTitle": "Salesforce_Configurations"
20758   },
20759   {
20760     "type": "put",
20761     "url": "/api/integrations/salesforce/configurations/{id}",
20762     "title": "Update an existing Salesforce Configuration",
20763     "examples": [
20764       {
20765         "title": "Example usage:",
20766         "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",
20767         "type": "json"
20768       }
20769     ],
20770     "name": "updateSalesforce_Configurations",
20771     "group": "Salesforce_Configurations",
20772     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20773     "version": "0.0.0",
20774     "filename": "server/api/intSalesforceConfiguration/index.js",
20775     "groupTitle": "Salesforce_Configurations"
20776   },
20777   {
20778     "type": "post",
20779     "url": "/api/integrations/salesforce/fields",
20780     "title": "Creates a new Salesforce Field",
20781     "examples": [
20782       {
20783         "title": "Example usage:",
20784         "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",
20785         "type": "json"
20786       }
20787     ],
20788     "name": "CreateSalesforce_Fields",
20789     "group": "Salesforce_Fields",
20790     "parameter": {
20791       "fields": {
20792         "Body": [
20793           {
20794             "group": "Body",
20795             "type": "String",
20796             "allowedValues": [
20797               "\"string\"",
20798               "\"variable\"",
20799               "\"customVariable\"",
20800               "\"keyValue\"",
20801               "\"picklist\""
20802             ],
20803             "optional": true,
20804             "field": "type",
20805             "description": ""
20806           },
20807           {
20808             "group": "Body",
20809             "type": "String",
20810             "optional": true,
20811             "field": "content",
20812             "description": ""
20813           },
20814           {
20815             "group": "Body",
20816             "type": "String",
20817             "optional": true,
20818             "field": "key",
20819             "description": ""
20820           },
20821           {
20822             "group": "Body",
20823             "type": "String",
20824             "allowedValues": [
20825               "\"string\"",
20826               "\"variable\"",
20827               "\"customVariable\""
20828             ],
20829             "optional": true,
20830             "field": "keyType",
20831             "description": ""
20832           },
20833           {
20834             "group": "Body",
20835             "type": "String",
20836             "optional": true,
20837             "field": "keyContent",
20838             "description": ""
20839           },
20840           {
20841             "group": "Body",
20842             "type": "String",
20843             "optional": true,
20844             "field": "idField",
20845             "description": ""
20846           },
20847           {
20848             "group": "Body",
20849             "type": "String",
20850             "optional": true,
20851             "field": "variableName",
20852             "description": ""
20853           }
20854         ]
20855       }
20856     },
20857     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20858     "version": "0.0.0",
20859     "filename": "server/api/intSalesforceField/index.js",
20860     "groupTitle": "Salesforce_Fields"
20861   },
20862   {
20863     "type": "delete",
20864     "url": "/api/integrations/salesforce/fields/{id}",
20865     "title": "Deletes a Salesforce Field",
20866     "examples": [
20867       {
20868         "title": "Example usage:",
20869         "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password} -X DELETE",
20870         "type": "json"
20871       }
20872     ],
20873     "name": "DeleteSalesforce_Fields",
20874     "group": "Salesforce_Fields",
20875     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20876     "version": "0.0.0",
20877     "filename": "server/api/intSalesforceField/index.js",
20878     "groupTitle": "Salesforce_Fields"
20879   },
20880   {
20881     "type": "get",
20882     "url": "/api/integrations/salesforce/fields",
20883     "title": "Gets a list of Salesforce Fields",
20884     "examples": [
20885       {
20886         "title": "Example usage:",
20887         "content": "curl https://{domain}/api/integrations/salesforce/fields -v -u {name}:{password}",
20888         "type": "json"
20889       }
20890     ],
20891     "name": "GetSalesforce_Fields",
20892     "group": "Salesforce_Fields",
20893     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20894     "version": "0.0.0",
20895     "filename": "server/api/intSalesforceField/index.js",
20896     "groupTitle": "Salesforce_Fields"
20897   },
20898   {
20899     "type": "get",
20900     "url": "/api/integrations/salesforce/fields/{id}",
20901     "title": "Gets a single Salesforce Field",
20902     "examples": [
20903       {
20904         "title": "Example usage:",
20905         "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password}",
20906         "type": "json"
20907       }
20908     ],
20909     "name": "ShowSalesforce_Fields",
20910     "group": "Salesforce_Fields",
20911     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20912     "version": "0.0.0",
20913     "filename": "server/api/intSalesforceField/index.js",
20914     "groupTitle": "Salesforce_Fields"
20915   },
20916   {
20917     "type": "put",
20918     "url": "/api/integrations/salesforce/fields/{id}",
20919     "title": "Update an existing Salesforce Field",
20920     "examples": [
20921       {
20922         "title": "Example usage:",
20923         "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",
20924         "type": "json"
20925       }
20926     ],
20927     "name": "updateSalesforce_Fields",
20928     "group": "Salesforce_Fields",
20929     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20930     "version": "0.0.0",
20931     "filename": "server/api/intSalesforceField/index.js",
20932     "groupTitle": "Salesforce_Fields"
20933   },
20934   {
20935     "type": "post",
20936     "url": "/api/schedules",
20937     "title": "Creates a new Schedule",
20938     "examples": [
20939       {
20940         "title": "Example usage:",
20941         "content": "curl https://{domain}/api/schedules -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
20942         "type": "json"
20943       }
20944     ],
20945     "name": "CreateSchedules",
20946     "group": "Schedules",
20947     "parameter": {
20948       "fields": {
20949         "Body": [
20950           {
20951             "group": "Body",
20952             "type": "String",
20953             "optional": false,
20954             "field": "name",
20955             "description": ""
20956           },
20957           {
20958             "group": "Body",
20959             "type": "String",
20960             "optional": true,
20961             "field": "description",
20962             "description": ""
20963           },
20964           {
20965             "group": "Body",
20966             "type": "Boolean",
20967             "optional": false,
20968             "field": "active",
20969             "description": ""
20970           },
20971           {
20972             "group": "Body",
20973             "type": "String",
20974             "optional": false,
20975             "field": "cron",
20976             "description": ""
20977           },
20978           {
20979             "group": "Body",
20980             "type": "String",
20981             "optional": false,
20982             "field": "startAt",
20983             "description": ""
20984           },
20985           {
20986             "group": "Body",
20987             "type": "String",
20988             "optional": false,
20989             "field": "endAt",
20990             "description": ""
20991           },
20992           {
20993             "group": "Body",
20994             "type": "Integer",
20995             "optional": false,
20996             "field": "subtractNumber",
20997             "description": ""
20998           },
20999           {
21000             "group": "Body",
21001             "type": "String",
21002             "allowedValues": [
21003               "\"years\"",
21004               "\"quarters\"",
21005               "\"months\"",
21006               "\"weeks\"",
21007               "\"days\"",
21008               "\"hours\"",
21009               "\"minutes\""
21010             ],
21011             "optional": false,
21012             "field": "subtractUnit",
21013             "description": ""
21014           },
21015           {
21016             "group": "Body",
21017             "type": "String",
21018             "allowedValues": [
21019               "\"csv\"",
21020               "\"pdf\"",
21021               "\"xlsx\""
21022             ],
21023             "optional": false,
21024             "field": "output",
21025             "description": ""
21026           },
21027           {
21028             "group": "Body",
21029             "type": "String",
21030             "allowedValues": [
21031               "\"custom\"",
21032               "\"default\""
21033             ],
21034             "optional": false,
21035             "field": "type",
21036             "description": ""
21037           },
21038           {
21039             "group": "Body",
21040             "type": "Boolean",
21041             "optional": true,
21042             "field": "sendMail",
21043             "description": ""
21044           },
21045           {
21046             "group": "Body",
21047             "type": "String",
21048             "optional": true,
21049             "field": "email",
21050             "description": ""
21051           },
21052           {
21053             "group": "Body",
21054             "type": "Text",
21055             "optional": true,
21056             "field": "cc",
21057             "description": ""
21058           },
21059           {
21060             "group": "Body",
21061             "type": "Text",
21062             "optional": true,
21063             "field": "bcc",
21064             "description": ""
21065           },
21066           {
21067             "group": "Body",
21068             "type": "Boolean",
21069             "optional": true,
21070             "field": "sendIfEmpty",
21071             "description": ""
21072           }
21073         ]
21074       }
21075     },
21076     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21077     "version": "0.0.0",
21078     "filename": "server/api/schedule/index.js",
21079     "groupTitle": "Schedules"
21080   },
21081   {
21082     "type": "delete",
21083     "url": "/api/schedules/{id}",
21084     "title": "Deletes a Schedule",
21085     "examples": [
21086       {
21087         "title": "Example usage:",
21088         "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password} -X DELETE",
21089         "type": "json"
21090       }
21091     ],
21092     "name": "DeleteSchedules",
21093     "group": "Schedules",
21094     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21095     "version": "0.0.0",
21096     "filename": "server/api/schedule/index.js",
21097     "groupTitle": "Schedules"
21098   },
21099   {
21100     "type": "get",
21101     "url": "/api/schedules",
21102     "title": "Gets a list of Schedules",
21103     "examples": [
21104       {
21105         "title": "Example usage:",
21106         "content": "curl https://{domain}/api/schedules -v -u {name}:{password}",
21107         "type": "json"
21108       }
21109     ],
21110     "name": "GetSchedules",
21111     "group": "Schedules",
21112     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21113     "version": "0.0.0",
21114     "filename": "server/api/schedule/index.js",
21115     "groupTitle": "Schedules"
21116   },
21117   {
21118     "type": "get",
21119     "url": "/api/schedules/{id}",
21120     "title": "Gets a single Schedule",
21121     "examples": [
21122       {
21123         "title": "Example usage:",
21124         "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password}",
21125         "type": "json"
21126       }
21127     ],
21128     "name": "ShowSchedules",
21129     "group": "Schedules",
21130     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21131     "version": "0.0.0",
21132     "filename": "server/api/schedule/index.js",
21133     "groupTitle": "Schedules"
21134   },
21135   {
21136     "type": "get",
21137     "url": "/api/schedules/{id}/run",
21138     "title": "Run Scheduler",
21139     "examples": [
21140       {
21141         "title": "Example usage:",
21142         "content": "curl https://{domain}/api/schedules/{id}/run -v -u {name}:{password} -X GET",
21143         "type": "json"
21144       }
21145     ],
21146     "name": "run",
21147     "group": "Schedules",
21148     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21149     "version": "0.0.0",
21150     "filename": "server/api/schedule/index.js",
21151     "groupTitle": "Schedules"
21152   },
21153   {
21154     "type": "put",
21155     "url": "/api/schedules/{id}",
21156     "title": "Update an existing Schedule",
21157     "examples": [
21158       {
21159         "title": "Example usage:",
21160         "content": "curl https://{domain}/api/schedules/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
21161         "type": "json"
21162       }
21163     ],
21164     "name": "updateSchedules",
21165     "group": "Schedules",
21166     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21167     "version": "0.0.0",
21168     "filename": "server/api/schedule/index.js",
21169     "groupTitle": "Schedules"
21170   },
21171   {
21172     "type": "post",
21173     "url": "/api/screen/recordings",
21174     "title": "Creates a new Recording",
21175     "examples": [
21176       {
21177         "title": "Example usage:",
21178         "content": "curl https://{domain}/api/screen/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
21179         "type": "json"
21180       }
21181     ],
21182     "name": "CreateRecordings",
21183     "group": "Screen_Recordings",
21184     "parameter": {
21185       "fields": {
21186         "Body": [
21187           {
21188             "group": "Body",
21189             "type": "Virtual",
21190             "optional": true,
21191             "field": "format",
21192             "description": ""
21193           },
21194           {
21195             "group": "Body",
21196             "type": "String",
21197             "optional": true,
21198             "field": "interactionid",
21199             "description": ""
21200           },
21201           {
21202             "group": "Body",
21203             "type": "String",
21204             "optional": true,
21205             "field": "channel",
21206             "description": ""
21207           },
21208           {
21209             "group": "Body",
21210             "type": "String",
21211             "optional": true,
21212             "field": "value",
21213             "description": ""
21214           },
21215           {
21216             "group": "Body",
21217             "type": "Integer",
21218             "optional": true,
21219             "field": "rating",
21220             "description": ""
21221           },
21222           {
21223             "group": "Body",
21224             "type": "Integer",
21225             "optional": true,
21226             "field": "duration",
21227             "description": ""
21228           },
21229           {
21230             "group": "Body",
21231             "type": "String",
21232             "optional": true,
21233             "field": "startedAt",
21234             "description": ""
21235           },
21236           {
21237             "group": "Body",
21238             "type": "String",
21239             "optional": true,
21240             "field": "closedAt",
21241             "description": ""
21242           },
21243           {
21244             "group": "Body",
21245             "type": "String",
21246             "optional": true,
21247             "field": "createdAt",
21248             "description": ""
21249           },
21250           {
21251             "group": "Body",
21252             "type": "String",
21253             "optional": true,
21254             "field": "updatedAt",
21255             "description": ""
21256           }
21257         ]
21258       }
21259     },
21260     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21261     "version": "0.0.0",
21262     "filename": "server/api/screenRecording/index.js",
21263     "groupTitle": "Screen_Recordings"
21264   },
21265   {
21266     "type": "get",
21267     "url": "/api/screen/recordings/describe",
21268     "title": "Gets table info about Recordings",
21269     "examples": [
21270       {
21271         "title": "Example usage:",
21272         "content": "curl https://{domain}/api/screen/recordings/describe -v -u {name}:{password}",
21273         "type": "json"
21274       }
21275     ],
21276     "name": "DescribeRecordings",
21277     "group": "Screen_Recordings",
21278     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21279     "version": "0.0.0",
21280     "filename": "server/api/screenRecording/index.js",
21281     "groupTitle": "Screen_Recordings"
21282   },
21283   {
21284     "type": "get",
21285     "url": "/api/screen/recordings",
21286     "title": "Gets a list of Recordings",
21287     "examples": [
21288       {
21289         "title": "Example usage:",
21290         "content": "curl https://{domain}/api/screen/recordings -v -u {name}:{password}",
21291         "type": "json"
21292       }
21293     ],
21294     "name": "GetRecordings",
21295     "group": "Screen_Recordings",
21296     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21297     "version": "0.0.0",
21298     "filename": "server/api/screenRecording/index.js",
21299     "groupTitle": "Screen_Recordings"
21300   },
21301   {
21302     "type": "get",
21303     "url": "/api/screen/recordings/{id}",
21304     "title": "Gets a single Recording",
21305     "examples": [
21306       {
21307         "title": "Example usage:",
21308         "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password}",
21309         "type": "json"
21310       }
21311     ],
21312     "name": "ShowRecordings",
21313     "group": "Screen_Recordings",
21314     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21315     "version": "0.0.0",
21316     "filename": "server/api/screenRecording/index.js",
21317     "groupTitle": "Screen_Recordings"
21318   },
21319   {
21320     "type": "delete",
21321     "url": "/api/screen/recordings/{id}",
21322     "title": "Delete screen recording",
21323     "examples": [
21324       {
21325         "title": "Example usage:",
21326         "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password} -X DELETE",
21327         "type": "json"
21328       }
21329     ],
21330     "name": "destroy",
21331     "group": "Screen_Recordings",
21332     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21333     "version": "0.0.0",
21334     "filename": "server/api/screenRecording/index.js",
21335     "groupTitle": "Screen_Recordings"
21336   },
21337   {
21338     "type": "get",
21339     "url": "/api/screen/recordings/{id}/download",
21340     "title": "Download Recording",
21341     "examples": [
21342       {
21343         "title": "Example usage:",
21344         "content": "curl https://{domain}/api/screen/recordings/{id}/download -v -u {name}:{password} -X GET",
21345         "type": "json"
21346       }
21347     ],
21348     "name": "download",
21349     "group": "Screen_Recordings",
21350     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21351     "version": "0.0.0",
21352     "filename": "server/api/screenRecording/index.js",
21353     "groupTitle": "Screen_Recordings"
21354   },
21355   {
21356     "type": "put",
21357     "url": "/api/screen/recordings/{id}",
21358     "title": "Update an existing Recording",
21359     "examples": [
21360       {
21361         "title": "Example usage:",
21362         "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",
21363         "type": "json"
21364       }
21365     ],
21366     "name": "updateRecordings",
21367     "group": "Screen_Recordings",
21368     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21369     "version": "0.0.0",
21370     "filename": "server/api/screenRecording/index.js",
21371     "groupTitle": "Screen_Recordings"
21372   },
21373   {
21374     "type": "post",
21375     "url": "/api/integrations/servicenow/accounts",
21376     "title": "Creates a new Servicenow Account",
21377     "examples": [
21378       {
21379         "title": "Example usage:",
21380         "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",
21381         "type": "json"
21382       }
21383     ],
21384     "name": "CreateServicenow_Accounts",
21385     "group": "Servicenow_Accounts",
21386     "parameter": {
21387       "fields": {
21388         "Body": [
21389           {
21390             "group": "Body",
21391             "type": "String",
21392             "optional": true,
21393             "field": "name",
21394             "description": ""
21395           },
21396           {
21397             "group": "Body",
21398             "type": "String",
21399             "optional": true,
21400             "field": "description",
21401             "description": ""
21402           },
21403           {
21404             "group": "Body",
21405             "type": "String",
21406             "optional": true,
21407             "field": "username",
21408             "description": ""
21409           },
21410           {
21411             "group": "Body",
21412             "type": "String",
21413             "optional": true,
21414             "field": "password",
21415             "description": ""
21416           },
21417           {
21418             "group": "Body",
21419             "type": "String",
21420             "optional": true,
21421             "field": "email",
21422             "description": ""
21423           },
21424           {
21425             "group": "Body",
21426             "type": "String",
21427             "optional": true,
21428             "field": "remoteUri",
21429             "description": ""
21430           },
21431           {
21432             "group": "Body",
21433             "type": "String",
21434             "optional": false,
21435             "field": "serverUrl",
21436             "description": ""
21437           }
21438         ]
21439       }
21440     },
21441     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21442     "version": "0.0.0",
21443     "filename": "server/api/intServicenowAccount/index.js",
21444     "groupTitle": "Servicenow_Accounts"
21445   },
21446   {
21447     "type": "delete",
21448     "url": "/api/integrations/servicenow/accounts/{id}",
21449     "title": "Deletes a Servicenow Account",
21450     "examples": [
21451       {
21452         "title": "Example usage:",
21453         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password} -X DELETE",
21454         "type": "json"
21455       }
21456     ],
21457     "name": "DeleteServicenow_Accounts",
21458     "group": "Servicenow_Accounts",
21459     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21460     "version": "0.0.0",
21461     "filename": "server/api/intServicenowAccount/index.js",
21462     "groupTitle": "Servicenow_Accounts"
21463   },
21464   {
21465     "type": "get",
21466     "url": "/api/integrations/servicenow/accounts",
21467     "title": "Gets a list of Servicenow Accounts",
21468     "examples": [
21469       {
21470         "title": "Example usage:",
21471         "content": "curl https://{domain}/api/integrations/servicenow/accounts -v -u {name}:{password}",
21472         "type": "json"
21473       }
21474     ],
21475     "name": "GetServicenow_Accounts",
21476     "group": "Servicenow_Accounts",
21477     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21478     "version": "0.0.0",
21479     "filename": "server/api/intServicenowAccount/index.js",
21480     "groupTitle": "Servicenow_Accounts"
21481   },
21482   {
21483     "type": "get",
21484     "url": "/api/integrations/servicenow/accounts/{id}",
21485     "title": "Gets a single Servicenow Account",
21486     "examples": [
21487       {
21488         "title": "Example usage:",
21489         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password}",
21490         "type": "json"
21491       }
21492     ],
21493     "name": "ShowServicenow_Accounts",
21494     "group": "Servicenow_Accounts",
21495     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21496     "version": "0.0.0",
21497     "filename": "server/api/intServicenowAccount/index.js",
21498     "groupTitle": "Servicenow_Accounts"
21499   },
21500   {
21501     "type": "post",
21502     "url": "/api/integrations/servicenow/accounts/{id}/configurations",
21503     "title": "Creates new configuration",
21504     "examples": [
21505       {
21506         "title": "Example usage:",
21507         "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",
21508         "type": "json"
21509       }
21510     ],
21511     "name": "addConfiguration",
21512     "group": "Servicenow_Accounts",
21513     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21514     "version": "0.0.0",
21515     "filename": "server/api/intServicenowAccount/index.js",
21516     "groupTitle": "Servicenow_Accounts"
21517   },
21518   {
21519     "type": "get",
21520     "url": "/api/integrations/servicenow/accounts/{id}/configurations",
21521     "title": "Gets account configurations",
21522     "examples": [
21523       {
21524         "title": "Example usage:",
21525         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/configurations -v -u {name}:{password} -X GET",
21526         "type": "json"
21527       }
21528     ],
21529     "name": "getConfigurations",
21530     "group": "Servicenow_Accounts",
21531     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21532     "version": "0.0.0",
21533     "filename": "server/api/intServicenowAccount/index.js",
21534     "groupTitle": "Servicenow_Accounts"
21535   },
21536   {
21537     "type": "get",
21538     "url": "/api/integrations/servicenow/accounts/{id}/fields",
21539     "title": "Gets account fields",
21540     "examples": [
21541       {
21542         "title": "Example usage:",
21543         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/fields -v -u {name}:{password} -X GET",
21544         "type": "json"
21545       }
21546     ],
21547     "name": "getFields",
21548     "group": "Servicenow_Accounts",
21549     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21550     "version": "0.0.0",
21551     "filename": "server/api/intServicenowAccount/index.js",
21552     "groupTitle": "Servicenow_Accounts"
21553   },
21554   {
21555     "type": "put",
21556     "url": "/api/integrations/servicenow/accounts/{id}",
21557     "title": "Update an existing Servicenow Account",
21558     "examples": [
21559       {
21560         "title": "Example usage:",
21561         "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",
21562         "type": "json"
21563       }
21564     ],
21565     "name": "updateServicenow_Accounts",
21566     "group": "Servicenow_Accounts",
21567     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21568     "version": "0.0.0",
21569     "filename": "server/api/intServicenowAccount/index.js",
21570     "groupTitle": "Servicenow_Accounts"
21571   },
21572   {
21573     "type": "post",
21574     "url": "/api/integrations/servicenow/configurations",
21575     "title": "Creates a new Servicenow Configuration",
21576     "examples": [
21577       {
21578         "title": "Example usage:",
21579         "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",
21580         "type": "json"
21581       }
21582     ],
21583     "name": "CreateServicenow_Configurations",
21584     "group": "Servicenow_Configurations",
21585     "parameter": {
21586       "fields": {
21587         "Body": [
21588           {
21589             "group": "Body",
21590             "type": "String",
21591             "optional": true,
21592             "field": "name",
21593             "description": ""
21594           },
21595           {
21596             "group": "Body",
21597             "type": "String",
21598             "optional": true,
21599             "field": "description",
21600             "description": ""
21601           }
21602         ]
21603       }
21604     },
21605     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21606     "version": "0.0.0",
21607     "filename": "server/api/intServicenowConfiguration/index.js",
21608     "groupTitle": "Servicenow_Configurations"
21609   },
21610   {
21611     "type": "delete",
21612     "url": "/api/integrations/servicenow/configurations/{id}",
21613     "title": "Deletes a Servicenow Configuration",
21614     "examples": [
21615       {
21616         "title": "Example usage:",
21617         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password} -X DELETE",
21618         "type": "json"
21619       }
21620     ],
21621     "name": "DeleteServicenow_Configurations",
21622     "group": "Servicenow_Configurations",
21623     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21624     "version": "0.0.0",
21625     "filename": "server/api/intServicenowConfiguration/index.js",
21626     "groupTitle": "Servicenow_Configurations"
21627   },
21628   {
21629     "type": "get",
21630     "url": "/api/integrations/servicenow/configurations",
21631     "title": "Gets a list of Servicenow Configurations",
21632     "examples": [
21633       {
21634         "title": "Example usage:",
21635         "content": "curl https://{domain}/api/integrations/servicenow/configurations -v -u {name}:{password}",
21636         "type": "json"
21637       }
21638     ],
21639     "name": "GetServicenow_Configurations",
21640     "group": "Servicenow_Configurations",
21641     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21642     "version": "0.0.0",
21643     "filename": "server/api/intServicenowConfiguration/index.js",
21644     "groupTitle": "Servicenow_Configurations"
21645   },
21646   {
21647     "type": "get",
21648     "url": "/api/integrations/servicenow/configurations/{id}",
21649     "title": "Gets a single Servicenow Configuration",
21650     "examples": [
21651       {
21652         "title": "Example usage:",
21653         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password}",
21654         "type": "json"
21655       }
21656     ],
21657     "name": "ShowServicenow_Configurations",
21658     "group": "Servicenow_Configurations",
21659     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21660     "version": "0.0.0",
21661     "filename": "server/api/intServicenowConfiguration/index.js",
21662     "groupTitle": "Servicenow_Configurations"
21663   },
21664   {
21665     "type": "get",
21666     "url": "/api/integrations/servicenow/configurations/{id}/descriptions",
21667     "title": "Gets configurations descriptions",
21668     "examples": [
21669       {
21670         "title": "Example usage:",
21671         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
21672         "type": "json"
21673       }
21674     ],
21675     "name": "getDescriptions",
21676     "group": "Servicenow_Configurations",
21677     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21678     "version": "0.0.0",
21679     "filename": "server/api/intServicenowConfiguration/index.js",
21680     "groupTitle": "Servicenow_Configurations"
21681   },
21682   {
21683     "type": "get",
21684     "url": "/api/integrations/servicenow/configurations/{id}/fields",
21685     "title": "Gets configurations fields",
21686     "examples": [
21687       {
21688         "title": "Example usage:",
21689         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/fields -v -u {name}:{password} -X GET",
21690         "type": "json"
21691       }
21692     ],
21693     "name": "getFields",
21694     "group": "Servicenow_Configurations",
21695     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21696     "version": "0.0.0",
21697     "filename": "server/api/intServicenowConfiguration/index.js",
21698     "groupTitle": "Servicenow_Configurations"
21699   },
21700   {
21701     "type": "get",
21702     "url": "/api/integrations/servicenow/configurations/{id}/subjects",
21703     "title": "Gets configurations subjects",
21704     "examples": [
21705       {
21706         "title": "Example usage:",
21707         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/subjects -v -u {name}:{password} -X GET",
21708         "type": "json"
21709       }
21710     ],
21711     "name": "getSubjects",
21712     "group": "Servicenow_Configurations",
21713     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21714     "version": "0.0.0",
21715     "filename": "server/api/intServicenowConfiguration/index.js",
21716     "groupTitle": "Servicenow_Configurations"
21717   },
21718   {
21719     "type": "put",
21720     "url": "/api/integrations/servicenow/configurations/{id}",
21721     "title": "Update an existing Servicenow Configuration",
21722     "examples": [
21723       {
21724         "title": "Example usage:",
21725         "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",
21726         "type": "json"
21727       }
21728     ],
21729     "name": "updateServicenow_Configurations",
21730     "group": "Servicenow_Configurations",
21731     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21732     "version": "0.0.0",
21733     "filename": "server/api/intServicenowConfiguration/index.js",
21734     "groupTitle": "Servicenow_Configurations"
21735   },
21736   {
21737     "type": "post",
21738     "url": "/api/integrations/servicenow/fields",
21739     "title": "Creates a new Servicenow Field",
21740     "examples": [
21741       {
21742         "title": "Example usage:",
21743         "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",
21744         "type": "json"
21745       }
21746     ],
21747     "name": "CreateServicenow_Fields",
21748     "group": "Servicenow_Fields",
21749     "parameter": {
21750       "fields": {
21751         "Body": [
21752           {
21753             "group": "Body",
21754             "type": "String",
21755             "allowedValues": [
21756               "\"string\"",
21757               "\"variable\"",
21758               "\"customVariable\"",
21759               "\"keyValue\"",
21760               "\"picklist\""
21761             ],
21762             "optional": true,
21763             "field": "type",
21764             "description": ""
21765           },
21766           {
21767             "group": "Body",
21768             "type": "String",
21769             "optional": true,
21770             "field": "content",
21771             "description": ""
21772           },
21773           {
21774             "group": "Body",
21775             "type": "String",
21776             "optional": true,
21777             "field": "key",
21778             "description": ""
21779           },
21780           {
21781             "group": "Body",
21782             "type": "String",
21783             "allowedValues": [
21784               "\"string\"",
21785               "\"variable\"",
21786               "\"customVariable\""
21787             ],
21788             "optional": true,
21789             "field": "keyType",
21790             "description": ""
21791           },
21792           {
21793             "group": "Body",
21794             "type": "String",
21795             "optional": true,
21796             "field": "keyContent",
21797             "description": ""
21798           },
21799           {
21800             "group": "Body",
21801             "type": "String",
21802             "optional": true,
21803             "field": "idField",
21804             "description": ""
21805           },
21806           {
21807             "group": "Body",
21808             "type": "String",
21809             "optional": true,
21810             "field": "nameField",
21811             "description": ""
21812           },
21813           {
21814             "group": "Body",
21815             "type": "Boolean",
21816             "optional": true,
21817             "field": "customField",
21818             "description": ""
21819           },
21820           {
21821             "group": "Body",
21822             "type": "String",
21823             "optional": true,
21824             "field": "variableName",
21825             "description": ""
21826           }
21827         ]
21828       }
21829     },
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/intServicenowField/index.js",
21833     "groupTitle": "Servicenow_Fields"
21834   },
21835   {
21836     "type": "delete",
21837     "url": "/api/integrations/servicenow/fields/{id}",
21838     "title": "Deletes a Servicenow Field",
21839     "examples": [
21840       {
21841         "title": "Example usage:",
21842         "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password} -X DELETE",
21843         "type": "json"
21844       }
21845     ],
21846     "name": "DeleteServicenow_Fields",
21847     "group": "Servicenow_Fields",
21848     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21849     "version": "0.0.0",
21850     "filename": "server/api/intServicenowField/index.js",
21851     "groupTitle": "Servicenow_Fields"
21852   },
21853   {
21854     "type": "get",
21855     "url": "/api/integrations/servicenow/fields",
21856     "title": "Gets a list of Servicenow Fields",
21857     "examples": [
21858       {
21859         "title": "Example usage:",
21860         "content": "curl https://{domain}/api/integrations/servicenow/fields -v -u {name}:{password}",
21861         "type": "json"
21862       }
21863     ],
21864     "name": "GetServicenow_Fields",
21865     "group": "Servicenow_Fields",
21866     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21867     "version": "0.0.0",
21868     "filename": "server/api/intServicenowField/index.js",
21869     "groupTitle": "Servicenow_Fields"
21870   },
21871   {
21872     "type": "get",
21873     "url": "/api/integrations/servicenow/fields/{id}",
21874     "title": "Gets a single Servicenow Field",
21875     "examples": [
21876       {
21877         "title": "Example usage:",
21878         "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password}",
21879         "type": "json"
21880       }
21881     ],
21882     "name": "ShowServicenow_Fields",
21883     "group": "Servicenow_Fields",
21884     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21885     "version": "0.0.0",
21886     "filename": "server/api/intServicenowField/index.js",
21887     "groupTitle": "Servicenow_Fields"
21888   },
21889   {
21890     "type": "put",
21891     "url": "/api/integrations/servicenow/fields/{id}",
21892     "title": "Update an existing Servicenow Field",
21893     "examples": [
21894       {
21895         "title": "Example usage:",
21896         "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",
21897         "type": "json"
21898       }
21899     ],
21900     "name": "updateServicenow_Fields",
21901     "group": "Servicenow_Fields",
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/intServicenowField/index.js",
21905     "groupTitle": "Servicenow_Fields"
21906   },
21907   {
21908     "type": "get",
21909     "url": "/api/settings",
21910     "title": "Gets a list of Settings",
21911     "examples": [
21912       {
21913         "title": "Example usage:",
21914         "content": "curl https://{domain}/api/settings -v -u {name}:{password}",
21915         "type": "json"
21916       }
21917     ],
21918     "name": "GetSettings",
21919     "group": "Settings",
21920     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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}",
21928     "title": "Gets a single Setting",
21929     "examples": [
21930       {
21931         "title": "Example usage:",
21932         "content": "curl https://{domain}/api/settings/{id} -v -u {name}:{password}",
21933         "type": "json"
21934       }
21935     ],
21936     "name": "ShowSettings",
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": "post",
21945     "url": "/api/settings/{id}/favicon",
21946     "title": "Add Favicon",
21947     "examples": [
21948       {
21949         "title": "Example usage:",
21950         "content": "curl https://{domain}/api/settings/{id}/favicon -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21951         "type": "json"
21952       }
21953     ],
21954     "name": "addFavicon",
21955     "group": "Settings",
21956     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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": "post",
21963     "url": "/api/settings/{id}/logo",
21964     "title": "Add logo",
21965     "examples": [
21966       {
21967         "title": "Example usage:",
21968         "content": "curl https://{domain}/api/settings/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21969         "type": "json"
21970       }
21971     ],
21972     "name": "addLogo",
21973     "group": "Settings",
21974     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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": "post",
21981     "url": "/api/settings/{id}/logo_login",
21982     "title": "Add logo login",
21983     "examples": [
21984       {
21985         "title": "Example usage:",
21986         "content": "curl https://{domain}/api/settings/{id}/logo_login -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21987         "type": "json"
21988       }
21989     ],
21990     "name": "addLogoLogin",
21991     "group": "Settings",
21992     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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": "post",
21999     "url": "/api/settings/{id}/preferred",
22000     "title": "Add Preferred",
22001     "examples": [
22002       {
22003         "title": "Example usage:",
22004         "content": "curl https://{domain}/api/settings/{id}/preferred -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
22005         "type": "json"
22006       }
22007     ],
22008     "name": "addPreferred",
22009     "group": "Settings",
22010     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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": "get",
22017     "url": "/api/settings/now",
22018     "title": "Get Server Current Date",
22019     "examples": [
22020       {
22021         "title": "Example usage:",
22022         "content": "curl https://{domain}/api/settings/now -v -X GET",
22023         "type": "json"
22024       }
22025     ],
22026     "name": "getDate",
22027     "group": "Settings",
22028     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22029     "version": "0.0.0",
22030     "filename": "server/api/setting/index.js",
22031     "groupTitle": "Settings"
22032   },
22033   {
22034     "type": "get",
22035     "url": "/api/settings/{id}/favicon",
22036     "title": "Get Favicon",
22037     "examples": [
22038       {
22039         "title": "Example usage:",
22040         "content": "curl https://{domain}/api/settings/{id}/favicon -v -X GET",
22041         "type": "json"
22042       }
22043     ],
22044     "name": "getFavicon",
22045     "group": "Settings",
22046     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22047     "version": "0.0.0",
22048     "filename": "server/api/setting/index.js",
22049     "groupTitle": "Settings"
22050   },
22051   {
22052     "type": "get",
22053     "url": "/api/settings/{id}/gdpr",
22054     "title": "Get gdpr settings",
22055     "examples": [
22056       {
22057         "title": "Example usage:",
22058         "content": "curl https://{domain}/api/settings/{id}/gdpr -v -u {name}:{password} -X GET",
22059         "type": "json"
22060       }
22061     ],
22062     "name": "getGdpr",
22063     "group": "Settings",
22064     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22065     "version": "0.0.0",
22066     "filename": "server/api/setting/index.js",
22067     "groupTitle": "Settings"
22068   },
22069   {
22070     "type": "get",
22071     "url": "/api/settings/{id}/logo",
22072     "title": "Get logo",
22073     "examples": [
22074       {
22075         "title": "Example usage:",
22076         "content": "curl https://{domain}/api/settings/{id}/logo -v -X GET",
22077         "type": "json"
22078       }
22079     ],
22080     "name": "getLogo",
22081     "group": "Settings",
22082     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22083     "version": "0.0.0",
22084     "filename": "server/api/setting/index.js",
22085     "groupTitle": "Settings"
22086   },
22087   {
22088     "type": "get",
22089     "url": "/api/settings/{id}/logo_login",
22090     "title": "Get logo login",
22091     "examples": [
22092       {
22093         "title": "Example usage:",
22094         "content": "curl https://{domain}/api/settings/{id}/logo_login -v -X GET",
22095         "type": "json"
22096       }
22097     ],
22098     "name": "getLogoLogin",
22099     "group": "Settings",
22100     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22101     "version": "0.0.0",
22102     "filename": "server/api/setting/index.js",
22103     "groupTitle": "Settings"
22104   },
22105   {
22106     "type": "get",
22107     "url": "/api/settings/{id}/preferred",
22108     "title": "Get Preferred",
22109     "examples": [
22110       {
22111         "title": "Example usage:",
22112         "content": "curl https://{domain}/api/settings/{id}/preferred -v -X GET",
22113         "type": "json"
22114       }
22115     ],
22116     "name": "getPreferred",
22117     "group": "Settings",
22118     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22119     "version": "0.0.0",
22120     "filename": "server/api/setting/index.js",
22121     "groupTitle": "Settings"
22122   },
22123   {
22124     "type": "put",
22125     "url": "/api/settings/{id}",
22126     "title": "Update an existing Setting",
22127     "examples": [
22128       {
22129         "title": "Example usage:",
22130         "content": "curl https://{domain}/api/settings/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
22131         "type": "json"
22132       }
22133     ],
22134     "name": "updateSettings",
22135     "group": "Settings",
22136     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22137     "version": "0.0.0",
22138     "filename": "server/api/setting/index.js",
22139     "groupTitle": "Settings"
22140   },
22141   {
22142     "type": "post",
22143     "url": "/api/sms/accounts/{id}/users",
22144     "title": "Add agents to a sms account",
22145     "examples": [
22146       {
22147         "title": "Example usage:",
22148         "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",
22149         "type": "json"
22150       }
22151     ],
22152     "name": "AddAgents",
22153     "group": "Sms_Accounts",
22154     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22155     "version": "0.0.0",
22156     "filename": "server/api/smsAccount/index.js",
22157     "groupTitle": "Sms_Accounts"
22158   },
22159   {
22160     "type": "post",
22161     "url": "/api/sms/accounts",
22162     "title": "Creates a new Account",
22163     "examples": [
22164       {
22165         "title": "Example usage:",
22166         "content": "curl https://{domain}/api/sms/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22167         "type": "json"
22168       }
22169     ],
22170     "name": "CreateAccounts",
22171     "group": "Sms_Accounts",
22172     "parameter": {
22173       "fields": {
22174         "Body": [
22175           {
22176             "group": "Body",
22177             "type": "String",
22178             "optional": false,
22179             "field": "name",
22180             "description": ""
22181           },
22182           {
22183             "group": "Body",
22184             "type": "String",
22185             "optional": false,
22186             "field": "key",
22187             "description": ""
22188           },
22189           {
22190             "group": "Body",
22191             "type": "String",
22192             "optional": false,
22193             "field": "remote",
22194             "description": ""
22195           },
22196           {
22197             "group": "Body",
22198             "type": "String",
22199             "optional": true,
22200             "field": "token",
22201             "description": ""
22202           },
22203           {
22204             "group": "Body",
22205             "type": "String",
22206             "optional": true,
22207             "field": "phone",
22208             "description": ""
22209           },
22210           {
22211             "group": "Body",
22212             "type": "String",
22213             "allowedValues": [
22214               "\"twilio\"",
22215               "\"skebby\"",
22216               "\"connectel\"",
22217               "\"clicksend\"",
22218               "\"plivo\"",
22219               "\"clickatell\"",
22220               "\"bandwidth\"",
22221               "\"csc\"",
22222               "\"infobip\"",
22223               "\"intelepeer\""
22224             ],
22225             "optional": true,
22226             "field": "type",
22227             "description": ""
22228           },
22229           {
22230             "group": "Body",
22231             "type": "String",
22232             "optional": true,
22233             "field": "accountSid",
22234             "description": ""
22235           },
22236           {
22237             "group": "Body",
22238             "type": "String",
22239             "optional": true,
22240             "field": "authId",
22241             "description": ""
22242           },
22243           {
22244             "group": "Body",
22245             "type": "String",
22246             "optional": true,
22247             "field": "authToken",
22248             "description": ""
22249           },
22250           {
22251             "group": "Body",
22252             "type": "String",
22253             "allowedValues": [
22254               "\"SI\"",
22255               "\"TI\"",
22256               "\"GP\""
22257             ],
22258             "optional": true,
22259             "field": "smsMethod",
22260             "description": ""
22261           },
22262           {
22263             "group": "Body",
22264             "type": "String",
22265             "optional": true,
22266             "field": "username",
22267             "description": ""
22268           },
22269           {
22270             "group": "Body",
22271             "type": "String",
22272             "optional": true,
22273             "field": "password",
22274             "description": ""
22275           },
22276           {
22277             "group": "Body",
22278             "type": "String",
22279             "optional": true,
22280             "field": "apiKey",
22281             "description": ""
22282           },
22283           {
22284             "group": "Body",
22285             "type": "String",
22286             "optional": true,
22287             "field": "applicationId",
22288             "description": ""
22289           },
22290           {
22291             "group": "Body",
22292             "type": "String",
22293             "optional": true,
22294             "field": "accountId",
22295             "description": ""
22296           },
22297           {
22298             "group": "Body",
22299             "type": "String",
22300             "optional": true,
22301             "field": "senderString",
22302             "description": ""
22303           },
22304           {
22305             "group": "Body",
22306             "type": "Boolean",
22307             "optional": true,
22308             "field": "deliveryReport",
22309             "description": ""
22310           },
22311           {
22312             "group": "Body",
22313             "type": "String",
22314             "optional": true,
22315             "field": "description",
22316             "description": ""
22317           },
22318           {
22319             "group": "Body",
22320             "type": "Text",
22321             "optional": true,
22322             "field": "notificationTemplate",
22323             "description": ""
22324           },
22325           {
22326             "group": "Body",
22327             "type": "Boolean",
22328             "optional": true,
22329             "field": "notificationSound",
22330             "description": ""
22331           },
22332           {
22333             "group": "Body",
22334             "type": "Boolean",
22335             "optional": true,
22336             "field": "notificationShake",
22337             "description": ""
22338           },
22339           {
22340             "group": "Body",
22341             "type": "Integer",
22342             "optional": true,
22343             "field": "waitForTheAssignedAgent",
22344             "description": ""
22345           },
22346           {
22347             "group": "Body",
22348             "type": "Boolean",
22349             "optional": true,
22350             "field": "queueTransfer",
22351             "description": ""
22352           },
22353           {
22354             "group": "Body",
22355             "type": "Integer",
22356             "optional": true,
22357             "field": "queueTransferTimeout",
22358             "description": ""
22359           },
22360           {
22361             "group": "Body",
22362             "type": "Boolean",
22363             "optional": true,
22364             "field": "agentTransfer",
22365             "description": ""
22366           },
22367           {
22368             "group": "Body",
22369             "type": "Integer",
22370             "optional": true,
22371             "field": "agentTransferTimeout",
22372             "description": ""
22373           },
22374           {
22375             "group": "Body",
22376             "type": "String",
22377             "optional": true,
22378             "field": "baseUrl",
22379             "description": ""
22380           },
22381           {
22382             "group": "Body",
22383             "type": "Integer",
22384             "optional": true,
22385             "field": "mandatoryDispositionPauseId",
22386             "description": "<p>Status to put when mandatory disposition is enabled</p>"
22387           },
22388           {
22389             "group": "Body",
22390             "type": "Boolean",
22391             "optional": true,
22392             "field": "mandatoryDisposition",
22393             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
22394           }
22395         ]
22396       }
22397     },
22398     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22399     "version": "0.0.0",
22400     "filename": "server/api/smsAccount/index.js",
22401     "groupTitle": "Sms_Accounts"
22402   },
22403   {
22404     "type": "delete",
22405     "url": "/api/sms/accounts/{id}",
22406     "title": "Deletes a Account",
22407     "examples": [
22408       {
22409         "title": "Example usage:",
22410         "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password} -X DELETE",
22411         "type": "json"
22412       }
22413     ],
22414     "name": "DeleteAccounts",
22415     "group": "Sms_Accounts",
22416     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22417     "version": "0.0.0",
22418     "filename": "server/api/smsAccount/index.js",
22419     "groupTitle": "Sms_Accounts"
22420   },
22421   {
22422     "type": "get",
22423     "url": "/api/sms/accounts/describe",
22424     "title": "Gets table info about Accounts",
22425     "examples": [
22426       {
22427         "title": "Example usage:",
22428         "content": "curl https://{domain}/api/sms/accounts/describe -v -u {name}:{password}",
22429         "type": "json"
22430       }
22431     ],
22432     "name": "DescribeAccounts",
22433     "group": "Sms_Accounts",
22434     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22435     "version": "0.0.0",
22436     "filename": "server/api/smsAccount/index.js",
22437     "groupTitle": "Sms_Accounts"
22438   },
22439   {
22440     "type": "get",
22441     "url": "/api/sms/accounts",
22442     "title": "Gets a list of Accounts",
22443     "examples": [
22444       {
22445         "title": "Example usage:",
22446         "content": "curl https://{domain}/api/sms/accounts -v -u {name}:{password}",
22447         "type": "json"
22448       }
22449     ],
22450     "name": "GetAccounts",
22451     "group": "Sms_Accounts",
22452     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22453     "version": "0.0.0",
22454     "filename": "server/api/smsAccount/index.js",
22455     "groupTitle": "Sms_Accounts"
22456   },
22457   {
22458     "type": "get",
22459     "url": "/api/sms/accounts/{id}/users",
22460     "title": "Gets agents from sms account",
22461     "examples": [
22462       {
22463         "title": "Example usage:",
22464         "content": "curl https://{domain}/api/sms/accounts/{id}/users -v -u {name}:{password} -X GET",
22465         "type": "json"
22466       }
22467     ],
22468     "name": "GetAgents",
22469     "group": "Sms_Accounts",
22470     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22471     "version": "0.0.0",
22472     "filename": "server/api/smsAccount/index.js",
22473     "groupTitle": "Sms_Accounts"
22474   },
22475   {
22476     "type": "delete",
22477     "url": "/api/sms/accounts/{id}/users",
22478     "title": "Removes agents from a sms account",
22479     "examples": [
22480       {
22481         "title": "Example usage:",
22482         "content": "curl https://{domain}/api/sms/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22483         "type": "json"
22484       }
22485     ],
22486     "name": "RemoveAgents",
22487     "group": "Sms_Accounts",
22488     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22489     "version": "0.0.0",
22490     "filename": "server/api/smsAccount/index.js",
22491     "groupTitle": "Sms_Accounts"
22492   },
22493   {
22494     "type": "delete",
22495     "url": "/api/sms/accounts/{id}/canned_answers",
22496     "title": "Removes canned answers from account",
22497     "examples": [
22498       {
22499         "title": "Example usage:",
22500         "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22501         "type": "json"
22502       }
22503     ],
22504     "name": "RemoveAnswers",
22505     "group": "Sms_Accounts",
22506     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22507     "version": "0.0.0",
22508     "filename": "server/api/smsAccount/index.js",
22509     "groupTitle": "Sms_Accounts"
22510   },
22511   {
22512     "type": "delete",
22513     "url": "/api/sms/accounts/{id}/dispositions",
22514     "title": "Removes dispositions from account",
22515     "examples": [
22516       {
22517         "title": "Example usage:",
22518         "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22519         "type": "json"
22520       }
22521     ],
22522     "name": "RemoveDispositions",
22523     "group": "Sms_Accounts",
22524     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22525     "version": "0.0.0",
22526     "filename": "server/api/smsAccount/index.js",
22527     "groupTitle": "Sms_Accounts"
22528   },
22529   {
22530     "type": "get",
22531     "url": "/api/sms/accounts/{id}",
22532     "title": "Gets a single Account",
22533     "examples": [
22534       {
22535         "title": "Example usage:",
22536         "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password}",
22537         "type": "json"
22538       }
22539     ],
22540     "name": "ShowAccounts",
22541     "group": "Sms_Accounts",
22542     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22543     "version": "0.0.0",
22544     "filename": "server/api/smsAccount/index.js",
22545     "groupTitle": "Sms_Accounts"
22546   },
22547   {
22548     "type": "put",
22549     "url": "/api/sms/messages/{id}/accept",
22550     "title": "Accepts message",
22551     "examples": [
22552       {
22553         "title": "Example usage:",
22554         "content": "curl https://{domain}/api/sms/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
22555         "type": "json"
22556       }
22557     ],
22558     "name": "acceptMessage",
22559     "group": "Sms_Accounts",
22560     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22561     "version": "0.0.0",
22562     "filename": "server/api/smsMessage/index.js",
22563     "groupTitle": "Sms_Accounts"
22564   },
22565   {
22566     "type": "post",
22567     "url": "/api/sms/accounts/{id}/canned_answers",
22568     "title": "Creates new canned answer",
22569     "examples": [
22570       {
22571         "title": "Example usage:",
22572         "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",
22573         "type": "json"
22574       }
22575     ],
22576     "name": "addAnswer",
22577     "group": "Sms_Accounts",
22578     "parameter": {
22579       "fields": {
22580         "Body": [
22581           {
22582             "group": "Body",
22583             "type": "String",
22584             "optional": false,
22585             "field": "key",
22586             "description": ""
22587           },
22588           {
22589             "group": "Body",
22590             "type": "Text",
22591             "optional": false,
22592             "field": "value",
22593             "description": ""
22594           },
22595           {
22596             "group": "Body",
22597             "type": "String",
22598             "optional": true,
22599             "field": "description",
22600             "description": ""
22601           },
22602           {
22603             "group": "Body",
22604             "type": "Virtual",
22605             "optional": true,
22606             "field": "name",
22607             "description": ""
22608           }
22609         ]
22610       }
22611     },
22612     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22613     "version": "0.0.0",
22614     "filename": "server/api/smsAccount/index.js",
22615     "groupTitle": "Sms_Accounts"
22616   },
22617   {
22618     "type": "post",
22619     "url": "/api/sms/accounts/{id}/applications",
22620     "title": "Creates new applications",
22621     "examples": [
22622       {
22623         "title": "Example usage:",
22624         "content": "curl https://{domain}/api/sms/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
22625         "type": "json"
22626       }
22627     ],
22628     "name": "addApplications",
22629     "group": "Sms_Accounts",
22630     "parameter": {
22631       "fields": {
22632         "Body": [
22633           {
22634             "group": "Body",
22635             "type": "Integer",
22636             "optional": false,
22637             "field": "priority",
22638             "description": ""
22639           },
22640           {
22641             "group": "Body",
22642             "type": "String",
22643             "optional": false,
22644             "field": "app",
22645             "description": ""
22646           },
22647           {
22648             "group": "Body",
22649             "type": "Text",
22650             "optional": true,
22651             "field": "appdata",
22652             "description": ""
22653           },
22654           {
22655             "group": "Body",
22656             "type": "String",
22657             "optional": true,
22658             "field": "description",
22659             "description": ""
22660           },
22661           {
22662             "group": "Body",
22663             "type": "String",
22664             "optional": true,
22665             "field": "interval",
22666             "description": ""
22667           }
22668         ]
22669       }
22670     },
22671     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22672     "version": "0.0.0",
22673     "filename": "server/api/smsAccount/index.js",
22674     "groupTitle": "Sms_Accounts"
22675   },
22676   {
22677     "type": "post",
22678     "url": "/api/sms/accounts/{id}/dispositions",
22679     "title": "Creates new disposition",
22680     "examples": [
22681       {
22682         "title": "Example usage:",
22683         "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
22684         "type": "json"
22685       }
22686     ],
22687     "name": "addDisposition",
22688     "group": "Sms_Accounts",
22689     "parameter": {
22690       "fields": {
22691         "Body": [
22692           {
22693             "group": "Body",
22694             "type": "String",
22695             "optional": false,
22696             "field": "name",
22697             "description": ""
22698           },
22699           {
22700             "group": "Body",
22701             "type": "String",
22702             "allowedValues": [
22703               "\"first\"",
22704               "\"second\"",
22705               "\"third\""
22706             ],
22707             "optional": false,
22708             "field": "level",
22709             "description": ""
22710           },
22711           {
22712             "group": "Body",
22713             "type": "String",
22714             "optional": true,
22715             "field": "description",
22716             "description": ""
22717           }
22718         ]
22719       }
22720     },
22721     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22722     "version": "0.0.0",
22723     "filename": "server/api/smsAccount/index.js",
22724     "groupTitle": "Sms_Accounts"
22725   },
22726   {
22727     "type": "get",
22728     "url": "/api/sms/accounts/{id}/canned_answers",
22729     "title": "Gets account canned answers",
22730     "examples": [
22731       {
22732         "title": "Example usage:",
22733         "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
22734         "type": "json"
22735       }
22736     ],
22737     "name": "getAnswers",
22738     "group": "Sms_Accounts",
22739     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22740     "version": "0.0.0",
22741     "filename": "server/api/smsAccount/index.js",
22742     "groupTitle": "Sms_Accounts"
22743   },
22744   {
22745     "type": "get",
22746     "url": "/api/sms/accounts/{id}/applications",
22747     "title": "Gets account applications",
22748     "examples": [
22749       {
22750         "title": "Example usage:",
22751         "content": "curl https://{domain}/api/sms/accounts/{id}/applications -v -u {name}:{password} -X GET",
22752         "type": "json"
22753       }
22754     ],
22755     "name": "getApplications",
22756     "group": "Sms_Accounts",
22757     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22758     "version": "0.0.0",
22759     "filename": "server/api/smsAccount/index.js",
22760     "groupTitle": "Sms_Accounts"
22761   },
22762   {
22763     "type": "get",
22764     "url": "/api/sms/accounts/{id}/dispositions",
22765     "title": "Gets account dispositions",
22766     "examples": [
22767       {
22768         "title": "Example usage:",
22769         "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
22770         "type": "json"
22771       }
22772     ],
22773     "name": "getDispositions",
22774     "group": "Sms_Accounts",
22775     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22776     "version": "0.0.0",
22777     "filename": "server/api/smsAccount/index.js",
22778     "groupTitle": "Sms_Accounts"
22779   },
22780   {
22781     "type": "get",
22782     "url": "/api/sms/accounts/{id}/interactions",
22783     "title": "Gets Sms Account interactions",
22784     "examples": [
22785       {
22786         "title": "Example usage:",
22787         "content": "curl https://{domain}/api/sms/accounts/{id}/interactions -v -u {name}:{password} -X GET",
22788         "type": "json"
22789       }
22790     ],
22791     "name": "getInteractions",
22792     "group": "Sms_Accounts",
22793     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22794     "version": "0.0.0",
22795     "filename": "server/api/smsAccount/index.js",
22796     "groupTitle": "Sms_Accounts"
22797   },
22798   {
22799     "type": "post",
22800     "url": "/api/sms/accounts/{id}/notify",
22801     "title": "Notify new message",
22802     "examples": [
22803       {
22804         "title": "Example usage:",
22805         "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",
22806         "type": "json"
22807       }
22808     ],
22809     "name": "notify",
22810     "group": "Sms_Accounts",
22811     "description": "<p>Motion 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>",
22812     "version": "0.0.0",
22813     "filename": "server/api/smsAccount/index.js",
22814     "groupTitle": "Sms_Accounts"
22815   },
22816   {
22817     "type": "put",
22818     "url": "/api/sms/messages/{id}/reject",
22819     "title": "Rejects message",
22820     "examples": [
22821       {
22822         "title": "Example usage:",
22823         "content": "curl https://{domain}/api/sms/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
22824         "type": "json"
22825       }
22826     ],
22827     "name": "rejectMessage",
22828     "group": "Sms_Accounts",
22829     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22830     "version": "0.0.0",
22831     "filename": "server/api/smsMessage/index.js",
22832     "groupTitle": "Sms_Accounts"
22833   },
22834   {
22835     "type": "post",
22836     "url": "/api/sms/accounts/{id}/send",
22837     "title": "Send new sms message",
22838     "examples": [
22839       {
22840         "title": "Example usage:",
22841         "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",
22842         "type": "json"
22843       }
22844     ],
22845     "name": "sendSms",
22846     "group": "Sms_Accounts",
22847     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22848     "version": "0.0.0",
22849     "filename": "server/api/smsAccount/index.js",
22850     "groupTitle": "Sms_Accounts"
22851   },
22852   {
22853     "type": "post",
22854     "url": "/api/sms/accounts/{id}/status",
22855     "title": "Receive message status",
22856     "examples": [
22857       {
22858         "title": "Example usage:",
22859         "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X POST",
22860         "type": "json"
22861       }
22862     ],
22863     "name": "statusMessage",
22864     "group": "Sms_Accounts",
22865     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22866     "version": "0.0.0",
22867     "filename": "server/api/smsAccount/index.js",
22868     "groupTitle": "Sms_Accounts"
22869   },
22870   {
22871     "type": "post",
22872     "url": "/api/sms/messages/{id}/status",
22873     "title": "Receive message status",
22874     "examples": [
22875       {
22876         "title": "Example usage:",
22877         "content": "curl https://{domain}/api/sms/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
22878         "type": "json"
22879       }
22880     ],
22881     "name": "statusMessage",
22882     "group": "Sms_Accounts",
22883     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22884     "version": "0.0.0",
22885     "filename": "server/api/smsMessage/index.js",
22886     "groupTitle": "Sms_Accounts"
22887   },
22888   {
22889     "type": "get",
22890     "url": "/api/sms/accounts/{id}/status",
22891     "title": "Receive message status as get request",
22892     "examples": [
22893       {
22894         "title": "Example usage:",
22895         "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X GET",
22896         "type": "json"
22897       }
22898     ],
22899     "name": "statusMessage",
22900     "group": "Sms_Accounts",
22901     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22902     "version": "0.0.0",
22903     "filename": "server/api/smsAccount/index.js",
22904     "groupTitle": "Sms_Accounts"
22905   },
22906   {
22907     "type": "put",
22908     "url": "/api/sms/accounts/{id}",
22909     "title": "Update an existing Account",
22910     "examples": [
22911       {
22912         "title": "Example usage:",
22913         "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",
22914         "type": "json"
22915       }
22916     ],
22917     "name": "updateAccounts",
22918     "group": "Sms_Accounts",
22919     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22920     "version": "0.0.0",
22921     "filename": "server/api/smsAccount/index.js",
22922     "groupTitle": "Sms_Accounts"
22923   },
22924   {
22925     "type": "post",
22926     "url": "/api/sms/applications",
22927     "title": "Creates a new Application",
22928     "examples": [
22929       {
22930         "title": "Example usage:",
22931         "content": "curl https://{domain}/api/sms/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22932         "type": "json"
22933       }
22934     ],
22935     "name": "CreateApplications",
22936     "group": "Sms_Applications",
22937     "parameter": {
22938       "fields": {
22939         "Body": [
22940           {
22941             "group": "Body",
22942             "type": "Integer",
22943             "optional": false,
22944             "field": "priority",
22945             "description": ""
22946           },
22947           {
22948             "group": "Body",
22949             "type": "String",
22950             "optional": false,
22951             "field": "app",
22952             "description": ""
22953           },
22954           {
22955             "group": "Body",
22956             "type": "Text",
22957             "optional": true,
22958             "field": "appdata",
22959             "description": ""
22960           },
22961           {
22962             "group": "Body",
22963             "type": "String",
22964             "optional": true,
22965             "field": "description",
22966             "description": ""
22967           },
22968           {
22969             "group": "Body",
22970             "type": "String",
22971             "optional": true,
22972             "field": "interval",
22973             "description": ""
22974           }
22975         ]
22976       }
22977     },
22978     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22979     "version": "0.0.0",
22980     "filename": "server/api/smsApplication/index.js",
22981     "groupTitle": "Sms_Applications"
22982   },
22983   {
22984     "type": "delete",
22985     "url": "/api/sms/applications/{id}",
22986     "title": "Deletes a Application",
22987     "examples": [
22988       {
22989         "title": "Example usage:",
22990         "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password} -X DELETE",
22991         "type": "json"
22992       }
22993     ],
22994     "name": "DeleteApplications",
22995     "group": "Sms_Applications",
22996     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22997     "version": "0.0.0",
22998     "filename": "server/api/smsApplication/index.js",
22999     "groupTitle": "Sms_Applications"
23000   },
23001   {
23002     "type": "get",
23003     "url": "/api/sms/applications",
23004     "title": "Gets a list of Applications",
23005     "examples": [
23006       {
23007         "title": "Example usage:",
23008         "content": "curl https://{domain}/api/sms/applications -v -u {name}:{password}",
23009         "type": "json"
23010       }
23011     ],
23012     "name": "GetApplications",
23013     "group": "Sms_Applications",
23014     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23015     "version": "0.0.0",
23016     "filename": "server/api/smsApplication/index.js",
23017     "groupTitle": "Sms_Applications"
23018   },
23019   {
23020     "type": "get",
23021     "url": "/api/sms/applications/{id}",
23022     "title": "Gets a single Application",
23023     "examples": [
23024       {
23025         "title": "Example usage:",
23026         "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password}",
23027         "type": "json"
23028       }
23029     ],
23030     "name": "ShowApplications",
23031     "group": "Sms_Applications",
23032     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23033     "version": "0.0.0",
23034     "filename": "server/api/smsApplication/index.js",
23035     "groupTitle": "Sms_Applications"
23036   },
23037   {
23038     "type": "put",
23039     "url": "/api/sms/applications/{id}",
23040     "title": "Update an existing Application",
23041     "examples": [
23042       {
23043         "title": "Example usage:",
23044         "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",
23045         "type": "json"
23046       }
23047     ],
23048     "name": "updateApplications",
23049     "group": "Sms_Applications",
23050     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23051     "version": "0.0.0",
23052     "filename": "server/api/smsApplication/index.js",
23053     "groupTitle": "Sms_Applications"
23054   },
23055   {
23056     "type": "post",
23057     "url": "/api/sms/interactions/{id}/tags",
23058     "title": "Add tags to the interaction",
23059     "examples": [
23060       {
23061         "title": "Example usage:",
23062         "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",
23063         "type": "json"
23064       }
23065     ],
23066     "name": "AddTags",
23067     "group": "Sms_Interactions",
23068     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23069     "version": "0.0.0",
23070     "filename": "server/api/smsInteraction/index.js",
23071     "groupTitle": "Sms_Interactions"
23072   },
23073   {
23074     "type": "post",
23075     "url": "/api/sms/interactions",
23076     "title": "Creates a new Interaction",
23077     "examples": [
23078       {
23079         "title": "Example usage:",
23080         "content": "curl https://{domain}/api/sms/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23081         "type": "json"
23082       }
23083     ],
23084     "name": "CreateInteractions",
23085     "group": "Sms_Interactions",
23086     "parameter": {
23087       "fields": {
23088         "Body": [
23089           {
23090             "group": "Body",
23091             "type": "Boolean",
23092             "optional": true,
23093             "field": "closed",
23094             "description": ""
23095           },
23096           {
23097             "group": "Body",
23098             "type": "String",
23099             "optional": true,
23100             "field": "closedAt",
23101             "description": ""
23102           },
23103           {
23104             "group": "Body",
23105             "type": "String",
23106             "optional": true,
23107             "field": "disposition",
23108             "description": ""
23109           },
23110           {
23111             "group": "Body",
23112             "type": "String",
23113             "optional": true,
23114             "field": "secondDisposition",
23115             "description": ""
23116           },
23117           {
23118             "group": "Body",
23119             "type": "String",
23120             "optional": true,
23121             "field": "thirdDisposition",
23122             "description": ""
23123           },
23124           {
23125             "group": "Body",
23126             "type": "String",
23127             "optional": true,
23128             "field": "note",
23129             "description": ""
23130           },
23131           {
23132             "group": "Body",
23133             "type": "String",
23134             "optional": true,
23135             "field": "phone",
23136             "description": ""
23137           },
23138           {
23139             "group": "Body",
23140             "type": "String",
23141             "optional": true,
23142             "field": "read1stAt",
23143             "description": ""
23144           },
23145           {
23146             "group": "Body",
23147             "type": "String",
23148             "allowedValues": [
23149               "\"in\"",
23150               "\"out\""
23151             ],
23152             "optional": false,
23153             "field": "firstMsgDirection",
23154             "description": ""
23155           },
23156           {
23157             "group": "Body",
23158             "type": "String",
23159             "optional": true,
23160             "field": "lastMsgAt",
23161             "description": ""
23162           },
23163           {
23164             "group": "Body",
23165             "type": "String",
23166             "allowedValues": [
23167               "\"in\"",
23168               "\"out\""
23169             ],
23170             "optional": false,
23171             "field": "lastMsgDirection",
23172             "description": ""
23173           },
23174           {
23175             "group": "Body",
23176             "type": "Boolean",
23177             "optional": true,
23178             "field": "autoreplyExecuted",
23179             "description": ""
23180           }
23181         ]
23182       }
23183     },
23184     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23185     "version": "0.0.0",
23186     "filename": "server/api/smsInteraction/index.js",
23187     "groupTitle": "Sms_Interactions"
23188   },
23189   {
23190     "type": "delete",
23191     "url": "/api/sms/interactions/{id}",
23192     "title": "Deletes a Interaction",
23193     "examples": [
23194       {
23195         "title": "Example usage:",
23196         "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password} -X DELETE",
23197         "type": "json"
23198       }
23199     ],
23200     "name": "DeleteInteractions",
23201     "group": "Sms_Interactions",
23202     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23203     "version": "0.0.0",
23204     "filename": "server/api/smsInteraction/index.js",
23205     "groupTitle": "Sms_Interactions"
23206   },
23207   {
23208     "type": "get",
23209     "url": "/api/sms/interactions/describe",
23210     "title": "Gets table info about Interactions",
23211     "examples": [
23212       {
23213         "title": "Example usage:",
23214         "content": "curl https://{domain}/api/sms/interactions/describe -v -u {name}:{password}",
23215         "type": "json"
23216       }
23217     ],
23218     "name": "DescribeInteractions",
23219     "group": "Sms_Interactions",
23220     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23221     "version": "0.0.0",
23222     "filename": "server/api/smsInteraction/index.js",
23223     "groupTitle": "Sms_Interactions"
23224   },
23225   {
23226     "type": "get",
23227     "url": "/api/sms/interactions",
23228     "title": "Gets a list of Interactions",
23229     "examples": [
23230       {
23231         "title": "Example usage:",
23232         "content": "curl https://{domain}/api/sms/interactions -v -u {name}:{password}",
23233         "type": "json"
23234       }
23235     ],
23236     "name": "GetInteractions",
23237     "group": "Sms_Interactions",
23238     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23239     "version": "0.0.0",
23240     "filename": "server/api/smsInteraction/index.js",
23241     "groupTitle": "Sms_Interactions"
23242   },
23243   {
23244     "type": "delete",
23245     "url": "/api/sms/interactions/{id}/tags",
23246     "title": "Removes tags from interaction",
23247     "examples": [
23248       {
23249         "title": "Example usage:",
23250         "content": "curl https://{domain}/api/sms/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
23251         "type": "json"
23252       }
23253     ],
23254     "name": "RemoveTags",
23255     "group": "Sms_Interactions",
23256     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23257     "version": "0.0.0",
23258     "filename": "server/api/smsInteraction/index.js",
23259     "groupTitle": "Sms_Interactions"
23260   },
23261   {
23262     "type": "get",
23263     "url": "/api/sms/interactions/{id}",
23264     "title": "Gets a single Interaction",
23265     "examples": [
23266       {
23267         "title": "Example usage:",
23268         "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password}",
23269         "type": "json"
23270       }
23271     ],
23272     "name": "ShowInteractions",
23273     "group": "Sms_Interactions",
23274     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23275     "version": "0.0.0",
23276     "filename": "server/api/smsInteraction/index.js",
23277     "groupTitle": "Sms_Interactions"
23278   },
23279   {
23280     "type": "post",
23281     "url": "/api/sms/interactions/{id}/messages",
23282     "title": "Creates new messages",
23283     "examples": [
23284       {
23285         "title": "Example usage:",
23286         "content": "curl https://{domain}/api/sms/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
23287         "type": "json"
23288       }
23289     ],
23290     "name": "addMessage",
23291     "group": "Sms_Interactions",
23292     "parameter": {
23293       "fields": {
23294         "Body": [
23295           {
23296             "group": "Body",
23297             "type": "Text",
23298             "optional": false,
23299             "field": "body",
23300             "description": ""
23301           },
23302           {
23303             "group": "Body",
23304             "type": "Boolean",
23305             "optional": true,
23306             "field": "read",
23307             "description": ""
23308           },
23309           {
23310             "group": "Body",
23311             "type": "String",
23312             "allowedValues": [
23313               "\"in\"",
23314               "\"out\""
23315             ],
23316             "optional": false,
23317             "field": "direction",
23318             "description": ""
23319           },
23320           {
23321             "group": "Body",
23322             "type": "String",
23323             "optional": true,
23324             "field": "messageId",
23325             "description": ""
23326           },
23327           {
23328             "group": "Body",
23329             "type": "String",
23330             "optional": true,
23331             "field": "phone",
23332             "description": ""
23333           },
23334           {
23335             "group": "Body",
23336             "type": "String",
23337             "optional": true,
23338             "field": "readAt",
23339             "description": ""
23340           },
23341           {
23342             "group": "Body",
23343             "type": "Boolean",
23344             "optional": true,
23345             "field": "secret",
23346             "description": ""
23347           },
23348           {
23349             "group": "Body",
23350             "type": "String",
23351             "optional": true,
23352             "field": "providerName",
23353             "description": ""
23354           },
23355           {
23356             "group": "Body",
23357             "type": "Text",
23358             "optional": true,
23359             "field": "providerResponse",
23360             "description": ""
23361           }
23362         ]
23363       }
23364     },
23365     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23366     "version": "0.0.0",
23367     "filename": "server/api/smsInteraction/index.js",
23368     "groupTitle": "Sms_Interactions"
23369   },
23370   {
23371     "type": "get",
23372     "url": "/api/sms/interactions/{id}/download",
23373     "title": "Gets interaction",
23374     "examples": [
23375       {
23376         "title": "Example usage:",
23377         "content": "curl https://{domain}/api/sms/interactions/{id}/download -v -u {name}:{password} -X GET",
23378         "type": "json"
23379       }
23380     ],
23381     "name": "download",
23382     "group": "Sms_Interactions",
23383     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23384     "version": "0.0.0",
23385     "filename": "server/api/smsInteraction/index.js",
23386     "groupTitle": "Sms_Interactions"
23387   },
23388   {
23389     "type": "get",
23390     "url": "/api/sms/interactions/{id}/messages",
23391     "title": "Gets interaction messages",
23392     "examples": [
23393       {
23394         "title": "Example usage:",
23395         "content": "curl https://{domain}/api/sms/interactions/{id}/messages -v -u {name}:{password} -X GET",
23396         "type": "json"
23397       }
23398     ],
23399     "name": "getMessages",
23400     "group": "Sms_Interactions",
23401     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23402     "version": "0.0.0",
23403     "filename": "server/api/smsInteraction/index.js",
23404     "groupTitle": "Sms_Interactions"
23405   },
23406   {
23407     "type": "put",
23408     "url": "/api/sms/interactions/{id}",
23409     "title": "Update an existing Interaction",
23410     "examples": [
23411       {
23412         "title": "Example usage:",
23413         "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",
23414         "type": "json"
23415       }
23416     ],
23417     "name": "updateInteractions",
23418     "group": "Sms_Interactions",
23419     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23420     "version": "0.0.0",
23421     "filename": "server/api/smsInteraction/index.js",
23422     "groupTitle": "Sms_Interactions"
23423   },
23424   {
23425     "type": "post",
23426     "url": "/api/sms/messages",
23427     "title": "Creates a new Message",
23428     "examples": [
23429       {
23430         "title": "Example usage:",
23431         "content": "curl https://{domain}/api/sms/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23432         "type": "json"
23433       }
23434     ],
23435     "name": "CreateMessages",
23436     "group": "Sms_Messages",
23437     "parameter": {
23438       "fields": {
23439         "Body": [
23440           {
23441             "group": "Body",
23442             "type": "Text",
23443             "optional": false,
23444             "field": "body",
23445             "description": ""
23446           },
23447           {
23448             "group": "Body",
23449             "type": "Boolean",
23450             "optional": true,
23451             "field": "read",
23452             "description": ""
23453           },
23454           {
23455             "group": "Body",
23456             "type": "String",
23457             "allowedValues": [
23458               "\"in\"",
23459               "\"out\""
23460             ],
23461             "optional": false,
23462             "field": "direction",
23463             "description": ""
23464           },
23465           {
23466             "group": "Body",
23467             "type": "String",
23468             "optional": true,
23469             "field": "messageId",
23470             "description": ""
23471           },
23472           {
23473             "group": "Body",
23474             "type": "String",
23475             "optional": true,
23476             "field": "phone",
23477             "description": ""
23478           },
23479           {
23480             "group": "Body",
23481             "type": "String",
23482             "optional": true,
23483             "field": "readAt",
23484             "description": ""
23485           },
23486           {
23487             "group": "Body",
23488             "type": "Boolean",
23489             "optional": true,
23490             "field": "secret",
23491             "description": ""
23492           },
23493           {
23494             "group": "Body",
23495             "type": "String",
23496             "optional": true,
23497             "field": "providerName",
23498             "description": ""
23499           },
23500           {
23501             "group": "Body",
23502             "type": "Text",
23503             "optional": true,
23504             "field": "providerResponse",
23505             "description": ""
23506           }
23507         ]
23508       }
23509     },
23510     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23511     "version": "0.0.0",
23512     "filename": "server/api/smsMessage/index.js",
23513     "groupTitle": "Sms_Messages"
23514   },
23515   {
23516     "type": "delete",
23517     "url": "/api/sms/messages/{id}",
23518     "title": "Deletes a Message",
23519     "examples": [
23520       {
23521         "title": "Example usage:",
23522         "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password} -X DELETE",
23523         "type": "json"
23524       }
23525     ],
23526     "name": "DeleteMessages",
23527     "group": "Sms_Messages",
23528     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23529     "version": "0.0.0",
23530     "filename": "server/api/smsMessage/index.js",
23531     "groupTitle": "Sms_Messages"
23532   },
23533   {
23534     "type": "get",
23535     "url": "/api/sms/messages/describe",
23536     "title": "Gets table info about Messages",
23537     "examples": [
23538       {
23539         "title": "Example usage:",
23540         "content": "curl https://{domain}/api/sms/messages/describe -v -u {name}:{password}",
23541         "type": "json"
23542       }
23543     ],
23544     "name": "DescribeMessages",
23545     "group": "Sms_Messages",
23546     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23547     "version": "0.0.0",
23548     "filename": "server/api/smsMessage/index.js",
23549     "groupTitle": "Sms_Messages"
23550   },
23551   {
23552     "type": "get",
23553     "url": "/api/sms/messages",
23554     "title": "Gets a list of Messages",
23555     "examples": [
23556       {
23557         "title": "Example usage:",
23558         "content": "curl https://{domain}/api/sms/messages -v -u {name}:{password}",
23559         "type": "json"
23560       }
23561     ],
23562     "name": "GetMessages",
23563     "group": "Sms_Messages",
23564     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23565     "version": "0.0.0",
23566     "filename": "server/api/smsMessage/index.js",
23567     "groupTitle": "Sms_Messages"
23568   },
23569   {
23570     "type": "get",
23571     "url": "/api/sms/messages/{id}",
23572     "title": "Gets a single Message",
23573     "examples": [
23574       {
23575         "title": "Example usage:",
23576         "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password}",
23577         "type": "json"
23578       }
23579     ],
23580     "name": "ShowMessages",
23581     "group": "Sms_Messages",
23582     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23583     "version": "0.0.0",
23584     "filename": "server/api/smsMessage/index.js",
23585     "groupTitle": "Sms_Messages"
23586   },
23587   {
23588     "type": "put",
23589     "url": "/api/sms/messages/{id}",
23590     "title": "Update an existing Message",
23591     "examples": [
23592       {
23593         "title": "Example usage:",
23594         "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",
23595         "type": "json"
23596       }
23597     ],
23598     "name": "updateMessages",
23599     "group": "Sms_Messages",
23600     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23601     "version": "0.0.0",
23602     "filename": "server/api/smsMessage/index.js",
23603     "groupTitle": "Sms_Messages"
23604   },
23605   {
23606     "type": "post",
23607     "url": "/api/sms/reports/queue",
23608     "title": "Creates a new Sms Queue Report",
23609     "examples": [
23610       {
23611         "title": "Example usage:",
23612         "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",
23613         "type": "json"
23614       }
23615     ],
23616     "name": "CreateSms_Queue_Reports",
23617     "group": "Sms_Queue_Reports",
23618     "parameter": {
23619       "fields": {
23620         "Body": [
23621           {
23622             "group": "Body",
23623             "type": "String",
23624             "optional": false,
23625             "field": "uniqueid",
23626             "description": ""
23627           },
23628           {
23629             "group": "Body",
23630             "type": "String",
23631             "optional": true,
23632             "field": "from",
23633             "description": ""
23634           },
23635           {
23636             "group": "Body",
23637             "type": "String",
23638             "optional": true,
23639             "field": "joinAt",
23640             "description": ""
23641           },
23642           {
23643             "group": "Body",
23644             "type": "String",
23645             "optional": true,
23646             "field": "leaveAt",
23647             "description": ""
23648           },
23649           {
23650             "group": "Body",
23651             "type": "String",
23652             "optional": true,
23653             "field": "acceptAt",
23654             "description": ""
23655           },
23656           {
23657             "group": "Body",
23658             "type": "String",
23659             "optional": true,
23660             "field": "exitAt",
23661             "description": ""
23662           },
23663           {
23664             "group": "Body",
23665             "type": "String",
23666             "optional": true,
23667             "field": "reason",
23668             "description": ""
23669           }
23670         ]
23671       }
23672     },
23673     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23674     "version": "0.0.0",
23675     "filename": "server/api/smsQueueReport/index.js",
23676     "groupTitle": "Sms_Queue_Reports"
23677   },
23678   {
23679     "type": "delete",
23680     "url": "/api/sms/reports/queue/{id}",
23681     "title": "Deletes a Sms Queue Report",
23682     "examples": [
23683       {
23684         "title": "Example usage:",
23685         "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password} -X DELETE",
23686         "type": "json"
23687       }
23688     ],
23689     "name": "DeleteSms_Queue_Reports",
23690     "group": "Sms_Queue_Reports",
23691     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23692     "version": "0.0.0",
23693     "filename": "server/api/smsQueueReport/index.js",
23694     "groupTitle": "Sms_Queue_Reports"
23695   },
23696   {
23697     "type": "get",
23698     "url": "/api/sms/reports/queue/describe",
23699     "title": "Gets table info about Sms Queue Reports",
23700     "examples": [
23701       {
23702         "title": "Example usage:",
23703         "content": "curl https://{domain}/api/sms/reports/queue/describe -v -u {name}:{password}",
23704         "type": "json"
23705       }
23706     ],
23707     "name": "DescribeSms_Queue_Reports",
23708     "group": "Sms_Queue_Reports",
23709     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23710     "version": "0.0.0",
23711     "filename": "server/api/smsQueueReport/index.js",
23712     "groupTitle": "Sms_Queue_Reports"
23713   },
23714   {
23715     "type": "get",
23716     "url": "/api/sms/reports/queue",
23717     "title": "Gets a list of Sms Queue Reports",
23718     "examples": [
23719       {
23720         "title": "Example usage:",
23721         "content": "curl https://{domain}/api/sms/reports/queue -v -u {name}:{password}",
23722         "type": "json"
23723       }
23724     ],
23725     "name": "GetSms_Queue_Reports",
23726     "group": "Sms_Queue_Reports",
23727     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23728     "version": "0.0.0",
23729     "filename": "server/api/smsQueueReport/index.js",
23730     "groupTitle": "Sms_Queue_Reports"
23731   },
23732   {
23733     "type": "get",
23734     "url": "/api/sms/reports/queue/{id}",
23735     "title": "Gets a single Sms Queue Report",
23736     "examples": [
23737       {
23738         "title": "Example usage:",
23739         "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password}",
23740         "type": "json"
23741       }
23742     ],
23743     "name": "ShowSms_Queue_Reports",
23744     "group": "Sms_Queue_Reports",
23745     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23746     "version": "0.0.0",
23747     "filename": "server/api/smsQueueReport/index.js",
23748     "groupTitle": "Sms_Queue_Reports"
23749   },
23750   {
23751     "type": "put",
23752     "url": "/api/sms/reports/queue/{id}",
23753     "title": "Update an existing Sms Queue Report",
23754     "examples": [
23755       {
23756         "title": "Example usage:",
23757         "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",
23758         "type": "json"
23759       }
23760     ],
23761     "name": "updateSms_Queue_Reports",
23762     "group": "Sms_Queue_Reports",
23763     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23764     "version": "0.0.0",
23765     "filename": "server/api/smsQueueReport/index.js",
23766     "groupTitle": "Sms_Queue_Reports"
23767   },
23768   {
23769     "type": "post",
23770     "url": "/api/sms/queues/{id}/users",
23771     "title": "Add agents to a queue",
23772     "examples": [
23773       {
23774         "title": "Example usage:",
23775         "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",
23776         "type": "json"
23777       }
23778     ],
23779     "name": "AddAgents",
23780     "group": "Sms_Queues",
23781     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23782     "version": "0.0.0",
23783     "filename": "server/api/smsQueue/index.js",
23784     "groupTitle": "Sms_Queues"
23785   },
23786   {
23787     "type": "post",
23788     "url": "/api/sms/queues/{id}/teams",
23789     "title": "Add teams to a queue",
23790     "examples": [
23791       {
23792         "title": "Example usage:",
23793         "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",
23794         "type": "json"
23795       }
23796     ],
23797     "name": "AddTeams",
23798     "group": "Sms_Queues",
23799     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23800     "version": "0.0.0",
23801     "filename": "server/api/smsQueue/index.js",
23802     "groupTitle": "Sms_Queues"
23803   },
23804   {
23805     "type": "post",
23806     "url": "/api/sms/queues",
23807     "title": "Creates a new Queue",
23808     "examples": [
23809       {
23810         "title": "Example usage:",
23811         "content": "curl https://{domain}/api/sms/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23812         "type": "json"
23813       }
23814     ],
23815     "name": "CreateQueues",
23816     "group": "Sms_Queues",
23817     "parameter": {
23818       "fields": {
23819         "Body": [
23820           {
23821             "group": "Body",
23822             "type": "String",
23823             "optional": true,
23824             "field": "name",
23825             "description": ""
23826           },
23827           {
23828             "group": "Body",
23829             "type": "String",
23830             "optional": true,
23831             "field": "description",
23832             "description": ""
23833           },
23834           {
23835             "group": "Body",
23836             "type": "Integer",
23837             "optional": true,
23838             "field": "timeout",
23839             "description": ""
23840           },
23841           {
23842             "group": "Body",
23843             "type": "String",
23844             "allowedValues": [
23845               "\"rrmemory\"",
23846               "\"beepall\"",
23847               "\"roundrobin\""
23848             ],
23849             "optional": true,
23850             "field": "strategy",
23851             "description": ""
23852           }
23853         ]
23854       }
23855     },
23856     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23857     "version": "0.0.0",
23858     "filename": "server/api/smsQueue/index.js",
23859     "groupTitle": "Sms_Queues"
23860   },
23861   {
23862     "type": "delete",
23863     "url": "/api/sms/queues/{id}",
23864     "title": "Deletes a Queue",
23865     "examples": [
23866       {
23867         "title": "Example usage:",
23868         "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password} -X DELETE",
23869         "type": "json"
23870       }
23871     ],
23872     "name": "DeleteQueues",
23873     "group": "Sms_Queues",
23874     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23875     "version": "0.0.0",
23876     "filename": "server/api/smsQueue/index.js",
23877     "groupTitle": "Sms_Queues"
23878   },
23879   {
23880     "type": "get",
23881     "url": "/api/sms/queues/describe",
23882     "title": "Gets table info about Queues",
23883     "examples": [
23884       {
23885         "title": "Example usage:",
23886         "content": "curl https://{domain}/api/sms/queues/describe -v -u {name}:{password}",
23887         "type": "json"
23888       }
23889     ],
23890     "name": "DescribeQueues",
23891     "group": "Sms_Queues",
23892     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23893     "version": "0.0.0",
23894     "filename": "server/api/smsQueue/index.js",
23895     "groupTitle": "Sms_Queues"
23896   },
23897   {
23898     "type": "get",
23899     "url": "/api/sms/queues/{id}/users",
23900     "title": "Gets queue agents",
23901     "examples": [
23902       {
23903         "title": "Example usage:",
23904         "content": "curl https://{domain}/api/sms/queues/{id}/users -v -u {name}:{password} -X POST",
23905         "type": "json"
23906       }
23907     ],
23908     "name": "GetAgents",
23909     "group": "Sms_Queues",
23910     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23911     "version": "0.0.0",
23912     "filename": "server/api/smsQueue/index.js",
23913     "groupTitle": "Sms_Queues"
23914   },
23915   {
23916     "type": "get",
23917     "url": "/api/sms/queues/{id}/members",
23918     "title": "GetMembers",
23919     "examples": [
23920       {
23921         "title": "Example usage:",
23922         "content": "curl https://{domain}/api/sms/queues/{id}/members  -v -u {name}:{password}",
23923         "type": "json"
23924       }
23925     ],
23926     "name": "GetMembers",
23927     "group": "Sms_Queues",
23928     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23929     "version": "0.0.0",
23930     "filename": "server/api/smsQueue/index.js",
23931     "groupTitle": "Sms_Queues"
23932   },
23933   {
23934     "type": "get",
23935     "url": "/api/sms/queues",
23936     "title": "Gets a list of Queues",
23937     "examples": [
23938       {
23939         "title": "Example usage:",
23940         "content": "curl https://{domain}/api/sms/queues -v -u {name}:{password}",
23941         "type": "json"
23942       }
23943     ],
23944     "name": "GetQueues",
23945     "group": "Sms_Queues",
23946     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23947     "version": "0.0.0",
23948     "filename": "server/api/smsQueue/index.js",
23949     "groupTitle": "Sms_Queues"
23950   },
23951   {
23952     "type": "get",
23953     "url": "/api/sms/queues/{id}/teams",
23954     "title": "Gets queues list",
23955     "examples": [
23956       {
23957         "title": "Example usage:",
23958         "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password}",
23959         "type": "json"
23960       }
23961     ],
23962     "name": "GetTeams",
23963     "group": "Sms_Queues",
23964     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23965     "version": "0.0.0",
23966     "filename": "server/api/smsQueue/index.js",
23967     "groupTitle": "Sms_Queues"
23968   },
23969   {
23970     "type": "delete",
23971     "url": "/api/sms/queues/{id}/users",
23972     "title": "Removes agents from a queue",
23973     "examples": [
23974       {
23975         "title": "Example usage:",
23976         "content": "curl https://{domain}/api/sms/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
23977         "type": "json"
23978       }
23979     ],
23980     "name": "RemoveAgents",
23981     "group": "Sms_Queues",
23982     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23983     "version": "0.0.0",
23984     "filename": "server/api/smsQueue/index.js",
23985     "groupTitle": "Sms_Queues"
23986   },
23987   {
23988     "type": "get",
23989     "url": "/api/sms/queues/{id}",
23990     "title": "Gets a single Queue",
23991     "examples": [
23992       {
23993         "title": "Example usage:",
23994         "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password}",
23995         "type": "json"
23996       }
23997     ],
23998     "name": "ShowQueues",
23999     "group": "Sms_Queues",
24000     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24001     "version": "0.0.0",
24002     "filename": "server/api/smsQueue/index.js",
24003     "groupTitle": "Sms_Queues"
24004   },
24005   {
24006     "type": "put",
24007     "url": "/api/sms/queues/{id}",
24008     "title": "Update an existing Queue",
24009     "examples": [
24010       {
24011         "title": "Example usage:",
24012         "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",
24013         "type": "json"
24014       }
24015     ],
24016     "name": "updateQueues",
24017     "group": "Sms_Queues",
24018     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24019     "version": "0.0.0",
24020     "filename": "server/api/smsQueue/index.js",
24021     "groupTitle": "Sms_Queues"
24022   },
24023   {
24024     "type": "post",
24025     "url": "/api/sms/reports/transfer",
24026     "title": "Creates a new Sms Transfer Report",
24027     "examples": [
24028       {
24029         "title": "Example usage:",
24030         "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",
24031         "type": "json"
24032       }
24033     ],
24034     "name": "CreateSms_Transfer_Reports",
24035     "group": "Sms_Transfer_Reports",
24036     "parameter": {
24037       "fields": {
24038         "Body": [
24039           {
24040             "group": "Body",
24041             "type": "String",
24042             "optional": false,
24043             "field": "uniqueid",
24044             "description": ""
24045           },
24046           {
24047             "group": "Body",
24048             "type": "String",
24049             "allowedValues": [
24050               "\"account\"",
24051               "\"agent\"",
24052               "\"queue\""
24053             ],
24054             "optional": false,
24055             "field": "type",
24056             "description": ""
24057           },
24058           {
24059             "group": "Body",
24060             "type": "String",
24061             "optional": false,
24062             "field": "transferredAt",
24063             "description": ""
24064           }
24065         ]
24066       }
24067     },
24068     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24069     "version": "0.0.0",
24070     "filename": "server/api/smsTransferReport/index.js",
24071     "groupTitle": "Sms_Transfer_Reports"
24072   },
24073   {
24074     "type": "delete",
24075     "url": "/api/sms/reports/transfer/{id}",
24076     "title": "Deletes a Sms Transfer Report",
24077     "examples": [
24078       {
24079         "title": "Example usage:",
24080         "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
24081         "type": "json"
24082       }
24083     ],
24084     "name": "DeleteSms_Transfer_Reports",
24085     "group": "Sms_Transfer_Reports",
24086     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24087     "version": "0.0.0",
24088     "filename": "server/api/smsTransferReport/index.js",
24089     "groupTitle": "Sms_Transfer_Reports"
24090   },
24091   {
24092     "type": "get",
24093     "url": "/api/sms/reports/transfer/describe",
24094     "title": "Gets table info about Sms Transfer Reports",
24095     "examples": [
24096       {
24097         "title": "Example usage:",
24098         "content": "curl https://{domain}/api/sms/reports/transfer/describe -v -u {name}:{password}",
24099         "type": "json"
24100       }
24101     ],
24102     "name": "DescribeSms_Transfer_Reports",
24103     "group": "Sms_Transfer_Reports",
24104     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24105     "version": "0.0.0",
24106     "filename": "server/api/smsTransferReport/index.js",
24107     "groupTitle": "Sms_Transfer_Reports"
24108   },
24109   {
24110     "type": "get",
24111     "url": "/api/sms/reports/transfer",
24112     "title": "Gets a list of Sms Transfer Reports",
24113     "examples": [
24114       {
24115         "title": "Example usage:",
24116         "content": "curl https://{domain}/api/sms/reports/transfer -v -u {name}:{password}",
24117         "type": "json"
24118       }
24119     ],
24120     "name": "GetSms_Transfer_Reports",
24121     "group": "Sms_Transfer_Reports",
24122     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24123     "version": "0.0.0",
24124     "filename": "server/api/smsTransferReport/index.js",
24125     "groupTitle": "Sms_Transfer_Reports"
24126   },
24127   {
24128     "type": "get",
24129     "url": "/api/sms/reports/transfer/{id}",
24130     "title": "Gets a single Sms Transfer Report",
24131     "examples": [
24132       {
24133         "title": "Example usage:",
24134         "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password}",
24135         "type": "json"
24136       }
24137     ],
24138     "name": "ShowSms_Transfer_Reports",
24139     "group": "Sms_Transfer_Reports",
24140     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24141     "version": "0.0.0",
24142     "filename": "server/api/smsTransferReport/index.js",
24143     "groupTitle": "Sms_Transfer_Reports"
24144   },
24145   {
24146     "type": "put",
24147     "url": "/api/sms/reports/transfer/{id}",
24148     "title": "Update an existing Sms Transfer Report",
24149     "examples": [
24150       {
24151         "title": "Example usage:",
24152         "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",
24153         "type": "json"
24154       }
24155     ],
24156     "name": "updateSms_Transfer_Reports",
24157     "group": "Sms_Transfer_Reports",
24158     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24159     "version": "0.0.0",
24160     "filename": "server/api/smsTransferReport/index.js",
24161     "groupTitle": "Sms_Transfer_Reports"
24162   },
24163   {
24164     "type": "get",
24165     "url": "/api/sounds",
24166     "title": "Gets a list of Sounds",
24167     "examples": [
24168       {
24169         "title": "Example usage:",
24170         "content": "curl https://{domain}/api/sounds -v -u {name}:{password}",
24171         "type": "json"
24172       }
24173     ],
24174     "name": "GetSounds",
24175     "group": "Sounds",
24176     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24177     "version": "0.0.0",
24178     "filename": "server/api/sound/index.js",
24179     "groupTitle": "Sounds"
24180   },
24181   {
24182     "type": "get",
24183     "url": "/api/sounds/{id}",
24184     "title": "Gets a single Sound",
24185     "examples": [
24186       {
24187         "title": "Example usage:",
24188         "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password}",
24189         "type": "json"
24190       }
24191     ],
24192     "name": "ShowSounds",
24193     "group": "Sounds",
24194     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24195     "version": "0.0.0",
24196     "filename": "server/api/sound/index.js",
24197     "groupTitle": "Sounds"
24198   },
24199   {
24200     "type": "post",
24201     "url": "/api/sounds",
24202     "title": "Create a new sound",
24203     "examples": [
24204       {
24205         "title": "Example usage:",
24206         "content": "curl https://{domain}/api/sounds -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
24207         "type": "json"
24208       }
24209     ],
24210     "name": "addSound",
24211     "group": "Sounds",
24212     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24213     "version": "0.0.0",
24214     "filename": "server/api/sound/index.js",
24215     "groupTitle": "Sounds"
24216   },
24217   {
24218     "type": "delete",
24219     "url": "/api/sounds/{id}",
24220     "title": "Deletes a sound",
24221     "examples": [
24222       {
24223         "title": "Example usage:",
24224         "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password} -X DELETE",
24225         "type": "json"
24226       }
24227     ],
24228     "name": "destroySound",
24229     "group": "Sounds",
24230     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24231     "version": "0.0.0",
24232     "filename": "server/api/sound/index.js",
24233     "groupTitle": "Sounds"
24234   },
24235   {
24236     "type": "get",
24237     "url": "/api/sounds/{id}/download",
24238     "title": "Download Sound",
24239     "examples": [
24240       {
24241         "title": "Example usage:",
24242         "content": "curl https://{domain}/api/sounds/{id}/download -v -u {name}:{password} -X GET",
24243         "type": "json"
24244       }
24245     ],
24246     "name": "download",
24247     "group": "Sounds",
24248     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24249     "version": "0.0.0",
24250     "filename": "server/api/sound/index.js",
24251     "groupTitle": "Sounds"
24252   },
24253   {
24254     "type": "put",
24255     "url": "/api/sounds",
24256     "title": "Update an existing new sound",
24257     "examples": [
24258       {
24259         "title": "Example usage:",
24260         "content": "curl https://{domain}/api/sounds -d '[\"name\": \"sound_name\", \"description\": \"sound_desc\"]' -v -u {name}:{password} -X PUT",
24261         "type": "json"
24262       }
24263     ],
24264     "name": "updateSound",
24265     "group": "Sounds",
24266     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24267     "version": "0.0.0",
24268     "filename": "server/api/sound/index.js",
24269     "groupTitle": "Sounds"
24270   },
24271   {
24272     "type": "post",
24273     "url": "/api/square/details/reports",
24274     "title": "Creates a new Square Detail Report",
24275     "examples": [
24276       {
24277         "title": "Example usage:",
24278         "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",
24279         "type": "json"
24280       }
24281     ],
24282     "name": "CreateSquare_Detail_Reports",
24283     "group": "Square_Details_Reports",
24284     "parameter": {
24285       "fields": {
24286         "Body": [
24287           {
24288             "group": "Body",
24289             "type": "String",
24290             "optional": true,
24291             "field": "uniqueid",
24292             "description": ""
24293           },
24294           {
24295             "group": "Body",
24296             "type": "String",
24297             "optional": true,
24298             "field": "node",
24299             "description": ""
24300           },
24301           {
24302             "group": "Body",
24303             "type": "String",
24304             "optional": true,
24305             "field": "application",
24306             "description": ""
24307           },
24308           {
24309             "group": "Body",
24310             "type": "Text",
24311             "optional": true,
24312             "field": "data",
24313             "description": ""
24314           },
24315           {
24316             "group": "Body",
24317             "type": "String",
24318             "optional": true,
24319             "field": "project_name",
24320             "description": ""
24321           },
24322           {
24323             "group": "Body",
24324             "type": "String",
24325             "optional": true,
24326             "field": "callerid",
24327             "description": ""
24328           }
24329         ]
24330       }
24331     },
24332     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24333     "version": "0.0.0",
24334     "filename": "server/api/squareReportDetail/index.js",
24335     "groupTitle": "Square_Details_Reports"
24336   },
24337   {
24338     "type": "delete",
24339     "url": "/api/square/details/reports/{id}",
24340     "title": "Deletes a Square Detail Report",
24341     "examples": [
24342       {
24343         "title": "Example usage:",
24344         "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password} -X DELETE",
24345         "type": "json"
24346       }
24347     ],
24348     "name": "DeleteSquare_Detail_Reports",
24349     "group": "Square_Details_Reports",
24350     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24351     "version": "0.0.0",
24352     "filename": "server/api/squareReportDetail/index.js",
24353     "groupTitle": "Square_Details_Reports"
24354   },
24355   {
24356     "type": "get",
24357     "url": "/api/square/details/reports/describe",
24358     "title": "Gets table info about Square Detail Reports",
24359     "examples": [
24360       {
24361         "title": "Example usage:",
24362         "content": "curl https://{domain}/api/square/details/reports/describe -v -u {name}:{password}",
24363         "type": "json"
24364       }
24365     ],
24366     "name": "DescribeSquare_Detail_Reports",
24367     "group": "Square_Details_Reports",
24368     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24369     "version": "0.0.0",
24370     "filename": "server/api/squareReportDetail/index.js",
24371     "groupTitle": "Square_Details_Reports"
24372   },
24373   {
24374     "type": "get",
24375     "url": "/api/square/details/reports",
24376     "title": "Gets a list of Square Detail Reports",
24377     "examples": [
24378       {
24379         "title": "Example usage:",
24380         "content": "curl https://{domain}/api/square/details/reports -v -u {name}:{password}",
24381         "type": "json"
24382       }
24383     ],
24384     "name": "GetSquare_Detail_Reports",
24385     "group": "Square_Details_Reports",
24386     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24387     "version": "0.0.0",
24388     "filename": "server/api/squareReportDetail/index.js",
24389     "groupTitle": "Square_Details_Reports"
24390   },
24391   {
24392     "type": "get",
24393     "url": "/api/square/details/reports/{id}",
24394     "title": "Gets a single Square Detail Report",
24395     "examples": [
24396       {
24397         "title": "Example usage:",
24398         "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password}",
24399         "type": "json"
24400       }
24401     ],
24402     "name": "ShowSquare_Detail_Reports",
24403     "group": "Square_Details_Reports",
24404     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24405     "version": "0.0.0",
24406     "filename": "server/api/squareReportDetail/index.js",
24407     "groupTitle": "Square_Details_Reports"
24408   },
24409   {
24410     "type": "put",
24411     "url": "/api/square/details/reports/{id}",
24412     "title": "Update an existing Square Detail Report",
24413     "examples": [
24414       {
24415         "title": "Example usage:",
24416         "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",
24417         "type": "json"
24418       }
24419     ],
24420     "name": "updateSquare_Detail_Reports",
24421     "group": "Square_Details_Reports",
24422     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24423     "version": "0.0.0",
24424     "filename": "server/api/squareReportDetail/index.js",
24425     "groupTitle": "Square_Details_Reports"
24426   },
24427   {
24428     "type": "post",
24429     "url": "/api/square/messages",
24430     "title": "Creates a new Message",
24431     "examples": [
24432       {
24433         "title": "Example usage:",
24434         "content": "curl https://{domain}/api/square/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24435         "type": "json"
24436       }
24437     ],
24438     "name": "CreateMessages",
24439     "group": "Square_Messages",
24440     "parameter": {
24441       "fields": {
24442         "Body": [
24443           {
24444             "group": "Body",
24445             "type": "String",
24446             "optional": true,
24447             "field": "uniqueid",
24448             "description": ""
24449           },
24450           {
24451             "group": "Body",
24452             "type": "Text",
24453             "optional": false,
24454             "field": "body",
24455             "description": ""
24456           },
24457           {
24458             "group": "Body",
24459             "type": "String",
24460             "allowedValues": [
24461               "\"in\"",
24462               "\"out\""
24463             ],
24464             "optional": false,
24465             "field": "direction",
24466             "description": ""
24467           },
24468           {
24469             "group": "Body",
24470             "type": "String",
24471             "optional": true,
24472             "field": "providerName",
24473             "description": ""
24474           },
24475           {
24476             "group": "Body",
24477             "type": "Text",
24478             "optional": true,
24479             "field": "providerResponse",
24480             "description": ""
24481           }
24482         ]
24483       }
24484     },
24485     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24486     "version": "0.0.0",
24487     "filename": "server/api/squareMessage/index.js",
24488     "groupTitle": "Square_Messages"
24489   },
24490   {
24491     "type": "delete",
24492     "url": "/api/square/messages/{id}",
24493     "title": "Deletes a Message",
24494     "examples": [
24495       {
24496         "title": "Example usage:",
24497         "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password} -X DELETE",
24498         "type": "json"
24499       }
24500     ],
24501     "name": "DeleteMessages",
24502     "group": "Square_Messages",
24503     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24504     "version": "0.0.0",
24505     "filename": "server/api/squareMessage/index.js",
24506     "groupTitle": "Square_Messages"
24507   },
24508   {
24509     "type": "get",
24510     "url": "/api/square/messages",
24511     "title": "Gets a list of Messages",
24512     "examples": [
24513       {
24514         "title": "Example usage:",
24515         "content": "curl https://{domain}/api/square/messages -v -u {name}:{password}",
24516         "type": "json"
24517       }
24518     ],
24519     "name": "GetMessages",
24520     "group": "Square_Messages",
24521     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24522     "version": "0.0.0",
24523     "filename": "server/api/squareMessage/index.js",
24524     "groupTitle": "Square_Messages"
24525   },
24526   {
24527     "type": "get",
24528     "url": "/api/square/messages/{id}",
24529     "title": "Gets a single Message",
24530     "examples": [
24531       {
24532         "title": "Example usage:",
24533         "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password}",
24534         "type": "json"
24535       }
24536     ],
24537     "name": "ShowMessages",
24538     "group": "Square_Messages",
24539     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24540     "version": "0.0.0",
24541     "filename": "server/api/squareMessage/index.js",
24542     "groupTitle": "Square_Messages"
24543   },
24544   {
24545     "type": "put",
24546     "url": "/api/square/messages/{id}",
24547     "title": "Update an existing Message",
24548     "examples": [
24549       {
24550         "title": "Example usage:",
24551         "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",
24552         "type": "json"
24553       }
24554     ],
24555     "name": "updateMessages",
24556     "group": "Square_Messages",
24557     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24558     "version": "0.0.0",
24559     "filename": "server/api/squareMessage/index.js",
24560     "groupTitle": "Square_Messages"
24561   },
24562   {
24563     "type": "post",
24564     "url": "/api/square/odbc",
24565     "title": "Creates a new ODBC",
24566     "examples": [
24567       {
24568         "title": "Example usage:",
24569         "content": "curl https://{domain}/api/square/odbc -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24570         "type": "json"
24571       }
24572     ],
24573     "name": "CreateODBCs",
24574     "group": "Square_ODBC",
24575     "parameter": {
24576       "fields": {
24577         "Body": [
24578           {
24579             "group": "Body",
24580             "type": "String",
24581             "optional": false,
24582             "field": "name",
24583             "description": ""
24584           },
24585           {
24586             "group": "Body",
24587             "type": "String",
24588             "optional": true,
24589             "field": "dsn",
24590             "description": ""
24591           },
24592           {
24593             "group": "Body",
24594             "type": "String",
24595             "optional": true,
24596             "field": "description",
24597             "description": ""
24598           }
24599         ]
24600       }
24601     },
24602     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24603     "version": "0.0.0",
24604     "filename": "server/api/squareOdbc/index.js",
24605     "groupTitle": "Square_ODBC"
24606   },
24607   {
24608     "type": "delete",
24609     "url": "/api/square/odbc/{id}",
24610     "title": "Deletes a ODBC",
24611     "examples": [
24612       {
24613         "title": "Example usage:",
24614         "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password} -X DELETE",
24615         "type": "json"
24616       }
24617     ],
24618     "name": "DeleteODBCs",
24619     "group": "Square_ODBC",
24620     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24621     "version": "0.0.0",
24622     "filename": "server/api/squareOdbc/index.js",
24623     "groupTitle": "Square_ODBC"
24624   },
24625   {
24626     "type": "get",
24627     "url": "/api/square/odbc",
24628     "title": "Gets a list of ODBCs",
24629     "examples": [
24630       {
24631         "title": "Example usage:",
24632         "content": "curl https://{domain}/api/square/odbc -v -u {name}:{password}",
24633         "type": "json"
24634       }
24635     ],
24636     "name": "GetODBCs",
24637     "group": "Square_ODBC",
24638     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24639     "version": "0.0.0",
24640     "filename": "server/api/squareOdbc/index.js",
24641     "groupTitle": "Square_ODBC"
24642   },
24643   {
24644     "type": "get",
24645     "url": "/api/square/odbc/{id}",
24646     "title": "Gets a single ODBC",
24647     "examples": [
24648       {
24649         "title": "Example usage:",
24650         "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password}",
24651         "type": "json"
24652       }
24653     ],
24654     "name": "ShowODBCs",
24655     "group": "Square_ODBC",
24656     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24657     "version": "0.0.0",
24658     "filename": "server/api/squareOdbc/index.js",
24659     "groupTitle": "Square_ODBC"
24660   },
24661   {
24662     "type": "get",
24663     "url": "/api/square/odbc/{id}/test",
24664     "title": "Test Odbc",
24665     "examples": [
24666       {
24667         "title": "Example usage:",
24668         "content": "curl https://{domain}/api/square/odbc/{id}/test -v -u {name}:{password} -X GET",
24669         "type": "json"
24670       }
24671     ],
24672     "name": "test",
24673     "group": "Square_ODBC",
24674     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24675     "version": "0.0.0",
24676     "filename": "server/api/squareOdbc/index.js",
24677     "groupTitle": "Square_ODBC"
24678   },
24679   {
24680     "type": "put",
24681     "url": "/api/square/odbc/{id}",
24682     "title": "Update an existing ODBC",
24683     "examples": [
24684       {
24685         "title": "Example usage:",
24686         "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",
24687         "type": "json"
24688       }
24689     ],
24690     "name": "updateODBCs",
24691     "group": "Square_ODBC",
24692     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24693     "version": "0.0.0",
24694     "filename": "server/api/squareOdbc/index.js",
24695     "groupTitle": "Square_ODBC"
24696   },
24697   {
24698     "type": "post",
24699     "url": "/api/square/projects",
24700     "title": "Creates a new Project",
24701     "examples": [
24702       {
24703         "title": "Example usage:",
24704         "content": "curl https://{domain}/api/square/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24705         "type": "json"
24706       }
24707     ],
24708     "name": "CreateProjects",
24709     "group": "Square_Projects",
24710     "parameter": {
24711       "fields": {
24712         "Body": [
24713           {
24714             "group": "Body",
24715             "type": "String",
24716             "optional": false,
24717             "field": "name",
24718             "description": ""
24719           },
24720           {
24721             "group": "Body",
24722             "type": "String",
24723             "optional": true,
24724             "field": "description",
24725             "description": ""
24726           },
24727           {
24728             "group": "Body",
24729             "type": "Text",
24730             "optional": true,
24731             "field": "notes",
24732             "description": ""
24733           },
24734           {
24735             "group": "Body",
24736             "type": "Blob",
24737             "optional": true,
24738             "field": "preproduction",
24739             "description": ""
24740           },
24741           {
24742             "group": "Body",
24743             "type": "Blob",
24744             "optional": true,
24745             "field": "production",
24746             "description": ""
24747           },
24748           {
24749             "group": "Body",
24750             "type": "String",
24751             "optional": true,
24752             "field": "savedAt",
24753             "description": ""
24754           },
24755           {
24756             "group": "Body",
24757             "type": "String",
24758             "optional": true,
24759             "field": "publishedAt",
24760             "description": ""
24761           }
24762         ]
24763       }
24764     },
24765     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24766     "version": "0.0.0",
24767     "filename": "server/api/squareProject/index.js",
24768     "groupTitle": "Square_Projects"
24769   },
24770   {
24771     "type": "delete",
24772     "url": "/api/square/projects/{id}",
24773     "title": "Deletes a Project",
24774     "examples": [
24775       {
24776         "title": "Example usage:",
24777         "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password} -X DELETE",
24778         "type": "json"
24779       }
24780     ],
24781     "name": "DeleteProjects",
24782     "group": "Square_Projects",
24783     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24784     "version": "0.0.0",
24785     "filename": "server/api/squareProject/index.js",
24786     "groupTitle": "Square_Projects"
24787   },
24788   {
24789     "type": "get",
24790     "url": "/api/square/projects",
24791     "title": "Gets a list of Projects",
24792     "examples": [
24793       {
24794         "title": "Example usage:",
24795         "content": "curl https://{domain}/api/square/projects -v -u {name}:{password}",
24796         "type": "json"
24797       }
24798     ],
24799     "name": "GetProjects",
24800     "group": "Square_Projects",
24801     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24802     "version": "0.0.0",
24803     "filename": "server/api/squareProject/index.js",
24804     "groupTitle": "Square_Projects"
24805   },
24806   {
24807     "type": "get",
24808     "url": "/api/square/projects/{id}",
24809     "title": "Gets a single Project",
24810     "examples": [
24811       {
24812         "title": "Example usage:",
24813         "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password}",
24814         "type": "json"
24815       }
24816     ],
24817     "name": "ShowProjects",
24818     "group": "Square_Projects",
24819     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24820     "version": "0.0.0",
24821     "filename": "server/api/squareProject/index.js",
24822     "groupTitle": "Square_Projects"
24823   },
24824   {
24825     "type": "post",
24826     "url": "/api/square/projects/{id}/users",
24827     "title": "Adds user permissions to a Project",
24828     "examples": [
24829       {
24830         "title": "Example usage:",
24831         "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",
24832         "type": "json"
24833       }
24834     ],
24835     "name": "addUsers",
24836     "group": "Square_Projects",
24837     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24838     "version": "0.0.0",
24839     "filename": "server/api/squareProject/index.js",
24840     "groupTitle": "Square_Projects"
24841   },
24842   {
24843     "type": "get",
24844     "url": "/api/square/projects/{id}/users",
24845     "title": "Gets users permissions from Project",
24846     "examples": [
24847       {
24848         "title": "Example usage:",
24849         "content": "curl https://{domain}/api/square/projects/{id}/users -v -u {name}:{password} -X GET",
24850         "type": "json"
24851       }
24852     ],
24853     "name": "getUsers",
24854     "group": "Square_Projects",
24855     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24856     "version": "0.0.0",
24857     "filename": "server/api/squareProject/index.js",
24858     "groupTitle": "Square_Projects"
24859   },
24860   {
24861     "type": "delete",
24862     "url": "/api/square/projects/{id}/users",
24863     "title": "Removes user permissions from a Project",
24864     "examples": [
24865       {
24866         "title": "Example usage:",
24867         "content": "curl https://{domain}/api/square/projects/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
24868         "type": "json"
24869       }
24870     ],
24871     "name": "removeUsers",
24872     "group": "Square_Projects",
24873     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24874     "version": "0.0.0",
24875     "filename": "server/api/squareProject/index.js",
24876     "groupTitle": "Square_Projects"
24877   },
24878   {
24879     "type": "put",
24880     "url": "/api/square/projects/{id}",
24881     "title": "Update an existing Project",
24882     "examples": [
24883       {
24884         "title": "Example usage:",
24885         "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",
24886         "type": "json"
24887       }
24888     ],
24889     "name": "updateProjects",
24890     "group": "Square_Projects",
24891     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24892     "version": "0.0.0",
24893     "filename": "server/api/squareProject/index.js",
24894     "groupTitle": "Square_Projects"
24895   },
24896   {
24897     "type": "post",
24898     "url": "/api/square/recordings",
24899     "title": "Creates a new Recording",
24900     "examples": [
24901       {
24902         "title": "Example usage:",
24903         "content": "curl https://{domain}/api/square/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24904         "type": "json"
24905       }
24906     ],
24907     "name": "CreateRecordings",
24908     "group": "Square_Recordings",
24909     "parameter": {
24910       "fields": {
24911         "Body": [
24912           {
24913             "group": "Body",
24914             "type": "String",
24915             "optional": true,
24916             "field": "uniqueid",
24917             "description": ""
24918           },
24919           {
24920             "group": "Body",
24921             "type": "String",
24922             "optional": true,
24923             "field": "callerid",
24924             "description": ""
24925           },
24926           {
24927             "group": "Body",
24928             "type": "String",
24929             "optional": true,
24930             "field": "calleridname",
24931             "description": ""
24932           },
24933           {
24934             "group": "Body",
24935             "type": "String",
24936             "optional": true,
24937             "field": "context",
24938             "description": ""
24939           },
24940           {
24941             "group": "Body",
24942             "type": "String",
24943             "optional": true,
24944             "field": "extension",
24945             "description": ""
24946           },
24947           {
24948             "group": "Body",
24949             "type": "String",
24950             "optional": true,
24951             "field": "priority",
24952             "description": ""
24953           },
24954           {
24955             "group": "Body",
24956             "type": "String",
24957             "optional": true,
24958             "field": "accountcode",
24959             "description": ""
24960           },
24961           {
24962             "group": "Body",
24963             "type": "String",
24964             "optional": true,
24965             "field": "dnid",
24966             "description": ""
24967           },
24968           {
24969             "group": "Body",
24970             "type": "String",
24971             "optional": true,
24972             "field": "projectName",
24973             "description": ""
24974           },
24975           {
24976             "group": "Body",
24977             "type": "String",
24978             "optional": true,
24979             "field": "saveName",
24980             "description": ""
24981           },
24982           {
24983             "group": "Body",
24984             "type": "String",
24985             "optional": true,
24986             "field": "filename",
24987             "description": ""
24988           },
24989           {
24990             "group": "Body",
24991             "type": "String",
24992             "optional": true,
24993             "field": "savePath",
24994             "description": ""
24995           },
24996           {
24997             "group": "Body",
24998             "type": "Virtual",
24999             "optional": true,
25000             "field": "format",
25001             "description": ""
25002           }
25003         ]
25004       }
25005     },
25006     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25007     "version": "0.0.0",
25008     "filename": "server/api/squareRecording/index.js",
25009     "groupTitle": "Square_Recordings"
25010   },
25011   {
25012     "type": "get",
25013     "url": "/api/square/recordings",
25014     "title": "Gets a list of Recordings",
25015     "examples": [
25016       {
25017         "title": "Example usage:",
25018         "content": "curl https://{domain}/api/square/recordings -v -u {name}:{password}",
25019         "type": "json"
25020       }
25021     ],
25022     "name": "GetRecordings",
25023     "group": "Square_Recordings",
25024     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25025     "version": "0.0.0",
25026     "filename": "server/api/squareRecording/index.js",
25027     "groupTitle": "Square_Recordings"
25028   },
25029   {
25030     "type": "get",
25031     "url": "/api/square/recordings/{id}",
25032     "title": "Gets a single Recording",
25033     "examples": [
25034       {
25035         "title": "Example usage:",
25036         "content": "curl https://{domain}/api/square/recordings/{id} -v -u {name}:{password}",
25037         "type": "json"
25038       }
25039     ],
25040     "name": "ShowRecordings",
25041     "group": "Square_Recordings",
25042     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25043     "version": "0.0.0",
25044     "filename": "server/api/squareRecording/index.js",
25045     "groupTitle": "Square_Recordings"
25046   },
25047   {
25048     "type": "delete",
25049     "url": "/api/square/recordings/{id}",
25050     "title": "Delete recording",
25051     "examples": [
25052       {
25053         "title": "Example usage:",
25054         "content": "curl https://{domain}/api/square/recordings/{id} -v -u {name}:{password} -X DELETE",
25055         "type": "json"
25056       }
25057     ],
25058     "name": "destroy",
25059     "group": "Square_Recordings",
25060     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25061     "version": "0.0.0",
25062     "filename": "server/api/squareRecording/index.js",
25063     "groupTitle": "Square_Recordings"
25064   },
25065   {
25066     "type": "get",
25067     "url": "/api/square/recordings/{id}/download",
25068     "title": "Download Recording",
25069     "examples": [
25070       {
25071         "title": "Example usage:",
25072         "content": "curl https://{domain}/api/square/recordings/{id}/download -v -u {name}:{password} -X GET",
25073         "type": "json"
25074       }
25075     ],
25076     "name": "download",
25077     "group": "Square_Recordings",
25078     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25079     "version": "0.0.0",
25080     "filename": "server/api/squareRecording/index.js",
25081     "groupTitle": "Square_Recordings"
25082   },
25083   {
25084     "type": "put",
25085     "url": "/api/square/recordings/{id}",
25086     "title": "Update an existing Recording",
25087     "examples": [
25088       {
25089         "title": "Example usage:",
25090         "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",
25091         "type": "json"
25092       }
25093     ],
25094     "name": "updateRecordings",
25095     "group": "Square_Recordings",
25096     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25097     "version": "0.0.0",
25098     "filename": "server/api/squareRecording/index.js",
25099     "groupTitle": "Square_Recordings"
25100   },
25101   {
25102     "type": "post",
25103     "url": "/api/square/reports",
25104     "title": "Creates a new Square Report",
25105     "examples": [
25106       {
25107         "title": "Example usage:",
25108         "content": "curl https://{domain}/api/square/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25109         "type": "json"
25110       }
25111     ],
25112     "name": "CreateSquare_Reports",
25113     "group": "Square_Reports",
25114     "parameter": {
25115       "fields": {
25116         "Body": [
25117           {
25118             "group": "Body",
25119             "type": "String",
25120             "optional": true,
25121             "field": "network",
25122             "description": ""
25123           },
25124           {
25125             "group": "Body",
25126             "type": "String",
25127             "optional": true,
25128             "field": "network_script",
25129             "description": ""
25130           },
25131           {
25132             "group": "Body",
25133             "type": "String",
25134             "optional": true,
25135             "field": "request",
25136             "description": ""
25137           },
25138           {
25139             "group": "Body",
25140             "type": "String",
25141             "optional": true,
25142             "field": "channel",
25143             "description": ""
25144           },
25145           {
25146             "group": "Body",
25147             "type": "String",
25148             "optional": true,
25149             "field": "language",
25150             "description": ""
25151           },
25152           {
25153             "group": "Body",
25154             "type": "String",
25155             "optional": true,
25156             "field": "type",
25157             "description": ""
25158           },
25159           {
25160             "group": "Body",
25161             "type": "String",
25162             "optional": true,
25163             "field": "uniqueid",
25164             "description": ""
25165           },
25166           {
25167             "group": "Body",
25168             "type": "String",
25169             "optional": true,
25170             "field": "version",
25171             "description": ""
25172           },
25173           {
25174             "group": "Body",
25175             "type": "String",
25176             "optional": true,
25177             "field": "callerid",
25178             "description": ""
25179           },
25180           {
25181             "group": "Body",
25182             "type": "String",
25183             "optional": true,
25184             "field": "calleridname",
25185             "description": ""
25186           },
25187           {
25188             "group": "Body",
25189             "type": "String",
25190             "optional": true,
25191             "field": "callingpres",
25192             "description": ""
25193           },
25194           {
25195             "group": "Body",
25196             "type": "String",
25197             "optional": true,
25198             "field": "callingani2",
25199             "description": ""
25200           },
25201           {
25202             "group": "Body",
25203             "type": "String",
25204             "optional": true,
25205             "field": "callington",
25206             "description": ""
25207           },
25208           {
25209             "group": "Body",
25210             "type": "String",
25211             "optional": true,
25212             "field": "callingtns",
25213             "description": ""
25214           },
25215           {
25216             "group": "Body",
25217             "type": "String",
25218             "optional": true,
25219             "field": "dnid",
25220             "description": ""
25221           },
25222           {
25223             "group": "Body",
25224             "type": "String",
25225             "optional": true,
25226             "field": "rdnis",
25227             "description": ""
25228           },
25229           {
25230             "group": "Body",
25231             "type": "String",
25232             "optional": true,
25233             "field": "context",
25234             "description": ""
25235           },
25236           {
25237             "group": "Body",
25238             "type": "String",
25239             "optional": true,
25240             "field": "extension",
25241             "description": ""
25242           },
25243           {
25244             "group": "Body",
25245             "type": "String",
25246             "optional": true,
25247             "field": "priority",
25248             "description": ""
25249           },
25250           {
25251             "group": "Body",
25252             "type": "String",
25253             "optional": true,
25254             "field": "enhanced",
25255             "description": ""
25256           },
25257           {
25258             "group": "Body",
25259             "type": "String",
25260             "optional": true,
25261             "field": "accountcode",
25262             "description": ""
25263           },
25264           {
25265             "group": "Body",
25266             "type": "String",
25267             "optional": true,
25268             "field": "threadid",
25269             "description": ""
25270           },
25271           {
25272             "group": "Body",
25273             "type": "String",
25274             "optional": true,
25275             "field": "project_name",
25276             "description": ""
25277           },
25278           {
25279             "group": "Body",
25280             "type": "String",
25281             "optional": true,
25282             "field": "joinAt",
25283             "description": ""
25284           },
25285           {
25286             "group": "Body",
25287             "type": "String",
25288             "optional": true,
25289             "field": "leaveAt",
25290             "description": ""
25291           },
25292           {
25293             "group": "Body",
25294             "type": "Boolean",
25295             "optional": true,
25296             "field": "bot",
25297             "description": ""
25298           }
25299         ]
25300       }
25301     },
25302     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25303     "version": "0.0.0",
25304     "filename": "server/api/squareReport/index.js",
25305     "groupTitle": "Square_Reports"
25306   },
25307   {
25308     "type": "delete",
25309     "url": "/api/square/reports/{id}",
25310     "title": "Deletes a Square Report",
25311     "examples": [
25312       {
25313         "title": "Example usage:",
25314         "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password} -X DELETE",
25315         "type": "json"
25316       }
25317     ],
25318     "name": "DeleteSquare_Reports",
25319     "group": "Square_Reports",
25320     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25321     "version": "0.0.0",
25322     "filename": "server/api/squareReport/index.js",
25323     "groupTitle": "Square_Reports"
25324   },
25325   {
25326     "type": "get",
25327     "url": "/api/square/reports/describe",
25328     "title": "Gets table info about Square Reports",
25329     "examples": [
25330       {
25331         "title": "Example usage:",
25332         "content": "curl https://{domain}/api/square/reports/describe -v -u {name}:{password}",
25333         "type": "json"
25334       }
25335     ],
25336     "name": "DescribeSquare_Reports",
25337     "group": "Square_Reports",
25338     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25339     "version": "0.0.0",
25340     "filename": "server/api/squareReport/index.js",
25341     "groupTitle": "Square_Reports"
25342   },
25343   {
25344     "type": "get",
25345     "url": "/api/square/reports",
25346     "title": "Gets a list of Square Reports",
25347     "examples": [
25348       {
25349         "title": "Example usage:",
25350         "content": "curl https://{domain}/api/square/reports -v -u {name}:{password}",
25351         "type": "json"
25352       }
25353     ],
25354     "name": "GetSquare_Reports",
25355     "group": "Square_Reports",
25356     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25357     "version": "0.0.0",
25358     "filename": "server/api/squareReport/index.js",
25359     "groupTitle": "Square_Reports"
25360   },
25361   {
25362     "type": "get",
25363     "url": "/api/square/reports/{id}",
25364     "title": "Gets a single Square Report",
25365     "examples": [
25366       {
25367         "title": "Example usage:",
25368         "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password}",
25369         "type": "json"
25370       }
25371     ],
25372     "name": "ShowSquare_Reports",
25373     "group": "Square_Reports",
25374     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25375     "version": "0.0.0",
25376     "filename": "server/api/squareReport/index.js",
25377     "groupTitle": "Square_Reports"
25378   },
25379   {
25380     "type": "put",
25381     "url": "/api/square/reports/{id}",
25382     "title": "Update an existing Square Report",
25383     "examples": [
25384       {
25385         "title": "Example usage:",
25386         "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",
25387         "type": "json"
25388       }
25389     ],
25390     "name": "updateSquare_Reports",
25391     "group": "Square_Reports",
25392     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25393     "version": "0.0.0",
25394     "filename": "server/api/squareReport/index.js",
25395     "groupTitle": "Square_Reports"
25396   },
25397   {
25398     "type": "post",
25399     "url": "/api/integrations/sugarcrm/configurations",
25400     "title": "Creates a new SugarCRM Configuration",
25401     "examples": [
25402       {
25403         "title": "Example usage:",
25404         "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",
25405         "type": "json"
25406       }
25407     ],
25408     "name": "CreateSugarCRM_Configurations",
25409     "group": "SugarCRM_Configurations",
25410     "parameter": {
25411       "fields": {
25412         "Body": [
25413           {
25414             "group": "Body",
25415             "type": "String",
25416             "optional": true,
25417             "field": "name",
25418             "description": ""
25419           },
25420           {
25421             "group": "Body",
25422             "type": "String",
25423             "optional": true,
25424             "field": "description",
25425             "description": ""
25426           }
25427         ]
25428       }
25429     },
25430     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25431     "version": "0.0.0",
25432     "filename": "server/api/intSugarcrmConfiguration/index.js",
25433     "groupTitle": "SugarCRM_Configurations"
25434   },
25435   {
25436     "type": "delete",
25437     "url": "/api/integrations/sugarcrm/configurations/{id}",
25438     "title": "Deletes a SugarCRM Configuration",
25439     "examples": [
25440       {
25441         "title": "Example usage:",
25442         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password} -X DELETE",
25443         "type": "json"
25444       }
25445     ],
25446     "name": "DeleteSugarCRM_Configurations",
25447     "group": "SugarCRM_Configurations",
25448     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25449     "version": "0.0.0",
25450     "filename": "server/api/intSugarcrmConfiguration/index.js",
25451     "groupTitle": "SugarCRM_Configurations"
25452   },
25453   {
25454     "type": "get",
25455     "url": "/api/integrations/sugarcrm/configurations",
25456     "title": "Gets a list of SugarCRM Configurations",
25457     "examples": [
25458       {
25459         "title": "Example usage:",
25460         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations -v -u {name}:{password}",
25461         "type": "json"
25462       }
25463     ],
25464     "name": "GetSugarCRM_Configurations",
25465     "group": "SugarCRM_Configurations",
25466     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25467     "version": "0.0.0",
25468     "filename": "server/api/intSugarcrmConfiguration/index.js",
25469     "groupTitle": "SugarCRM_Configurations"
25470   },
25471   {
25472     "type": "get",
25473     "url": "/api/integrations/sugarcrm/configurations/{id}",
25474     "title": "Gets a single SugarCRM Configuration",
25475     "examples": [
25476       {
25477         "title": "Example usage:",
25478         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password}",
25479         "type": "json"
25480       }
25481     ],
25482     "name": "ShowSugarCRM_Configurations",
25483     "group": "SugarCRM_Configurations",
25484     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25485     "version": "0.0.0",
25486     "filename": "server/api/intSugarcrmConfiguration/index.js",
25487     "groupTitle": "SugarCRM_Configurations"
25488   },
25489   {
25490     "type": "put",
25491     "url": "/api/integrations/sugarcrm/configurations/{id}",
25492     "title": "Update an existing SugarCRM Configuration",
25493     "examples": [
25494       {
25495         "title": "Example usage:",
25496         "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",
25497         "type": "json"
25498       }
25499     ],
25500     "name": "updateSugarCRM_Configurations",
25501     "group": "SugarCRM_Configurations",
25502     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25503     "version": "0.0.0",
25504     "filename": "server/api/intSugarcrmConfiguration/index.js",
25505     "groupTitle": "SugarCRM_Configurations"
25506   },
25507   {
25508     "type": "post",
25509     "url": "/api/integrations/sugarcrm/accounts",
25510     "title": "Creates a new Sugarcrm Account",
25511     "examples": [
25512       {
25513         "title": "Example usage:",
25514         "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",
25515         "type": "json"
25516       }
25517     ],
25518     "name": "CreateSugarcrm_Accounts",
25519     "group": "Sugarcrm_Accounts",
25520     "parameter": {
25521       "fields": {
25522         "Body": [
25523           {
25524             "group": "Body",
25525             "type": "String",
25526             "optional": true,
25527             "field": "name",
25528             "description": ""
25529           },
25530           {
25531             "group": "Body",
25532             "type": "String",
25533             "optional": true,
25534             "field": "description",
25535             "description": ""
25536           },
25537           {
25538             "group": "Body",
25539             "type": "String",
25540             "optional": true,
25541             "field": "username",
25542             "description": ""
25543           },
25544           {
25545             "group": "Body",
25546             "type": "String",
25547             "optional": true,
25548             "field": "password",
25549             "description": ""
25550           },
25551           {
25552             "group": "Body",
25553             "type": "String",
25554             "optional": true,
25555             "field": "remoteUri",
25556             "description": ""
25557           },
25558           {
25559             "group": "Body",
25560             "type": "String",
25561             "optional": false,
25562             "field": "serverUrl",
25563             "description": ""
25564           }
25565         ]
25566       }
25567     },
25568     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25569     "version": "0.0.0",
25570     "filename": "server/api/intSugarcrmAccount/index.js",
25571     "groupTitle": "Sugarcrm_Accounts"
25572   },
25573   {
25574     "type": "delete",
25575     "url": "/api/integrations/sugarcrm/accounts/{id}",
25576     "title": "Deletes a Sugarcrm Account",
25577     "examples": [
25578       {
25579         "title": "Example usage:",
25580         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password} -X DELETE",
25581         "type": "json"
25582       }
25583     ],
25584     "name": "DeleteSugarcrm_Accounts",
25585     "group": "Sugarcrm_Accounts",
25586     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/intSugarcrmAccount/index.js",
25589     "groupTitle": "Sugarcrm_Accounts"
25590   },
25591   {
25592     "type": "get",
25593     "url": "/api/integrations/sugarcrm/accounts",
25594     "title": "Gets a list of Sugarcrm Accounts",
25595     "examples": [
25596       {
25597         "title": "Example usage:",
25598         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts -v -u {name}:{password}",
25599         "type": "json"
25600       }
25601     ],
25602     "name": "GetSugarcrm_Accounts",
25603     "group": "Sugarcrm_Accounts",
25604     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25605     "version": "0.0.0",
25606     "filename": "server/api/intSugarcrmAccount/index.js",
25607     "groupTitle": "Sugarcrm_Accounts"
25608   },
25609   {
25610     "type": "get",
25611     "url": "/api/integrations/sugarcrm/accounts/{id}",
25612     "title": "Gets a single Sugarcrm Account",
25613     "examples": [
25614       {
25615         "title": "Example usage:",
25616         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password}",
25617         "type": "json"
25618       }
25619     ],
25620     "name": "ShowSugarcrm_Accounts",
25621     "group": "Sugarcrm_Accounts",
25622     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25623     "version": "0.0.0",
25624     "filename": "server/api/intSugarcrmAccount/index.js",
25625     "groupTitle": "Sugarcrm_Accounts"
25626   },
25627   {
25628     "type": "post",
25629     "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
25630     "title": "Creates new configuration",
25631     "examples": [
25632       {
25633         "title": "Example usage:",
25634         "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",
25635         "type": "json"
25636       }
25637     ],
25638     "name": "addConfiguration",
25639     "group": "Sugarcrm_Accounts",
25640     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25641     "version": "0.0.0",
25642     "filename": "server/api/intSugarcrmAccount/index.js",
25643     "groupTitle": "Sugarcrm_Accounts"
25644   },
25645   {
25646     "type": "get",
25647     "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
25648     "title": "Gets account configurations",
25649     "examples": [
25650       {
25651         "title": "Example usage:",
25652         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/configurations -v -u {name}:{password} -X GET",
25653         "type": "json"
25654       }
25655     ],
25656     "name": "getConfigurations",
25657     "group": "Sugarcrm_Accounts",
25658     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25659     "version": "0.0.0",
25660     "filename": "server/api/intSugarcrmAccount/index.js",
25661     "groupTitle": "Sugarcrm_Accounts"
25662   },
25663   {
25664     "type": "get",
25665     "url": "/api/integrations/sugarcrm/accounts/{id}/fields",
25666     "title": "Gets account fields",
25667     "examples": [
25668       {
25669         "title": "Example usage:",
25670         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/fields -v -u {name}:{password} -X GET",
25671         "type": "json"
25672       }
25673     ],
25674     "name": "getFields",
25675     "group": "Sugarcrm_Accounts",
25676     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25677     "version": "0.0.0",
25678     "filename": "server/api/intSugarcrmAccount/index.js",
25679     "groupTitle": "Sugarcrm_Accounts"
25680   },
25681   {
25682     "type": "put",
25683     "url": "/api/integrations/sugarcrm/accounts/{id}",
25684     "title": "Update an existing Sugarcrm Account",
25685     "examples": [
25686       {
25687         "title": "Example usage:",
25688         "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",
25689         "type": "json"
25690       }
25691     ],
25692     "name": "updateSugarcrm_Accounts",
25693     "group": "Sugarcrm_Accounts",
25694     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25695     "version": "0.0.0",
25696     "filename": "server/api/intSugarcrmAccount/index.js",
25697     "groupTitle": "Sugarcrm_Accounts"
25698   },
25699   {
25700     "type": "get",
25701     "url": "/api/integrations/sugarcrm/configurations/{id}/descriptions",
25702     "title": "Gets configurations descriptions",
25703     "examples": [
25704       {
25705         "title": "Example usage:",
25706         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
25707         "type": "json"
25708       }
25709     ],
25710     "name": "getDescriptions",
25711     "group": "Sugarcrm_Configurations",
25712     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25713     "version": "0.0.0",
25714     "filename": "server/api/intSugarcrmConfiguration/index.js",
25715     "groupTitle": "Sugarcrm_Configurations"
25716   },
25717   {
25718     "type": "get",
25719     "url": "/api/integrations/sugarcrm/configurations/{id}/fields",
25720     "title": "Gets configurations fields",
25721     "examples": [
25722       {
25723         "title": "Example usage:",
25724         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/fields -v -u {name}:{password} -X GET",
25725         "type": "json"
25726       }
25727     ],
25728     "name": "getFields",
25729     "group": "Sugarcrm_Configurations",
25730     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25731     "version": "0.0.0",
25732     "filename": "server/api/intSugarcrmConfiguration/index.js",
25733     "groupTitle": "Sugarcrm_Configurations"
25734   },
25735   {
25736     "type": "get",
25737     "url": "/api/integrations/sugarcrm/configurations/{id}/subjects",
25738     "title": "Gets configurations subjects",
25739     "examples": [
25740       {
25741         "title": "Example usage:",
25742         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/subjects -v -u {name}:{password} -X GET",
25743         "type": "json"
25744       }
25745     ],
25746     "name": "getSubjects",
25747     "group": "Sugarcrm_Configurations",
25748     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25749     "version": "0.0.0",
25750     "filename": "server/api/intSugarcrmConfiguration/index.js",
25751     "groupTitle": "Sugarcrm_Configurations"
25752   },
25753   {
25754     "type": "post",
25755     "url": "/api/integrations/sugarcrm/fields",
25756     "title": "Creates a new Sugarcrm Field",
25757     "examples": [
25758       {
25759         "title": "Example usage:",
25760         "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",
25761         "type": "json"
25762       }
25763     ],
25764     "name": "CreateSugarcrm_Fields",
25765     "group": "Sugarcrm_Fields",
25766     "parameter": {
25767       "fields": {
25768         "Body": [
25769           {
25770             "group": "Body",
25771             "type": "String",
25772             "allowedValues": [
25773               "\"string\"",
25774               "\"variable\"",
25775               "\"customVariable\"",
25776               "\"keyValue\"",
25777               "\"picklist\""
25778             ],
25779             "optional": true,
25780             "field": "type",
25781             "description": ""
25782           },
25783           {
25784             "group": "Body",
25785             "type": "String",
25786             "optional": true,
25787             "field": "content",
25788             "description": ""
25789           },
25790           {
25791             "group": "Body",
25792             "type": "String",
25793             "optional": true,
25794             "field": "key",
25795             "description": ""
25796           },
25797           {
25798             "group": "Body",
25799             "type": "String",
25800             "allowedValues": [
25801               "\"string\"",
25802               "\"variable\"",
25803               "\"customVariable\""
25804             ],
25805             "optional": true,
25806             "field": "keyType",
25807             "description": ""
25808           },
25809           {
25810             "group": "Body",
25811             "type": "String",
25812             "optional": true,
25813             "field": "keyContent",
25814             "description": ""
25815           },
25816           {
25817             "group": "Body",
25818             "type": "String",
25819             "optional": true,
25820             "field": "idField",
25821             "description": ""
25822           },
25823           {
25824             "group": "Body",
25825             "type": "String",
25826             "optional": true,
25827             "field": "nameField",
25828             "description": ""
25829           },
25830           {
25831             "group": "Body",
25832             "type": "Boolean",
25833             "optional": true,
25834             "field": "customField",
25835             "description": ""
25836           },
25837           {
25838             "group": "Body",
25839             "type": "String",
25840             "optional": true,
25841             "field": "variableName",
25842             "description": ""
25843           }
25844         ]
25845       }
25846     },
25847     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25848     "version": "0.0.0",
25849     "filename": "server/api/intSugarcrmField/index.js",
25850     "groupTitle": "Sugarcrm_Fields"
25851   },
25852   {
25853     "type": "delete",
25854     "url": "/api/integrations/sugarcrm/fields/{id}",
25855     "title": "Deletes a Sugarcrm Field",
25856     "examples": [
25857       {
25858         "title": "Example usage:",
25859         "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password} -X DELETE",
25860         "type": "json"
25861       }
25862     ],
25863     "name": "DeleteSugarcrm_Fields",
25864     "group": "Sugarcrm_Fields",
25865     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25866     "version": "0.0.0",
25867     "filename": "server/api/intSugarcrmField/index.js",
25868     "groupTitle": "Sugarcrm_Fields"
25869   },
25870   {
25871     "type": "get",
25872     "url": "/api/integrations/sugarcrm/fields",
25873     "title": "Gets a list of Sugarcrm Fields",
25874     "examples": [
25875       {
25876         "title": "Example usage:",
25877         "content": "curl https://{domain}/api/integrations/sugarcrm/fields -v -u {name}:{password}",
25878         "type": "json"
25879       }
25880     ],
25881     "name": "GetSugarcrm_Fields",
25882     "group": "Sugarcrm_Fields",
25883     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25884     "version": "0.0.0",
25885     "filename": "server/api/intSugarcrmField/index.js",
25886     "groupTitle": "Sugarcrm_Fields"
25887   },
25888   {
25889     "type": "get",
25890     "url": "/api/integrations/sugarcrm/fields/{id}",
25891     "title": "Gets a single Sugarcrm Field",
25892     "examples": [
25893       {
25894         "title": "Example usage:",
25895         "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password}",
25896         "type": "json"
25897       }
25898     ],
25899     "name": "ShowSugarcrm_Fields",
25900     "group": "Sugarcrm_Fields",
25901     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25902     "version": "0.0.0",
25903     "filename": "server/api/intSugarcrmField/index.js",
25904     "groupTitle": "Sugarcrm_Fields"
25905   },
25906   {
25907     "type": "put",
25908     "url": "/api/integrations/sugarcrm/fields/{id}",
25909     "title": "Update an existing Sugarcrm Field",
25910     "examples": [
25911       {
25912         "title": "Example usage:",
25913         "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",
25914         "type": "json"
25915       }
25916     ],
25917     "name": "updateSugarcrm_Fields",
25918     "group": "Sugarcrm_Fields",
25919     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25920     "version": "0.0.0",
25921     "filename": "server/api/intSugarcrmField/index.js",
25922     "groupTitle": "Sugarcrm_Fields"
25923   },
25924   {
25925     "type": "get",
25926     "url": "/api/system",
25927     "title": "Gets system information",
25928     "examples": [
25929       {
25930         "title": "Example usage:",
25931         "content": "curl https://{domain}/api/system -v -u {name}:{password}",
25932         "type": "json"
25933       }
25934     ],
25935     "name": "GetSystemInformation",
25936     "group": "System_Information",
25937     "description": "<p>Motion returns the system information.</p>",
25938     "version": "0.0.0",
25939     "filename": "server/api/system/index.js",
25940     "groupTitle": "System_Information"
25941   },
25942   {
25943     "type": "get",
25944     "url": "/api/system/process",
25945     "title": "Gets system information",
25946     "examples": [
25947       {
25948         "title": "Example usage:",
25949         "content": "curl https://{domain}/api/system -v -u {name}:{password}",
25950         "type": "json"
25951       }
25952     ],
25953     "name": "GetSystemInformation",
25954     "group": "System_Information",
25955     "description": "<p>Motion returns the system information.</p>",
25956     "version": "0.0.0",
25957     "filename": "server/api/system/index.js",
25958     "groupTitle": "System_Information"
25959   },
25960   {
25961     "type": "post",
25962     "url": "/api/tags",
25963     "title": "Creates a new Tag",
25964     "examples": [
25965       {
25966         "title": "Example usage:",
25967         "content": "curl https://{domain}/api/tags -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25968         "type": "json"
25969       }
25970     ],
25971     "name": "CreateTags",
25972     "group": "Tags",
25973     "parameter": {
25974       "fields": {
25975         "Body": [
25976           {
25977             "group": "Body",
25978             "type": "String",
25979             "optional": false,
25980             "field": "name",
25981             "description": ""
25982           },
25983           {
25984             "group": "Body",
25985             "type": "String",
25986             "optional": true,
25987             "field": "color",
25988             "description": ""
25989           },
25990           {
25991             "group": "Body",
25992             "type": "String",
25993             "optional": true,
25994             "field": "description",
25995             "description": ""
25996           }
25997         ]
25998       }
25999     },
26000     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26001     "version": "0.0.0",
26002     "filename": "server/api/tag/index.js",
26003     "groupTitle": "Tags"
26004   },
26005   {
26006     "type": "delete",
26007     "url": "/api/tags/{id}",
26008     "title": "Deletes a Tag",
26009     "examples": [
26010       {
26011         "title": "Example usage:",
26012         "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password} -X DELETE",
26013         "type": "json"
26014       }
26015     ],
26016     "name": "DeleteTags",
26017     "group": "Tags",
26018     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26019     "version": "0.0.0",
26020     "filename": "server/api/tag/index.js",
26021     "groupTitle": "Tags"
26022   },
26023   {
26024     "type": "get",
26025     "url": "/api/tags",
26026     "title": "Gets a list of Tags",
26027     "examples": [
26028       {
26029         "title": "Example usage:",
26030         "content": "curl https://{domain}/api/tags -v -u {name}:{password}",
26031         "type": "json"
26032       }
26033     ],
26034     "name": "GetTags",
26035     "group": "Tags",
26036     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26037     "version": "0.0.0",
26038     "filename": "server/api/tag/index.js",
26039     "groupTitle": "Tags"
26040   },
26041   {
26042     "type": "get",
26043     "url": "/api/tags/{id}",
26044     "title": "Gets a single Tag",
26045     "examples": [
26046       {
26047         "title": "Example usage:",
26048         "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password}",
26049         "type": "json"
26050       }
26051     ],
26052     "name": "ShowTags",
26053     "group": "Tags",
26054     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26055     "version": "0.0.0",
26056     "filename": "server/api/tag/index.js",
26057     "groupTitle": "Tags"
26058   },
26059   {
26060     "type": "put",
26061     "url": "/api/tags/{id}",
26062     "title": "Update an existing Tag",
26063     "examples": [
26064       {
26065         "title": "Example usage:",
26066         "content": "curl https://{domain}/api/tags/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26067         "type": "json"
26068       }
26069     ],
26070     "name": "updateTags",
26071     "group": "Tags",
26072     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26073     "version": "0.0.0",
26074     "filename": "server/api/tag/index.js",
26075     "groupTitle": "Tags"
26076   },
26077   {
26078     "type": "post",
26079     "url": "/api/teams/{id}/queues",
26080     "title": "Add queues to a team",
26081     "examples": [
26082       {
26083         "title": "Example usage:",
26084         "content": "curl https://{domain}/api/teams/{id}/queues -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26085         "type": "json"
26086       }
26087     ],
26088     "name": "AddQueues",
26089     "group": "Teams",
26090     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26091     "version": "0.0.0",
26092     "filename": "server/api/team/index.js",
26093     "groupTitle": "Teams"
26094   },
26095   {
26096     "type": "post",
26097     "url": "/api/teams",
26098     "title": "Creates a new Team",
26099     "examples": [
26100       {
26101         "title": "Example usage:",
26102         "content": "curl https://{domain}/api/teams -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26103         "type": "json"
26104       }
26105     ],
26106     "name": "CreateTeams",
26107     "group": "Teams",
26108     "parameter": {
26109       "fields": {
26110         "Body": [
26111           {
26112             "group": "Body",
26113             "type": "String",
26114             "optional": false,
26115             "field": "name",
26116             "description": ""
26117           },
26118           {
26119             "group": "Body",
26120             "type": "String",
26121             "optional": true,
26122             "field": "description",
26123             "description": ""
26124           }
26125         ]
26126       }
26127     },
26128     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26129     "version": "0.0.0",
26130     "filename": "server/api/team/index.js",
26131     "groupTitle": "Teams"
26132   },
26133   {
26134     "type": "delete",
26135     "url": "/api/teams/{id}",
26136     "title": "Deletes a Team",
26137     "examples": [
26138       {
26139         "title": "Example usage:",
26140         "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password} -X DELETE",
26141         "type": "json"
26142       }
26143     ],
26144     "name": "DeleteTeams",
26145     "group": "Teams",
26146     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26147     "version": "0.0.0",
26148     "filename": "server/api/team/index.js",
26149     "groupTitle": "Teams"
26150   },
26151   {
26152     "type": "get",
26153     "url": "/api/teams/{id}/users",
26154     "title": "Gets agents from team",
26155     "examples": [
26156       {
26157         "title": "Example usage:",
26158         "content": "curl https://{domain}/api/teams/{id}/users -v -u {name}:{password} -X GET",
26159         "type": "json"
26160       }
26161     ],
26162     "name": "GetAgents",
26163     "group": "Teams",
26164     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26165     "version": "0.0.0",
26166     "filename": "server/api/team/index.js",
26167     "groupTitle": "Teams"
26168   },
26169   {
26170     "type": "get",
26171     "url": "/api/teams/{id}/queues?channel={channel}",
26172     "title": "Gets Queues list",
26173     "examples": [
26174       {
26175         "title": "Example usage:",
26176         "content": "curl https://{domain}/api/teams/{id}/queues?channel={channel} -v -u {name}:{password}",
26177         "type": "json"
26178       }
26179     ],
26180     "name": "GetQueues",
26181     "group": "Teams",
26182     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26183     "version": "0.0.0",
26184     "filename": "server/api/team/index.js",
26185     "groupTitle": "Teams"
26186   },
26187   {
26188     "type": "get",
26189     "url": "/api/teams",
26190     "title": "Gets a list of Teams",
26191     "examples": [
26192       {
26193         "title": "Example usage:",
26194         "content": "curl https://{domain}/api/teams -v -u {name}:{password}",
26195         "type": "json"
26196       }
26197     ],
26198     "name": "GetTeams",
26199     "group": "Teams",
26200     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26201     "version": "0.0.0",
26202     "filename": "server/api/team/index.js",
26203     "groupTitle": "Teams"
26204   },
26205   {
26206     "type": "delete",
26207     "url": "/api/teams/{id}/users",
26208     "title": "Removes agents from a team",
26209     "examples": [
26210       {
26211         "title": "Example usage:",
26212         "content": "curl https://{domain}/api/teams/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
26213         "type": "json"
26214       }
26215     ],
26216     "name": "RemoveAgents",
26217     "group": "Teams",
26218     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26219     "version": "0.0.0",
26220     "filename": "server/api/team/index.js",
26221     "groupTitle": "Teams"
26222   },
26223   {
26224     "type": "delete",
26225     "url": "/api/teams/{id}/queues",
26226     "title": "Remove queues to a team",
26227     "examples": [
26228       {
26229         "title": "Example usage:",
26230         "content": "curl https://{domain}/api/teams/{id}/queues?channel=voice&ids=1&ids=2 -v -u {name}:{password} -X DELETE",
26231         "type": "json"
26232       }
26233     ],
26234     "name": "RemoveQueues",
26235     "group": "Teams",
26236     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26237     "version": "0.0.0",
26238     "filename": "server/api/team/index.js",
26239     "groupTitle": "Teams"
26240   },
26241   {
26242     "type": "delete",
26243     "url": "/api/whatsapp/queues/{id}/teams",
26244     "title": "Remove teams from a queue",
26245     "examples": [
26246       {
26247         "title": "Example usage:",
26248         "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26249         "type": "json"
26250       }
26251     ],
26252     "name": "RemoveTeams",
26253     "group": "Teams",
26254     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26255     "version": "0.0.0",
26256     "filename": "server/api/whatsappQueue/index.js",
26257     "groupTitle": "Teams"
26258   },
26259   {
26260     "type": "delete",
26261     "url": "/api/openchannel/queues/{id}/teams",
26262     "title": "Remove teams from a queue",
26263     "examples": [
26264       {
26265         "title": "Example usage:",
26266         "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26267         "type": "json"
26268       }
26269     ],
26270     "name": "RemoveTeams",
26271     "group": "Teams",
26272     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26273     "version": "0.0.0",
26274     "filename": "server/api/openchannelQueue/index.js",
26275     "groupTitle": "Teams"
26276   },
26277   {
26278     "type": "delete",
26279     "url": "/api/voice/queues/{id}/teams",
26280     "title": "Remove teams from a queue",
26281     "examples": [
26282       {
26283         "title": "Example usage:",
26284         "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26285         "type": "json"
26286       }
26287     ],
26288     "name": "RemoveTeams",
26289     "group": "Teams",
26290     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26291     "version": "0.0.0",
26292     "filename": "server/api/voiceQueue/index.js",
26293     "groupTitle": "Teams"
26294   },
26295   {
26296     "type": "delete",
26297     "url": "/api/sms/queues/{id}/teams",
26298     "title": "Remove teams from a queue",
26299     "examples": [
26300       {
26301         "title": "Example usage:",
26302         "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26303         "type": "json"
26304       }
26305     ],
26306     "name": "RemoveTeams",
26307     "group": "Teams",
26308     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26309     "version": "0.0.0",
26310     "filename": "server/api/smsQueue/index.js",
26311     "groupTitle": "Teams"
26312   },
26313   {
26314     "type": "delete",
26315     "url": "/api/voice/Prefixes/{id}/teams",
26316     "title": "Remove teams from a voice prefix",
26317     "examples": [
26318       {
26319         "title": "Example usage:",
26320         "content": "curl https://{domain}/api/voice/prefixes/{id}/teams -v -u {name}:{password} -X DELETE",
26321         "type": "json"
26322       }
26323     ],
26324     "name": "RemoveTeams",
26325     "group": "Teams",
26326     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26327     "version": "0.0.0",
26328     "filename": "server/api/voicePrefix/index.js",
26329     "groupTitle": "Teams"
26330   },
26331   {
26332     "type": "delete",
26333     "url": "/api/chat/queues/{id}/teams",
26334     "title": "Remove teams from a queue",
26335     "examples": [
26336       {
26337         "title": "Example usage:",
26338         "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26339         "type": "json"
26340       }
26341     ],
26342     "name": "RemoveTeams",
26343     "group": "Teams",
26344     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26345     "version": "0.0.0",
26346     "filename": "server/api/chatQueue/index.js",
26347     "groupTitle": "Teams"
26348   },
26349   {
26350     "type": "delete",
26351     "url": "/api/fax/queues/{id}/teams",
26352     "title": "Remove teams from a queue",
26353     "examples": [
26354       {
26355         "title": "Example usage:",
26356         "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26357         "type": "json"
26358       }
26359     ],
26360     "name": "RemoveTeams",
26361     "group": "Teams",
26362     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26363     "version": "0.0.0",
26364     "filename": "server/api/faxQueue/index.js",
26365     "groupTitle": "Teams"
26366   },
26367   {
26368     "type": "delete",
26369     "url": "/api/mail/queues/{id}/teams",
26370     "title": "Remove teams from a queue",
26371     "examples": [
26372       {
26373         "title": "Example usage:",
26374         "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26375         "type": "json"
26376       }
26377     ],
26378     "name": "RemoveTeams",
26379     "group": "Teams",
26380     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26381     "version": "0.0.0",
26382     "filename": "server/api/mailQueue/index.js",
26383     "groupTitle": "Teams"
26384   },
26385   {
26386     "type": "get",
26387     "url": "/api/teams/{id}",
26388     "title": "Gets a single Team",
26389     "examples": [
26390       {
26391         "title": "Example usage:",
26392         "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password}",
26393         "type": "json"
26394       }
26395     ],
26396     "name": "ShowTeams",
26397     "group": "Teams",
26398     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26399     "version": "0.0.0",
26400     "filename": "server/api/team/index.js",
26401     "groupTitle": "Teams"
26402   },
26403   {
26404     "type": "post",
26405     "url": "/api/teams/{id}/users",
26406     "title": "Adds agents to a team",
26407     "examples": [
26408       {
26409         "title": "Example usage:",
26410         "content": "curl https://{domain}/api/teams/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26411         "type": "json"
26412       }
26413     ],
26414     "name": "addAgents",
26415     "group": "Teams",
26416     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26417     "version": "0.0.0",
26418     "filename": "server/api/team/index.js",
26419     "groupTitle": "Teams"
26420   },
26421   {
26422     "type": "put",
26423     "url": "/api/teams/{id}",
26424     "title": "Update an existing Team",
26425     "examples": [
26426       {
26427         "title": "Example usage:",
26428         "content": "curl https://{domain}/api/teams/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26429         "type": "json"
26430       }
26431     ],
26432     "name": "updateTeams",
26433     "group": "Teams",
26434     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26435     "version": "0.0.0",
26436     "filename": "server/api/team/index.js",
26437     "groupTitle": "Teams"
26438   },
26439   {
26440     "type": "post",
26441     "url": "/api/templates",
26442     "title": "Creates a new Template",
26443     "examples": [
26444       {
26445         "title": "Example usage:",
26446         "content": "curl https://{domain}/api/templates -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26447         "type": "json"
26448       }
26449     ],
26450     "name": "CreateTemplates",
26451     "group": "Templates",
26452     "parameter": {
26453       "fields": {
26454         "Body": [
26455           {
26456             "group": "Body",
26457             "type": "String",
26458             "optional": true,
26459             "field": "name",
26460             "description": ""
26461           },
26462           {
26463             "group": "Body",
26464             "type": "String",
26465             "optional": true,
26466             "field": "description",
26467             "description": ""
26468           },
26469           {
26470             "group": "Body",
26471             "type": "Text",
26472             "optional": true,
26473             "field": "html",
26474             "description": ""
26475           }
26476         ]
26477       }
26478     },
26479     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26480     "version": "0.0.0",
26481     "filename": "server/api/template/index.js",
26482     "groupTitle": "Templates"
26483   },
26484   {
26485     "type": "delete",
26486     "url": "/api/templates/{id}",
26487     "title": "Deletes a Template",
26488     "examples": [
26489       {
26490         "title": "Example usage:",
26491         "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password} -X DELETE",
26492         "type": "json"
26493       }
26494     ],
26495     "name": "DeleteTemplates",
26496     "group": "Templates",
26497     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26498     "version": "0.0.0",
26499     "filename": "server/api/template/index.js",
26500     "groupTitle": "Templates"
26501   },
26502   {
26503     "type": "get",
26504     "url": "/api/templates",
26505     "title": "Gets a list of Templates",
26506     "examples": [
26507       {
26508         "title": "Example usage:",
26509         "content": "curl https://{domain}/api/templates -v -u {name}:{password}",
26510         "type": "json"
26511       }
26512     ],
26513     "name": "GetTemplates",
26514     "group": "Templates",
26515     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26516     "version": "0.0.0",
26517     "filename": "server/api/template/index.js",
26518     "groupTitle": "Templates"
26519   },
26520   {
26521     "type": "get",
26522     "url": "/api/templates/{id}",
26523     "title": "Gets a single Template",
26524     "examples": [
26525       {
26526         "title": "Example usage:",
26527         "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password}",
26528         "type": "json"
26529       }
26530     ],
26531     "name": "ShowTemplates",
26532     "group": "Templates",
26533     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26534     "version": "0.0.0",
26535     "filename": "server/api/template/index.js",
26536     "groupTitle": "Templates"
26537   },
26538   {
26539     "type": "put",
26540     "url": "/api/templates/{id}",
26541     "title": "Update an existing Template",
26542     "examples": [
26543       {
26544         "title": "Example usage:",
26545         "content": "curl https://{domain}/api/templates/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26546         "type": "json"
26547       }
26548     ],
26549     "name": "updateTemplates",
26550     "group": "Templates",
26551     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26552     "version": "0.0.0",
26553     "filename": "server/api/template/index.js",
26554     "groupTitle": "Templates"
26555   },
26556   {
26557     "type": "post",
26558     "url": "/api/triggers",
26559     "title": "Creates a new Trigger",
26560     "examples": [
26561       {
26562         "title": "Example usage:",
26563         "content": "curl https://{domain}/api/triggers -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26564         "type": "json"
26565       }
26566     ],
26567     "name": "CreateTriggers",
26568     "group": "Triggers",
26569     "parameter": {
26570       "fields": {
26571         "Body": [
26572           {
26573             "group": "Body",
26574             "type": "String",
26575             "optional": true,
26576             "field": "name",
26577             "description": ""
26578           },
26579           {
26580             "group": "Body",
26581             "type": "String",
26582             "optional": true,
26583             "field": "channel",
26584             "description": ""
26585           },
26586           {
26587             "group": "Body",
26588             "type": "String",
26589             "optional": true,
26590             "field": "description",
26591             "description": ""
26592           },
26593           {
26594             "group": "Body",
26595             "type": "Boolean",
26596             "optional": true,
26597             "field": "status",
26598             "description": ""
26599           }
26600         ]
26601       }
26602     },
26603     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26604     "version": "0.0.0",
26605     "filename": "server/api/trigger/index.js",
26606     "groupTitle": "Triggers"
26607   },
26608   {
26609     "type": "delete",
26610     "url": "/api/triggers/{id}",
26611     "title": "Deletes a Trigger",
26612     "examples": [
26613       {
26614         "title": "Example usage:",
26615         "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password} -X DELETE",
26616         "type": "json"
26617       }
26618     ],
26619     "name": "DeleteTriggers",
26620     "group": "Triggers",
26621     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26622     "version": "0.0.0",
26623     "filename": "server/api/trigger/index.js",
26624     "groupTitle": "Triggers"
26625   },
26626   {
26627     "type": "get",
26628     "url": "/api/triggers",
26629     "title": "Gets a list of Triggers",
26630     "examples": [
26631       {
26632         "title": "Example usage:",
26633         "content": "curl https://{domain}/api/triggers -v -u {name}:{password}",
26634         "type": "json"
26635       }
26636     ],
26637     "name": "GetTriggers",
26638     "group": "Triggers",
26639     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26640     "version": "0.0.0",
26641     "filename": "server/api/trigger/index.js",
26642     "groupTitle": "Triggers"
26643   },
26644   {
26645     "type": "get",
26646     "url": "/api/triggers/{id}",
26647     "title": "Gets a single Trigger",
26648     "examples": [
26649       {
26650         "title": "Example usage:",
26651         "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password}",
26652         "type": "json"
26653       }
26654     ],
26655     "name": "ShowTriggers",
26656     "group": "Triggers",
26657     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26658     "version": "0.0.0",
26659     "filename": "server/api/trigger/index.js",
26660     "groupTitle": "Triggers"
26661   },
26662   {
26663     "type": "post",
26664     "url": "/api/triggers/{id}/actions",
26665     "title": "Creates new actions",
26666     "examples": [
26667       {
26668         "title": "Example usage:",
26669         "content": "curl https://{domain}/api/triggers/{id}/actions -d '{\"action\": \"contactManager\",\"data1\": \"1\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26670         "type": "json"
26671       }
26672     ],
26673     "name": "addAction",
26674     "group": "Triggers",
26675     "parameter": {
26676       "fields": {
26677         "Body": [
26678           {
26679             "group": "Body",
26680             "type": "Virtual",
26681             "optional": true,
26682             "field": "name",
26683             "description": ""
26684           },
26685           {
26686             "group": "Body",
26687             "type": "String",
26688             "optional": false,
26689             "field": "action",
26690             "description": "<p>Allowed values: contactManager, integration, motionbar, jscripty, urlForward, browser, bot, script</p>"
26691           },
26692           {
26693             "group": "Body",
26694             "type": "String",
26695             "optional": true,
26696             "field": "data1",
26697             "description": "<p>contactManager[ListId], integration[intName(zendesk)], motionbar[Popup(0),URL(1),WinApp(2)], urlForward[GET,POST], browser[TemplateId(0),URL(1)]</p>"
26698           },
26699           {
26700             "group": "Body",
26701             "type": "String",
26702             "optional": true,
26703             "field": "data2",
26704             "description": "<p>integration[AccountId], motionbar[TemplateId,URL,WinAppPath], urlForward[URL]</p>"
26705           },
26706           {
26707             "group": "Body",
26708             "type": "String",
26709             "optional": true,
26710             "field": "data3",
26711             "description": "<p>motionbar[NULL,NULL,WinAppArguments]</p>"
26712           },
26713           {
26714             "group": "Body",
26715             "type": "String",
26716             "optional": true,
26717             "field": "data4",
26718             "description": ""
26719           },
26720           {
26721             "group": "Body",
26722             "type": "String",
26723             "optional": true,
26724             "field": "data5",
26725             "description": ""
26726           },
26727           {
26728             "group": "Body",
26729             "type": "String",
26730             "optional": true,
26731             "field": "data6",
26732             "description": ""
26733           },
26734           {
26735             "group": "Body",
26736             "type": "Text",
26737             "optional": true,
26738             "field": "data7",
26739             "description": ""
26740           }
26741         ]
26742       }
26743     },
26744     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26745     "version": "0.0.0",
26746     "filename": "server/api/trigger/index.js",
26747     "groupTitle": "Triggers"
26748   },
26749   {
26750     "type": "post",
26751     "url": "/api/triggers/{id}/all_conditions",
26752     "title": "Creates a new \"AND\"condition",
26753     "examples": [
26754       {
26755         "title": "Example usage:",
26756         "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",
26757         "type": "json"
26758       }
26759     ],
26760     "name": "addAllCondition",
26761     "group": "Triggers",
26762     "parameter": {
26763       "fields": {
26764         "Body": [
26765           {
26766             "group": "Body",
26767             "type": "Virtual",
26768             "optional": true,
26769             "field": "name",
26770             "description": ""
26771           },
26772           {
26773             "group": "Body",
26774             "type": "String",
26775             "optional": false,
26776             "field": "field",
26777             "description": ""
26778           },
26779           {
26780             "group": "Body",
26781             "type": "String",
26782             "optional": false,
26783             "field": "operator",
26784             "description": ""
26785           },
26786           {
26787             "group": "Body",
26788             "type": "String",
26789             "optional": false,
26790             "field": "value",
26791             "description": ""
26792           }
26793         ]
26794       }
26795     },
26796     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26797     "version": "0.0.0",
26798     "filename": "server/api/trigger/index.js",
26799     "groupTitle": "Triggers"
26800   },
26801   {
26802     "type": "post",
26803     "url": "/api/triggers/{id}/any_conditions",
26804     "title": "Creates a new \"OR\"condition",
26805     "examples": [
26806       {
26807         "title": "Example usage:",
26808         "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",
26809         "type": "json"
26810       }
26811     ],
26812     "name": "addAnyCondition",
26813     "group": "Triggers",
26814     "parameter": {
26815       "fields": {
26816         "Body": [
26817           {
26818             "group": "Body",
26819             "type": "Virtual",
26820             "optional": true,
26821             "field": "name",
26822             "description": ""
26823           },
26824           {
26825             "group": "Body",
26826             "type": "String",
26827             "optional": false,
26828             "field": "field",
26829             "description": ""
26830           },
26831           {
26832             "group": "Body",
26833             "type": "String",
26834             "optional": false,
26835             "field": "operator",
26836             "description": ""
26837           },
26838           {
26839             "group": "Body",
26840             "type": "String",
26841             "optional": false,
26842             "field": "value",
26843             "description": ""
26844           }
26845         ]
26846       }
26847     },
26848     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26849     "version": "0.0.0",
26850     "filename": "server/api/trigger/index.js",
26851     "groupTitle": "Triggers"
26852   },
26853   {
26854     "type": "get",
26855     "url": "/api/triggers/{id}/actions",
26856     "title": "Gets Trigger Actions",
26857     "examples": [
26858       {
26859         "title": "Example usage:",
26860         "content": "curl https://{domain}/api/triggers/{id}/actions -v -u {name}:{password} -X GET",
26861         "type": "json"
26862       }
26863     ],
26864     "name": "getActions",
26865     "group": "Triggers",
26866     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26867     "version": "0.0.0",
26868     "filename": "server/api/trigger/index.js",
26869     "groupTitle": "Triggers"
26870   },
26871   {
26872     "type": "get",
26873     "url": "/api/triggers/{id}/all_conditions",
26874     "title": "Gets \"AND\" Trigger Conditions",
26875     "examples": [
26876       {
26877         "title": "Example usage:",
26878         "content": "curl https://{domain}/api/triggers/{id}/all_conditions -v -u {name}:{password} -X GET",
26879         "type": "json"
26880       }
26881     ],
26882     "name": "getAllConditions",
26883     "group": "Triggers",
26884     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26885     "version": "0.0.0",
26886     "filename": "server/api/trigger/index.js",
26887     "groupTitle": "Triggers"
26888   },
26889   {
26890     "type": "get",
26891     "url": "/api/triggers/{id}/any_conditions",
26892     "title": "Gets \"OR\" Trigger Conditions",
26893     "examples": [
26894       {
26895         "title": "Example usage:",
26896         "content": "curl https://{domain}/api/triggers/{id}/any_conditions -v -u {name}:{password} -X GET",
26897         "type": "json"
26898       }
26899     ],
26900     "name": "getAnyConditions",
26901     "group": "Triggers",
26902     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26903     "version": "0.0.0",
26904     "filename": "server/api/trigger/index.js",
26905     "groupTitle": "Triggers"
26906   },
26907   {
26908     "type": "put",
26909     "url": "/api/triggers/{id}",
26910     "title": "Update an existing Trigger",
26911     "examples": [
26912       {
26913         "title": "Example usage:",
26914         "content": "curl https://{domain}/api/triggers/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26915         "type": "json"
26916       }
26917     ],
26918     "name": "updateTriggers",
26919     "group": "Triggers",
26920     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26921     "version": "0.0.0",
26922     "filename": "server/api/trigger/index.js",
26923     "groupTitle": "Triggers"
26924   },
26925   {
26926     "type": "post",
26927     "url": "/api/trunks/clone",
26928     "title": "Clone an existing Trunk",
26929     "examples": [
26930       {
26931         "title": "Example usage:",
26932         "content": "curl https://{domain}/api/trunks/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26933         "type": "json"
26934       }
26935     ],
26936     "name": "CloneTrunks",
26937     "group": "Trunks",
26938     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26939     "version": "0.0.0",
26940     "filename": "server/api/trunk/index.js",
26941     "groupTitle": "Trunks"
26942   },
26943   {
26944     "type": "post",
26945     "url": "/api/trunks",
26946     "title": "Create a new trunk",
26947     "examples": [
26948       {
26949         "title": "Example usage:",
26950         "content": "curl https://{domain}/api/trunks -v -u {name}:{password} -X POST",
26951         "type": "json"
26952       }
26953     ],
26954     "name": "Create",
26955     "group": "Trunks",
26956     "parameter": {
26957       "fields": {
26958         "Body": [
26959           {
26960             "group": "Body",
26961             "type": "String",
26962             "optional": false,
26963             "field": "name",
26964             "description": ""
26965           },
26966           {
26967             "group": "Body",
26968             "type": "String",
26969             "allowedValues": [
26970               "\"friend\"",
26971               "\"user\"",
26972               "\"peer\""
26973             ],
26974             "optional": false,
26975             "field": "type",
26976             "description": ""
26977           },
26978           {
26979             "group": "Body",
26980             "type": "String",
26981             "optional": false,
26982             "field": "context",
26983             "description": ""
26984           },
26985           {
26986             "group": "Body",
26987             "type": "String",
26988             "allowedValues": [
26989               "\"ALLOWED_NOT_SCREENED\"",
26990               "\"ALLOWED_PASSED_SCREEN\"",
26991               "\"ALLOWED_FAILED_SCREEN\"",
26992               "\"ALLOWED\"",
26993               "\"PROHIB_NOT_SCREENED\"",
26994               "\"PROHIB_PASSED_SCREEN\"",
26995               "\"PROHIB_FAILED_SCREEN\"",
26996               "\"PROHIB\""
26997             ],
26998             "optional": true,
26999             "field": "callingpres",
27000             "description": ""
27001           },
27002           {
27003             "group": "Body",
27004             "type": "String",
27005             "optional": true,
27006             "field": "deny",
27007             "description": ""
27008           },
27009           {
27010             "group": "Body",
27011             "type": "String",
27012             "optional": true,
27013             "field": "permit",
27014             "description": ""
27015           },
27016           {
27017             "group": "Body",
27018             "type": "String",
27019             "optional": true,
27020             "field": "secret",
27021             "description": ""
27022           },
27023           {
27024             "group": "Body",
27025             "type": "String",
27026             "optional": true,
27027             "field": "md5secret",
27028             "description": ""
27029           },
27030           {
27031             "group": "Body",
27032             "type": "String",
27033             "optional": true,
27034             "field": "remotesecret",
27035             "description": ""
27036           },
27037           {
27038             "group": "Body",
27039             "type": "String",
27040             "optional": true,
27041             "field": "transport",
27042             "description": "<p>String is deprecated. Please use an Array as [&quot;udp&quot;, &quot;tcp&quot;]</p>"
27043           },
27044           {
27045             "group": "Body",
27046             "type": "String",
27047             "allowedValues": [
27048               "\"rfc2833\"",
27049               "\"info\"",
27050               "\"shortinfo\"",
27051               "\"inband\"",
27052               "\"auto\""
27053             ],
27054             "optional": true,
27055             "field": "dtmfmode",
27056             "description": ""
27057           },
27058           {
27059             "group": "Body",
27060             "type": "String",
27061             "allowedValues": [
27062               "\"yes\"",
27063               "\"no\"",
27064               "\"nonat\"",
27065               "\"update\"",
27066               "\"outgoing\""
27067             ],
27068             "optional": true,
27069             "field": "directmedia",
27070             "description": ""
27071           },
27072           {
27073             "group": "Body",
27074             "type": "String",
27075             "allowedValues": [
27076               "\"yes\"",
27077               "\"no\""
27078             ],
27079             "optional": true,
27080             "field": "directrtpsetup",
27081             "description": ""
27082           },
27083           {
27084             "group": "Body",
27085             "type": "String",
27086             "optional": true,
27087             "field": "directmediapermit",
27088             "description": ""
27089           },
27090           {
27091             "group": "Body",
27092             "type": "String",
27093             "optional": true,
27094             "field": "directmediadeny",
27095             "description": ""
27096           },
27097           {
27098             "group": "Body",
27099             "type": "String",
27100             "optional": true,
27101             "field": "nat",
27102             "description": "<p>String is deprecated. Please use an Array as [&quot;force_rport&quot;, &quot;comedia&quot;]</p>"
27103           },
27104           {
27105             "group": "Body",
27106             "type": "String",
27107             "optional": true,
27108             "field": "callgroup",
27109             "description": ""
27110           },
27111           {
27112             "group": "Body",
27113             "type": "String",
27114             "optional": true,
27115             "field": "namedcallgroup",
27116             "description": ""
27117           },
27118           {
27119             "group": "Body",
27120             "type": "String",
27121             "optional": true,
27122             "field": "pickupgroup",
27123             "description": ""
27124           },
27125           {
27126             "group": "Body",
27127             "type": "String",
27128             "optional": true,
27129             "field": "namedpickupgroup",
27130             "description": ""
27131           },
27132           {
27133             "group": "Body",
27134             "type": "String",
27135             "optional": true,
27136             "field": "language",
27137             "description": ""
27138           },
27139           {
27140             "group": "Body",
27141             "type": "String",
27142             "optional": true,
27143             "field": "tonezone",
27144             "description": ""
27145           },
27146           {
27147             "group": "Body",
27148             "type": "String",
27149             "optional": true,
27150             "field": "disallow",
27151             "description": ""
27152           },
27153           {
27154             "group": "Body",
27155             "type": "String",
27156             "optional": false,
27157             "field": "allow",
27158             "description": "<p>String is deprecated. Please use an Array as [&quot;ulaw&quot;, &quot;alaw&quot;, &quot;alaw&quot;]</p>"
27159           },
27160           {
27161             "group": "Body",
27162             "type": "String",
27163             "allowedValues": [
27164               "\"yes\"",
27165               "\"no\""
27166             ],
27167             "optional": true,
27168             "field": "autoframing",
27169             "description": ""
27170           },
27171           {
27172             "group": "Body",
27173             "type": "String",
27174             "optional": true,
27175             "field": "insecure",
27176             "description": "<p>String is deprecated. Please use an Array as [&quot;port&quot;, &quot;invite&quot;]</p>"
27177           },
27178           {
27179             "group": "Body",
27180             "type": "String",
27181             "allowedValues": [
27182               "\"yes\"",
27183               "\"no\""
27184             ],
27185             "optional": true,
27186             "field": "trustrpid",
27187             "description": ""
27188           },
27189           {
27190             "group": "Body",
27191             "type": "String",
27192             "allowedValues": [
27193               "\"yes\"",
27194               "\"no\""
27195             ],
27196             "optional": true,
27197             "field": "trust_id_outbound",
27198             "description": ""
27199           },
27200           {
27201             "group": "Body",
27202             "type": "String",
27203             "allowedValues": [
27204               "\"yes\"",
27205               "\"no\"",
27206               "\"never\""
27207             ],
27208             "optional": true,
27209             "field": "progressinband",
27210             "description": ""
27211           },
27212           {
27213             "group": "Body",
27214             "type": "String",
27215             "allowedValues": [
27216               "\"yes\"",
27217               "\"no\""
27218             ],
27219             "optional": true,
27220             "field": "promiscredir",
27221             "description": ""
27222           },
27223           {
27224             "group": "Body",
27225             "type": "String",
27226             "allowedValues": [
27227               "\"yes\"",
27228               "\"no\""
27229             ],
27230             "optional": true,
27231             "field": "useclientcode",
27232             "description": ""
27233           },
27234           {
27235             "group": "Body",
27236             "type": "Integer",
27237             "optional": true,
27238             "field": "accountcode",
27239             "description": ""
27240           },
27241           {
27242             "group": "Body",
27243             "type": "String",
27244             "optional": true,
27245             "field": "setvar",
27246             "description": ""
27247           },
27248           {
27249             "group": "Body",
27250             "type": "String",
27251             "optional": true,
27252             "field": "callerid",
27253             "description": ""
27254           },
27255           {
27256             "group": "Body",
27257             "type": "String",
27258             "optional": true,
27259             "field": "amaflags",
27260             "description": ""
27261           },
27262           {
27263             "group": "Body",
27264             "type": "String",
27265             "allowedValues": [
27266               "\"yes\"",
27267               "\"no\""
27268             ],
27269             "optional": true,
27270             "field": "callcounter",
27271             "description": ""
27272           },
27273           {
27274             "group": "Body",
27275             "type": "Integer",
27276             "optional": true,
27277             "field": "busylevel",
27278             "description": ""
27279           },
27280           {
27281             "group": "Body",
27282             "type": "String",
27283             "allowedValues": [
27284               "\"yes\"",
27285               "\"no\""
27286             ],
27287             "optional": true,
27288             "field": "allowoverlap",
27289             "description": ""
27290           },
27291           {
27292             "group": "Body",
27293             "type": "String",
27294             "allowedValues": [
27295               "\"yes\"",
27296               "\"no\""
27297             ],
27298             "optional": true,
27299             "field": "allowsubscribe",
27300             "description": ""
27301           },
27302           {
27303             "group": "Body",
27304             "type": "String",
27305             "allowedValues": [
27306               "\"yes\"",
27307               "\"no\""
27308             ],
27309             "optional": true,
27310             "field": "allowtransfer",
27311             "description": ""
27312           },
27313           {
27314             "group": "Body",
27315             "type": "String",
27316             "allowedValues": [
27317               "\"yes\"",
27318               "\"no\""
27319             ],
27320             "optional": true,
27321             "field": "ignoresdpversion",
27322             "description": ""
27323           },
27324           {
27325             "group": "Body",
27326             "type": "String",
27327             "optional": true,
27328             "field": "subscribecontext",
27329             "description": ""
27330           },
27331           {
27332             "group": "Body",
27333             "type": "String",
27334             "optional": true,
27335             "field": "template",
27336             "description": ""
27337           },
27338           {
27339             "group": "Body",
27340             "type": "String",
27341             "allowedValues": [
27342               "\"yes\"",
27343               "\"no\"",
27344               "\"always\""
27345             ],
27346             "optional": true,
27347             "field": "videosupport",
27348             "description": ""
27349           },
27350           {
27351             "group": "Body",
27352             "type": "Integer",
27353             "optional": true,
27354             "field": "maxcallbitrate",
27355             "description": ""
27356           },
27357           {
27358             "group": "Body",
27359             "type": "String",
27360             "allowedValues": [
27361               "\"yes\"",
27362               "\"no\""
27363             ],
27364             "optional": true,
27365             "field": "rfc2833compensate",
27366             "description": ""
27367           },
27368           {
27369             "group": "Body",
27370             "type": "String",
27371             "optional": true,
27372             "field": "mailbox",
27373             "description": ""
27374           },
27375           {
27376             "group": "Body",
27377             "type": "String",
27378             "allowedValues": [
27379               "\"accept\"",
27380               "\"refuse\"",
27381               "\"originate\""
27382             ],
27383             "optional": true,
27384             "field": "session_timers",
27385             "description": ""
27386           },
27387           {
27388             "group": "Body",
27389             "type": "Integer",
27390             "optional": true,
27391             "field": "session_expires",
27392             "description": ""
27393           },
27394           {
27395             "group": "Body",
27396             "type": "Integer",
27397             "optional": true,
27398             "field": "session_minse",
27399             "description": ""
27400           },
27401           {
27402             "group": "Body",
27403             "type": "String",
27404             "allowedValues": [
27405               "\"uac\"",
27406               "\"uas\""
27407             ],
27408             "optional": true,
27409             "field": "session_refresher",
27410             "description": ""
27411           },
27412           {
27413             "group": "Body",
27414             "type": "String",
27415             "optional": true,
27416             "field": "t38pt_usertpsource",
27417             "description": ""
27418           },
27419           {
27420             "group": "Body",
27421             "type": "String",
27422             "optional": true,
27423             "field": "regexten",
27424             "description": ""
27425           },
27426           {
27427             "group": "Body",
27428             "type": "String",
27429             "optional": true,
27430             "field": "fromdomain",
27431             "description": ""
27432           },
27433           {
27434             "group": "Body",
27435             "type": "String",
27436             "optional": true,
27437             "field": "fromuser",
27438             "description": ""
27439           },
27440           {
27441             "group": "Body",
27442             "type": "Integer",
27443             "optional": true,
27444             "field": "port",
27445             "description": ""
27446           },
27447           {
27448             "group": "Body",
27449             "type": "String",
27450             "allowedValues": [
27451               "\"yes\"",
27452               "\"no\""
27453             ],
27454             "optional": true,
27455             "field": "qualify",
27456             "description": ""
27457           },
27458           {
27459             "group": "Body",
27460             "type": "Integer",
27461             "optional": true,
27462             "field": "keepalive",
27463             "description": ""
27464           },
27465           {
27466             "group": "Body",
27467             "type": "String",
27468             "optional": true,
27469             "field": "defaultip",
27470             "description": ""
27471           },
27472           {
27473             "group": "Body",
27474             "type": "String",
27475             "optional": true,
27476             "field": "defaultuser",
27477             "description": ""
27478           },
27479           {
27480             "group": "Body",
27481             "type": "Integer",
27482             "optional": true,
27483             "field": "rtptimeout",
27484             "description": ""
27485           },
27486           {
27487             "group": "Body",
27488             "type": "Integer",
27489             "optional": true,
27490             "field": "rtpholdtimeout",
27491             "description": ""
27492           },
27493           {
27494             "group": "Body",
27495             "type": "Integer",
27496             "optional": true,
27497             "field": "rtpkeepalive",
27498             "description": ""
27499           },
27500           {
27501             "group": "Body",
27502             "type": "String",
27503             "allowedValues": [
27504               "\"yes\"",
27505               "\"no\"",
27506               "\"pai\""
27507             ],
27508             "optional": true,
27509             "field": "sendrpid",
27510             "description": ""
27511           },
27512           {
27513             "group": "Body",
27514             "type": "String",
27515             "optional": true,
27516             "field": "outboundproxy",
27517             "description": ""
27518           },
27519           {
27520             "group": "Body",
27521             "type": "String",
27522             "optional": true,
27523             "field": "callbackextension",
27524             "description": ""
27525           },
27526           {
27527             "group": "Body",
27528             "type": "Integer",
27529             "optional": true,
27530             "field": "timert1",
27531             "description": ""
27532           },
27533           {
27534             "group": "Body",
27535             "type": "Integer",
27536             "optional": true,
27537             "field": "timerb",
27538             "description": ""
27539           },
27540           {
27541             "group": "Body",
27542             "type": "Integer",
27543             "optional": true,
27544             "field": "qualifyfreq",
27545             "description": ""
27546           },
27547           {
27548             "group": "Body",
27549             "type": "String",
27550             "optional": true,
27551             "field": "contactpermit",
27552             "description": ""
27553           },
27554           {
27555             "group": "Body",
27556             "type": "String",
27557             "optional": true,
27558             "field": "contactdeny",
27559             "description": ""
27560           },
27561           {
27562             "group": "Body",
27563             "type": "String",
27564             "optional": true,
27565             "field": "contactacl",
27566             "description": ""
27567           },
27568           {
27569             "group": "Body",
27570             "type": "String",
27571             "optional": true,
27572             "field": "unsolicited_mailbox",
27573             "description": ""
27574           },
27575           {
27576             "group": "Body",
27577             "type": "String",
27578             "optional": true,
27579             "field": "use_q850_reason",
27580             "description": ""
27581           },
27582           {
27583             "group": "Body",
27584             "type": "Integer",
27585             "optional": true,
27586             "field": "maxforwards",
27587             "description": ""
27588           },
27589           {
27590             "group": "Body",
27591             "type": "String",
27592             "allowedValues": [
27593               "\"yes\"",
27594               "\"no\""
27595             ],
27596             "optional": true,
27597             "field": "encryption",
27598             "description": ""
27599           },
27600           {
27601             "group": "Body",
27602             "type": "String",
27603             "allowedValues": [
27604               "\"yes\"",
27605               "\"no\""
27606             ],
27607             "optional": true,
27608             "field": "avpf",
27609             "description": ""
27610           },
27611           {
27612             "group": "Body",
27613             "type": "String",
27614             "allowedValues": [
27615               "\"yes\"",
27616               "\"no\""
27617             ],
27618             "optional": true,
27619             "field": "force_avp",
27620             "description": ""
27621           },
27622           {
27623             "group": "Body",
27624             "type": "String",
27625             "allowedValues": [
27626               "\"yes\"",
27627               "\"no\""
27628             ],
27629             "optional": true,
27630             "field": "icesupport",
27631             "description": ""
27632           },
27633           {
27634             "group": "Body",
27635             "type": "String",
27636             "allowedValues": [
27637               "\"yes\"",
27638               "\"no\""
27639             ],
27640             "optional": true,
27641             "field": "dtlsenable",
27642             "description": ""
27643           },
27644           {
27645             "group": "Body",
27646             "type": "String",
27647             "allowedValues": [
27648               "\"yes\"",
27649               "\"no\"",
27650               "\"fingerprint\"",
27651               "\"certificate\""
27652             ],
27653             "optional": true,
27654             "field": "dtlsverify",
27655             "description": ""
27656           },
27657           {
27658             "group": "Body",
27659             "type": "Integer",
27660             "optional": true,
27661             "field": "dtlsrekey",
27662             "description": ""
27663           },
27664           {
27665             "group": "Body",
27666             "type": "String",
27667             "optional": true,
27668             "field": "dtlscertfile",
27669             "description": ""
27670           },
27671           {
27672             "group": "Body",
27673             "type": "String",
27674             "optional": true,
27675             "field": "dtlsprivatekey",
27676             "description": ""
27677           },
27678           {
27679             "group": "Body",
27680             "type": "String",
27681             "optional": true,
27682             "field": "dtlscipher",
27683             "description": ""
27684           },
27685           {
27686             "group": "Body",
27687             "type": "String",
27688             "optional": true,
27689             "field": "dtlscafile",
27690             "description": ""
27691           },
27692           {
27693             "group": "Body",
27694             "type": "String",
27695             "optional": true,
27696             "field": "dtlscapath",
27697             "description": ""
27698           },
27699           {
27700             "group": "Body",
27701             "type": "String",
27702             "allowedValues": [
27703               "\"active\"",
27704               "\"passive\"",
27705               "\"actpass\""
27706             ],
27707             "optional": true,
27708             "field": "dtlssetup",
27709             "description": ""
27710           },
27711           {
27712             "group": "Body",
27713             "type": "String",
27714             "optional": true,
27715             "field": "dtlsfingerprint",
27716             "description": ""
27717           },
27718           {
27719             "group": "Body",
27720             "type": "String",
27721             "allowedValues": [
27722               "\"yes\"",
27723               "\"no\""
27724             ],
27725             "optional": true,
27726             "field": "usereqphone",
27727             "description": ""
27728           },
27729           {
27730             "group": "Body",
27731             "type": "String",
27732             "optional": true,
27733             "field": "recordonfeature",
27734             "description": ""
27735           },
27736           {
27737             "group": "Body",
27738             "type": "String",
27739             "optional": true,
27740             "field": "recordofffeature",
27741             "description": ""
27742           },
27743           {
27744             "group": "Body",
27745             "type": "Integer",
27746             "optional": true,
27747             "field": "call_limit",
27748             "description": ""
27749           },
27750           {
27751             "group": "Body",
27752             "type": "String",
27753             "allowedValues": [
27754               "\"yes\"",
27755               "\"no\""
27756             ],
27757             "optional": true,
27758             "field": "registertrying",
27759             "description": ""
27760           },
27761           {
27762             "group": "Body",
27763             "type": "String",
27764             "allowedValues": [
27765               "\"yes\"",
27766               "\"no\""
27767             ],
27768             "optional": true,
27769             "field": "subscribemwi",
27770             "description": ""
27771           },
27772           {
27773             "group": "Body",
27774             "type": "String",
27775             "optional": true,
27776             "field": "vmexten",
27777             "description": ""
27778           },
27779           {
27780             "group": "Body",
27781             "type": "String",
27782             "optional": true,
27783             "field": "mohinterpret",
27784             "description": ""
27785           },
27786           {
27787             "group": "Body",
27788             "type": "String",
27789             "optional": true,
27790             "field": "mohsuggest",
27791             "description": ""
27792           },
27793           {
27794             "group": "Body",
27795             "type": "String",
27796             "optional": true,
27797             "field": "parkinglot",
27798             "description": ""
27799           },
27800           {
27801             "group": "Body",
27802             "type": "String",
27803             "optional": true,
27804             "field": "description",
27805             "description": ""
27806           },
27807           {
27808             "group": "Body",
27809             "type": "String",
27810             "optional": true,
27811             "field": "host",
27812             "description": ""
27813           },
27814           {
27815             "group": "Body",
27816             "type": "String",
27817             "allowedValues": [
27818               "\"yes\"",
27819               "\"no\"",
27820               "\"nonat\"",
27821               "\"update\"",
27822               "\"update,nonat\""
27823             ],
27824             "optional": true,
27825             "field": "canreinvite",
27826             "description": ""
27827           },
27828           {
27829             "group": "Body",
27830             "type": "String",
27831             "optional": true,
27832             "field": "registry",
27833             "description": ""
27834           },
27835           {
27836             "group": "Body",
27837             "type": "String",
27838             "optional": true,
27839             "field": "otherFields",
27840             "description": ""
27841           },
27842           {
27843             "group": "Body",
27844             "type": "Boolean",
27845             "optional": false,
27846             "field": "active",
27847             "description": ""
27848           },
27849           {
27850             "group": "Body",
27851             "type": "String",
27852             "optional": true,
27853             "field": "t38pt_udptl",
27854             "description": ""
27855           }
27856         ]
27857       }
27858     },
27859     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27860     "version": "0.0.0",
27861     "filename": "server/api/trunk/index.js",
27862     "groupTitle": "Trunks"
27863   },
27864   {
27865     "type": "delete",
27866     "url": "/api/trunks/{id}",
27867     "title": "Deletes a trunk",
27868     "examples": [
27869       {
27870         "title": "Example usage:",
27871         "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X DELETE",
27872         "type": "json"
27873       }
27874     ],
27875     "name": "Delete",
27876     "group": "Trunks",
27877     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27878     "version": "0.0.0",
27879     "filename": "server/api/trunk/index.js",
27880     "groupTitle": "Trunks"
27881   },
27882   {
27883     "type": "get",
27884     "url": "/api/trunks",
27885     "title": "Gets a list of Trunks",
27886     "examples": [
27887       {
27888         "title": "Example usage:",
27889         "content": "curl https://{domain}/api/trunks -v -u {name}:{password}",
27890         "type": "json"
27891       }
27892     ],
27893     "name": "GetTrunks",
27894     "group": "Trunks",
27895     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
27896     "version": "0.0.0",
27897     "filename": "server/api/trunk/index.js",
27898     "groupTitle": "Trunks"
27899   },
27900   {
27901     "type": "get",
27902     "url": "/api/trunks/{id}",
27903     "title": "Gets a single Trunk",
27904     "examples": [
27905       {
27906         "title": "Example usage:",
27907         "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password}",
27908         "type": "json"
27909       }
27910     ],
27911     "name": "ShowTrunks",
27912     "group": "Trunks",
27913     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27914     "version": "0.0.0",
27915     "filename": "server/api/trunk/index.js",
27916     "groupTitle": "Trunks"
27917   },
27918   {
27919     "type": "put",
27920     "url": "/api/trunks/{id}",
27921     "title": "Update an existing trunk",
27922     "examples": [
27923       {
27924         "title": "Example usage:",
27925         "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X PUT",
27926         "type": "json"
27927       }
27928     ],
27929     "name": "Update",
27930     "group": "Trunks",
27931     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27932     "version": "0.0.0",
27933     "filename": "server/api/trunk/index.js",
27934     "groupTitle": "Trunks"
27935   },
27936   {
27937     "type": "post",
27938     "url": "/api/userNotifications",
27939     "title": "Send notification to user",
27940     "examples": [
27941       {
27942         "title": "Example usage:",
27943         "content": "curl https://{domain}/api/userNotifications -d '{\"text\": \"Hello!\", \"TemplateId\": 1}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
27944         "type": "json"
27945       }
27946     ],
27947     "name": "Send",
27948     "group": "UserNotifications",
27949     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27950     "version": "0.0.0",
27951     "filename": "server/api/userNotification/index.js",
27952     "groupTitle": "UserNotifications"
27953   },
27954   {
27955     "type": "post",
27956     "url": "/api/userProfile/resources",
27957     "title": "Creates a new User Profile Resource",
27958     "examples": [
27959       {
27960         "title": "Example usage:",
27961         "content": "curl https://{domain}/api/userProfile/resources -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27962         "type": "json"
27963       }
27964     ],
27965     "name": "CreateUser_Profile_Resources",
27966     "group": "User_Profile_Resources",
27967     "parameter": {
27968       "fields": {
27969         "Body": [
27970           {
27971             "group": "Body",
27972             "type": "String",
27973             "optional": false,
27974             "field": "name",
27975             "description": ""
27976           },
27977           {
27978             "group": "Body",
27979             "type": "Integer",
27980             "optional": false,
27981             "field": "resourceId",
27982             "description": ""
27983           },
27984           {
27985             "group": "Body",
27986             "type": "String",
27987             "optional": false,
27988             "field": "type",
27989             "description": ""
27990           }
27991         ]
27992       }
27993     },
27994     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27995     "version": "0.0.0",
27996     "filename": "server/api/userProfileResource/index.js",
27997     "groupTitle": "User_Profile_Resources"
27998   },
27999   {
28000     "type": "delete",
28001     "url": "/api/userProfile/resources/{id}",
28002     "title": "Deletes a User Profile Resource",
28003     "examples": [
28004       {
28005         "title": "Example usage:",
28006         "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password} -X DELETE",
28007         "type": "json"
28008       }
28009     ],
28010     "name": "DeleteUser_Profile_Resources",
28011     "group": "User_Profile_Resources",
28012     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28013     "version": "0.0.0",
28014     "filename": "server/api/userProfileResource/index.js",
28015     "groupTitle": "User_Profile_Resources"
28016   },
28017   {
28018     "type": "get",
28019     "url": "/api/userProfile/resources/describe",
28020     "title": "Gets table info about User Profile Resources",
28021     "examples": [
28022       {
28023         "title": "Example usage:",
28024         "content": "curl https://{domain}/api/userProfile/resources/describe -v -u {name}:{password}",
28025         "type": "json"
28026       }
28027     ],
28028     "name": "DescribeUser_Profile_Resources",
28029     "group": "User_Profile_Resources",
28030     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28031     "version": "0.0.0",
28032     "filename": "server/api/userProfileResource/index.js",
28033     "groupTitle": "User_Profile_Resources"
28034   },
28035   {
28036     "type": "get",
28037     "url": "/api/userProfile/resources",
28038     "title": "Gets a list of User Profile Resources",
28039     "examples": [
28040       {
28041         "title": "Example usage:",
28042         "content": "curl https://{domain}/api/userProfile/resources -v -u {name}:{password}",
28043         "type": "json"
28044       }
28045     ],
28046     "name": "GetUser_Profile_Resources",
28047     "group": "User_Profile_Resources",
28048     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
28049     "version": "0.0.0",
28050     "filename": "server/api/userProfileResource/index.js",
28051     "groupTitle": "User_Profile_Resources"
28052   },
28053   {
28054     "type": "get",
28055     "url": "/api/userProfile/resources/{id}",
28056     "title": "Gets a single User Profile Resource",
28057     "examples": [
28058       {
28059         "title": "Example usage:",
28060         "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password}",
28061         "type": "json"
28062       }
28063     ],
28064     "name": "ShowUser_Profile_Resources",
28065     "group": "User_Profile_Resources",
28066     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28067     "version": "0.0.0",
28068     "filename": "server/api/userProfileResource/index.js",
28069     "groupTitle": "User_Profile_Resources"
28070   },
28071   {
28072     "type": "put",
28073     "url": "/api/userProfile/resources/{id}",
28074     "title": "Update an existing User Profile Resource",
28075     "examples": [
28076       {
28077         "title": "Example usage:",
28078         "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",
28079         "type": "json"
28080       }
28081     ],
28082     "name": "updateUser_Profile_Resources",
28083     "group": "User_Profile_Resources",
28084     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28085     "version": "0.0.0",
28086     "filename": "server/api/userProfileResource/index.js",
28087     "groupTitle": "User_Profile_Resources"
28088   },
28089   {
28090     "type": "post",
28091     "url": "/api/userProfile/sections",
28092     "title": "Creates a new User Profile Section",
28093     "examples": [
28094       {
28095         "title": "Example usage:",
28096         "content": "curl https://{domain}/api/userProfile/sections -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28097         "type": "json"
28098       }
28099     ],
28100     "name": "CreateUser_Profile_Sections",
28101     "group": "User_Profile_Sections",
28102     "parameter": {
28103       "fields": {
28104         "Body": [
28105           {
28106             "group": "Body",
28107             "type": "String",
28108             "optional": false,
28109             "field": "name",
28110             "description": ""
28111           },
28112           {
28113             "group": "Body",
28114             "type": "String",
28115             "optional": false,
28116             "field": "category",
28117             "description": ""
28118           },
28119           {
28120             "group": "Body",
28121             "type": "Integer",
28122             "optional": false,
28123             "field": "sectionId",
28124             "description": ""
28125           },
28126           {
28127             "group": "Body",
28128             "type": "Boolean",
28129             "optional": true,
28130             "field": "enabled",
28131             "description": ""
28132           },
28133           {
28134             "group": "Body",
28135             "type": "Boolean",
28136             "optional": true,
28137             "field": "autoAssociation",
28138             "description": ""
28139           },
28140           {
28141             "group": "Body",
28142             "type": "String",
28143             "optional": true,
28144             "field": "crudPermissions",
28145             "description": ""
28146           }
28147         ]
28148       }
28149     },
28150     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28151     "version": "0.0.0",
28152     "filename": "server/api/userProfileSection/index.js",
28153     "groupTitle": "User_Profile_Sections"
28154   },
28155   {
28156     "type": "delete",
28157     "url": "/api/userProfile/sections/{id}",
28158     "title": "Deletes a User Profile Section",
28159     "examples": [
28160       {
28161         "title": "Example usage:",
28162         "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password} -X DELETE",
28163         "type": "json"
28164       }
28165     ],
28166     "name": "DeleteUser_Profile_Sections",
28167     "group": "User_Profile_Sections",
28168     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28169     "version": "0.0.0",
28170     "filename": "server/api/userProfileSection/index.js",
28171     "groupTitle": "User_Profile_Sections"
28172   },
28173   {
28174     "type": "get",
28175     "url": "/api/userProfile/sections/describe",
28176     "title": "Gets table info about User Profile Sections",
28177     "examples": [
28178       {
28179         "title": "Example usage:",
28180         "content": "curl https://{domain}/api/userProfile/sections/describe -v -u {name}:{password}",
28181         "type": "json"
28182       }
28183     ],
28184     "name": "DescribeUser_Profile_Sections",
28185     "group": "User_Profile_Sections",
28186     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28187     "version": "0.0.0",
28188     "filename": "server/api/userProfileSection/index.js",
28189     "groupTitle": "User_Profile_Sections"
28190   },
28191   {
28192     "type": "get",
28193     "url": "/api/userProfile/sections",
28194     "title": "Gets a list of User Profile Sections",
28195     "examples": [
28196       {
28197         "title": "Example usage:",
28198         "content": "curl https://{domain}/api/userProfile/sections -v -u {name}:{password}",
28199         "type": "json"
28200       }
28201     ],
28202     "name": "GetUser_Profile_Sections",
28203     "group": "User_Profile_Sections",
28204     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
28205     "version": "0.0.0",
28206     "filename": "server/api/userProfileSection/index.js",
28207     "groupTitle": "User_Profile_Sections"
28208   },
28209   {
28210     "type": "get",
28211     "url": "/api/userProfile/sections/{id}",
28212     "title": "Gets a single User Profile Section",
28213     "examples": [
28214       {
28215         "title": "Example usage:",
28216         "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password}",
28217         "type": "json"
28218       }
28219     ],
28220     "name": "ShowUser_Profile_Sections",
28221     "group": "User_Profile_Sections",
28222     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28223     "version": "0.0.0",
28224     "filename": "server/api/userProfileSection/index.js",
28225     "groupTitle": "User_Profile_Sections"
28226   },
28227   {
28228     "type": "put",
28229     "url": "/api/userProfile/sections/{id}",
28230     "title": "Update an existing User Profile Section",
28231     "examples": [
28232       {
28233         "title": "Example usage:",
28234         "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",
28235         "type": "json"
28236       }
28237     ],
28238     "name": "updateUser_Profile_Sections",
28239     "group": "User_Profile_Sections",
28240     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28241     "version": "0.0.0",
28242     "filename": "server/api/userProfileSection/index.js",
28243     "groupTitle": "User_Profile_Sections"
28244   },
28245   {
28246     "type": "post",
28247     "url": "/api/userProfiles/{id}/resources",
28248     "title": "Add resources' permissions to User Profile",
28249     "examples": [
28250       {
28251         "title": "Example usage:",
28252         "content": "curl https://{domain}/api/userProfiles/{id}/resources -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28253         "type": "json"
28254       }
28255     ],
28256     "name": "AddResources",
28257     "group": "User_Profiles",
28258     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28259     "version": "0.0.0",
28260     "filename": "server/api/userProfile/index.js",
28261     "groupTitle": "User_Profiles"
28262   },
28263   {
28264     "type": "post",
28265     "url": "/api/userProfiles/{id}/sections",
28266     "title": "Add sections' permissions to User Profile",
28267     "examples": [
28268       {
28269         "title": "Example usage:",
28270         "content": "curl https://{domain}/api/userProfiles/{id}/sections -d '[{\"sectionId\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28271         "type": "json"
28272       }
28273     ],
28274     "name": "AddSections",
28275     "group": "User_Profiles",
28276     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28277     "version": "0.0.0",
28278     "filename": "server/api/userProfile/index.js",
28279     "groupTitle": "User_Profiles"
28280   },
28281   {
28282     "type": "post",
28283     "url": "/api/userProfiles/clone",
28284     "title": "Clone an existing User Profile",
28285     "examples": [
28286       {
28287         "title": "Example usage:",
28288         "content": "curl https://{domain}/api/userProfiles/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28289         "type": "json"
28290       }
28291     ],
28292     "name": "CloneUser_Profiles",
28293     "group": "User_Profiles",
28294     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28295     "version": "0.0.0",
28296     "filename": "server/api/userProfile/index.js",
28297     "groupTitle": "User_Profiles"
28298   },
28299   {
28300     "type": "post",
28301     "url": "/api/userProfiles",
28302     "title": "Creates a new User Profile",
28303     "examples": [
28304       {
28305         "title": "Example usage:",
28306         "content": "curl https://{domain}/api/userProfiles -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28307         "type": "json"
28308       }
28309     ],
28310     "name": "CreateUser_Profiles",
28311     "group": "User_Profiles",
28312     "parameter": {
28313       "fields": {
28314         "Body": [
28315           {
28316             "group": "Body",
28317             "type": "String",
28318             "optional": false,
28319             "field": "name",
28320             "description": ""
28321           },
28322           {
28323             "group": "Body",
28324             "type": "String",
28325             "optional": false,
28326             "field": "crudPermissions",
28327             "description": ""
28328           },
28329           {
28330             "group": "Body",
28331             "type": "String",
28332             "optional": true,
28333             "field": "description",
28334             "description": ""
28335           },
28336           {
28337             "group": "Body",
28338             "type": "Boolean",
28339             "optional": true,
28340             "field": "privacyEnabled",
28341             "description": ""
28342           },
28343           {
28344             "group": "Body",
28345             "type": "Boolean",
28346             "optional": true,
28347             "field": "downloadAttachments",
28348             "description": ""
28349           },
28350           {
28351             "group": "Body",
28352             "type": "Boolean",
28353             "optional": true,
28354             "field": "downloadCallySquareRecordings",
28355             "description": ""
28356           },
28357           {
28358             "group": "Body",
28359             "type": "Boolean",
28360             "optional": true,
28361             "field": "downloadContactManagerLists",
28362             "description": ""
28363           },
28364           {
28365             "group": "Body",
28366             "type": "Boolean",
28367             "optional": true,
28368             "field": "downloadJscriptySessions",
28369             "description": ""
28370           },
28371           {
28372             "group": "Body",
28373             "type": "Boolean",
28374             "optional": true,
28375             "field": "downloadOmnichannelInteractions",
28376             "description": ""
28377           },
28378           {
28379             "group": "Body",
28380             "type": "Boolean",
28381             "optional": true,
28382             "field": "downloadScreenRecordings",
28383             "description": ""
28384           },
28385           {
28386             "group": "Body",
28387             "type": "Boolean",
28388             "optional": true,
28389             "field": "downloadVoiceRecordings",
28390             "description": ""
28391           }
28392         ]
28393       }
28394     },
28395     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28396     "version": "0.0.0",
28397     "filename": "server/api/userProfile/index.js",
28398     "groupTitle": "User_Profiles"
28399   },
28400   {
28401     "type": "delete",
28402     "url": "/api/userProfiles/{id}",
28403     "title": "Deletes a User Profile",
28404     "examples": [
28405       {
28406         "title": "Example usage:",
28407         "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password} -X DELETE",
28408         "type": "json"
28409       }
28410     ],
28411     "name": "DeleteUser_Profiles",
28412     "group": "User_Profiles",
28413     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28414     "version": "0.0.0",
28415     "filename": "server/api/userProfile/index.js",
28416     "groupTitle": "User_Profiles"
28417   },
28418   {
28419     "type": "get",
28420     "url": "/api/userProfiles/describe",
28421     "title": "Gets table info about User Profiles",
28422     "examples": [
28423       {
28424         "title": "Example usage:",
28425         "content": "curl https://{domain}/api/userProfiles/describe -v -u {name}:{password}",
28426         "type": "json"
28427       }
28428     ],
28429     "name": "DescribeUser_Profiles",
28430     "group": "User_Profiles",
28431     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28432     "version": "0.0.0",
28433     "filename": "server/api/userProfile/index.js",
28434     "groupTitle": "User_Profiles"
28435   },
28436   {
28437     "type": "get",
28438     "url": "/api/userProfiles/{id}/resources?section={section}",
28439     "title": "Get Resources assigned to a Section",
28440     "examples": [
28441       {
28442         "title": "Example usage:",
28443         "content": "curl https://{domain}/api/userProfiles/{id}/resources?section={section} -v -u {name}:{password} -X GET",
28444         "type": "json"
28445       }
28446     ],
28447     "name": "GetResources",
28448     "group": "User_Profiles",
28449     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28450     "version": "0.0.0",
28451     "filename": "server/api/userProfile/index.js",
28452     "groupTitle": "User_Profiles"
28453   },
28454   {
28455     "type": "get",
28456     "url": "/api/userProfiles/{id}/sections",
28457     "title": "Get sections associated to a User Profile",
28458     "examples": [
28459       {
28460         "title": "Example usage:",
28461         "content": "curl https://{domain}/api/userProfiles/{id}/sections -v -u {name}:{password} -X GET",
28462         "type": "json"
28463       }
28464     ],
28465     "name": "GetSections",
28466     "group": "User_Profiles",
28467     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28468     "version": "0.0.0",
28469     "filename": "server/api/userProfile/index.js",
28470     "groupTitle": "User_Profiles"
28471   },
28472   {
28473     "type": "get",
28474     "url": "/api/userProfiles",
28475     "title": "Gets a list of User Profiles",
28476     "examples": [
28477       {
28478         "title": "Example usage:",
28479         "content": "curl https://{domain}/api/userProfiles -v -u {name}:{password}",
28480         "type": "json"
28481       }
28482     ],
28483     "name": "GetUser_Profiles",
28484     "group": "User_Profiles",
28485     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
28486     "version": "0.0.0",
28487     "filename": "server/api/userProfile/index.js",
28488     "groupTitle": "User_Profiles"
28489   },
28490   {
28491     "type": "delete",
28492     "url": "/api/userProfiles/{id}/resources",
28493     "title": "Removes resources' permissions from User Profile",
28494     "examples": [
28495       {
28496         "title": "Example usage:",
28497         "content": "curl https://{domain}/api/userProfiles/{id}/resources?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
28498         "type": "json"
28499       }
28500     ],
28501     "name": "RemoveResources",
28502     "group": "User_Profiles",
28503     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28504     "version": "0.0.0",
28505     "filename": "server/api/userProfile/index.js",
28506     "groupTitle": "User_Profiles"
28507   },
28508   {
28509     "type": "delete",
28510     "url": "/api/userProfiles/{id}/sections",
28511     "title": "Removes sections' permissions from User Profile",
28512     "examples": [
28513       {
28514         "title": "Example usage:",
28515         "content": "curl https://{domain}/api/userProfiles/{id}/sections?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
28516         "type": "json"
28517       }
28518     ],
28519     "name": "RemoveSections",
28520     "group": "User_Profiles",
28521     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28522     "version": "0.0.0",
28523     "filename": "server/api/userProfile/index.js",
28524     "groupTitle": "User_Profiles"
28525   },
28526   {
28527     "type": "get",
28528     "url": "/api/userProfiles/{id}",
28529     "title": "Gets a single User Profile",
28530     "examples": [
28531       {
28532         "title": "Example usage:",
28533         "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password}",
28534         "type": "json"
28535       }
28536     ],
28537     "name": "ShowUser_Profiles",
28538     "group": "User_Profiles",
28539     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28540     "version": "0.0.0",
28541     "filename": "server/api/userProfile/index.js",
28542     "groupTitle": "User_Profiles"
28543   },
28544   {
28545     "type": "put",
28546     "url": "/api/userProfiles/{id}",
28547     "title": "Update an existing User Profile",
28548     "examples": [
28549       {
28550         "title": "Example usage:",
28551         "content": "curl https://{domain}/api/userProfiles/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
28552         "type": "json"
28553       }
28554     ],
28555     "name": "updateUser_Profiles",
28556     "group": "User_Profiles",
28557     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28558     "version": "0.0.0",
28559     "filename": "server/api/userProfile/index.js",
28560     "groupTitle": "User_Profiles"
28561   },
28562   {
28563     "type": "post",
28564     "url": "/api/users/{id}/chat_interactions",
28565     "title": "Add chat interaction tabs to an agent",
28566     "examples": [
28567       {
28568         "title": "Example usage:",
28569         "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",
28570         "type": "json"
28571       }
28572     ],
28573     "name": "AddChatInteractions",
28574     "group": "Users",
28575     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28576     "version": "0.0.0",
28577     "filename": "server/api/user/index.js",
28578     "groupTitle": "Users"
28579   },
28580   {
28581     "type": "post",
28582     "url": "/api/users/{id}/chat_websites",
28583     "title": "Add a Chat Website to a user",
28584     "examples": [
28585       {
28586         "title": "Example usage:",
28587         "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",
28588         "type": "json"
28589       }
28590     ],
28591     "name": "AddChatWebsites",
28592     "group": "Users",
28593     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28594     "version": "0.0.0",
28595     "filename": "server/api/user/index.js",
28596     "groupTitle": "Users"
28597   },
28598   {
28599     "type": "post",
28600     "url": "/api/users/{id}/contacts",
28601     "title": "Add contacts to a user",
28602     "examples": [
28603       {
28604         "title": "Example usage:",
28605         "content": "curl https://{domain}/api/users/{id}/contacts -d '{\"ids\": [1,2]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28606         "type": "json"
28607       }
28608     ],
28609     "name": "AddContacts",
28610     "group": "Users",
28611     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28612     "version": "0.0.0",
28613     "filename": "server/api/user/index.js",
28614     "groupTitle": "Users"
28615   },
28616   {
28617     "type": "post",
28618     "url": "/api/users/{id}/fax_accounts",
28619     "title": "Add a Fax Account to a user",
28620     "examples": [
28621       {
28622         "title": "Example usage:",
28623         "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",
28624         "type": "json"
28625       }
28626     ],
28627     "name": "AddFaxAccounts",
28628     "group": "Users",
28629     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28630     "version": "0.0.0",
28631     "filename": "server/api/user/index.js",
28632     "groupTitle": "Users"
28633   },
28634   {
28635     "type": "post",
28636     "url": "/api/users/{id}/fax_interactions",
28637     "title": "Add fax interaction tabs to an agent",
28638     "examples": [
28639       {
28640         "title": "Example usage:",
28641         "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",
28642         "type": "json"
28643       }
28644     ],
28645     "name": "AddFaxInteractions",
28646     "group": "Users",
28647     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28648     "version": "0.0.0",
28649     "filename": "server/api/user/index.js",
28650     "groupTitle": "Users"
28651   },
28652   {
28653     "type": "post",
28654     "url": "/api/users/{id}/mail_accounts",
28655     "title": "Add a Mail Account to a user",
28656     "examples": [
28657       {
28658         "title": "Example usage:",
28659         "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",
28660         "type": "json"
28661       }
28662     ],
28663     "name": "AddMailAccounts",
28664     "group": "Users",
28665     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28666     "version": "0.0.0",
28667     "filename": "server/api/user/index.js",
28668     "groupTitle": "Users"
28669   },
28670   {
28671     "type": "post",
28672     "url": "/api/users/{id}/mail_interactions",
28673     "title": "Add mail interaction tabs to an agent",
28674     "examples": [
28675       {
28676         "title": "Example usage:",
28677         "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",
28678         "type": "json"
28679       }
28680     ],
28681     "name": "AddMailInteractions",
28682     "group": "Users",
28683     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28684     "version": "0.0.0",
28685     "filename": "server/api/user/index.js",
28686     "groupTitle": "Users"
28687   },
28688   {
28689     "type": "post",
28690     "url": "/api/users/{id}/openchannel_accounts",
28691     "title": "Add a Open Channel Account to a user",
28692     "examples": [
28693       {
28694         "title": "Example usage:",
28695         "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",
28696         "type": "json"
28697       }
28698     ],
28699     "name": "AddOpenchannelAccounts",
28700     "group": "Users",
28701     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28702     "version": "0.0.0",
28703     "filename": "server/api/user/index.js",
28704     "groupTitle": "Users"
28705   },
28706   {
28707     "type": "post",
28708     "url": "/api/users/{id}/openchannel_interactions",
28709     "title": "Add openchannel interaction tabs to an agent",
28710     "examples": [
28711       {
28712         "title": "Example usage:",
28713         "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",
28714         "type": "json"
28715       }
28716     ],
28717     "name": "AddOpenchannelInteractions",
28718     "group": "Users",
28719     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28720     "version": "0.0.0",
28721     "filename": "server/api/user/index.js",
28722     "groupTitle": "Users"
28723   },
28724   {
28725     "type": "post",
28726     "url": "/api/users/{id}/queues",
28727     "title": "Add queues to an agent",
28728     "examples": [
28729       {
28730         "title": "Example usage:",
28731         "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",
28732         "type": "json"
28733       }
28734     ],
28735     "name": "AddQueues",
28736     "group": "Users",
28737     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28738     "version": "0.0.0",
28739     "filename": "server/api/user/index.js",
28740     "groupTitle": "Users"
28741   },
28742   {
28743     "type": "post",
28744     "url": "/api/users/{id}/sms_accounts",
28745     "title": "Add a Sms Account to a user",
28746     "examples": [
28747       {
28748         "title": "Example usage:",
28749         "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",
28750         "type": "json"
28751       }
28752     ],
28753     "name": "AddSmsAccounts",
28754     "group": "Users",
28755     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28756     "version": "0.0.0",
28757     "filename": "server/api/user/index.js",
28758     "groupTitle": "Users"
28759   },
28760   {
28761     "type": "post",
28762     "url": "/api/users/{id}/sms_interactions",
28763     "title": "Add sms interaction tabs to an agent",
28764     "examples": [
28765       {
28766         "title": "Example usage:",
28767         "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",
28768         "type": "json"
28769       }
28770     ],
28771     "name": "AddSmsInteractions",
28772     "group": "Users",
28773     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28774     "version": "0.0.0",
28775     "filename": "server/api/user/index.js",
28776     "groupTitle": "Users"
28777   },
28778   {
28779     "type": "post",
28780     "url": "/api/users/{id}/square_projects",
28781     "title": "Add a Square Project to a user",
28782     "examples": [
28783       {
28784         "title": "Example usage:",
28785         "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",
28786         "type": "json"
28787       }
28788     ],
28789     "name": "AddSquareProjects",
28790     "group": "Users",
28791     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28792     "version": "0.0.0",
28793     "filename": "server/api/user/index.js",
28794     "groupTitle": "Users"
28795   },
28796   {
28797     "type": "post",
28798     "url": "/api/users/{id}/teams",
28799     "title": "Add teams to an agent",
28800     "examples": [
28801       {
28802         "title": "Example usage:",
28803         "content": "curl https://{domain}/api/users/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28804         "type": "json"
28805       }
28806     ],
28807     "name": "AddTeams",
28808     "group": "Users",
28809     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28810     "version": "0.0.0",
28811     "filename": "server/api/user/index.js",
28812     "groupTitle": "Users"
28813   },
28814   {
28815     "type": "post",
28816     "url": "/api/users/{id}/whatsapp_accounts",
28817     "title": "Add a Whatsapp Account to a user",
28818     "examples": [
28819       {
28820         "title": "Example usage:",
28821         "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",
28822         "type": "json"
28823       }
28824     ],
28825     "name": "AddWhatsappAccounts",
28826     "group": "Users",
28827     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28828     "version": "0.0.0",
28829     "filename": "server/api/user/index.js",
28830     "groupTitle": "Users"
28831   },
28832   {
28833     "type": "post",
28834     "url": "/api/users/{id}/whatsapp_interactions",
28835     "title": "Add Whatsapp interaction tabs to an agent",
28836     "examples": [
28837       {
28838         "title": "Example usage:",
28839         "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",
28840         "type": "json"
28841       }
28842     ],
28843     "name": "AddWhatsappInteractions",
28844     "group": "Users",
28845     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28846     "version": "0.0.0",
28847     "filename": "server/api/user/index.js",
28848     "groupTitle": "Users"
28849   },
28850   {
28851     "type": "put",
28852     "url": "/api/users/{id}/password",
28853     "title": "Change user password",
28854     "examples": [
28855       {
28856         "title": "Example usage:",
28857         "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",
28858         "type": "json"
28859       }
28860     ],
28861     "name": "ChangePwd",
28862     "group": "Users",
28863     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28864     "version": "0.0.0",
28865     "filename": "server/api/user/index.js",
28866     "groupTitle": "Users"
28867   },
28868   {
28869     "type": "post",
28870     "url": "/api/users",
28871     "title": "Create a new user",
28872     "examples": [
28873       {
28874         "title": "Example usage:",
28875         "content": "curl https://{domain}/api/users -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28876         "type": "json"
28877       }
28878     ],
28879     "name": "Create",
28880     "group": "Users",
28881     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28882     "version": "0.0.0",
28883     "filename": "server/api/user/index.js",
28884     "groupTitle": "Users"
28885   },
28886   {
28887     "type": "post",
28888     "url": "/api/users/{id}/api_key",
28889     "title": "Create a new API access key for the user",
28890     "examples": [
28891       {
28892         "title": "Example usage:",
28893         "content": "curl https://{domain}/api/users/:id/api_key -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28894         "type": "json"
28895       }
28896     ],
28897     "name": "CreateApiKey",
28898     "group": "Users",
28899     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28900     "version": "0.0.0",
28901     "filename": "server/api/user/index.js",
28902     "groupTitle": "Users"
28903   },
28904   {
28905     "type": "delete",
28906     "url": "/api/users/{id}",
28907     "title": "Deletes a user",
28908     "examples": [
28909       {
28910         "title": "Example usage:",
28911         "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password} -X DELETE",
28912         "type": "json"
28913       }
28914     ],
28915     "name": "Delete",
28916     "group": "Users",
28917     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28918     "version": "0.0.0",
28919     "filename": "server/api/user/index.js",
28920     "groupTitle": "Users"
28921   },
28922   {
28923     "type": "get",
28924     "url": "/api/users/describe",
28925     "title": "Gets table info about Users",
28926     "examples": [
28927       {
28928         "title": "Example usage:",
28929         "content": "curl https://{domain}/api/users/describe -v -u {name}:{password}",
28930         "type": "json"
28931       }
28932     ],
28933     "name": "DescribeUsers",
28934     "group": "Users",
28935     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28936     "version": "0.0.0",
28937     "filename": "server/api/user/index.js",
28938     "groupTitle": "Users"
28939   },
28940   {
28941     "type": "get",
28942     "url": "/api/users/{id}/agents",
28943     "title": "GetAgents",
28944     "examples": [
28945       {
28946         "title": "Example usage:",
28947         "content": "curl https://{domain}/api/users/{id}/agents -v -u {name}:{password} -X GET",
28948         "type": "json"
28949       }
28950     ],
28951     "name": "GetAgents",
28952     "group": "Users",
28953     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28954     "version": "0.0.0",
28955     "filename": "server/api/user/index.js",
28956     "groupTitle": "Users"
28957   },
28958   {
28959     "type": "get",
28960     "url": "/api/users/{id}/api_key",
28961     "title": "Get the API access key for the user",
28962     "examples": [
28963       {
28964         "title": "Example usage:",
28965         "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X GET",
28966         "type": "json"
28967       }
28968     ],
28969     "name": "GetApiKey",
28970     "group": "Users",
28971     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28972     "version": "0.0.0",
28973     "filename": "server/api/user/index.js",
28974     "groupTitle": "Users"
28975   },
28976   {
28977     "type": "get",
28978     "url": "/api/users/{id}/groups",
28979     "title": "GetChatGroups",
28980     "examples": [
28981       {
28982         "title": "Example usage:",
28983         "content": "curl https://{domain}/api/users/{id}/groups -v -u {name}:{password} -X GET",
28984         "type": "json"
28985       }
28986     ],
28987     "name": "GetChatGroups",
28988     "group": "Users",
28989     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28990     "version": "0.0.0",
28991     "filename": "server/api/user/index.js",
28992     "groupTitle": "Users"
28993   },
28994   {
28995     "type": "get",
28996     "url": "/api/users/{id}/chat/interactions",
28997     "title": "GetChatInteractions",
28998     "examples": [
28999       {
29000         "title": "Example usage:",
29001         "content": "curl https://{domain}/api/users/{id}/chat/interactions -v -u {name}:{password} -X GET",
29002         "type": "json"
29003       }
29004     ],
29005     "name": "GetChatInteractions",
29006     "group": "Users",
29007     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29008     "version": "0.0.0",
29009     "filename": "server/api/user/index.js",
29010     "groupTitle": "Users"
29011   },
29012   {
29013     "type": "get",
29014     "url": "/api/users/{id}/chat_websites",
29015     "title": "GetChatWebsites",
29016     "examples": [
29017       {
29018         "title": "Example usage:",
29019         "content": "curl https://{domain}/api/users/{id}/chat_websites -v -u {name}:{password} -X GET",
29020         "type": "json"
29021       }
29022     ],
29023     "name": "GetChatWebsites",
29024     "group": "Users",
29025     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29026     "version": "0.0.0",
29027     "filename": "server/api/user/index.js",
29028     "groupTitle": "Users"
29029   },
29030   {
29031     "type": "get",
29032     "url": "/api/users/{id}/contacts",
29033     "title": "GetContacts",
29034     "examples": [
29035       {
29036         "title": "Example usage:",
29037         "content": "curl https://{domain}/api/users/{id}/contacts -v -u {name}:{password} -X GET",
29038         "type": "json"
29039       }
29040     ],
29041     "name": "GetContacts",
29042     "group": "Users",
29043     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29044     "version": "0.0.0",
29045     "filename": "server/api/user/index.js",
29046     "groupTitle": "Users"
29047   },
29048   {
29049     "type": "get",
29050     "url": "/api/users/{id}/fax_accounts",
29051     "title": "GetFaxAccounts",
29052     "examples": [
29053       {
29054         "title": "Example usage:",
29055         "content": "curl https://{domain}/api/users/{id}/fax_accounts -v -u {name}:{password} -X GET",
29056         "type": "json"
29057       }
29058     ],
29059     "name": "GetFaxAccounts",
29060     "group": "Users",
29061     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29062     "version": "0.0.0",
29063     "filename": "server/api/user/index.js",
29064     "groupTitle": "Users"
29065   },
29066   {
29067     "type": "get",
29068     "url": "/api/users/{id}/fax/interactions",
29069     "title": "GetFaxInteractions",
29070     "examples": [
29071       {
29072         "title": "Example usage:",
29073         "content": "curl https://{domain}/api/users/{id}/fax/interactions -v -u {name}:{password} -X GET",
29074         "type": "json"
29075       }
29076     ],
29077     "name": "GetFaxInteractions",
29078     "group": "Users",
29079     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29080     "version": "0.0.0",
29081     "filename": "server/api/user/index.js",
29082     "groupTitle": "Users"
29083   },
29084   {
29085     "type": "get",
29086     "url": "/api/users/{id}/lists",
29087     "title": "GetLists",
29088     "examples": [
29089       {
29090         "title": "Example usage:",
29091         "content": "curl https://{domain}/api/users/{id}/lists -v -u {name}:{password} -X GET",
29092         "type": "json"
29093       }
29094     ],
29095     "name": "GetLists",
29096     "group": "Users",
29097     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29098     "version": "0.0.0",
29099     "filename": "server/api/user/index.js",
29100     "groupTitle": "Users"
29101   },
29102   {
29103     "type": "get",
29104     "url": "/api/users/{id}/mail_accounts",
29105     "title": "GetMailAccounts",
29106     "examples": [
29107       {
29108         "title": "Example usage:",
29109         "content": "curl https://{domain}/api/users/{id}/mail_accounts -v -u {name}:{password} -X GET",
29110         "type": "json"
29111       }
29112     ],
29113     "name": "GetMailAccounts",
29114     "group": "Users",
29115     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29116     "version": "0.0.0",
29117     "filename": "server/api/user/index.js",
29118     "groupTitle": "Users"
29119   },
29120   {
29121     "type": "get",
29122     "url": "/api/users/{id}/mail/interactions",
29123     "title": "GetMailInteractions",
29124     "examples": [
29125       {
29126         "title": "Example usage:",
29127         "content": "curl https://{domain}/api/users/{id}/mail/interactions -v -u {name}:{password} -X GET",
29128         "type": "json"
29129       }
29130     ],
29131     "name": "GetMailInteractions",
29132     "group": "Users",
29133     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29134     "version": "0.0.0",
29135     "filename": "server/api/user/index.js",
29136     "groupTitle": "Users"
29137   },
29138   {
29139     "type": "get",
29140     "url": "/api/users/{id}/openchannel_accounts",
29141     "title": "GetOpenchannelAccounts",
29142     "examples": [
29143       {
29144         "title": "Example usage:",
29145         "content": "curl https://{domain}/api/users/{id}/openchannel_accounts -v -u {name}:{password} -X GET",
29146         "type": "json"
29147       }
29148     ],
29149     "name": "GetOpenchannelAccounts",
29150     "group": "Users",
29151     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29152     "version": "0.0.0",
29153     "filename": "server/api/user/index.js",
29154     "groupTitle": "Users"
29155   },
29156   {
29157     "type": "get",
29158     "url": "/api/users/{id}/openchannel/interactions",
29159     "title": "GetOpenchannelInteractions",
29160     "examples": [
29161       {
29162         "title": "Example usage:",
29163         "content": "curl https://{domain}/api/users/{id}/openchannel/interactions -v -u {name}:{password}",
29164         "type": "json"
29165       }
29166     ],
29167     "name": "GetOpenchannelInteractions",
29168     "group": "Users",
29169     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29170     "version": "0.0.0",
29171     "filename": "server/api/user/index.js",
29172     "groupTitle": "Users"
29173   },
29174   {
29175     "type": "get",
29176     "url": "/api/users/{id}/prefixes",
29177     "title": "GetPrefixes",
29178     "examples": [
29179       {
29180         "title": "Example usage:",
29181         "content": "curl https://{domain}/api/users/{id}/prefixes -v -u {name}:{password} -X GET",
29182         "type": "json"
29183       }
29184     ],
29185     "name": "GetPrefixes",
29186     "group": "Users",
29187     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29188     "version": "0.0.0",
29189     "filename": "server/api/user/index.js",
29190     "groupTitle": "Users"
29191   },
29192   {
29193     "type": "get",
29194     "url": "/api/users/{id}/queues?channel={channel}",
29195     "title": "Gets Queues list",
29196     "examples": [
29197       {
29198         "title": "Example usage:",
29199         "content": "curl https://{domain}/api/users/{id}/queues/?channel={channel} -v -u {name}:{password} -X GET",
29200         "type": "json"
29201       }
29202     ],
29203     "name": "GetQueues",
29204     "group": "Users",
29205     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29206     "version": "0.0.0",
29207     "filename": "server/api/user/index.js",
29208     "groupTitle": "Users"
29209   },
29210   {
29211     "type": "get",
29212     "url": "/api/users/{id}/recordings",
29213     "title": "GetRecordings",
29214     "examples": [
29215       {
29216         "title": "Example usage:",
29217         "content": "curl https://{domain}/api/users/{id}/recordings -v -u {name}:{password} -X GET",
29218         "type": "json"
29219       }
29220     ],
29221     "name": "GetRecordings",
29222     "group": "Users",
29223     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29224     "version": "0.0.0",
29225     "filename": "server/api/user/index.js",
29226     "groupTitle": "Users"
29227   },
29228   {
29229     "type": "get",
29230     "url": "/api/users/{id}/scheduled_calls",
29231     "title": "GetScheduledCalls",
29232     "examples": [
29233       {
29234         "title": "Example usage:",
29235         "content": "curl https://{domain}/api/users/{id}/scheduled_calls -v -u {name}:{password} -X GET",
29236         "type": "json"
29237       }
29238     ],
29239     "name": "GetScheduledCalls",
29240     "group": "Users",
29241     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29242     "version": "0.0.0",
29243     "filename": "server/api/user/index.js",
29244     "groupTitle": "Users"
29245   },
29246   {
29247     "type": "get",
29248     "url": "/api/users/{id}/screen_recordings",
29249     "title": "GetScreenRecordings",
29250     "examples": [
29251       {
29252         "title": "Example usage:",
29253         "content": "curl https://{domain}/api/users/{id}/screen_recordings -v -u {name}:{password} -X GET",
29254         "type": "json"
29255       }
29256     ],
29257     "name": "GetScreenRecordings",
29258     "group": "Users",
29259     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29260     "version": "0.0.0",
29261     "filename": "server/api/user/index.js",
29262     "groupTitle": "Users"
29263   },
29264   {
29265     "type": "get",
29266     "url": "/api/users/{id}/sms_accounts",
29267     "title": "GetSmsAccounts",
29268     "examples": [
29269       {
29270         "title": "Example usage:",
29271         "content": "curl https://{domain}/api/users/{id}/sms_accounts -v -u {name}:{password} -X GET",
29272         "type": "json"
29273       }
29274     ],
29275     "name": "GetSmsAccounts",
29276     "group": "Users",
29277     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29278     "version": "0.0.0",
29279     "filename": "server/api/user/index.js",
29280     "groupTitle": "Users"
29281   },
29282   {
29283     "type": "get",
29284     "url": "/api/users/{id}/sms/interactions",
29285     "title": "GetSmsInteractions",
29286     "examples": [
29287       {
29288         "title": "Example usage:",
29289         "content": "curl https://{domain}/api/users/{id}/sms/interactions -v -u {name}:{password} -X GET",
29290         "type": "json"
29291       }
29292     ],
29293     "name": "GetSmsInteractions",
29294     "group": "Users",
29295     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29296     "version": "0.0.0",
29297     "filename": "server/api/user/index.js",
29298     "groupTitle": "Users"
29299   },
29300   {
29301     "type": "get",
29302     "url": "/api/users/{id}/square_projects",
29303     "title": "GetSquareProjects",
29304     "examples": [
29305       {
29306         "title": "Example usage:",
29307         "content": "curl https://{domain}/api/users/{id}/square_projects -v -u {name}:{password} -X GET",
29308         "type": "json"
29309       }
29310     ],
29311     "name": "GetSquareProjects",
29312     "group": "Users",
29313     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29314     "version": "0.0.0",
29315     "filename": "server/api/user/index.js",
29316     "groupTitle": "Users"
29317   },
29318   {
29319     "type": "get",
29320     "url": "/api/users/{id}/teams",
29321     "title": "GetTeams",
29322     "examples": [
29323       {
29324         "title": "Example usage:",
29325         "content": "curl https://{domain}/api/users/{id}/teams -v -u {name}:{password} -X GET",
29326         "type": "json"
29327       }
29328     ],
29329     "name": "GetTeams",
29330     "group": "Users",
29331     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29332     "version": "0.0.0",
29333     "filename": "server/api/user/index.js",
29334     "groupTitle": "Users"
29335   },
29336   {
29337     "type": "get",
29338     "url": "/api/users",
29339     "title": "Gets a list of Users",
29340     "examples": [
29341       {
29342         "title": "Example usage:",
29343         "content": "curl https://{domain}/api/users -v -u {name}:{password}",
29344         "type": "json"
29345       }
29346     ],
29347     "name": "GetUsers",
29348     "group": "Users",
29349     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
29350     "version": "0.0.0",
29351     "filename": "server/api/user/index.js",
29352     "groupTitle": "Users"
29353   },
29354   {
29355     "type": "get",
29356     "url": "/api/users/{id}/queues_rt",
29357     "title": "GetVoiceQueuesRt",
29358     "examples": [
29359       {
29360         "title": "Example usage:",
29361         "content": "curl https://{domain}/api/users/{id}/queues_rt -v -u {name}:{password} -X GET",
29362         "type": "json"
29363       }
29364     ],
29365     "name": "GetVoiceQueuesRt",
29366     "group": "Users",
29367     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29368     "version": "0.0.0",
29369     "filename": "server/api/user/index.js",
29370     "groupTitle": "Users"
29371   },
29372   {
29373     "type": "get",
29374     "url": "/api/users/{id}/whatsapp_accounts",
29375     "title": "GetWhatsappAccounts",
29376     "examples": [
29377       {
29378         "title": "Example usage:",
29379         "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts -v -u {name}:{password} -X GET",
29380         "type": "json"
29381       }
29382     ],
29383     "name": "GetWhatsappAccounts",
29384     "group": "Users",
29385     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29386     "version": "0.0.0",
29387     "filename": "server/api/user/index.js",
29388     "groupTitle": "Users"
29389   },
29390   {
29391     "type": "get",
29392     "url": "/api/users/{id}/whatsapp/interactions",
29393     "title": "GetWhatsappInteractions",
29394     "examples": [
29395       {
29396         "title": "Example usage:",
29397         "content": "curl https://{domain}/api/users/{id}/whatsapp/interactions -v -u {name}:{password} -X GET",
29398         "type": "json"
29399       }
29400     ],
29401     "name": "GetWhatsappInteractions",
29402     "group": "Users",
29403     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29404     "version": "0.0.0",
29405     "filename": "server/api/user/index.js",
29406     "groupTitle": "Users"
29407   },
29408   {
29409     "type": "post",
29410     "url": "/api/users/{id}/login",
29411     "title": "Login",
29412     "examples": [
29413       {
29414         "title": "Example usage:",
29415         "content": "curl https://{domain}/api/users/{id}/login  -v -u {name}:{password} -X POST",
29416         "type": "json"
29417       }
29418     ],
29419     "name": "Login",
29420     "group": "Users",
29421     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29422     "version": "0.0.0",
29423     "filename": "server/api/user/index.js",
29424     "groupTitle": "Users"
29425   },
29426   {
29427     "type": "post",
29428     "url": "/api/users/{id}/logout",
29429     "title": "Logout",
29430     "examples": [
29431       {
29432         "title": "Example usage:",
29433         "content": "curl https://{domain}/api/users/{id}/logout -v -u {name}:{password} -X POST",
29434         "type": "json"
29435       }
29436     ],
29437     "name": "Logout",
29438     "group": "Users",
29439     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29440     "version": "0.0.0",
29441     "filename": "server/api/user/index.js",
29442     "groupTitle": "Users"
29443   },
29444   {
29445     "type": "post",
29446     "url": "/api/users/{id}/pause",
29447     "title": "Pause",
29448     "examples": [
29449       {
29450         "title": "Example usage:",
29451         "content": "curl https://{domain}/api/users/{id}/pause -v -u {name}:{password} -X POST",
29452         "type": "json"
29453       }
29454     ],
29455     "name": "Pause",
29456     "group": "Users",
29457     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29458     "version": "0.0.0",
29459     "filename": "server/api/user/index.js",
29460     "groupTitle": "Users"
29461   },
29462   {
29463     "type": "delete",
29464     "url": "/api/users/{id}/api_key",
29465     "title": "Remove API access key for the user",
29466     "examples": [
29467       {
29468         "title": "Example usage:",
29469         "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X DELETE",
29470         "type": "json"
29471       }
29472     ],
29473     "name": "RemoveApiKey",
29474     "group": "Users",
29475     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29476     "version": "0.0.0",
29477     "filename": "server/api/user/index.js",
29478     "groupTitle": "Users"
29479   },
29480   {
29481     "type": "delete",
29482     "url": "/api/users/{id}/chat_interactions",
29483     "title": "Removes interactions from an agent",
29484     "examples": [
29485       {
29486         "title": "Example usage:",
29487         "content": "curl https://{domain}/api/users/{id}/chat_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29488         "type": "json"
29489       }
29490     ],
29491     "name": "RemoveChatInteractions",
29492     "group": "Users",
29493     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29494     "version": "0.0.0",
29495     "filename": "server/api/user/index.js",
29496     "groupTitle": "Users"
29497   },
29498   {
29499     "type": "delete",
29500     "url": "/api/users/{id}/chat_websites",
29501     "title": "Removes a Chat Website from a user",
29502     "examples": [
29503       {
29504         "title": "Example usage:",
29505         "content": "curl https://{domain}/api/users/{id}/chat_websites?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29506         "type": "json"
29507       }
29508     ],
29509     "name": "RemoveChatWebsites",
29510     "group": "Users",
29511     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29512     "version": "0.0.0",
29513     "filename": "server/api/user/index.js",
29514     "groupTitle": "Users"
29515   },
29516   {
29517     "type": "delete",
29518     "url": "/api/users/{id}/fax_accounts",
29519     "title": "Removes a Fax Account from a user",
29520     "examples": [
29521       {
29522         "title": "Example usage:",
29523         "content": "curl https://{domain}/api/users/{id}/fax_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29524         "type": "json"
29525       }
29526     ],
29527     "name": "RemoveFaxAccounts",
29528     "group": "Users",
29529     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29530     "version": "0.0.0",
29531     "filename": "server/api/user/index.js",
29532     "groupTitle": "Users"
29533   },
29534   {
29535     "type": "delete",
29536     "url": "/api/users/{id}/fax_interactions",
29537     "title": "Removes interactions from an agent",
29538     "examples": [
29539       {
29540         "title": "Example usage:",
29541         "content": "curl https://{domain}/api/users/{id}/fax_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29542         "type": "json"
29543       }
29544     ],
29545     "name": "RemoveFaxInteractions",
29546     "group": "Users",
29547     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29548     "version": "0.0.0",
29549     "filename": "server/api/user/index.js",
29550     "groupTitle": "Users"
29551   },
29552   {
29553     "type": "delete",
29554     "url": "/api/users/{id}/mail_accounts",
29555     "title": "Removes a Mail Account from a user",
29556     "examples": [
29557       {
29558         "title": "Example usage:",
29559         "content": "curl https://{domain}/api/users/{id}/mail_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29560         "type": "json"
29561       }
29562     ],
29563     "name": "RemoveMailAccounts",
29564     "group": "Users",
29565     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29566     "version": "0.0.0",
29567     "filename": "server/api/user/index.js",
29568     "groupTitle": "Users"
29569   },
29570   {
29571     "type": "delete",
29572     "url": "/api/users/{id}/mail_interactions",
29573     "title": "Removes interactions from an agent",
29574     "examples": [
29575       {
29576         "title": "Example usage:",
29577         "content": "curl https://{domain}/api/users/{id}/mail_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29578         "type": "json"
29579       }
29580     ],
29581     "name": "RemoveMailInteractions",
29582     "group": "Users",
29583     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29584     "version": "0.0.0",
29585     "filename": "server/api/user/index.js",
29586     "groupTitle": "Users"
29587   },
29588   {
29589     "type": "delete",
29590     "url": "/api/users/{id}/openchannel_accounts",
29591     "title": "Removes a Open Channel Account from a user",
29592     "examples": [
29593       {
29594         "title": "Example usage:",
29595         "content": "curl https://{domain}/api/users/{id}/openchannel_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29596         "type": "json"
29597       }
29598     ],
29599     "name": "RemoveOpenchannelAccounts",
29600     "group": "Users",
29601     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29602     "version": "0.0.0",
29603     "filename": "server/api/user/index.js",
29604     "groupTitle": "Users"
29605   },
29606   {
29607     "type": "delete",
29608     "url": "/api/users/{id}/openchannel_interactions",
29609     "title": "Removes openchannel interactions from an agent",
29610     "examples": [
29611       {
29612         "title": "Example usage:",
29613         "content": "curl https://{domain}/api/users/{id}/openchannel_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29614         "type": "json"
29615       }
29616     ],
29617     "name": "RemoveOpenchannelInteractions",
29618     "group": "Users",
29619     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29620     "version": "0.0.0",
29621     "filename": "server/api/user/index.js",
29622     "groupTitle": "Users"
29623   },
29624   {
29625     "type": "delete",
29626     "url": "/api/users/{id}/queues",
29627     "title": "Remove queues to an agent",
29628     "examples": [
29629       {
29630         "title": "Example usage:",
29631         "content": "curl https://{domain}/api/users/{id}/queues?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29632         "type": "json"
29633       }
29634     ],
29635     "name": "RemoveQueues",
29636     "group": "Users",
29637     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29638     "version": "0.0.0",
29639     "filename": "server/api/user/index.js",
29640     "groupTitle": "Users"
29641   },
29642   {
29643     "type": "delete",
29644     "url": "/api/users/{id}/sms_accounts",
29645     "title": "Removes a Sms Account from a user",
29646     "examples": [
29647       {
29648         "title": "Example usage:",
29649         "content": "curl https://{domain}/api/users/{id}/sms_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29650         "type": "json"
29651       }
29652     ],
29653     "name": "RemoveSmsAccounts",
29654     "group": "Users",
29655     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29656     "version": "0.0.0",
29657     "filename": "server/api/user/index.js",
29658     "groupTitle": "Users"
29659   },
29660   {
29661     "type": "delete",
29662     "url": "/api/users/{id}/sms_interactions",
29663     "title": "Removes interactions from an agent",
29664     "examples": [
29665       {
29666         "title": "Example usage:",
29667         "content": "curl https://{domain}/api/users/{id}/sms_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29668         "type": "json"
29669       }
29670     ],
29671     "name": "RemoveSmsInteractions",
29672     "group": "Users",
29673     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29674     "version": "0.0.0",
29675     "filename": "server/api/user/index.js",
29676     "groupTitle": "Users"
29677   },
29678   {
29679     "type": "delete",
29680     "url": "/api/users/{id}/square_projects",
29681     "title": "Removes a Square Project from a user",
29682     "examples": [
29683       {
29684         "title": "Example usage:",
29685         "content": "curl https://{domain}/api/users/{id}/square_projects?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29686         "type": "json"
29687       }
29688     ],
29689     "name": "RemoveSquareProjects",
29690     "group": "Users",
29691     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29692     "version": "0.0.0",
29693     "filename": "server/api/user/index.js",
29694     "groupTitle": "Users"
29695   },
29696   {
29697     "type": "delete",
29698     "url": "/api/users/{id}/teams",
29699     "title": "Removes teams from an agent",
29700     "examples": [
29701       {
29702         "title": "Example usage:",
29703         "content": "curl https://{domain}/api/users/{id}/teams?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29704         "type": "json"
29705       }
29706     ],
29707     "name": "RemoveTeams",
29708     "group": "Users",
29709     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29710     "version": "0.0.0",
29711     "filename": "server/api/user/index.js",
29712     "groupTitle": "Users"
29713   },
29714   {
29715     "type": "delete",
29716     "url": "/api/users/{id}/whatsapp_accounts",
29717     "title": "Removes a Whatsapp Account from a user",
29718     "examples": [
29719       {
29720         "title": "Example usage:",
29721         "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29722         "type": "json"
29723       }
29724     ],
29725     "name": "RemoveWhatsappAccounts",
29726     "group": "Users",
29727     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29728     "version": "0.0.0",
29729     "filename": "server/api/user/index.js",
29730     "groupTitle": "Users"
29731   },
29732   {
29733     "type": "delete",
29734     "url": "/api/users/{id}/whatsapp_interactions",
29735     "title": "Removes Whatsapp interactions from an agent",
29736     "examples": [
29737       {
29738         "title": "Example usage:",
29739         "content": "curl https://{domain}/api/users/{id}/whatsapp_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29740         "type": "json"
29741       }
29742     ],
29743     "name": "RemoveWhatsappInteractions",
29744     "group": "Users",
29745     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29746     "version": "0.0.0",
29747     "filename": "server/api/user/index.js",
29748     "groupTitle": "Users"
29749   },
29750   {
29751     "type": "get",
29752     "url": "/api/users/{id}",
29753     "title": "Gets a single User",
29754     "examples": [
29755       {
29756         "title": "Example usage:",
29757         "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password}",
29758         "type": "json"
29759       }
29760     ],
29761     "name": "ShowUsers",
29762     "group": "Users",
29763     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29764     "version": "0.0.0",
29765     "filename": "server/api/user/index.js",
29766     "groupTitle": "Users"
29767   },
29768   {
29769     "type": "post",
29770     "url": "/api/users/{id}/unpause",
29771     "title": "Unpause",
29772     "examples": [
29773       {
29774         "title": "Example usage:",
29775         "content": "curl https://{domain}/api/users/{id}/unpause -v -u {name}:{password} -X POST",
29776         "type": "json"
29777       }
29778     ],
29779     "name": "Unpause",
29780     "group": "Users",
29781     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29782     "version": "0.0.0",
29783     "filename": "server/api/user/index.js",
29784     "groupTitle": "Users"
29785   },
29786   {
29787     "type": "get",
29788     "url": "/api/users/whoami",
29789     "title": "WhoAmI",
29790     "examples": [
29791       {
29792         "title": "Example usage:",
29793         "content": "curl https://{domain}/api/users/whoami -v -u {name}:{password} -X GET",
29794         "type": "json"
29795       }
29796     ],
29797     "name": "WhoAmI",
29798     "group": "Users",
29799     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29800     "version": "0.0.0",
29801     "filename": "server/api/user/index.js",
29802     "groupTitle": "Users"
29803   },
29804   {
29805     "type": "post",
29806     "url": "/api/users/{id}/avatar",
29807     "title": "Add avatar",
29808     "examples": [
29809       {
29810         "title": "Example usage:",
29811         "content": "curl https://{domain}/api/users/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
29812         "type": "json"
29813       }
29814     ],
29815     "name": "addAvatar",
29816     "group": "Users",
29817     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29818     "version": "0.0.0",
29819     "filename": "server/api/user/index.js",
29820     "groupTitle": "Users"
29821   },
29822   {
29823     "type": "post",
29824     "url": "/api/users/create_many",
29825     "title": "Create Users",
29826     "examples": [
29827       {
29828         "title": "Example usage:",
29829         "content": "curl https://{domain}/api/users/create_many -d '[{\"name\": \"john.doe\", \"role\": \"user\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",
29830         "type": "json"
29831       }
29832     ],
29833     "name": "bulkCreate",
29834     "group": "Users",
29835     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29836     "version": "0.0.0",
29837     "filename": "server/api/user/index.js",
29838     "groupTitle": "Users"
29839   },
29840   {
29841     "type": "get",
29842     "url": "/api/users/{id}/avatar",
29843     "title": "Get avatar",
29844     "examples": [
29845       {
29846         "title": "Example usage:",
29847         "content": "curl https://{domain}/api/users/{id}/avatar -v -u {name}:{password} -X GET",
29848         "type": "json"
29849       }
29850     ],
29851     "name": "getAvatar",
29852     "group": "Users",
29853     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29854     "version": "0.0.0",
29855     "filename": "server/api/user/index.js",
29856     "groupTitle": "Users"
29857   },
29858   {
29859     "type": "get",
29860     "url": "/api/users/{id}/open_tabs",
29861     "title": "Get interactions opened tabs",
29862     "examples": [
29863       {
29864         "title": "Example usage:",
29865         "content": "curl https://{domain}/api/users/{id}/open_tabs -v -u {name}:{password} -X GET",
29866         "type": "json"
29867       }
29868     ],
29869     "name": "getOpenTabs",
29870     "group": "Users",
29871     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29872     "version": "0.0.0",
29873     "filename": "server/api/user/index.js",
29874     "groupTitle": "Users"
29875   },
29876   {
29877     "type": "get",
29878     "url": "/api/users/presence",
29879     "title": "Gets agent presence",
29880     "examples": [
29881       {
29882         "title": "Example usage:",
29883         "content": "curl https://{domain}/api/users/presence -v -u {name}:{password}  -X GET",
29884         "type": "json"
29885       }
29886     ],
29887     "name": "getPresence",
29888     "group": "Users",
29889     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29890     "version": "0.0.0",
29891     "filename": "server/api/user/index.js",
29892     "groupTitle": "Users"
29893   },
29894   {
29895     "type": "put",
29896     "url": "/api/users/{id}",
29897     "title": "Update an existing User",
29898     "examples": [
29899       {
29900         "title": "Example usage:",
29901         "content": "curl https://{domain}/api/users/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
29902         "type": "json"
29903       }
29904     ],
29905     "name": "updateUsers",
29906     "group": "Users",
29907     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29908     "version": "0.0.0",
29909     "filename": "server/api/user/index.js",
29910     "groupTitle": "Users"
29911   },
29912   {
29913     "type": "post",
29914     "url": "/api/variables",
29915     "title": "Creates a new Variable",
29916     "examples": [
29917       {
29918         "title": "Example usage:",
29919         "content": "curl https://{domain}/api/variables -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
29920         "type": "json"
29921       }
29922     ],
29923     "name": "CreateVariables",
29924     "group": "Variables",
29925     "parameter": {
29926       "fields": {
29927         "Body": [
29928           {
29929             "group": "Body",
29930             "type": "String",
29931             "optional": false,
29932             "field": "name",
29933             "description": ""
29934           },
29935           {
29936             "group": "Body",
29937             "type": "String",
29938             "optional": true,
29939             "field": "description",
29940             "description": ""
29941           }
29942         ]
29943       }
29944     },
29945     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29946     "version": "0.0.0",
29947     "filename": "server/api/variable/index.js",
29948     "groupTitle": "Variables"
29949   },
29950   {
29951     "type": "delete",
29952     "url": "/api/variables/{id}",
29953     "title": "Deletes a Variable",
29954     "examples": [
29955       {
29956         "title": "Example usage:",
29957         "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password} -X DELETE",
29958         "type": "json"
29959       }
29960     ],
29961     "name": "DeleteVariables",
29962     "group": "Variables",
29963     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29964     "version": "0.0.0",
29965     "filename": "server/api/variable/index.js",
29966     "groupTitle": "Variables"
29967   },
29968   {
29969     "type": "get",
29970     "url": "/api/variables",
29971     "title": "Gets a list of Variables",
29972     "examples": [
29973       {
29974         "title": "Example usage:",
29975         "content": "curl https://{domain}/api/variables -v -u {name}:{password}",
29976         "type": "json"
29977       }
29978     ],
29979     "name": "GetVariables",
29980     "group": "Variables",
29981     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
29982     "version": "0.0.0",
29983     "filename": "server/api/variable/index.js",
29984     "groupTitle": "Variables"
29985   },
29986   {
29987     "type": "get",
29988     "url": "/api/variables/{id}",
29989     "title": "Gets a single Variable",
29990     "examples": [
29991       {
29992         "title": "Example usage:",
29993         "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password}",
29994         "type": "json"
29995       }
29996     ],
29997     "name": "ShowVariables",
29998     "group": "Variables",
29999     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30000     "version": "0.0.0",
30001     "filename": "server/api/variable/index.js",
30002     "groupTitle": "Variables"
30003   },
30004   {
30005     "type": "put",
30006     "url": "/api/variables/{id}",
30007     "title": "Update an existing Variable",
30008     "examples": [
30009       {
30010         "title": "Example usage:",
30011         "content": "curl https://{domain}/api/variables/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
30012         "type": "json"
30013       }
30014     ],
30015     "name": "updateVariables",
30016     "group": "Variables",
30017     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30018     "version": "0.0.0",
30019     "filename": "server/api/variable/index.js",
30020     "groupTitle": "Variables"
30021   },
30022   {
30023     "type": "get",
30024     "url": "/api/version/fetch",
30025     "title": "Fetch git version",
30026     "examples": [
30027       {
30028         "title": "Example usage:",
30029         "content": "curl https://{domain}/api/version/fetch -v -u {name}:{password}",
30030         "type": "json"
30031       }
30032     ],
30033     "name": "FetchVersion",
30034     "group": "Version",
30035     "description": "<p>Motion run the following command: git fetch origin master</p>",
30036     "version": "0.0.0",
30037     "filename": "server/api/version/index.js",
30038     "groupTitle": "Version"
30039   },
30040   {
30041     "type": "get",
30042     "url": "/api/version",
30043     "title": "Gets version",
30044     "examples": [
30045       {
30046         "title": "Example usage:",
30047         "content": "curl https://{domain}/api/version -v -u {name}:{password}",
30048         "type": "json"
30049       }
30050     ],
30051     "name": "GetVersion",
30052     "group": "Version",
30053     "description": "<p>Motion returns the current and latest motion version.</p>",
30054     "version": "0.0.0",
30055     "filename": "server/api/version/index.js",
30056     "groupTitle": "Version"
30057   },
30058   {
30059     "type": "get",
30060     "url": "/api/version/migrations",
30061     "title": "Launch database migrations",
30062     "examples": [
30063       {
30064         "title": "Example usage:",
30065         "content": "curl https://{domain}/api/version/migrations -v -u {name}:{password}",
30066         "type": "json"
30067       }
30068     ],
30069     "name": "MigrateVersion",
30070     "group": "Version",
30071     "description": "<p>Motion launch the database migrations, according to the application version</p>",
30072     "version": "0.0.0",
30073     "filename": "server/api/version/index.js",
30074     "groupTitle": "Version"
30075   },
30076   {
30077     "type": "get",
30078     "url": "/api/version/pull",
30079     "title": "Pull git version",
30080     "examples": [
30081       {
30082         "title": "Example usage:",
30083         "content": "curl https://{domain}/api/version/pull -v -u {name}:{password}",
30084         "type": "json"
30085       }
30086     ],
30087     "name": "PullVersion",
30088     "group": "Version",
30089     "description": "<p>Motion run the following command: git pull</p>",
30090     "version": "0.0.0",
30091     "filename": "server/api/version/index.js",
30092     "groupTitle": "Version"
30093   },
30094   {
30095     "type": "get",
30096     "url": "/api/version/reset",
30097     "title": "Reset git version",
30098     "examples": [
30099       {
30100         "title": "Example usage:",
30101         "content": "curl https://{domain}/api/version/reset -v -u {name}:{password}",
30102         "type": "json"
30103       }
30104     ],
30105     "name": "ResetVersion",
30106     "group": "Version",
30107     "description": "<p>Motion run the following command: git reset --hard FETCH_HEAD</p>",
30108     "version": "0.0.0",
30109     "filename": "server/api/version/index.js",
30110     "groupTitle": "Version"
30111   },
30112   {
30113     "type": "get",
30114     "url": "/api/version/restart",
30115     "title": "Restart motion2 after update",
30116     "examples": [
30117       {
30118         "title": "Example usage:",
30119         "content": "curl https://{domain}/api/version/restart -v -u {name}:{password}",
30120         "type": "json"
30121       }
30122     ],
30123     "name": "RestartVersion",
30124     "group": "Version",
30125     "description": "<p>Motion run the following command: pm2 restart motion</p>",
30126     "version": "0.0.0",
30127     "filename": "server/api/version/index.js",
30128     "groupTitle": "Version"
30129   },
30130   {
30131     "type": "get",
30132     "url": "/api/voice/agents/reports/describe",
30133     "title": "Gets table info about Agent Reports",
30134     "examples": [
30135       {
30136         "title": "Example usage:",
30137         "content": "curl https://{domain}/api/voice/agents/reports/describe -v -u {name}:{password}",
30138         "type": "json"
30139       }
30140     ],
30141     "name": "DescribeAgent_Reports",
30142     "group": "Voice_Agent_Reports",
30143     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30144     "version": "0.0.0",
30145     "filename": "server/api/voiceAgentReport/index.js",
30146     "groupTitle": "Voice_Agent_Reports"
30147   },
30148   {
30149     "type": "get",
30150     "url": "/api/voice/agents/reports",
30151     "title": "Gets a list of Agent Reports",
30152     "examples": [
30153       {
30154         "title": "Example usage:",
30155         "content": "curl https://{domain}/api/voice/agents/reports -v -u {name}:{password}",
30156         "type": "json"
30157       }
30158     ],
30159     "name": "GetAgent_Reports",
30160     "group": "Voice_Agent_Reports",
30161     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30162     "version": "0.0.0",
30163     "filename": "server/api/voiceAgentReport/index.js",
30164     "groupTitle": "Voice_Agent_Reports"
30165   },
30166   {
30167     "type": "get",
30168     "url": "/api/voice/agents/reports/{id}",
30169     "title": "Gets a single Agent Report",
30170     "examples": [
30171       {
30172         "title": "Example usage:",
30173         "content": "curl https://{domain}/api/voice/agents/reports/{id} -v -u {name}:{password}",
30174         "type": "json"
30175       }
30176     ],
30177     "name": "ShowAgent_Reports",
30178     "group": "Voice_Agent_Reports",
30179     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30180     "version": "0.0.0",
30181     "filename": "server/api/voiceAgentReport/index.js",
30182     "groupTitle": "Voice_Agent_Reports"
30183   },
30184   {
30185     "type": "get",
30186     "url": "/api/voice/calls/reports/describe",
30187     "title": "Gets table info about Call Reports",
30188     "examples": [
30189       {
30190         "title": "Example usage:",
30191         "content": "curl https://{domain}/api/voice/calls/reports/describe -v -u {name}:{password}",
30192         "type": "json"
30193       }
30194     ],
30195     "name": "DescribeCall_Reports",
30196     "group": "Voice_Call_Reports",
30197     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30198     "version": "0.0.0",
30199     "filename": "server/api/voiceCallReport/index.js",
30200     "groupTitle": "Voice_Call_Reports"
30201   },
30202   {
30203     "type": "get",
30204     "url": "/api/voice/calls/reports",
30205     "title": "Gets a list of Call Reports",
30206     "examples": [
30207       {
30208         "title": "Example usage:",
30209         "content": "curl https://{domain}/api/voice/calls/reports -v -u {name}:{password}",
30210         "type": "json"
30211       }
30212     ],
30213     "name": "GetCall_Reports",
30214     "group": "Voice_Call_Reports",
30215     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30216     "version": "0.0.0",
30217     "filename": "server/api/voiceCallReport/index.js",
30218     "groupTitle": "Voice_Call_Reports"
30219   },
30220   {
30221     "type": "get",
30222     "url": "/api/voice/calls/reports/{id}",
30223     "title": "Gets a single Call Report",
30224     "examples": [
30225       {
30226         "title": "Example usage:",
30227         "content": "curl https://{domain}/api/voice/calls/reports/{id} -v -u {name}:{password}",
30228         "type": "json"
30229       }
30230     ],
30231     "name": "ShowCall_Reports",
30232     "group": "Voice_Call_Reports",
30233     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30234     "version": "0.0.0",
30235     "filename": "server/api/voiceCallReport/index.js",
30236     "groupTitle": "Voice_Call_Reports"
30237   },
30238   {
30239     "type": "put",
30240     "url": "/api/voice/calls/reports/{id}",
30241     "title": "Update a single cdr",
30242     "examples": [
30243       {
30244         "title": "Example usage:",
30245         "content": "curl https://{domain}/api/voice/calls/reports/{id} -d '{\"userDispositio\": \"OK\"}' -v -u {name}:{password} -X PUT",
30246         "type": "json"
30247       }
30248     ],
30249     "name": "update",
30250     "group": "Voice_Call_Reports",
30251     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30252     "version": "0.0.0",
30253     "filename": "server/api/voiceCallReport/index.js",
30254     "groupTitle": "Voice_Call_Reports"
30255   },
30256   {
30257     "type": "post",
30258     "url": "/api/voice/chanspy",
30259     "title": "Creates a new ChanSpy",
30260     "examples": [
30261       {
30262         "title": "Example usage:",
30263         "content": "curl https://{domain}/api/voice/chanspy -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
30264         "type": "json"
30265       }
30266     ],
30267     "name": "CreateChanSpy",
30268     "group": "Voice_ChanSpy",
30269     "parameter": {
30270       "fields": {
30271         "Body": [
30272           {
30273             "group": "Body",
30274             "type": "String",
30275             "optional": true,
30276             "field": "name",
30277             "description": ""
30278           },
30279           {
30280             "group": "Body",
30281             "type": "String",
30282             "optional": false,
30283             "field": "prefix",
30284             "description": ""
30285           },
30286           {
30287             "group": "Body",
30288             "type": "String",
30289             "optional": true,
30290             "field": "options",
30291             "description": ""
30292           },
30293           {
30294             "group": "Body",
30295             "type": "Boolean",
30296             "optional": true,
30297             "field": "auth",
30298             "description": ""
30299           },
30300           {
30301             "group": "Body",
30302             "type": "String",
30303             "optional": true,
30304             "field": "password",
30305             "description": ""
30306           },
30307           {
30308             "group": "Body",
30309             "type": "Boolean",
30310             "optional": true,
30311             "field": "record",
30312             "description": ""
30313           },
30314           {
30315             "group": "Body",
30316             "type": "String",
30317             "optional": true,
30318             "field": "recordingFormat",
30319             "description": ""
30320           },
30321           {
30322             "group": "Body",
30323             "type": "String",
30324             "optional": true,
30325             "field": "description",
30326             "description": ""
30327           }
30328         ]
30329       }
30330     },
30331     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30332     "version": "0.0.0",
30333     "filename": "server/api/voiceChanSpy/index.js",
30334     "groupTitle": "Voice_ChanSpy"
30335   },
30336   {
30337     "type": "delete",
30338     "url": "/api/voice/chanspy/{id}",
30339     "title": "Deletes a ChanSpy",
30340     "examples": [
30341       {
30342         "title": "Example usage:",
30343         "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password} -X DELETE",
30344         "type": "json"
30345       }
30346     ],
30347     "name": "DeleteChanSpy",
30348     "group": "Voice_ChanSpy",
30349     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30350     "version": "0.0.0",
30351     "filename": "server/api/voiceChanSpy/index.js",
30352     "groupTitle": "Voice_ChanSpy"
30353   },
30354   {
30355     "type": "get",
30356     "url": "/api/voice/chanspy",
30357     "title": "Gets a list of ChanSpy",
30358     "examples": [
30359       {
30360         "title": "Example usage:",
30361         "content": "curl https://{domain}/api/voice/chanspy -v -u {name}:{password}",
30362         "type": "json"
30363       }
30364     ],
30365     "name": "GetChanSpy",
30366     "group": "Voice_ChanSpy",
30367     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30368     "version": "0.0.0",
30369     "filename": "server/api/voiceChanSpy/index.js",
30370     "groupTitle": "Voice_ChanSpy"
30371   },
30372   {
30373     "type": "get",
30374     "url": "/api/voice/chanspy/{id}",
30375     "title": "Gets a single ChanSpy",
30376     "examples": [
30377       {
30378         "title": "Example usage:",
30379         "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password}",
30380         "type": "json"
30381       }
30382     ],
30383     "name": "ShowChanSpy",
30384     "group": "Voice_ChanSpy",
30385     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30386     "version": "0.0.0",
30387     "filename": "server/api/voiceChanSpy/index.js",
30388     "groupTitle": "Voice_ChanSpy"
30389   },
30390   {
30391     "type": "put",
30392     "url": "/api/voice/chanspy/{id}",
30393     "title": "Update an existing ChanSpy",
30394     "examples": [
30395       {
30396         "title": "Example usage:",
30397         "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",
30398         "type": "json"
30399       }
30400     ],
30401     "name": "updateChanSpy",
30402     "group": "Voice_ChanSpy",
30403     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30404     "version": "0.0.0",
30405     "filename": "server/api/voiceChanSpy/index.js",
30406     "groupTitle": "Voice_ChanSpy"
30407   },
30408   {
30409     "type": "post",
30410     "url": "/api/voice/contexts",
30411     "title": "Create a new context",
30412     "examples": [
30413       {
30414         "title": "Example usage:",
30415         "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password} -X POST",
30416         "type": "json"
30417       }
30418     ],
30419     "name": "Create",
30420     "group": "Voice_Contexts",
30421     "parameter": {
30422       "fields": {
30423         "Body": [
30424           {
30425             "group": "Body",
30426             "type": "String",
30427             "optional": true,
30428             "field": "name",
30429             "description": ""
30430           },
30431           {
30432             "group": "Body",
30433             "type": "String",
30434             "optional": true,
30435             "field": "description",
30436             "description": ""
30437           },
30438           {
30439             "group": "Body",
30440             "type": "Boolean",
30441             "optional": true,
30442             "field": "defaultEntry",
30443             "description": ""
30444           }
30445         ]
30446       }
30447     },
30448     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30449     "version": "0.0.0",
30450     "filename": "server/api/voiceContext/index.js",
30451     "groupTitle": "Voice_Contexts"
30452   },
30453   {
30454     "type": "delete",
30455     "url": "/api/voice/contexts/{id}",
30456     "title": "Deletes a context",
30457     "examples": [
30458       {
30459         "title": "Example usage:",
30460         "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X DELETE",
30461         "type": "json"
30462       }
30463     ],
30464     "name": "Delete",
30465     "group": "Voice_Contexts",
30466     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30467     "version": "0.0.0",
30468     "filename": "server/api/voiceContext/index.js",
30469     "groupTitle": "Voice_Contexts"
30470   },
30471   {
30472     "type": "get",
30473     "url": "/api/voice/contexts",
30474     "title": "Gets a list of Contexts",
30475     "examples": [
30476       {
30477         "title": "Example usage:",
30478         "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password}",
30479         "type": "json"
30480       }
30481     ],
30482     "name": "GetContexts",
30483     "group": "Voice_Contexts",
30484     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30485     "version": "0.0.0",
30486     "filename": "server/api/voiceContext/index.js",
30487     "groupTitle": "Voice_Contexts"
30488   },
30489   {
30490     "type": "get",
30491     "url": "/api/voice/contexts/{id}",
30492     "title": "Gets a single Context",
30493     "examples": [
30494       {
30495         "title": "Example usage:",
30496         "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password}",
30497         "type": "json"
30498       }
30499     ],
30500     "name": "ShowContexts",
30501     "group": "Voice_Contexts",
30502     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30503     "version": "0.0.0",
30504     "filename": "server/api/voiceContext/index.js",
30505     "groupTitle": "Voice_Contexts"
30506   },
30507   {
30508     "type": "put",
30509     "url": "/api/voice/contexts/{id}",
30510     "title": "Update an existing context",
30511     "examples": [
30512       {
30513         "title": "Example usage:",
30514         "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X PUT",
30515         "type": "json"
30516       }
30517     ],
30518     "name": "Update",
30519     "group": "Voice_Contexts",
30520     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30521     "version": "0.0.0",
30522     "filename": "server/api/voiceContext/index.js",
30523     "groupTitle": "Voice_Contexts"
30524   },
30525   {
30526     "type": "get",
30527     "url": "/api/voice/dials/reports/describe",
30528     "title": "Gets table info about Dial Reports",
30529     "examples": [
30530       {
30531         "title": "Example usage:",
30532         "content": "curl https://{domain}/api/voice/dials/reports/describe -v -u {name}:{password}",
30533         "type": "json"
30534       }
30535     ],
30536     "name": "DescribeDial_Reports",
30537     "group": "Voice_Dial_Reports",
30538     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30539     "version": "0.0.0",
30540     "filename": "server/api/voiceDialReport/index.js",
30541     "groupTitle": "Voice_Dial_Reports"
30542   },
30543   {
30544     "type": "get",
30545     "url": "/api/voice/dials/reports",
30546     "title": "Gets a list of Dial Reports",
30547     "examples": [
30548       {
30549         "title": "Example usage:",
30550         "content": "curl https://{domain}/api/voice/dials/reports -v -u {name}:{password}",
30551         "type": "json"
30552       }
30553     ],
30554     "name": "GetDial_Reports",
30555     "group": "Voice_Dial_Reports",
30556     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30557     "version": "0.0.0",
30558     "filename": "server/api/voiceDialReport/index.js",
30559     "groupTitle": "Voice_Dial_Reports"
30560   },
30561   {
30562     "type": "get",
30563     "url": "/api/voice/dials/reports/{id}",
30564     "title": "Gets a single Dial Report",
30565     "examples": [
30566       {
30567         "title": "Example usage:",
30568         "content": "curl https://{domain}/api/voice/dials/reports/{id} -v -u {name}:{password}",
30569         "type": "json"
30570       }
30571     ],
30572     "name": "ShowDial_Reports",
30573     "group": "Voice_Dial_Reports",
30574     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30575     "version": "0.0.0",
30576     "filename": "server/api/voiceDialReport/index.js",
30577     "groupTitle": "Voice_Dial_Reports"
30578   },
30579   {
30580     "type": "delete",
30581     "url": "/api/voice/extensions/{id}",
30582     "title": "Deletes a Extension",
30583     "examples": [
30584       {
30585         "title": "Example usage:",
30586         "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password} -X DELETE",
30587         "type": "json"
30588       }
30589     ],
30590     "name": "DeleteExtensions",
30591     "group": "Voice_Extensions",
30592     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30593     "version": "0.0.0",
30594     "filename": "server/api/voiceExtension/index.js",
30595     "groupTitle": "Voice_Extensions"
30596   },
30597   {
30598     "type": "get",
30599     "url": "/api/voice/extensions",
30600     "title": "Gets a list of Extensions",
30601     "examples": [
30602       {
30603         "title": "Example usage:",
30604         "content": "curl https://{domain}/api/voice/extensions -v -u {name}:{password}",
30605         "type": "json"
30606       }
30607     ],
30608     "name": "GetExtensions",
30609     "group": "Voice_Extensions",
30610     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30611     "version": "0.0.0",
30612     "filename": "server/api/voiceExtension/index.js",
30613     "groupTitle": "Voice_Extensions"
30614   },
30615   {
30616     "type": "get",
30617     "url": "/api/voice/extensions/{id}",
30618     "title": "Gets a single Extension",
30619     "examples": [
30620       {
30621         "title": "Example usage:",
30622         "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password}",
30623         "type": "json"
30624       }
30625     ],
30626     "name": "ShowExtensions",
30627     "group": "Voice_Extensions",
30628     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30629     "version": "0.0.0",
30630     "filename": "server/api/voiceExtension/index.js",
30631     "groupTitle": "Voice_Extensions"
30632   },
30633   {
30634     "type": "post",
30635     "url": "/api/voice/extensions",
30636     "title": "Create new applications",
30637     "examples": [
30638       {
30639         "title": "Example usage:",
30640         "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",
30641         "type": "json"
30642       }
30643     ],
30644     "name": "addApplications",
30645     "group": "Voice_Extensions",
30646     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30647     "version": "0.0.0",
30648     "filename": "server/api/voiceExtension/index.js",
30649     "groupTitle": "Voice_Extensions"
30650   },
30651   {
30652     "type": "post",
30653     "url": "/api/voice/extensions",
30654     "title": "Create an extension",
30655     "examples": [
30656       {
30657         "title": "Example usage:",
30658         "content": "curl https://{domain}/api/voice/extensions -d '{\"exten\": \"12345\", \"context\": \"from-custom\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30659         "type": "json"
30660       }
30661     ],
30662     "name": "create",
30663     "group": "Voice_Extensions",
30664     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30665     "version": "0.0.0",
30666     "filename": "server/api/voiceExtension/index.js",
30667     "groupTitle": "Voice_Extensions"
30668   },
30669   {
30670     "type": "put",
30671     "url": "/api/voice/extensions/{id}",
30672     "title": "Update an extension",
30673     "examples": [
30674       {
30675         "title": "Example usage:",
30676         "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",
30677         "type": "json"
30678       }
30679     ],
30680     "name": "update",
30681     "group": "Voice_Extensions",
30682     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30683     "version": "0.0.0",
30684     "filename": "server/api/voiceExtension/index.js",
30685     "groupTitle": "Voice_Extensions"
30686   },
30687   {
30688     "type": "post",
30689     "url": "/api/voice/mohs",
30690     "title": "Create a new a new MOH",
30691     "examples": [
30692       {
30693         "title": "Example usage:",
30694         "content": "curl https://{domain}/api/voice/mohs -d '{\"name\": \"xmas_musics\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30695         "type": "json"
30696       }
30697     ],
30698     "name": "AddMoh",
30699     "group": "Voice_MOHs",
30700     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30701     "version": "0.0.0",
30702     "filename": "server/api/voiceMusicOnHold/index.js",
30703     "groupTitle": "Voice_MOHs"
30704   },
30705   {
30706     "type": "post",
30707     "url": "/api/voice/mohs/{id}/sounds",
30708     "title": "Add sound to MOH",
30709     "examples": [
30710       {
30711         "title": "Example usage:",
30712         "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -d '{\"id\": 1}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30713         "type": "json"
30714       }
30715     ],
30716     "name": "AddSound",
30717     "group": "Voice_MOHs",
30718     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30719     "version": "0.0.0",
30720     "filename": "server/api/voiceMusicOnHold/index.js",
30721     "groupTitle": "Voice_MOHs"
30722   },
30723   {
30724     "type": "delete",
30725     "url": "/api/voice/mohs/{id}",
30726     "title": "Deletes an MOH",
30727     "examples": [
30728       {
30729         "title": "Example usage:",
30730         "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password} -X DELETE",
30731         "type": "json"
30732       }
30733     ],
30734     "name": "DestroyMoh",
30735     "group": "Voice_MOHs",
30736     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30737     "version": "0.0.0",
30738     "filename": "server/api/voiceMusicOnHold/index.js",
30739     "groupTitle": "Voice_MOHs"
30740   },
30741   {
30742     "type": "get",
30743     "url": "/api/voice/mohs",
30744     "title": "Gets a list of Music On Holds",
30745     "examples": [
30746       {
30747         "title": "Example usage:",
30748         "content": "curl https://{domain}/api/voice/mohs -v -u {name}:{password}",
30749         "type": "json"
30750       }
30751     ],
30752     "name": "GetMusic_On_Holds",
30753     "group": "Voice_MOHs",
30754     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30755     "version": "0.0.0",
30756     "filename": "server/api/voiceMusicOnHold/index.js",
30757     "groupTitle": "Voice_MOHs"
30758   },
30759   {
30760     "type": "get",
30761     "url": "/api/voice/mohs/{id}/sounds",
30762     "title": "Gets sounds from MOH",
30763     "examples": [
30764       {
30765         "title": "Example usage:",
30766         "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -v -u {name}:{password} -X DELETE",
30767         "type": "json"
30768       }
30769     ],
30770     "name": "GetSounds",
30771     "group": "Voice_MOHs",
30772     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30773     "version": "0.0.0",
30774     "filename": "server/api/voiceMusicOnHold/index.js",
30775     "groupTitle": "Voice_MOHs"
30776   },
30777   {
30778     "type": "delete",
30779     "url": "/api/voice/mohs/{id}/sounds/{id2}",
30780     "title": "Remove sound from MOH",
30781     "examples": [
30782       {
30783         "title": "Example usage:",
30784         "content": "curl https://{domain}/api/voice/mohs/{id}/sounds/{id2} -v -u {name}:{password} -X DELETE",
30785         "type": "json"
30786       }
30787     ],
30788     "name": "RemoveSound",
30789     "group": "Voice_MOHs",
30790     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30791     "version": "0.0.0",
30792     "filename": "server/api/voiceMusicOnHold/index.js",
30793     "groupTitle": "Voice_MOHs"
30794   },
30795   {
30796     "type": "get",
30797     "url": "/api/voice/mohs/{id}",
30798     "title": "Gets a single Music On Hold",
30799     "examples": [
30800       {
30801         "title": "Example usage:",
30802         "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password}",
30803         "type": "json"
30804       }
30805     ],
30806     "name": "ShowMusic_On_Holds",
30807     "group": "Voice_MOHs",
30808     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30809     "version": "0.0.0",
30810     "filename": "server/api/voiceMusicOnHold/index.js",
30811     "groupTitle": "Voice_MOHs"
30812   },
30813   {
30814     "type": "put",
30815     "url": "/api/voice/mohs/{id}",
30816     "title": "Update an existing Music On Hold",
30817     "examples": [
30818       {
30819         "title": "Example usage:",
30820         "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",
30821         "type": "json"
30822       }
30823     ],
30824     "name": "updateMusic_On_Holds",
30825     "group": "Voice_MOHs",
30826     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30827     "version": "0.0.0",
30828     "filename": "server/api/voiceMusicOnHold/index.js",
30829     "groupTitle": "Voice_MOHs"
30830   },
30831   {
30832     "type": "post",
30833     "url": "/api/voice/mails",
30834     "title": "Creates a new Mail",
30835     "examples": [
30836       {
30837         "title": "Example usage:",
30838         "content": "curl https://{domain}/api/voice/mails -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
30839         "type": "json"
30840       }
30841     ],
30842     "name": "CreateMails",
30843     "group": "Voice_Mails",
30844     "parameter": {
30845       "fields": {
30846         "Body": [
30847           {
30848             "group": "Body",
30849             "type": "String",
30850             "optional": true,
30851             "field": "customer_id",
30852             "description": ""
30853           },
30854           {
30855             "group": "Body",
30856             "type": "String",
30857             "optional": true,
30858             "field": "context",
30859             "description": ""
30860           },
30861           {
30862             "group": "Body",
30863             "type": "String",
30864             "optional": false,
30865             "field": "mailbox",
30866             "description": ""
30867           },
30868           {
30869             "group": "Body",
30870             "type": "String",
30871             "optional": true,
30872             "field": "password",
30873             "description": ""
30874           },
30875           {
30876             "group": "Body",
30877             "type": "String",
30878             "optional": true,
30879             "field": "fullname",
30880             "description": ""
30881           },
30882           {
30883             "group": "Body",
30884             "type": "String",
30885             "optional": true,
30886             "field": "email",
30887             "description": ""
30888           },
30889           {
30890             "group": "Body",
30891             "type": "String",
30892             "optional": true,
30893             "field": "pager",
30894             "description": ""
30895           },
30896           {
30897             "group": "Body",
30898             "type": "String",
30899             "optional": true,
30900             "field": "tz",
30901             "description": ""
30902           },
30903           {
30904             "group": "Body",
30905             "type": "String",
30906             "allowedValues": [
30907               "\"yes\"",
30908               "\"no\""
30909             ],
30910             "optional": false,
30911             "field": "attach",
30912             "description": ""
30913           },
30914           {
30915             "group": "Body",
30916             "type": "String",
30917             "allowedValues": [
30918               "\"yes\"",
30919               "\"no\""
30920             ],
30921             "optional": false,
30922             "field": "saycid",
30923             "description": ""
30924           },
30925           {
30926             "group": "Body",
30927             "type": "String",
30928             "optional": true,
30929             "field": "dialout",
30930             "description": ""
30931           },
30932           {
30933             "group": "Body",
30934             "type": "String",
30935             "optional": true,
30936             "field": "callback",
30937             "description": ""
30938           },
30939           {
30940             "group": "Body",
30941             "type": "String",
30942             "allowedValues": [
30943               "\"yes\"",
30944               "\"no\""
30945             ],
30946             "optional": false,
30947             "field": "review",
30948             "description": ""
30949           },
30950           {
30951             "group": "Body",
30952             "type": "String",
30953             "allowedValues": [
30954               "\"yes\"",
30955               "\"no\""
30956             ],
30957             "optional": false,
30958             "field": "operator",
30959             "description": ""
30960           },
30961           {
30962             "group": "Body",
30963             "type": "String",
30964             "allowedValues": [
30965               "\"yes\"",
30966               "\"no\""
30967             ],
30968             "optional": false,
30969             "field": "envelope",
30970             "description": ""
30971           },
30972           {
30973             "group": "Body",
30974             "type": "String",
30975             "allowedValues": [
30976               "\"yes\"",
30977               "\"no\""
30978             ],
30979             "optional": false,
30980             "field": "sayduration",
30981             "description": ""
30982           },
30983           {
30984             "group": "Body",
30985             "type": "String",
30986             "optional": false,
30987             "field": "saydurationm",
30988             "description": ""
30989           },
30990           {
30991             "group": "Body",
30992             "type": "String",
30993             "allowedValues": [
30994               "\"yes\"",
30995               "\"no\""
30996             ],
30997             "optional": false,
30998             "field": "sendvoicemail",
30999             "description": ""
31000           },
31001           {
31002             "group": "Body",
31003             "type": "String",
31004             "allowedValues": [
31005               "\"yes\"",
31006               "\"no\""
31007             ],
31008             "optional": false,
31009             "field": "delete",
31010             "description": ""
31011           },
31012           {
31013             "group": "Body",
31014             "type": "String",
31015             "allowedValues": [
31016               "\"yes\"",
31017               "\"no\""
31018             ],
31019             "optional": false,
31020             "field": "nextaftercmd",
31021             "description": ""
31022           },
31023           {
31024             "group": "Body",
31025             "type": "String",
31026             "allowedValues": [
31027               "\"yes\"",
31028               "\"no\""
31029             ],
31030             "optional": false,
31031             "field": "forcename",
31032             "description": ""
31033           },
31034           {
31035             "group": "Body",
31036             "type": "String",
31037             "allowedValues": [
31038               "\"yes\"",
31039               "\"no\""
31040             ],
31041             "optional": false,
31042             "field": "forcegreetings",
31043             "description": ""
31044           },
31045           {
31046             "group": "Body",
31047             "type": "String",
31048             "allowedValues": [
31049               "\"yes\"",
31050               "\"no\""
31051             ],
31052             "optional": false,
31053             "field": "hidefromdir",
31054             "description": ""
31055           },
31056           {
31057             "group": "Body",
31058             "type": "String",
31059             "optional": true,
31060             "field": "stamp",
31061             "description": ""
31062           },
31063           {
31064             "group": "Body",
31065             "type": "String",
31066             "optional": true,
31067             "field": "emailsubject",
31068             "description": ""
31069           },
31070           {
31071             "group": "Body",
31072             "type": "String",
31073             "optional": true,
31074             "field": "emailbody",
31075             "description": ""
31076           },
31077           {
31078             "group": "Body",
31079             "type": "Integer",
31080             "optional": false,
31081             "field": "maxsecs",
31082             "description": ""
31083           },
31084           {
31085             "group": "Body",
31086             "type": "Integer",
31087             "optional": false,
31088             "field": "maxmsg",
31089             "description": ""
31090           },
31091           {
31092             "group": "Body",
31093             "type": "Virtual",
31094             "optional": true,
31095             "field": "name",
31096             "description": ""
31097           }
31098         ]
31099       }
31100     },
31101     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31102     "version": "0.0.0",
31103     "filename": "server/api/voiceMail/index.js",
31104     "groupTitle": "Voice_Mails"
31105   },
31106   {
31107     "type": "delete",
31108     "url": "/api/voice/mails/{id}",
31109     "title": "Deletes a Mail",
31110     "examples": [
31111       {
31112         "title": "Example usage:",
31113         "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password} -X DELETE",
31114         "type": "json"
31115       }
31116     ],
31117     "name": "DeleteMails",
31118     "group": "Voice_Mails",
31119     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31120     "version": "0.0.0",
31121     "filename": "server/api/voiceMail/index.js",
31122     "groupTitle": "Voice_Mails"
31123   },
31124   {
31125     "type": "get",
31126     "url": "/api/voice/mails",
31127     "title": "Gets a list of Mails",
31128     "examples": [
31129       {
31130         "title": "Example usage:",
31131         "content": "curl https://{domain}/api/voice/mails -v -u {name}:{password}",
31132         "type": "json"
31133       }
31134     ],
31135     "name": "GetMails",
31136     "group": "Voice_Mails",
31137     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31138     "version": "0.0.0",
31139     "filename": "server/api/voiceMail/index.js",
31140     "groupTitle": "Voice_Mails"
31141   },
31142   {
31143     "type": "get",
31144     "url": "/api/voice/mails/{id}",
31145     "title": "Gets a single Mail",
31146     "examples": [
31147       {
31148         "title": "Example usage:",
31149         "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password}",
31150         "type": "json"
31151       }
31152     ],
31153     "name": "ShowMails",
31154     "group": "Voice_Mails",
31155     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31156     "version": "0.0.0",
31157     "filename": "server/api/voiceMail/index.js",
31158     "groupTitle": "Voice_Mails"
31159   },
31160   {
31161     "type": "get",
31162     "url": "/api/voice/mails/{id}/messages",
31163     "title": "Gets voice mail messages",
31164     "examples": [
31165       {
31166         "title": "Example usage:",
31167         "content": "curl https://{domain}/api/voice/mails/{id}/messages -v -u {name}:{password} -X GET",
31168         "type": "json"
31169       }
31170     ],
31171     "name": "getMessages",
31172     "group": "Voice_Mails",
31173     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31174     "version": "0.0.0",
31175     "filename": "server/api/voiceMail/index.js",
31176     "groupTitle": "Voice_Mails"
31177   },
31178   {
31179     "type": "put",
31180     "url": "/api/voice/mails/{id}",
31181     "title": "Update an existing Mail",
31182     "examples": [
31183       {
31184         "title": "Example usage:",
31185         "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",
31186         "type": "json"
31187       }
31188     ],
31189     "name": "updateMails",
31190     "group": "Voice_Mails",
31191     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31192     "version": "0.0.0",
31193     "filename": "server/api/voiceMail/index.js",
31194     "groupTitle": "Voice_Mails"
31195   },
31196   {
31197     "type": "post",
31198     "url": "/api/voice/mails/messages",
31199     "title": "Creates a new Message",
31200     "examples": [
31201       {
31202         "title": "Example usage:",
31203         "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",
31204         "type": "json"
31205       }
31206     ],
31207     "name": "CreateMessages",
31208     "group": "Voice_Messages",
31209     "parameter": {
31210       "fields": {
31211         "Body": [
31212           {
31213             "group": "Body",
31214             "type": "Virtual",
31215             "optional": true,
31216             "field": "name",
31217             "description": ""
31218           },
31219           {
31220             "group": "Body",
31221             "type": "Integer",
31222             "optional": false,
31223             "field": "msgnum",
31224             "description": ""
31225           },
31226           {
31227             "group": "Body",
31228             "type": "String",
31229             "optional": true,
31230             "field": "dir",
31231             "description": ""
31232           },
31233           {
31234             "group": "Body",
31235             "type": "String",
31236             "optional": true,
31237             "field": "context",
31238             "description": ""
31239           },
31240           {
31241             "group": "Body",
31242             "type": "String",
31243             "optional": true,
31244             "field": "macrocontext",
31245             "description": ""
31246           },
31247           {
31248             "group": "Body",
31249             "type": "String",
31250             "optional": true,
31251             "field": "callerid",
31252             "description": ""
31253           },
31254           {
31255             "group": "Body",
31256             "type": "String",
31257             "optional": true,
31258             "field": "origtime",
31259             "description": ""
31260           },
31261           {
31262             "group": "Body",
31263             "type": "String",
31264             "optional": true,
31265             "field": "duration",
31266             "description": ""
31267           },
31268           {
31269             "group": "Body",
31270             "type": "String",
31271             "optional": true,
31272             "field": "mailboxuser",
31273             "description": ""
31274           },
31275           {
31276             "group": "Body",
31277             "type": "String",
31278             "optional": true,
31279             "field": "mailboxcontext",
31280             "description": ""
31281           },
31282           {
31283             "group": "Body",
31284             "type": "Blob",
31285             "optional": true,
31286             "field": "recording",
31287             "description": ""
31288           },
31289           {
31290             "group": "Body",
31291             "type": "String",
31292             "optional": true,
31293             "field": "flag",
31294             "description": ""
31295           },
31296           {
31297             "group": "Body",
31298             "type": "String",
31299             "optional": true,
31300             "field": "msg_id",
31301             "description": ""
31302           },
31303           {
31304             "group": "Body",
31305             "type": "String",
31306             "optional": true,
31307             "field": "stamp",
31308             "description": ""
31309           }
31310         ]
31311       }
31312     },
31313     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31314     "version": "0.0.0",
31315     "filename": "server/api/voiceMailMessage/index.js",
31316     "groupTitle": "Voice_Messages"
31317   },
31318   {
31319     "type": "delete",
31320     "url": "/api/voice/mails/messages/{id}",
31321     "title": "Deletes a Message",
31322     "examples": [
31323       {
31324         "title": "Example usage:",
31325         "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password} -X DELETE",
31326         "type": "json"
31327       }
31328     ],
31329     "name": "DeleteMessages",
31330     "group": "Voice_Messages",
31331     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31332     "version": "0.0.0",
31333     "filename": "server/api/voiceMailMessage/index.js",
31334     "groupTitle": "Voice_Messages"
31335   },
31336   {
31337     "type": "get",
31338     "url": "/api/voice/mails/messages",
31339     "title": "Gets a list of Messages",
31340     "examples": [
31341       {
31342         "title": "Example usage:",
31343         "content": "curl https://{domain}/api/voice/mails/messages -v -u {name}:{password}",
31344         "type": "json"
31345       }
31346     ],
31347     "name": "GetMessages",
31348     "group": "Voice_Messages",
31349     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31350     "version": "0.0.0",
31351     "filename": "server/api/voiceMailMessage/index.js",
31352     "groupTitle": "Voice_Messages"
31353   },
31354   {
31355     "type": "get",
31356     "url": "/api/voice/mails/messages/{id}",
31357     "title": "Gets a single Message",
31358     "examples": [
31359       {
31360         "title": "Example usage:",
31361         "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password}",
31362         "type": "json"
31363       }
31364     ],
31365     "name": "ShowMessages",
31366     "group": "Voice_Messages",
31367     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31368     "version": "0.0.0",
31369     "filename": "server/api/voiceMailMessage/index.js",
31370     "groupTitle": "Voice_Messages"
31371   },
31372   {
31373     "type": "get",
31374     "url": "voice/mails/messages/{id}/download",
31375     "title": "Download Voice Message",
31376     "examples": [
31377       {
31378         "title": "Example usage:",
31379         "content": "curl https://{domain}voice/mails/messages/{id}/download -v -u {name}:{password} -X GET",
31380         "type": "json"
31381       }
31382     ],
31383     "name": "download",
31384     "group": "Voice_Messages",
31385     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31386     "version": "0.0.0",
31387     "filename": "server/api/voiceMailMessage/index.js",
31388     "groupTitle": "Voice_Messages"
31389   },
31390   {
31391     "type": "put",
31392     "url": "/api/voice/mails/messages/{id}",
31393     "title": "Update an existing Message",
31394     "examples": [
31395       {
31396         "title": "Example usage:",
31397         "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",
31398         "type": "json"
31399       }
31400     ],
31401     "name": "updateMessages",
31402     "group": "Voice_Messages",
31403     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31404     "version": "0.0.0",
31405     "filename": "server/api/voiceMailMessage/index.js",
31406     "groupTitle": "Voice_Messages"
31407   },
31408   {
31409     "type": "post",
31410     "url": "/api/voice/prefixes/{id}/teams",
31411     "title": "Add teams to voice prefix",
31412     "examples": [
31413       {
31414         "title": "Example usage:",
31415         "content": "curl https://{domain}/api/voice/prefixes/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31416         "type": "json"
31417       }
31418     ],
31419     "name": "AddTeams",
31420     "group": "Voice_Prefix",
31421     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31422     "version": "0.0.0",
31423     "filename": "server/api/voicePrefix/index.js",
31424     "groupTitle": "Voice_Prefix"
31425   },
31426   {
31427     "type": "get",
31428     "url": "/api/voice/prefixes/{id}/teams",
31429     "title": "Gets voice prefix team",
31430     "examples": [
31431       {
31432         "title": "Example usage:",
31433         "content": "curl https://{domain}/api/voice/prefixes/{id}/teams -v -u {name}:{password}  -X GET",
31434         "type": "json"
31435       }
31436     ],
31437     "name": "GetTeams",
31438     "group": "Voice_Prefix",
31439     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31440     "version": "0.0.0",
31441     "filename": "server/api/voicePrefix/index.js",
31442     "groupTitle": "Voice_Prefix"
31443   },
31444   {
31445     "type": "post",
31446     "url": "/api/voice/prefixes/{id}/users",
31447     "title": "Add agents to a prefix",
31448     "examples": [
31449       {
31450         "title": "Example usage:",
31451         "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",
31452         "type": "json"
31453       }
31454     ],
31455     "name": "AddAgents",
31456     "group": "Voice_Prefixes",
31457     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31458     "version": "0.0.0",
31459     "filename": "server/api/voicePrefix/index.js",
31460     "groupTitle": "Voice_Prefixes"
31461   },
31462   {
31463     "type": "delete",
31464     "url": "/api/voice/prefixes/{id}",
31465     "title": "Deletes a Prefix",
31466     "examples": [
31467       {
31468         "title": "Example usage:",
31469         "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X DELETE",
31470         "type": "json"
31471       }
31472     ],
31473     "name": "DeletePrefixes",
31474     "group": "Voice_Prefixes",
31475     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31476     "version": "0.0.0",
31477     "filename": "server/api/voicePrefix/index.js",
31478     "groupTitle": "Voice_Prefixes"
31479   },
31480   {
31481     "type": "get",
31482     "url": "/api/voice/prefixes/describe",
31483     "title": "Gets table info about Prefixes",
31484     "examples": [
31485       {
31486         "title": "Example usage:",
31487         "content": "curl https://{domain}/api/voice/prefixes/describe -v -u {name}:{password}",
31488         "type": "json"
31489       }
31490     ],
31491     "name": "DescribePrefixes",
31492     "group": "Voice_Prefixes",
31493     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31494     "version": "0.0.0",
31495     "filename": "server/api/voicePrefix/index.js",
31496     "groupTitle": "Voice_Prefixes"
31497   },
31498   {
31499     "type": "get",
31500     "url": "/api/voice/prefixes/{id}/users",
31501     "title": "Gets agents from prefix",
31502     "examples": [
31503       {
31504         "title": "Example usage:",
31505         "content": "curl https://{domain}/api/voice/prefixes/{id}/users -v -u {name}:{password} -X GET",
31506         "type": "json"
31507       }
31508     ],
31509     "name": "GetAgents",
31510     "group": "Voice_Prefixes",
31511     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31512     "version": "0.0.0",
31513     "filename": "server/api/voicePrefix/index.js",
31514     "groupTitle": "Voice_Prefixes"
31515   },
31516   {
31517     "type": "get",
31518     "url": "/api/voice/prefixes",
31519     "title": "Gets a list of Prefixes",
31520     "examples": [
31521       {
31522         "title": "Example usage:",
31523         "content": "curl https://{domain}/api/voice/prefixes -v -u {name}:{password}",
31524         "type": "json"
31525       }
31526     ],
31527     "name": "GetPrefixes",
31528     "group": "Voice_Prefixes",
31529     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31530     "version": "0.0.0",
31531     "filename": "server/api/voicePrefix/index.js",
31532     "groupTitle": "Voice_Prefixes"
31533   },
31534   {
31535     "type": "delete",
31536     "url": "/api/voice/prefixes/{id}/users",
31537     "title": "Removes agents from a prefix",
31538     "examples": [
31539       {
31540         "title": "Example usage:",
31541         "content": "curl https://{domain}/api/voice/prefixes/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
31542         "type": "json"
31543       }
31544     ],
31545     "name": "RemoveAgents",
31546     "group": "Voice_Prefixes",
31547     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31548     "version": "0.0.0",
31549     "filename": "server/api/voicePrefix/index.js",
31550     "groupTitle": "Voice_Prefixes"
31551   },
31552   {
31553     "type": "get",
31554     "url": "/api/voice/prefixes/{id}",
31555     "title": "Gets a single Prefix",
31556     "examples": [
31557       {
31558         "title": "Example usage:",
31559         "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password}",
31560         "type": "json"
31561       }
31562     ],
31563     "name": "ShowPrefixes",
31564     "group": "Voice_Prefixes",
31565     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31566     "version": "0.0.0",
31567     "filename": "server/api/voicePrefix/index.js",
31568     "groupTitle": "Voice_Prefixes"
31569   },
31570   {
31571     "type": "put",
31572     "url": "/api/voice/prefixes/{id}",
31573     "title": "Update an existing prefix",
31574     "examples": [
31575       {
31576         "title": "Example usage:",
31577         "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X PUT",
31578         "type": "json"
31579       }
31580     ],
31581     "name": "Update",
31582     "group": "Voice_Prefixes",
31583     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31584     "version": "0.0.0",
31585     "filename": "server/api/voicePrefix/index.js",
31586     "groupTitle": "Voice_Prefixes"
31587   },
31588   {
31589     "type": "post",
31590     "url": "/api/voice/prefixes",
31591     "title": "Create a prefix",
31592     "examples": [
31593       {
31594         "title": "Example usage:",
31595         "content": "curl https://{domain}/api/voice/prefixes -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31596         "type": "json"
31597       }
31598     ],
31599     "name": "create",
31600     "group": "Voice_Prefixes",
31601     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31602     "version": "0.0.0",
31603     "filename": "server/api/voicePrefix/index.js",
31604     "groupTitle": "Voice_Prefixes"
31605   },
31606   {
31607     "type": "get",
31608     "url": "/api/voice/queues/reports/describe",
31609     "title": "Gets table info about Queue Reports",
31610     "examples": [
31611       {
31612         "title": "Example usage:",
31613         "content": "curl https://{domain}/api/voice/queues/reports/describe -v -u {name}:{password}",
31614         "type": "json"
31615       }
31616     ],
31617     "name": "DescribeQueue_Reports",
31618     "group": "Voice_Queue_Reports",
31619     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31620     "version": "0.0.0",
31621     "filename": "server/api/voiceQueueReport/index.js",
31622     "groupTitle": "Voice_Queue_Reports"
31623   },
31624   {
31625     "type": "get",
31626     "url": "/api/voice/queues/reports",
31627     "title": "Gets a list of Queue Reports",
31628     "examples": [
31629       {
31630         "title": "Example usage:",
31631         "content": "curl https://{domain}/api/voice/queues/reports -v -u {name}:{password}",
31632         "type": "json"
31633       }
31634     ],
31635     "name": "GetQueue_Reports",
31636     "group": "Voice_Queue_Reports",
31637     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31638     "version": "0.0.0",
31639     "filename": "server/api/voiceQueueReport/index.js",
31640     "groupTitle": "Voice_Queue_Reports"
31641   },
31642   {
31643     "type": "get",
31644     "url": "/api/voice/queues/reports/{id}",
31645     "title": "Gets a single Queue Report",
31646     "examples": [
31647       {
31648         "title": "Example usage:",
31649         "content": "curl https://{domain}/api/voice/queues/reports/{id} -v -u {name}:{password}",
31650         "type": "json"
31651       }
31652     ],
31653     "name": "ShowQueue_Reports",
31654     "group": "Voice_Queue_Reports",
31655     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31656     "version": "0.0.0",
31657     "filename": "server/api/voiceQueueReport/index.js",
31658     "groupTitle": "Voice_Queue_Reports"
31659   },
31660   {
31661     "type": "get",
31662     "url": "/api/voice/queues/reports/index",
31663     "title": "Get Voice Queues Report",
31664     "examples": [
31665       {
31666         "title": "Example usage:",
31667         "content": "curl https://{domain}/api/voice/queues/reports/index -v -u {name}:{password} -X GET",
31668         "type": "json"
31669       }
31670     ],
31671     "name": "getVoiceQueuesReport",
31672     "group": "Voice_Queue_Reports",
31673     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31674     "version": "0.0.0",
31675     "filename": "server/api/voiceQueueReport/index.js",
31676     "groupTitle": "Voice_Queue_Reports"
31677   },
31678   {
31679     "type": "post",
31680     "url": "/api/voice/queues/{id}/users",
31681     "title": "Add agents to queue",
31682     "examples": [
31683       {
31684         "title": "Example usage:",
31685         "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",
31686         "type": "json"
31687       }
31688     ],
31689     "name": "AddAgents",
31690     "group": "Voice_Queues",
31691     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31692     "version": "0.0.0",
31693     "filename": "server/api/voiceQueue/index.js",
31694     "groupTitle": "Voice_Queues"
31695   },
31696   {
31697     "type": "post",
31698     "url": "/api/voice/queues/{id}/blacklists",
31699     "title": "Add blacklists to a queue",
31700     "examples": [
31701       {
31702         "title": "Example usage:",
31703         "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",
31704         "type": "json"
31705       }
31706     ],
31707     "name": "AddBlackLists",
31708     "group": "Voice_Queues",
31709     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31710     "version": "0.0.0",
31711     "filename": "server/api/voiceQueue/index.js",
31712     "groupTitle": "Voice_Queues"
31713   },
31714   {
31715     "type": "post",
31716     "url": "/api/voice/queues/{id}/lists",
31717     "title": "Add lists to a queue",
31718     "examples": [
31719       {
31720         "title": "Example usage:",
31721         "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",
31722         "type": "json"
31723       }
31724     ],
31725     "name": "AddLists",
31726     "group": "Voice_Queues",
31727     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31728     "version": "0.0.0",
31729     "filename": "server/api/voiceQueue/index.js",
31730     "groupTitle": "Voice_Queues"
31731   },
31732   {
31733     "type": "post",
31734     "url": "/api/voice/queues/{id}/teams",
31735     "title": "Add teams to queue",
31736     "examples": [
31737       {
31738         "title": "Example usage:",
31739         "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",
31740         "type": "json"
31741       }
31742     ],
31743     "name": "AddTeams",
31744     "group": "Voice_Queues",
31745     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31746     "version": "0.0.0",
31747     "filename": "server/api/voiceQueue/index.js",
31748     "groupTitle": "Voice_Queues"
31749   },
31750   {
31751     "type": "post",
31752     "url": "/api/voice/queues/clone",
31753     "title": "Clone an existing Queue",
31754     "examples": [
31755       {
31756         "title": "Example usage:",
31757         "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",
31758         "type": "json"
31759       }
31760     ],
31761     "name": "CloneQueues",
31762     "group": "Voice_Queues",
31763     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31764     "version": "0.0.0",
31765     "filename": "server/api/voiceQueue/index.js",
31766     "groupTitle": "Voice_Queues"
31767   },
31768   {
31769     "type": "post",
31770     "url": "/api/voice/queues",
31771     "title": "Creates a new Queue",
31772     "examples": [
31773       {
31774         "title": "Example usage:",
31775         "content": "curl https://{domain}/api/voice/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
31776         "type": "json"
31777       }
31778     ],
31779     "name": "CreateQueues",
31780     "group": "Voice_Queues",
31781     "parameter": {
31782       "fields": {
31783         "Body": [
31784           {
31785             "group": "Body",
31786             "type": "String",
31787             "optional": false,
31788             "field": "name",
31789             "description": ""
31790           },
31791           {
31792             "group": "Body",
31793             "type": "String",
31794             "allowedValues": [
31795               "\"inbound\"",
31796               "\"outbound\""
31797             ],
31798             "optional": false,
31799             "field": "type",
31800             "description": ""
31801           },
31802           {
31803             "group": "Body",
31804             "type": "String",
31805             "optional": true,
31806             "field": "musiconhold",
31807             "description": ""
31808           },
31809           {
31810             "group": "Body",
31811             "type": "String",
31812             "optional": true,
31813             "field": "announce",
31814             "description": ""
31815           },
31816           {
31817             "group": "Body",
31818             "type": "String",
31819             "allowedValues": [
31820               "\"rr\"",
31821               "\"ringall\"",
31822               "\"leastrecent\"",
31823               "\"fewestcalls\"",
31824               "\"random\"",
31825               "\"rrmemory\"",
31826               "\"linear\"",
31827               "\"wrandom\"",
31828               "\"rrordered\""
31829             ],
31830             "optional": false,
31831             "field": "strategy",
31832             "description": ""
31833           },
31834           {
31835             "group": "Body",
31836             "type": "Integer",
31837             "optional": true,
31838             "field": "servicelevel",
31839             "description": ""
31840           },
31841           {
31842             "group": "Body",
31843             "type": "String",
31844             "optional": true,
31845             "field": "context",
31846             "description": ""
31847           },
31848           {
31849             "group": "Body",
31850             "type": "Integer",
31851             "optional": true,
31852             "field": "penaltymemberslimit",
31853             "description": ""
31854           },
31855           {
31856             "group": "Body",
31857             "type": "Integer",
31858             "optional": true,
31859             "field": "timeout",
31860             "description": ""
31861           },
31862           {
31863             "group": "Body",
31864             "type": "Integer",
31865             "optional": true,
31866             "field": "retry",
31867             "description": ""
31868           },
31869           {
31870             "group": "Body",
31871             "type": "String",
31872             "optional": true,
31873             "field": "timeoutpriority",
31874             "description": ""
31875           },
31876           {
31877             "group": "Body",
31878             "type": "Integer",
31879             "optional": true,
31880             "field": "weight",
31881             "description": ""
31882           },
31883           {
31884             "group": "Body",
31885             "type": "Integer",
31886             "optional": true,
31887             "field": "wrapuptime",
31888             "description": ""
31889           },
31890           {
31891             "group": "Body",
31892             "type": "String",
31893             "allowedValues": [
31894               "\"yes\"",
31895               "\"no\""
31896             ],
31897             "optional": true,
31898             "field": "autofill",
31899             "description": ""
31900           },
31901           {
31902             "group": "Body",
31903             "type": "String",
31904             "allowedValues": [
31905               "\"yes\"",
31906               "\"no\"",
31907               "\"all\""
31908             ],
31909             "optional": true,
31910             "field": "autopause",
31911             "description": ""
31912           },
31913           {
31914             "group": "Body",
31915             "type": "Integer",
31916             "optional": true,
31917             "field": "autopausedelay",
31918             "description": ""
31919           },
31920           {
31921             "group": "Body",
31922             "type": "String",
31923             "allowedValues": [
31924               "\"yes\"",
31925               "\"no\""
31926             ],
31927             "optional": true,
31928             "field": "autopausebusy",
31929             "description": ""
31930           },
31931           {
31932             "group": "Body",
31933             "type": "String",
31934             "allowedValues": [
31935               "\"yes\"",
31936               "\"no\""
31937             ],
31938             "optional": true,
31939             "field": "autopauseunavail",
31940             "description": ""
31941           },
31942           {
31943             "group": "Body",
31944             "type": "Integer",
31945             "optional": true,
31946             "field": "maxlen",
31947             "description": ""
31948           },
31949           {
31950             "group": "Body",
31951             "type": "String",
31952             "allowedValues": [
31953               "\"yes\"",
31954               "\"no\""
31955             ],
31956             "optional": true,
31957             "field": "setinterfacevar",
31958             "description": ""
31959           },
31960           {
31961             "group": "Body",
31962             "type": "String",
31963             "allowedValues": [
31964               "\"yes\"",
31965               "\"no\""
31966             ],
31967             "optional": true,
31968             "field": "setqueueentryvar",
31969             "description": ""
31970           },
31971           {
31972             "group": "Body",
31973             "type": "String",
31974             "allowedValues": [
31975               "\"yes\"",
31976               "\"no\""
31977             ],
31978             "optional": true,
31979             "field": "setqueuevar",
31980             "description": ""
31981           },
31982           {
31983             "group": "Body",
31984             "type": "String",
31985             "allowedValues": [
31986               "\"yes\"",
31987               "\"no\""
31988             ],
31989             "optional": true,
31990             "field": "eventmemberstatus",
31991             "description": ""
31992           },
31993           {
31994             "group": "Body",
31995             "type": "String",
31996             "optional": true,
31997             "field": "membermacro",
31998             "description": ""
31999           },
32000           {
32001             "group": "Body",
32002             "type": "String",
32003             "optional": true,
32004             "field": "membergosub",
32005             "description": ""
32006           },
32007           {
32008             "group": "Body",
32009             "type": "Integer",
32010             "optional": true,
32011             "field": "announce_frequency",
32012             "description": ""
32013           },
32014           {
32015             "group": "Body",
32016             "type": "Integer",
32017             "optional": true,
32018             "field": "min_announce_frequency",
32019             "description": ""
32020           },
32021           {
32022             "group": "Body",
32023             "type": "Integer",
32024             "optional": true,
32025             "field": "periodic_announce_frequency",
32026             "description": ""
32027           },
32028           {
32029             "group": "Body",
32030             "type": "String",
32031             "allowedValues": [
32032               "\"yes\"",
32033               "\"no\""
32034             ],
32035             "optional": true,
32036             "field": "random_periodic_announce",
32037             "description": ""
32038           },
32039           {
32040             "group": "Body",
32041             "type": "String",
32042             "allowedValues": [
32043               "\"yes\"",
32044               "\"no\""
32045             ],
32046             "optional": true,
32047             "field": "relative_periodic_announce",
32048             "description": ""
32049           },
32050           {
32051             "group": "Body",
32052             "type": "String",
32053             "allowedValues": [
32054               "\"yes\"",
32055               "\"no\"",
32056               "\"once\""
32057             ],
32058             "optional": true,
32059             "field": "announce_holdtime",
32060             "description": ""
32061           },
32062           {
32063             "group": "Body",
32064             "type": "String",
32065             "optional": true,
32066             "field": "announce_position",
32067             "description": ""
32068           },
32069           {
32070             "group": "Body",
32071             "type": "String",
32072             "allowedValues": [
32073               "\"yes\"",
32074               "\"no\""
32075             ],
32076             "optional": true,
32077             "field": "announce_to_first_user",
32078             "description": ""
32079           },
32080           {
32081             "group": "Body",
32082             "type": "Integer",
32083             "optional": true,
32084             "field": "announce_position_limit",
32085             "description": ""
32086           },
32087           {
32088             "group": "Body",
32089             "type": "String",
32090             "allowedValues": [
32091               "\"0\"",
32092               "\"5\"",
32093               "\"10\"",
32094               "\"15\"",
32095               "\"20\"",
32096               "\"30\""
32097             ],
32098             "optional": true,
32099             "field": "announce_round_seconds",
32100             "description": ""
32101           },
32102           {
32103             "group": "Body",
32104             "type": "String",
32105             "optional": true,
32106             "field": "monitor_format",
32107             "description": ""
32108           },
32109           {
32110             "group": "Body",
32111             "type": "String",
32112             "optional": true,
32113             "field": "monitor_type",
32114             "description": ""
32115           },
32116           {
32117             "group": "Body",
32118             "type": "String",
32119             "optional": true,
32120             "field": "queue_youarenext",
32121             "description": ""
32122           },
32123           {
32124             "group": "Body",
32125             "type": "String",
32126             "optional": true,
32127             "field": "queue_thereare",
32128             "description": ""
32129           },
32130           {
32131             "group": "Body",
32132             "type": "String",
32133             "optional": true,
32134             "field": "queue_callswaiting",
32135             "description": ""
32136           },
32137           {
32138             "group": "Body",
32139             "type": "String",
32140             "optional": true,
32141             "field": "queue_holdtime",
32142             "description": ""
32143           },
32144           {
32145             "group": "Body",
32146             "type": "String",
32147             "optional": true,
32148             "field": "queue_minute",
32149             "description": ""
32150           },
32151           {
32152             "group": "Body",
32153             "type": "String",
32154             "optional": true,
32155             "field": "queue_minutes",
32156             "description": ""
32157           },
32158           {
32159             "group": "Body",
32160             "type": "String",
32161             "optional": true,
32162             "field": "queue_seconds",
32163             "description": ""
32164           },
32165           {
32166             "group": "Body",
32167             "type": "String",
32168             "optional": true,
32169             "field": "queue_thankyou",
32170             "description": ""
32171           },
32172           {
32173             "group": "Body",
32174             "type": "String",
32175             "optional": true,
32176             "field": "queue_reporthold",
32177             "description": ""
32178           },
32179           {
32180             "group": "Body",
32181             "type": "String",
32182             "optional": true,
32183             "field": "queue_quantity1",
32184             "description": ""
32185           },
32186           {
32187             "group": "Body",
32188             "type": "String",
32189             "optional": true,
32190             "field": "queue_quantity2",
32191             "description": ""
32192           },
32193           {
32194             "group": "Body",
32195             "type": "String",
32196             "optional": true,
32197             "field": "queue_periodic_announce",
32198             "description": ""
32199           },
32200           {
32201             "group": "Body",
32202             "type": "String",
32203             "optional": true,
32204             "field": "queue_less_than",
32205             "description": ""
32206           },
32207           {
32208             "group": "Body",
32209             "type": "Text",
32210             "optional": true,
32211             "field": "periodic_announce",
32212             "description": ""
32213           },
32214           {
32215             "group": "Body",
32216             "type": "String",
32217             "optional": true,
32218             "field": "joinempty",
32219             "description": ""
32220           },
32221           {
32222             "group": "Body",
32223             "type": "String",
32224             "optional": true,
32225             "field": "leavewhenempty",
32226             "description": ""
32227           },
32228           {
32229             "group": "Body",
32230             "type": "String",
32231             "allowedValues": [
32232               "\"yes\"",
32233               "\"no\""
32234             ],
32235             "optional": true,
32236             "field": "reportholdtime",
32237             "description": ""
32238           },
32239           {
32240             "group": "Body",
32241             "type": "String",
32242             "allowedValues": [
32243               "\"yes\"",
32244               "\"no\""
32245             ],
32246             "optional": true,
32247             "field": "ringinuse",
32248             "description": ""
32249           },
32250           {
32251             "group": "Body",
32252             "type": "Integer",
32253             "optional": true,
32254             "field": "memberdelay",
32255             "description": ""
32256           },
32257           {
32258             "group": "Body",
32259             "type": "String",
32260             "allowedValues": [
32261               "\"yes\"",
32262               "\"no\""
32263             ],
32264             "optional": true,
32265             "field": "timeoutrestart",
32266             "description": ""
32267           },
32268           {
32269             "group": "Body",
32270             "type": "String",
32271             "optional": true,
32272             "field": "defaultrule",
32273             "description": ""
32274           },
32275           {
32276             "group": "Body",
32277             "type": "String",
32278             "optional": true,
32279             "field": "description",
32280             "description": ""
32281           },
32282           {
32283             "group": "Body",
32284             "type": "Boolean",
32285             "optional": true,
32286             "field": "acw",
32287             "description": ""
32288           },
32289           {
32290             "group": "Body",
32291             "type": "Integer",
32292             "optional": true,
32293             "field": "acwTimeout",
32294             "description": ""
32295           },
32296           {
32297             "group": "Body",
32298             "type": "Boolean",
32299             "optional": true,
32300             "field": "dialActive",
32301             "description": "<p>Active/Disactive Campaign</p>"
32302           },
32303           {
32304             "group": "Body",
32305             "type": "String",
32306             "allowedValues": [
32307               "\"preview\"",
32308               "\"progressive\"",
32309               "\"power\"",
32310               "\"predictive\"",
32311               "\"booked\""
32312             ],
32313             "optional": true,
32314             "field": "dialMethod",
32315             "description": "<p>Dial Method.</p>"
32316           },
32317           {
32318             "group": "Body",
32319             "type": "Integer",
32320             "optional": true,
32321             "field": "dialLimitChannel",
32322             "description": "<p>Max 9999 channels, 0 means unlimited.</p>"
32323           },
32324           {
32325             "group": "Body",
32326             "type": "Integer",
32327             "optional": true,
32328             "field": "dialLimitQueue",
32329             "description": "<p>Max 9999 member in queue(min:1, max:9999), 0 means unlimited.</p>"
32330           },
32331           {
32332             "group": "Body",
32333             "type": "Float",
32334             "optional": true,
32335             "field": "dialPowerLevel",
32336             "description": "<p>Power Level: Calls for agents (min:1, max:10).</p>"
32337           },
32338           {
32339             "group": "Body",
32340             "type": "String",
32341             "allowedValues": [
32342               "\"agentBusyFactor\"",
32343               "\"dropRate\""
32344             ],
32345             "optional": true,
32346             "field": "dialPredictiveOptimization",
32347             "description": "<p>Only for predictive method.</p>"
32348           },
32349           {
32350             "group": "Body",
32351             "type": "Float",
32352             "optional": true,
32353             "field": "dialPredictiveOptimizationPercentage",
32354             "description": "<p>Predictive Optimization Percentage (min: 1, max: 95)</p>"
32355           },
32356           {
32357             "group": "Body",
32358             "type": "Integer",
32359             "optional": true,
32360             "field": "dialPredictiveInterval",
32361             "description": "<p>Interval Predictive Minutes (min:5 max:30)</p>"
32362           },
32363           {
32364             "group": "Body",
32365             "type": "String",
32366             "optional": true,
32367             "field": "dialOriginateCallerIdName",
32368             "description": ""
32369           },
32370           {
32371             "group": "Body",
32372             "type": "String",
32373             "optional": true,
32374             "field": "dialOriginateCallerIdNumber",
32375             "description": ""
32376           },
32377           {
32378             "group": "Body",
32379             "type": "Integer",
32380             "optional": true,
32381             "field": "dialOriginateTimeout",
32382             "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
32383           },
32384           {
32385             "group": "Body",
32386             "type": "String",
32387             "optional": true,
32388             "field": "dialQueueOptions",
32389             "description": "<p>https://wiki.asterisk.org/wiki/display/AST/Asterisk+13+Application_Queue</p>"
32390           },
32391           {
32392             "group": "Body",
32393             "type": "Integer",
32394             "optional": true,
32395             "field": "dialQueueTimeout",
32396             "description": "<p>Queue Timeout Seconds (min:1, max:999)</p>"
32397           },
32398           {
32399             "group": "Body",
32400             "type": "String",
32401             "optional": true,
32402             "field": "dialQueueProject",
32403             "description": "<p>AGI queue option (use: agi://127.0.0.1/square,&lt;project_name&gt;)</p>"
32404           },
32405           {
32406             "group": "Body",
32407             "type": "Integer",
32408             "optional": true,
32409             "field": "dialCongestionMaxRetry",
32410             "description": "<p>#Congestion Retry (min:1, max:999)</p>"
32411           },
32412           {
32413             "group": "Body",
32414             "type": "Integer",
32415             "optional": true,
32416             "field": "dialCongestionRetryFrequency",
32417             "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
32418           },
32419           {
32420             "group": "Body",
32421             "type": "Integer",
32422             "optional": true,
32423             "field": "dialBusyMaxRetry",
32424             "description": "<p>#Busy Retry (min:1, max:999)</p>"
32425           },
32426           {
32427             "group": "Body",
32428             "type": "Integer",
32429             "optional": true,
32430             "field": "dialBusyRetryFrequency",
32431             "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
32432           },
32433           {
32434             "group": "Body",
32435             "type": "Integer",
32436             "optional": true,
32437             "field": "dialNoAnswerMaxRetry",
32438             "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
32439           },
32440           {
32441             "group": "Body",
32442             "type": "Integer",
32443             "optional": true,
32444             "field": "dialNoAnswerRetryFrequency",
32445             "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
32446           },
32447           {
32448             "group": "Body",
32449             "type": "Integer",
32450             "optional": true,
32451             "field": "dialGlobalMaxRetry",
32452             "description": "<p>#Global Max Retry (min:1, max:999)</p>"
32453           },
32454           {
32455             "group": "Body",
32456             "type": "String",
32457             "optional": true,
32458             "field": "dialTimezone",
32459             "description": ""
32460           },
32461           {
32462             "group": "Body",
32463             "type": "String",
32464             "optional": true,
32465             "field": "dialGlobalInterval",
32466             "description": ""
32467           },
32468           {
32469             "group": "Body",
32470             "type": "String",
32471             "optional": true,
32472             "field": "dialPrefix",
32473             "description": ""
32474           },
32475           {
32476             "group": "Body",
32477             "type": "String",
32478             "allowedValues": [
32479               "\"always\"",
32480               "\"never\"",
32481               "\"onlyIfOpen\""
32482             ],
32483             "optional": true,
32484             "field": "dialCheckDuplicateType",
32485             "description": ""
32486           },
32487           {
32488             "group": "Body",
32489             "type": "Boolean",
32490             "optional": true,
32491             "field": "dialAMDActive",
32492             "description": "<p>Active/Disactive AMD</p>"
32493           },
32494           {
32495             "group": "Body",
32496             "type": "Integer",
32497             "optional": true,
32498             "field": "dialAMDInitialSilence",
32499             "description": "<p>#AMD Initial Silence</p>"
32500           },
32501           {
32502             "group": "Body",
32503             "type": "Integer",
32504             "optional": true,
32505             "field": "dialAMDGreeting",
32506             "description": "<p>#AMD Greeting</p>"
32507           },
32508           {
32509             "group": "Body",
32510             "type": "Integer",
32511             "optional": true,
32512             "field": "dialAMDAfterGreetingSilence",
32513             "description": "<p>#AMD After Greeting Silence</p>"
32514           },
32515           {
32516             "group": "Body",
32517             "type": "Integer",
32518             "optional": true,
32519             "field": "dialAMDTotalAnalysisTime",
32520             "description": "<p>#AMD Total Analysis Time</p>"
32521           },
32522           {
32523             "group": "Body",
32524             "type": "Integer",
32525             "optional": true,
32526             "field": "dialAMDMinWordLength",
32527             "description": "<p>#AMD Min Word Length</p>"
32528           },
32529           {
32530             "group": "Body",
32531             "type": "Integer",
32532             "optional": true,
32533             "field": "dialAMDBetweenWordsSilence",
32534             "description": "<p>#AMD Between Words Silence</p>"
32535           },
32536           {
32537             "group": "Body",
32538             "type": "Integer",
32539             "optional": true,
32540             "field": "dialAMDMaximumNumberOfWords",
32541             "description": "<p>#AMD Maximum Number Of Words</p>"
32542           },
32543           {
32544             "group": "Body",
32545             "type": "Integer",
32546             "optional": true,
32547             "field": "dialAMDSilenceThreshold",
32548             "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
32549           },
32550           {
32551             "group": "Body",
32552             "type": "Integer",
32553             "optional": true,
32554             "field": "dialAMDMaximumWordLength",
32555             "description": "<p>#AMD Maximum Word Length</p>"
32556           },
32557           {
32558             "group": "Body",
32559             "type": "Integer",
32560             "optional": true,
32561             "field": "dialRecallMeTimeout",
32562             "description": "<p>#RecallMe Timeout (min:1)</p>"
32563           },
32564           {
32565             "group": "Body",
32566             "type": "Boolean",
32567             "optional": true,
32568             "field": "dialRecallInQueue",
32569             "description": "<p>Active/Disactive Recall In Queue</p>"
32570           },
32571           {
32572             "group": "Body",
32573             "type": "String",
32574             "allowedValues": [
32575               "\"DESC\"",
32576               "\"ASC\""
32577             ],
32578             "optional": true,
32579             "field": "dialOrderByScheduledAt",
32580             "description": ""
32581           },
32582           {
32583             "group": "Body",
32584             "type": "String",
32585             "optional": true,
32586             "field": "dialQueueProject2",
32587             "description": "<p>AGI queue option (use: agi://127.0.0.1/square,&lt;project_name&gt;)</p>"
32588           },
32589           {
32590             "group": "Body",
32591             "type": "Boolean",
32592             "optional": true,
32593             "field": "dialAgiAfterHangupClient",
32594             "description": ""
32595           },
32596           {
32597             "group": "Body",
32598             "type": "Boolean",
32599             "optional": true,
32600             "field": "dialAgiAfterHangupAgent",
32601             "description": ""
32602           },
32603           {
32604             "group": "Body",
32605             "type": "Integer",
32606             "optional": true,
32607             "field": "dialRandomLastDigitCallerIdNumber",
32608             "description": "<p>Random Last Digit (min:1, max:15)</p>"
32609           },
32610           {
32611             "group": "Body",
32612             "type": "Integer",
32613             "optional": true,
32614             "field": "dialCutDigit",
32615             "description": "<p>Cut Digit (min:1, max:15)</p>"
32616           },
32617           {
32618             "group": "Body",
32619             "type": "Integer",
32620             "optional": true,
32621             "field": "dialNoSuchNumberMaxRetry",
32622             "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
32623           },
32624           {
32625             "group": "Body",
32626             "type": "Integer",
32627             "optional": true,
32628             "field": "dialNoSuchNumberRetryFrequency",
32629             "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
32630           },
32631           {
32632             "group": "Body",
32633             "type": "Integer",
32634             "optional": true,
32635             "field": "dialDropMaxRetry",
32636             "description": "<p>#Drop Retry (min:1, max:999)</p>"
32637           },
32638           {
32639             "group": "Body",
32640             "type": "Integer",
32641             "optional": true,
32642             "field": "dialDropRetryFrequency",
32643             "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
32644           },
32645           {
32646             "group": "Body",
32647             "type": "Integer",
32648             "optional": true,
32649             "field": "dialAbandonedMaxRetry",
32650             "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
32651           },
32652           {
32653             "group": "Body",
32654             "type": "Integer",
32655             "optional": true,
32656             "field": "dialAbandonedRetryFrequency",
32657             "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
32658           },
32659           {
32660             "group": "Body",
32661             "type": "Integer",
32662             "optional": true,
32663             "field": "dialMachineMaxRetry",
32664             "description": "<p>#Machine Retry (min:1, max:999)</p>"
32665           },
32666           {
32667             "group": "Body",
32668             "type": "Integer",
32669             "optional": true,
32670             "field": "dialMachineRetryFrequency",
32671             "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
32672           },
32673           {
32674             "group": "Body",
32675             "type": "Integer",
32676             "optional": true,
32677             "field": "dialAgentRejectMaxRetry",
32678             "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
32679           },
32680           {
32681             "group": "Body",
32682             "type": "Integer",
32683             "optional": true,
32684             "field": "dialAgentRejectRetryFrequency",
32685             "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
32686           },
32687           {
32688             "group": "Body",
32689             "type": "Integer",
32690             "optional": true,
32691             "field": "mandatoryDispositionPauseId",
32692             "description": "<p>Status to put when mandatory disposition is enabled</p>"
32693           },
32694           {
32695             "group": "Body",
32696             "type": "Boolean",
32697             "optional": true,
32698             "field": "mandatoryDisposition",
32699             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
32700           },
32701           {
32702             "group": "Body",
32703             "type": "Integer",
32704             "optional": true,
32705             "field": "dialPredictiveIntervalMaxThreshold",
32706             "description": ""
32707           },
32708           {
32709             "group": "Body",
32710             "type": "Integer",
32711             "optional": true,
32712             "field": "dialPredictiveIntervalMinThreshold",
32713             "description": ""
32714           }
32715         ]
32716       }
32717     },
32718     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32719     "version": "0.0.0",
32720     "filename": "server/api/voiceQueue/index.js",
32721     "groupTitle": "Voice_Queues"
32722   },
32723   {
32724     "type": "delete",
32725     "url": "/api/voice/queues/{id}",
32726     "title": "Deletes a Queue",
32727     "examples": [
32728       {
32729         "title": "Example usage:",
32730         "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password} -X DELETE",
32731         "type": "json"
32732       }
32733     ],
32734     "name": "DeleteQueues",
32735     "group": "Voice_Queues",
32736     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32737     "version": "0.0.0",
32738     "filename": "server/api/voiceQueue/index.js",
32739     "groupTitle": "Voice_Queues"
32740   },
32741   {
32742     "type": "get",
32743     "url": "/api/voice/queues/{id}/users",
32744     "title": "Gets queue agents",
32745     "examples": [
32746       {
32747         "title": "Example usage:",
32748         "content": "curl https://{domain}/api/voice/queues/{id}/users -v -u {name}:{password} -X GET",
32749         "type": "json"
32750       }
32751     ],
32752     "name": "GetAgents",
32753     "group": "Voice_Queues",
32754     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32755     "version": "0.0.0",
32756     "filename": "server/api/voiceQueue/index.js",
32757     "groupTitle": "Voice_Queues"
32758   },
32759   {
32760     "type": "get",
32761     "url": "/api/voice/queues/{id}/blacklists",
32762     "title": "Get queue blacklists",
32763     "examples": [
32764       {
32765         "title": "Example usage:",
32766         "content": "curl https://{domain}/api/voice/queues/{id}/blacklists -v -u {name}:{password} -X GET",
32767         "type": "json"
32768       }
32769     ],
32770     "name": "GetBlackLists",
32771     "group": "Voice_Queues",
32772     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32773     "version": "0.0.0",
32774     "filename": "server/api/voiceQueue/index.js",
32775     "groupTitle": "Voice_Queues"
32776   },
32777   {
32778     "type": "get",
32779     "url": "/api/voice/queues/{id}/finals",
32780     "title": "Gets queue hopper finals",
32781     "examples": [
32782       {
32783         "title": "Example usage:",
32784         "content": "curl https://{domain}/api/voice/queues/{id}/hopper_finals -v -u {name}:{password}  -X GET",
32785         "type": "json"
32786       }
32787     ],
32788     "name": "GetHopperFinals",
32789     "group": "Voice_Queues",
32790     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32791     "version": "0.0.0",
32792     "filename": "server/api/voiceQueue/index.js",
32793     "groupTitle": "Voice_Queues"
32794   },
32795   {
32796     "type": "get",
32797     "url": "/api/voice/queues/{id}/hopper_histories",
32798     "title": "Gets queue hopper histories",
32799     "examples": [
32800       {
32801         "title": "Example usage:",
32802         "content": "curl https://{domain}/api/voice/queues/{id}/hopper_histories -v -u {name}:{password} -X GET",
32803         "type": "json"
32804       }
32805     ],
32806     "name": "GetHopperHistories",
32807     "group": "Voice_Queues",
32808     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32809     "version": "0.0.0",
32810     "filename": "server/api/voiceQueue/index.js",
32811     "groupTitle": "Voice_Queues"
32812   },
32813   {
32814     "type": "get",
32815     "url": "/api/voice/queues/{id}/hoppers",
32816     "title": "Gets queue hoppers",
32817     "examples": [
32818       {
32819         "title": "Example usage:",
32820         "content": "curl https://{domain}/api/voice/queues/{id}/hoppers -v -u {name}:{password} -X GET",
32821         "type": "json"
32822       }
32823     ],
32824     "name": "GetHoppers",
32825     "group": "Voice_Queues",
32826     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32827     "version": "0.0.0",
32828     "filename": "server/api/voiceQueue/index.js",
32829     "groupTitle": "Voice_Queues"
32830   },
32831   {
32832     "type": "get",
32833     "url": "/api/voice/queues/{id}/lists",
32834     "title": "Get queue lists",
32835     "examples": [
32836       {
32837         "title": "Example usage:",
32838         "content": "curl https://{domain}/api/voice/queues/{id}/lists -v -u {name}:{password} -X GET",
32839         "type": "json"
32840       }
32841     ],
32842     "name": "GetLists",
32843     "group": "Voice_Queues",
32844     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32845     "version": "0.0.0",
32846     "filename": "server/api/voiceQueue/index.js",
32847     "groupTitle": "Voice_Queues"
32848   },
32849   {
32850     "type": "get",
32851     "url": "/api/voice/queues/{id}/members",
32852     "title": "Gets queue members",
32853     "examples": [
32854       {
32855         "title": "Example usage:",
32856         "content": "curl https://{domain}/api/voice/queues/{id}/members -v -u {name}:{password} -X GET",
32857         "type": "json"
32858       }
32859     ],
32860     "name": "GetMembers",
32861     "group": "Voice_Queues",
32862     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32863     "version": "0.0.0",
32864     "filename": "server/api/voiceQueue/index.js",
32865     "groupTitle": "Voice_Queues"
32866   },
32867   {
32868     "type": "get",
32869     "url": "/api/voice/queues",
32870     "title": "Gets a list of Queues",
32871     "examples": [
32872       {
32873         "title": "Example usage:",
32874         "content": "curl https://{domain}/api/voice/queues -v -u {name}:{password}",
32875         "type": "json"
32876       }
32877     ],
32878     "name": "GetQueues",
32879     "group": "Voice_Queues",
32880     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
32881     "version": "0.0.0",
32882     "filename": "server/api/voiceQueue/index.js",
32883     "groupTitle": "Voice_Queues"
32884   },
32885   {
32886     "type": "get",
32887     "url": "/api/voice/queues/{id}/teams",
32888     "title": "Gets queue team",
32889     "examples": [
32890       {
32891         "title": "Example usage:",
32892         "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password}  -X GET",
32893         "type": "json"
32894       }
32895     ],
32896     "name": "GetTeams",
32897     "group": "Voice_Queues",
32898     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32899     "version": "0.0.0",
32900     "filename": "server/api/voiceQueue/index.js",
32901     "groupTitle": "Voice_Queues"
32902   },
32903   {
32904     "type": "delete",
32905     "url": "/api/voice/queues/{id}/users",
32906     "title": "Removes agents from a queue",
32907     "examples": [
32908       {
32909         "title": "Example usage:",
32910         "content": "curl https://{domain}/api/voice/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32911         "type": "json"
32912       }
32913     ],
32914     "name": "RemoveAgents",
32915     "group": "Voice_Queues",
32916     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32917     "version": "0.0.0",
32918     "filename": "server/api/voiceQueue/index.js",
32919     "groupTitle": "Voice_Queues"
32920   },
32921   {
32922     "type": "delete",
32923     "url": "/api/voice/queues/{id}/blacklists",
32924     "title": "Remove blacklists from a queue",
32925     "examples": [
32926       {
32927         "title": "Example usage:",
32928         "content": "curl https://{domain}/api/voice/queues/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32929         "type": "json"
32930       }
32931     ],
32932     "name": "RemoveBlackLists",
32933     "group": "Voice_Queues",
32934     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32935     "version": "0.0.0",
32936     "filename": "server/api/voiceQueue/index.js",
32937     "groupTitle": "Voice_Queues"
32938   },
32939   {
32940     "type": "delete",
32941     "url": "/api/voice/queues/{id}/lists",
32942     "title": "Remove lists from a queue",
32943     "examples": [
32944       {
32945         "title": "Example usage:",
32946         "content": "curl https://{domain}/api/voice/queues/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32947         "type": "json"
32948       }
32949     ],
32950     "name": "RemoveLists",
32951     "group": "Voice_Queues",
32952     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32953     "version": "0.0.0",
32954     "filename": "server/api/voiceQueue/index.js",
32955     "groupTitle": "Voice_Queues"
32956   },
32957   {
32958     "type": "get",
32959     "url": "/api/voice/queues/{id}",
32960     "title": "Gets a single Queue",
32961     "examples": [
32962       {
32963         "title": "Example usage:",
32964         "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password}",
32965         "type": "json"
32966       }
32967     ],
32968     "name": "ShowQueues",
32969     "group": "Voice_Queues",
32970     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32971     "version": "0.0.0",
32972     "filename": "server/api/voiceQueue/index.js",
32973     "groupTitle": "Voice_Queues"
32974   },
32975   {
32976     "type": "get",
32977     "url": "/api/voice/queues/{id}/blacks",
32978     "title": "Gets queue hopper blacks",
32979     "examples": [
32980       {
32981         "title": "Example usage:",
32982         "content": "curl https://{domain}/api/voice/queues/{id}/hopper_black -v -u {name}:{password}  -X GET",
32983         "type": "json"
32984       }
32985     ],
32986     "name": "getHopperBlacks",
32987     "group": "Voice_Queues",
32988     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32989     "version": "0.0.0",
32990     "filename": "server/api/voiceQueue/index.js",
32991     "groupTitle": "Voice_Queues"
32992   },
32993   {
32994     "type": "put",
32995     "url": "/api/voice/queues/{id}",
32996     "title": "Update an existing Queue",
32997     "examples": [
32998       {
32999         "title": "Example usage:",
33000         "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",
33001         "type": "json"
33002       }
33003     ],
33004     "name": "updateQueues",
33005     "group": "Voice_Queues",
33006     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33007     "version": "0.0.0",
33008     "filename": "server/api/voiceQueue/index.js",
33009     "groupTitle": "Voice_Queues"
33010   },
33011   {
33012     "type": "post",
33013     "url": "/api/voice/recordings",
33014     "title": "Creates a new Recording",
33015     "examples": [
33016       {
33017         "title": "Example usage:",
33018         "content": "curl https://{domain}/api/voice/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
33019         "type": "json"
33020       }
33021     ],
33022     "name": "CreateRecordings",
33023     "group": "Voice_Recordings",
33024     "parameter": {
33025       "fields": {
33026         "Body": [
33027           {
33028             "group": "Body",
33029             "type": "Virtual",
33030             "optional": true,
33031             "field": "format",
33032             "description": ""
33033           },
33034           {
33035             "group": "Body",
33036             "type": "String",
33037             "optional": true,
33038             "field": "uniqueid",
33039             "description": ""
33040           },
33041           {
33042             "group": "Body",
33043             "type": "String",
33044             "optional": true,
33045             "field": "channel",
33046             "description": ""
33047           },
33048           {
33049             "group": "Body",
33050             "type": "String",
33051             "optional": true,
33052             "field": "membername",
33053             "description": ""
33054           },
33055           {
33056             "group": "Body",
33057             "type": "String",
33058             "optional": true,
33059             "field": "calleridnum",
33060             "description": ""
33061           },
33062           {
33063             "group": "Body",
33064             "type": "String",
33065             "optional": true,
33066             "field": "calleridname",
33067             "description": ""
33068           },
33069           {
33070             "group": "Body",
33071             "type": "String",
33072             "optional": true,
33073             "field": "connectedlinenum",
33074             "description": ""
33075           },
33076           {
33077             "group": "Body",
33078             "type": "String",
33079             "optional": true,
33080             "field": "connectedlinename",
33081             "description": ""
33082           },
33083           {
33084             "group": "Body",
33085             "type": "String",
33086             "optional": true,
33087             "field": "accountcode",
33088             "description": ""
33089           },
33090           {
33091             "group": "Body",
33092             "type": "String",
33093             "optional": true,
33094             "field": "context",
33095             "description": ""
33096           },
33097           {
33098             "group": "Body",
33099             "type": "String",
33100             "optional": true,
33101             "field": "exten",
33102             "description": ""
33103           },
33104           {
33105             "group": "Body",
33106             "type": "String",
33107             "optional": true,
33108             "field": "value",
33109             "description": ""
33110           },
33111           {
33112             "group": "Body",
33113             "type": "String",
33114             "optional": true,
33115             "field": "type",
33116             "description": ""
33117           },
33118           {
33119             "group": "Body",
33120             "type": "Integer",
33121             "optional": true,
33122             "field": "rating",
33123             "description": ""
33124           },
33125           {
33126             "group": "Body",
33127             "type": "String",
33128             "optional": true,
33129             "field": "queue",
33130             "description": ""
33131           },
33132           {
33133             "group": "Body",
33134             "type": "String",
33135             "optional": true,
33136             "field": "userDisposition",
33137             "description": ""
33138           },
33139           {
33140             "group": "Body",
33141             "type": "String",
33142             "optional": true,
33143             "field": "userSecondDisposition",
33144             "description": ""
33145           },
33146           {
33147             "group": "Body",
33148             "type": "String",
33149             "optional": true,
33150             "field": "userThirdDisposition",
33151             "description": ""
33152           },
33153           {
33154             "group": "Body",
33155             "type": "Text",
33156             "optional": true,
33157             "field": "location",
33158             "description": ""
33159           },
33160           {
33161             "group": "Body",
33162             "type": "String",
33163             "optional": true,
33164             "field": "transcribeName",
33165             "description": ""
33166           },
33167           {
33168             "group": "Body",
33169             "type": "String",
33170             "optional": true,
33171             "field": "transcribeStatus",
33172             "description": ""
33173           },
33174           {
33175             "group": "Body",
33176             "type": "Text",
33177             "optional": true,
33178             "field": "fileUri",
33179             "description": ""
33180           },
33181           {
33182             "group": "Body",
33183             "type": "Text",
33184             "optional": true,
33185             "field": "fileText",
33186             "description": ""
33187           },
33188           {
33189             "group": "Body",
33190             "type": "Text",
33191             "optional": true,
33192             "field": "failureReason",
33193             "description": ""
33194           },
33195           {
33196             "group": "Body",
33197             "type": "String",
33198             "optional": true,
33199             "field": "sentiment",
33200             "description": ""
33201           },
33202           {
33203             "group": "Body",
33204             "type": "Float",
33205             "optional": true,
33206             "field": "sPositive",
33207             "description": ""
33208           },
33209           {
33210             "group": "Body",
33211             "type": "Float",
33212             "optional": true,
33213             "field": "sNegative",
33214             "description": ""
33215           },
33216           {
33217             "group": "Body",
33218             "type": "Float",
33219             "optional": true,
33220             "field": "sNeutral",
33221             "description": ""
33222           },
33223           {
33224             "group": "Body",
33225             "type": "Float",
33226             "optional": true,
33227             "field": "sMixed",
33228             "description": ""
33229           },
33230           {
33231             "group": "Body",
33232             "type": "Boolean",
33233             "optional": true,
33234             "field": "tempSentiment",
33235             "description": ""
33236           },
33237           {
33238             "group": "Body",
33239             "type": "String",
33240             "optional": true,
33241             "field": "createdAt",
33242             "description": ""
33243           },
33244           {
33245             "group": "Body",
33246             "type": "String",
33247             "optional": true,
33248             "field": "updatedAt",
33249             "description": ""
33250           }
33251         ]
33252       }
33253     },
33254     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33255     "version": "0.0.0",
33256     "filename": "server/api/voiceRecording/index.js",
33257     "groupTitle": "Voice_Recordings"
33258   },
33259   {
33260     "type": "get",
33261     "url": "/api/voice/recordings/describe",
33262     "title": "Gets table info about Recordings",
33263     "examples": [
33264       {
33265         "title": "Example usage:",
33266         "content": "curl https://{domain}/api/voice/recordings/describe -v -u {name}:{password}",
33267         "type": "json"
33268       }
33269     ],
33270     "name": "DescribeRecordings",
33271     "group": "Voice_Recordings",
33272     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33273     "version": "0.0.0",
33274     "filename": "server/api/voiceRecording/index.js",
33275     "groupTitle": "Voice_Recordings"
33276   },
33277   {
33278     "type": "get",
33279     "url": "/api/voice/recordings",
33280     "title": "Gets a list of Recordings",
33281     "examples": [
33282       {
33283         "title": "Example usage:",
33284         "content": "curl https://{domain}/api/voice/recordings -v -u {name}:{password}",
33285         "type": "json"
33286       }
33287     ],
33288     "name": "GetRecordings",
33289     "group": "Voice_Recordings",
33290     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33291     "version": "0.0.0",
33292     "filename": "server/api/voiceRecording/index.js",
33293     "groupTitle": "Voice_Recordings"
33294   },
33295   {
33296     "type": "get",
33297     "url": "/api/voice/recordings/{id}",
33298     "title": "Gets a single Recording",
33299     "examples": [
33300       {
33301         "title": "Example usage:",
33302         "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password}",
33303         "type": "json"
33304       }
33305     ],
33306     "name": "ShowRecordings",
33307     "group": "Voice_Recordings",
33308     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33309     "version": "0.0.0",
33310     "filename": "server/api/voiceRecording/index.js",
33311     "groupTitle": "Voice_Recordings"
33312   },
33313   {
33314     "type": "delete",
33315     "url": "/api/voice/recordings/{id}",
33316     "title": "Delete voice recording",
33317     "examples": [
33318       {
33319         "title": "Example usage:",
33320         "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password} -X DELETE",
33321         "type": "json"
33322       }
33323     ],
33324     "name": "destroy",
33325     "group": "Voice_Recordings",
33326     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33327     "version": "0.0.0",
33328     "filename": "server/api/voiceRecording/index.js",
33329     "groupTitle": "Voice_Recordings"
33330   },
33331   {
33332     "type": "get",
33333     "url": "/api/voice/recordings/{id}/download",
33334     "title": "Download Recording",
33335     "examples": [
33336       {
33337         "title": "Example usage:",
33338         "content": "curl https://{domain}/api/voice/recordings/{id}/download -v -u {name}:{password} -X GET",
33339         "type": "json"
33340       }
33341     ],
33342     "name": "download",
33343     "group": "Voice_Recordings",
33344     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33345     "version": "0.0.0",
33346     "filename": "server/api/voiceRecording/index.js",
33347     "groupTitle": "Voice_Recordings"
33348   },
33349   {
33350     "type": "get",
33351     "url": "/api/voice/recordings/{id}/downloads",
33352     "title": "Download Recording",
33353     "examples": [
33354       {
33355         "title": "Example usage:",
33356         "content": "curl https://{domain}/api/voice/recordings/{id}/downloads -v -u {name}:{password} -X GET",
33357         "type": "json"
33358       }
33359     ],
33360     "name": "downloads",
33361     "group": "Voice_Recordings",
33362     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33363     "version": "0.0.0",
33364     "filename": "server/api/voiceRecording/index.js",
33365     "groupTitle": "Voice_Recordings"
33366   },
33367   {
33368     "type": "get",
33369     "url": "/api/voice/recordings/{id}/transcribe",
33370     "title": "Run Transcribe Recording",
33371     "examples": [
33372       {
33373         "title": "Example usage:",
33374         "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -v -u {name}:{password} -X GET",
33375         "type": "json"
33376       }
33377     ],
33378     "name": "transcribe",
33379     "group": "Voice_Recordings",
33380     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33381     "version": "0.0.0",
33382     "filename": "server/api/voiceRecording/index.js",
33383     "groupTitle": "Voice_Recordings"
33384   },
33385   {
33386     "type": "post",
33387     "url": "/api/voice/recordings/{id}/transcribe",
33388     "title": "Run Transcribe Recording",
33389     "examples": [
33390       {
33391         "title": "Example usage:",
33392         "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -d '{\"runSentiment\": \"true\"}' -v -u {name}:{password} -X POST",
33393         "type": "json"
33394       }
33395     ],
33396     "name": "transcribe",
33397     "group": "Voice_Recordings",
33398     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33399     "version": "0.0.0",
33400     "filename": "server/api/voiceRecording/index.js",
33401     "groupTitle": "Voice_Recordings"
33402   },
33403   {
33404     "type": "put",
33405     "url": "/api/voice/recordings/{id}",
33406     "title": "Update an existing Recording",
33407     "examples": [
33408       {
33409         "title": "Example usage:",
33410         "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",
33411         "type": "json"
33412       }
33413     ],
33414     "name": "updateRecordings",
33415     "group": "Voice_Recordings",
33416     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33417     "version": "0.0.0",
33418     "filename": "server/api/voiceRecording/index.js",
33419     "groupTitle": "Voice_Recordings"
33420   },
33421   {
33422     "type": "post",
33423     "url": "/api/voice/transfers/reports",
33424     "title": "Creates a new Transfer Report",
33425     "examples": [
33426       {
33427         "title": "Example usage:",
33428         "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",
33429         "type": "json"
33430       }
33431     ],
33432     "name": "CreateTransfer_Reports",
33433     "group": "Voice_Transfer_Reports",
33434     "parameter": {
33435       "fields": {
33436         "Body": [
33437           {
33438             "group": "Body",
33439             "type": "String",
33440             "allowedValues": [
33441               "\"blind\"",
33442               "\"attended\""
33443             ],
33444             "optional": true,
33445             "field": "type",
33446             "description": ""
33447           },
33448           {
33449             "group": "Body",
33450             "type": "String",
33451             "optional": true,
33452             "field": "result",
33453             "description": ""
33454           },
33455           {
33456             "group": "Body",
33457             "type": "String",
33458             "optional": true,
33459             "field": "transfererchannel",
33460             "description": ""
33461           },
33462           {
33463             "group": "Body",
33464             "type": "String",
33465             "optional": true,
33466             "field": "transferercalleridnum",
33467             "description": ""
33468           },
33469           {
33470             "group": "Body",
33471             "type": "String",
33472             "optional": true,
33473             "field": "transferercalleridname",
33474             "description": ""
33475           },
33476           {
33477             "group": "Body",
33478             "type": "String",
33479             "optional": true,
33480             "field": "transfererconnectedlinenum",
33481             "description": ""
33482           },
33483           {
33484             "group": "Body",
33485             "type": "String",
33486             "optional": true,
33487             "field": "transfererconnectedlinename",
33488             "description": ""
33489           },
33490           {
33491             "group": "Body",
33492             "type": "String",
33493             "optional": true,
33494             "field": "transfereraccountcode",
33495             "description": ""
33496           },
33497           {
33498             "group": "Body",
33499             "type": "String",
33500             "optional": true,
33501             "field": "transferercontext",
33502             "description": ""
33503           },
33504           {
33505             "group": "Body",
33506             "type": "String",
33507             "optional": true,
33508             "field": "transfererexten",
33509             "description": ""
33510           },
33511           {
33512             "group": "Body",
33513             "type": "String",
33514             "optional": true,
33515             "field": "transfererlinkedid",
33516             "description": ""
33517           },
33518           {
33519             "group": "Body",
33520             "type": "String",
33521             "optional": true,
33522             "field": "transfereechannel",
33523             "description": ""
33524           },
33525           {
33526             "group": "Body",
33527             "type": "String",
33528             "optional": true,
33529             "field": "transfereecalleridnum",
33530             "description": ""
33531           },
33532           {
33533             "group": "Body",
33534             "type": "String",
33535             "optional": true,
33536             "field": "transfereecalleridname",
33537             "description": ""
33538           },
33539           {
33540             "group": "Body",
33541             "type": "String",
33542             "optional": true,
33543             "field": "transfereeconnectedlinenum",
33544             "description": ""
33545           },
33546           {
33547             "group": "Body",
33548             "type": "String",
33549             "optional": true,
33550             "field": "transfereeconnectedlinename",
33551             "description": ""
33552           },
33553           {
33554             "group": "Body",
33555             "type": "String",
33556             "optional": true,
33557             "field": "transfereeaccountcode",
33558             "description": ""
33559           },
33560           {
33561             "group": "Body",
33562             "type": "String",
33563             "optional": true,
33564             "field": "transfereecontext",
33565             "description": ""
33566           },
33567           {
33568             "group": "Body",
33569             "type": "String",
33570             "optional": true,
33571             "field": "transfereeexten",
33572             "description": ""
33573           },
33574           {
33575             "group": "Body",
33576             "type": "String",
33577             "optional": true,
33578             "field": "transfereelinkedid",
33579             "description": ""
33580           },
33581           {
33582             "group": "Body",
33583             "type": "String",
33584             "allowedValues": [
33585               "\"Yes\"",
33586               "\"No\""
33587             ],
33588             "optional": true,
33589             "field": "isexternal",
33590             "description": ""
33591           },
33592           {
33593             "group": "Body",
33594             "type": "String",
33595             "optional": true,
33596             "field": "context",
33597             "description": ""
33598           },
33599           {
33600             "group": "Body",
33601             "type": "String",
33602             "optional": true,
33603             "field": "extension",
33604             "description": ""
33605           }
33606         ]
33607       }
33608     },
33609     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33610     "version": "0.0.0",
33611     "filename": "server/api/voiceTransferReport/index.js",
33612     "groupTitle": "Voice_Transfer_Reports"
33613   },
33614   {
33615     "type": "delete",
33616     "url": "/api/voice/transfers/reports/{id}",
33617     "title": "Deletes a Transfer Report",
33618     "examples": [
33619       {
33620         "title": "Example usage:",
33621         "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password} -X DELETE",
33622         "type": "json"
33623       }
33624     ],
33625     "name": "DeleteTransfer_Reports",
33626     "group": "Voice_Transfer_Reports",
33627     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33628     "version": "0.0.0",
33629     "filename": "server/api/voiceTransferReport/index.js",
33630     "groupTitle": "Voice_Transfer_Reports"
33631   },
33632   {
33633     "type": "get",
33634     "url": "/api/voice/transfers/reports/describe",
33635     "title": "Gets table info about Transfer Reports",
33636     "examples": [
33637       {
33638         "title": "Example usage:",
33639         "content": "curl https://{domain}/api/voice/transfers/reports/describe -v -u {name}:{password}",
33640         "type": "json"
33641       }
33642     ],
33643     "name": "DescribeTransfer_Reports",
33644     "group": "Voice_Transfer_Reports",
33645     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33646     "version": "0.0.0",
33647     "filename": "server/api/voiceTransferReport/index.js",
33648     "groupTitle": "Voice_Transfer_Reports"
33649   },
33650   {
33651     "type": "get",
33652     "url": "/api/voice/transfers/reports",
33653     "title": "Gets a list of Transfer Reports",
33654     "examples": [
33655       {
33656         "title": "Example usage:",
33657         "content": "curl https://{domain}/api/voice/transfers/reports -v -u {name}:{password}",
33658         "type": "json"
33659       }
33660     ],
33661     "name": "GetTransfer_Reports",
33662     "group": "Voice_Transfer_Reports",
33663     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33664     "version": "0.0.0",
33665     "filename": "server/api/voiceTransferReport/index.js",
33666     "groupTitle": "Voice_Transfer_Reports"
33667   },
33668   {
33669     "type": "get",
33670     "url": "/api/voice/transfers/reports/{id}",
33671     "title": "Gets a single Transfer Report",
33672     "examples": [
33673       {
33674         "title": "Example usage:",
33675         "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password}",
33676         "type": "json"
33677       }
33678     ],
33679     "name": "ShowTransfer_Reports",
33680     "group": "Voice_Transfer_Reports",
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/voiceTransferReport/index.js",
33684     "groupTitle": "Voice_Transfer_Reports"
33685   },
33686   {
33687     "type": "put",
33688     "url": "/api/voice/transfers/reports/{id}",
33689     "title": "Update an existing Transfer Report",
33690     "examples": [
33691       {
33692         "title": "Example usage:",
33693         "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",
33694         "type": "json"
33695       }
33696     ],
33697     "name": "updateTransfer_Reports",
33698     "group": "Voice_Transfer_Reports",
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/voiceTransferReport/index.js",
33702     "groupTitle": "Voice_Transfer_Reports"
33703   },
33704   {
33705     "type": "post",
33706     "url": "/api/integrations/vtiger/accounts",
33707     "title": "Creates a new Vtiger Account",
33708     "examples": [
33709       {
33710         "title": "Example usage:",
33711         "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",
33712         "type": "json"
33713       }
33714     ],
33715     "name": "CreateVtiger_Accounts",
33716     "group": "Vtiger_Accounts",
33717     "parameter": {
33718       "fields": {
33719         "Body": [
33720           {
33721             "group": "Body",
33722             "type": "String",
33723             "optional": false,
33724             "field": "name",
33725             "description": ""
33726           },
33727           {
33728             "group": "Body",
33729             "type": "String",
33730             "optional": true,
33731             "field": "description",
33732             "description": ""
33733           },
33734           {
33735             "group": "Body",
33736             "type": "String",
33737             "optional": false,
33738             "field": "username",
33739             "description": ""
33740           },
33741           {
33742             "group": "Body",
33743             "type": "String",
33744             "optional": false,
33745             "field": "moduleName",
33746             "description": ""
33747           },
33748           {
33749             "group": "Body",
33750             "type": "String",
33751             "optional": false,
33752             "field": "remoteUri",
33753             "description": ""
33754           },
33755           {
33756             "group": "Body",
33757             "type": "String",
33758             "optional": false,
33759             "field": "serverUrl",
33760             "description": ""
33761           },
33762           {
33763             "group": "Body",
33764             "type": "String",
33765             "optional": false,
33766             "field": "accessKey",
33767             "description": ""
33768           }
33769         ]
33770       }
33771     },
33772     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33773     "version": "0.0.0",
33774     "filename": "server/api/intVtigerAccount/index.js",
33775     "groupTitle": "Vtiger_Accounts"
33776   },
33777   {
33778     "type": "delete",
33779     "url": "/api/integrations/vtiger/accounts/{id}",
33780     "title": "Deletes a Vtiger Account",
33781     "examples": [
33782       {
33783         "title": "Example usage:",
33784         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password} -X DELETE",
33785         "type": "json"
33786       }
33787     ],
33788     "name": "DeleteVtiger_Accounts",
33789     "group": "Vtiger_Accounts",
33790     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33791     "version": "0.0.0",
33792     "filename": "server/api/intVtigerAccount/index.js",
33793     "groupTitle": "Vtiger_Accounts"
33794   },
33795   {
33796     "type": "get",
33797     "url": "/api/integrations/vtiger/accounts",
33798     "title": "Gets a list of Vtiger Accounts",
33799     "examples": [
33800       {
33801         "title": "Example usage:",
33802         "content": "curl https://{domain}/api/integrations/vtiger/accounts -v -u {name}:{password}",
33803         "type": "json"
33804       }
33805     ],
33806     "name": "GetVtiger_Accounts",
33807     "group": "Vtiger_Accounts",
33808     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33809     "version": "0.0.0",
33810     "filename": "server/api/intVtigerAccount/index.js",
33811     "groupTitle": "Vtiger_Accounts"
33812   },
33813   {
33814     "type": "get",
33815     "url": "/api/integrations/vtiger/accounts/{id}",
33816     "title": "Gets a single Vtiger Account",
33817     "examples": [
33818       {
33819         "title": "Example usage:",
33820         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password}",
33821         "type": "json"
33822       }
33823     ],
33824     "name": "ShowVtiger_Accounts",
33825     "group": "Vtiger_Accounts",
33826     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33827     "version": "0.0.0",
33828     "filename": "server/api/intVtigerAccount/index.js",
33829     "groupTitle": "Vtiger_Accounts"
33830   },
33831   {
33832     "type": "post",
33833     "url": "/api/integrations/vtiger/accounts/{id}/configurations",
33834     "title": "Creates new configuration",
33835     "examples": [
33836       {
33837         "title": "Example usage:",
33838         "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",
33839         "type": "json"
33840       }
33841     ],
33842     "name": "addConfiguration",
33843     "group": "Vtiger_Accounts",
33844     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33845     "version": "0.0.0",
33846     "filename": "server/api/intVtigerAccount/index.js",
33847     "groupTitle": "Vtiger_Accounts"
33848   },
33849   {
33850     "type": "get",
33851     "url": "/api/integrations/vtiger/accounts/{id}/configurations",
33852     "title": "Gets account configurations",
33853     "examples": [
33854       {
33855         "title": "Example usage:",
33856         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/configurations -v -u {name}:{password} -X GET",
33857         "type": "json"
33858       }
33859     ],
33860     "name": "getConfigurations",
33861     "group": "Vtiger_Accounts",
33862     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33863     "version": "0.0.0",
33864     "filename": "server/api/intVtigerAccount/index.js",
33865     "groupTitle": "Vtiger_Accounts"
33866   },
33867   {
33868     "type": "get",
33869     "url": "/api/integrations/vtiger/accounts/{id}/fields",
33870     "title": "Gets account fields",
33871     "examples": [
33872       {
33873         "title": "Example usage:",
33874         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/fields -v -u {name}:{password} -X GET",
33875         "type": "json"
33876       }
33877     ],
33878     "name": "getFields",
33879     "group": "Vtiger_Accounts",
33880     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33881     "version": "0.0.0",
33882     "filename": "server/api/intVtigerAccount/index.js",
33883     "groupTitle": "Vtiger_Accounts"
33884   },
33885   {
33886     "type": "put",
33887     "url": "/api/integrations/vtiger/accounts/{id}",
33888     "title": "Update an existing Vtiger Account",
33889     "examples": [
33890       {
33891         "title": "Example usage:",
33892         "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",
33893         "type": "json"
33894       }
33895     ],
33896     "name": "updateVtiger_Accounts",
33897     "group": "Vtiger_Accounts",
33898     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33899     "version": "0.0.0",
33900     "filename": "server/api/intVtigerAccount/index.js",
33901     "groupTitle": "Vtiger_Accounts"
33902   },
33903   {
33904     "type": "post",
33905     "url": "/api/integrations/vtiger/configurations",
33906     "title": "Creates a new Vtiger Configuration",
33907     "examples": [
33908       {
33909         "title": "Example usage:",
33910         "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",
33911         "type": "json"
33912       }
33913     ],
33914     "name": "CreateVtiger_Configurations",
33915     "group": "Vtiger_Configurations",
33916     "parameter": {
33917       "fields": {
33918         "Body": [
33919           {
33920             "group": "Body",
33921             "type": "String",
33922             "optional": true,
33923             "field": "name",
33924             "description": ""
33925           },
33926           {
33927             "group": "Body",
33928             "type": "String",
33929             "optional": true,
33930             "field": "description",
33931             "description": ""
33932           }
33933         ]
33934       }
33935     },
33936     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33937     "version": "0.0.0",
33938     "filename": "server/api/intVtigerConfiguration/index.js",
33939     "groupTitle": "Vtiger_Configurations"
33940   },
33941   {
33942     "type": "delete",
33943     "url": "/api/integrations/vtiger/configurations/{id}",
33944     "title": "Deletes a Vtiger Configuration",
33945     "examples": [
33946       {
33947         "title": "Example usage:",
33948         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password} -X DELETE",
33949         "type": "json"
33950       }
33951     ],
33952     "name": "DeleteVtiger_Configurations",
33953     "group": "Vtiger_Configurations",
33954     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33955     "version": "0.0.0",
33956     "filename": "server/api/intVtigerConfiguration/index.js",
33957     "groupTitle": "Vtiger_Configurations"
33958   },
33959   {
33960     "type": "get",
33961     "url": "/api/integrations/vtiger/configurations",
33962     "title": "Gets a list of Vtiger Configurations",
33963     "examples": [
33964       {
33965         "title": "Example usage:",
33966         "content": "curl https://{domain}/api/integrations/vtiger/configurations -v -u {name}:{password}",
33967         "type": "json"
33968       }
33969     ],
33970     "name": "GetVtiger_Configurations",
33971     "group": "Vtiger_Configurations",
33972     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33973     "version": "0.0.0",
33974     "filename": "server/api/intVtigerConfiguration/index.js",
33975     "groupTitle": "Vtiger_Configurations"
33976   },
33977   {
33978     "type": "get",
33979     "url": "/api/integrations/vtiger/configurations/{id}",
33980     "title": "Gets a single Vtiger Configuration",
33981     "examples": [
33982       {
33983         "title": "Example usage:",
33984         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password}",
33985         "type": "json"
33986       }
33987     ],
33988     "name": "ShowVtiger_Configurations",
33989     "group": "Vtiger_Configurations",
33990     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33991     "version": "0.0.0",
33992     "filename": "server/api/intVtigerConfiguration/index.js",
33993     "groupTitle": "Vtiger_Configurations"
33994   },
33995   {
33996     "type": "get",
33997     "url": "/api/integrations/vtiger/configurations/{id}/descriptions",
33998     "title": "Gets configurations descriptions",
33999     "examples": [
34000       {
34001         "title": "Example usage:",
34002         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
34003         "type": "json"
34004       }
34005     ],
34006     "name": "getDescriptions",
34007     "group": "Vtiger_Configurations",
34008     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34009     "version": "0.0.0",
34010     "filename": "server/api/intVtigerConfiguration/index.js",
34011     "groupTitle": "Vtiger_Configurations"
34012   },
34013   {
34014     "type": "get",
34015     "url": "/api/integrations/vtiger/configurations/{id}/fields",
34016     "title": "Gets configurations fields",
34017     "examples": [
34018       {
34019         "title": "Example usage:",
34020         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/fields -v -u {name}:{password} -X GET",
34021         "type": "json"
34022       }
34023     ],
34024     "name": "getFields",
34025     "group": "Vtiger_Configurations",
34026     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34027     "version": "0.0.0",
34028     "filename": "server/api/intVtigerConfiguration/index.js",
34029     "groupTitle": "Vtiger_Configurations"
34030   },
34031   {
34032     "type": "get",
34033     "url": "/api/integrations/vtiger/configurations/{id}/subjects",
34034     "title": "Gets configurations subjects",
34035     "examples": [
34036       {
34037         "title": "Example usage:",
34038         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/subjects -v -u {name}:{password} -X GET",
34039         "type": "json"
34040       }
34041     ],
34042     "name": "getSubjects",
34043     "group": "Vtiger_Configurations",
34044     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34045     "version": "0.0.0",
34046     "filename": "server/api/intVtigerConfiguration/index.js",
34047     "groupTitle": "Vtiger_Configurations"
34048   },
34049   {
34050     "type": "put",
34051     "url": "/api/integrations/vtiger/configurations/{id}",
34052     "title": "Update an existing Vtiger Configuration",
34053     "examples": [
34054       {
34055         "title": "Example usage:",
34056         "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",
34057         "type": "json"
34058       }
34059     ],
34060     "name": "updateVtiger_Configurations",
34061     "group": "Vtiger_Configurations",
34062     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34063     "version": "0.0.0",
34064     "filename": "server/api/intVtigerConfiguration/index.js",
34065     "groupTitle": "Vtiger_Configurations"
34066   },
34067   {
34068     "type": "post",
34069     "url": "/api/integrations/vtiger/fields",
34070     "title": "Creates a new Vtiger Field",
34071     "examples": [
34072       {
34073         "title": "Example usage:",
34074         "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",
34075         "type": "json"
34076       }
34077     ],
34078     "name": "CreateVtiger_Fields",
34079     "group": "Vtiger_Fields",
34080     "parameter": {
34081       "fields": {
34082         "Body": [
34083           {
34084             "group": "Body",
34085             "type": "String",
34086             "allowedValues": [
34087               "\"string\"",
34088               "\"variable\"",
34089               "\"customVariable\"",
34090               "\"keyValue\"",
34091               "\"picklist\""
34092             ],
34093             "optional": true,
34094             "field": "type",
34095             "description": ""
34096           },
34097           {
34098             "group": "Body",
34099             "type": "String",
34100             "optional": true,
34101             "field": "content",
34102             "description": ""
34103           },
34104           {
34105             "group": "Body",
34106             "type": "String",
34107             "optional": true,
34108             "field": "key",
34109             "description": ""
34110           },
34111           {
34112             "group": "Body",
34113             "type": "String",
34114             "allowedValues": [
34115               "\"string\"",
34116               "\"variable\"",
34117               "\"customVariable\""
34118             ],
34119             "optional": true,
34120             "field": "keyType",
34121             "description": ""
34122           },
34123           {
34124             "group": "Body",
34125             "type": "String",
34126             "optional": true,
34127             "field": "keyContent",
34128             "description": ""
34129           },
34130           {
34131             "group": "Body",
34132             "type": "String",
34133             "optional": true,
34134             "field": "idField",
34135             "description": ""
34136           },
34137           {
34138             "group": "Body",
34139             "type": "String",
34140             "optional": true,
34141             "field": "nameField",
34142             "description": ""
34143           },
34144           {
34145             "group": "Body",
34146             "type": "Boolean",
34147             "optional": true,
34148             "field": "customField",
34149             "description": ""
34150           },
34151           {
34152             "group": "Body",
34153             "type": "String",
34154             "optional": true,
34155             "field": "variableName",
34156             "description": ""
34157           }
34158         ]
34159       }
34160     },
34161     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34162     "version": "0.0.0",
34163     "filename": "server/api/intVtigerField/index.js",
34164     "groupTitle": "Vtiger_Fields"
34165   },
34166   {
34167     "type": "delete",
34168     "url": "/api/integrations/vtiger/fields/{id}",
34169     "title": "Deletes a Vtiger Field",
34170     "examples": [
34171       {
34172         "title": "Example usage:",
34173         "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password} -X DELETE",
34174         "type": "json"
34175       }
34176     ],
34177     "name": "DeleteVtiger_Fields",
34178     "group": "Vtiger_Fields",
34179     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34180     "version": "0.0.0",
34181     "filename": "server/api/intVtigerField/index.js",
34182     "groupTitle": "Vtiger_Fields"
34183   },
34184   {
34185     "type": "get",
34186     "url": "/api/integrations/vtiger/fields",
34187     "title": "Gets a list of Vtiger Fields",
34188     "examples": [
34189       {
34190         "title": "Example usage:",
34191         "content": "curl https://{domain}/api/integrations/vtiger/fields -v -u {name}:{password}",
34192         "type": "json"
34193       }
34194     ],
34195     "name": "GetVtiger_Fields",
34196     "group": "Vtiger_Fields",
34197     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34198     "version": "0.0.0",
34199     "filename": "server/api/intVtigerField/index.js",
34200     "groupTitle": "Vtiger_Fields"
34201   },
34202   {
34203     "type": "get",
34204     "url": "/api/integrations/vtiger/fields/{id}",
34205     "title": "Gets a single Vtiger Field",
34206     "examples": [
34207       {
34208         "title": "Example usage:",
34209         "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password}",
34210         "type": "json"
34211       }
34212     ],
34213     "name": "ShowVtiger_Fields",
34214     "group": "Vtiger_Fields",
34215     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34216     "version": "0.0.0",
34217     "filename": "server/api/intVtigerField/index.js",
34218     "groupTitle": "Vtiger_Fields"
34219   },
34220   {
34221     "type": "put",
34222     "url": "/api/integrations/vtiger/fields/{id}",
34223     "title": "Update an existing Vtiger Field",
34224     "examples": [
34225       {
34226         "title": "Example usage:",
34227         "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",
34228         "type": "json"
34229       }
34230     ],
34231     "name": "updateVtiger_Fields",
34232     "group": "Vtiger_Fields",
34233     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34234     "version": "0.0.0",
34235     "filename": "server/api/intVtigerField/index.js",
34236     "groupTitle": "Vtiger_Fields"
34237   },
34238   {
34239     "type": "post",
34240     "url": "/api/webbar/answer",
34241     "title": "answer webrtc call",
34242     "examples": [
34243       {
34244         "title": "Example usage:",
34245         "content": "curl https://{domain}/api/webbar/answer -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34246         "type": "json"
34247       }
34248     ],
34249     "name": "Web_Bar_answer",
34250     "group": "WebBar",
34251     "parameter": {
34252       "fields": {
34253         "Body": [
34254           {
34255             "group": "Body",
34256             "type": "String",
34257             "optional": false,
34258             "field": "sessionId",
34259             "description": ""
34260           },
34261           {
34262             "group": "Body",
34263             "type": "number",
34264             "optional": false,
34265             "field": "userId",
34266             "description": ""
34267           }
34268         ]
34269       }
34270     },
34271     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34272     "version": "0.0.0",
34273     "filename": "server/api/webbar/index.js",
34274     "groupTitle": "WebBar"
34275   },
34276   {
34277     "type": "post",
34278     "url": "/api/webbar/calls",
34279     "title": "webrtc call list",
34280     "examples": [
34281       {
34282         "title": "Example usage:",
34283         "content": "curl https://{domain}/api/webbar/calls -d '{\"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34284         "type": "json"
34285       }
34286     ],
34287     "name": "Web_Bar_calls",
34288     "group": "WebBar",
34289     "parameter": {
34290       "fields": {
34291         "Body": [
34292           {
34293             "group": "Body",
34294             "type": "number",
34295             "optional": false,
34296             "field": "userId",
34297             "description": ""
34298           }
34299         ]
34300       }
34301     },
34302     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34303     "version": "0.0.0",
34304     "filename": "server/api/webbar/index.js",
34305     "groupTitle": "WebBar"
34306   },
34307   {
34308     "type": "post",
34309     "url": "/api/webbar/hangup",
34310     "title": "hangup webrtc call",
34311     "examples": [
34312       {
34313         "title": "Example usage:",
34314         "content": "curl https://{domain}/api/webbar/hangup -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34315         "type": "json"
34316       }
34317     ],
34318     "name": "Web_Bar_hangup",
34319     "group": "WebBar",
34320     "parameter": {
34321       "fields": {
34322         "Body": [
34323           {
34324             "group": "Body",
34325             "type": "String",
34326             "optional": false,
34327             "field": "sessionId",
34328             "description": ""
34329           },
34330           {
34331             "group": "Body",
34332             "type": "number",
34333             "optional": false,
34334             "field": "userId",
34335             "description": ""
34336           }
34337         ]
34338       }
34339     },
34340     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34341     "version": "0.0.0",
34342     "filename": "server/api/webbar/index.js",
34343     "groupTitle": "WebBar"
34344   },
34345   {
34346     "type": "post",
34347     "url": "/api/webbar/unhold",
34348     "title": "unhold webrtc call",
34349     "examples": [
34350       {
34351         "title": "Example usage:",
34352         "content": "curl https://{domain}/api/webbar/unhold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34353         "type": "json"
34354       }
34355     ],
34356     "name": "Web_Bar_hold",
34357     "group": "WebBar",
34358     "parameter": {
34359       "fields": {
34360         "Body": [
34361           {
34362             "group": "Body",
34363             "type": "String",
34364             "optional": false,
34365             "field": "sessionId",
34366             "description": ""
34367           },
34368           {
34369             "group": "Body",
34370             "type": "number",
34371             "optional": false,
34372             "field": "userId",
34373             "description": ""
34374           }
34375         ]
34376       }
34377     },
34378     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34379     "version": "0.0.0",
34380     "filename": "server/api/webbar/index.js",
34381     "groupTitle": "WebBar"
34382   },
34383   {
34384     "type": "post",
34385     "url": "/api/webbar/hold",
34386     "title": "hold webrtc call",
34387     "examples": [
34388       {
34389         "title": "Example usage:",
34390         "content": "curl https://{domain}/api/webbar/hold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34391         "type": "json"
34392       }
34393     ],
34394     "name": "Web_Bar_hold",
34395     "group": "WebBar",
34396     "parameter": {
34397       "fields": {
34398         "Body": [
34399           {
34400             "group": "Body",
34401             "type": "String",
34402             "optional": true,
34403             "field": "sessionId",
34404             "description": ""
34405           },
34406           {
34407             "group": "Body",
34408             "type": "number",
34409             "optional": false,
34410             "field": "userId",
34411             "description": ""
34412           }
34413         ]
34414       }
34415     },
34416     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34417     "version": "0.0.0",
34418     "filename": "server/api/webbar/index.js",
34419     "groupTitle": "WebBar"
34420   },
34421   {
34422     "type": "post",
34423     "url": "/api/webbar/originate",
34424     "title": "Originate new webrtc call",
34425     "examples": [
34426       {
34427         "title": "Example usage:",
34428         "content": "curl https://{domain}/api/webbar/originate -d '{\"callNumber\": \"0119692844\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34429         "type": "json"
34430       }
34431     ],
34432     "name": "Web_Bar_originate",
34433     "group": "WebBar",
34434     "parameter": {
34435       "fields": {
34436         "Body": [
34437           {
34438             "group": "Body",
34439             "type": "String",
34440             "optional": false,
34441             "field": "callNumber",
34442             "description": ""
34443           },
34444           {
34445             "group": "Body",
34446             "type": "number",
34447             "optional": false,
34448             "field": "userId",
34449             "description": ""
34450           },
34451           {
34452             "group": "Body",
34453             "type": "String",
34454             "optional": false,
34455             "field": "callerId",
34456             "description": ""
34457           },
34458           {
34459             "group": "Body",
34460             "type": "String",
34461             "optional": false,
34462             "field": "callbackUrl",
34463             "description": ""
34464           }
34465         ]
34466       }
34467     },
34468     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34469     "version": "0.0.0",
34470     "filename": "server/api/webbar/index.js",
34471     "groupTitle": "WebBar"
34472   },
34473   {
34474     "type": "post",
34475     "url": "/api/webbar/transfer",
34476     "title": "blind transfer webrtc call",
34477     "examples": [
34478       {
34479         "title": "Example usage:",
34480         "content": "curl https://{domain}/api/webbar/transfer -d '{\"userId\": 54, \"sessionId\":\"<sessionId>\", \"transferNumber\":\"<transferNumber>\"}' \\\n -H \"Content-Type: application/json\" -X POST",
34481         "type": "json"
34482       }
34483     ],
34484     "name": "Web_Bar_transfer",
34485     "group": "WebBar",
34486     "parameter": {
34487       "fields": {
34488         "Body": [
34489           {
34490             "group": "Body",
34491             "type": "number",
34492             "optional": false,
34493             "field": "userId",
34494             "description": ""
34495           },
34496           {
34497             "group": "Body",
34498             "type": "string",
34499             "optional": false,
34500             "field": "sessionId",
34501             "description": ""
34502           },
34503           {
34504             "group": "Body",
34505             "type": "string",
34506             "optional": false,
34507             "field": "transferNumber",
34508             "description": ""
34509           }
34510         ]
34511       }
34512     },
34513     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34514     "version": "0.0.0",
34515     "filename": "server/api/webbar/index.js",
34516     "groupTitle": "WebBar"
34517   },
34518   {
34519     "type": "post",
34520     "url": "/api/whatsapp/accounts/{id}/users",
34521     "title": "Add agents to a whatsapp account",
34522     "examples": [
34523       {
34524         "title": "Example usage:",
34525         "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",
34526         "type": "json"
34527       }
34528     ],
34529     "name": "AddAgents",
34530     "group": "Whatsapp_Accounts",
34531     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34532     "version": "0.0.0",
34533     "filename": "server/api/whatsappAccount/index.js",
34534     "groupTitle": "Whatsapp_Accounts"
34535   },
34536   {
34537     "type": "post",
34538     "url": "/api/whatsapp/accounts",
34539     "title": "Creates a new Account",
34540     "examples": [
34541       {
34542         "title": "Example usage:",
34543         "content": "curl https://{domain}/api/whatsapp/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
34544         "type": "json"
34545       }
34546     ],
34547     "name": "CreateAccounts",
34548     "group": "Whatsapp_Accounts",
34549     "parameter": {
34550       "fields": {
34551         "Body": [
34552           {
34553             "group": "Body",
34554             "type": "String",
34555             "optional": false,
34556             "field": "name",
34557             "description": ""
34558           },
34559           {
34560             "group": "Body",
34561             "type": "String",
34562             "optional": false,
34563             "field": "key",
34564             "description": ""
34565           },
34566           {
34567             "group": "Body",
34568             "type": "String",
34569             "optional": false,
34570             "field": "remote",
34571             "description": ""
34572           },
34573           {
34574             "group": "Body",
34575             "type": "String",
34576             "optional": true,
34577             "field": "token",
34578             "description": ""
34579           },
34580           {
34581             "group": "Body",
34582             "type": "String",
34583             "optional": true,
34584             "field": "phone",
34585             "description": ""
34586           },
34587           {
34588             "group": "Body",
34589             "type": "String",
34590             "allowedValues": [
34591               "\"twilio\""
34592             ],
34593             "optional": true,
34594             "field": "type",
34595             "description": ""
34596           },
34597           {
34598             "group": "Body",
34599             "type": "String",
34600             "optional": true,
34601             "field": "accountSid",
34602             "description": ""
34603           },
34604           {
34605             "group": "Body",
34606             "type": "String",
34607             "optional": true,
34608             "field": "authToken",
34609             "description": ""
34610           },
34611           {
34612             "group": "Body",
34613             "type": "Text",
34614             "optional": true,
34615             "field": "notificationTemplate",
34616             "description": ""
34617           },
34618           {
34619             "group": "Body",
34620             "type": "Boolean",
34621             "optional": true,
34622             "field": "notificationSound",
34623             "description": ""
34624           },
34625           {
34626             "group": "Body",
34627             "type": "Boolean",
34628             "optional": true,
34629             "field": "notificationShake",
34630             "description": ""
34631           },
34632           {
34633             "group": "Body",
34634             "type": "Integer",
34635             "optional": true,
34636             "field": "waitForTheAssignedAgent",
34637             "description": ""
34638           },
34639           {
34640             "group": "Body",
34641             "type": "Boolean",
34642             "optional": true,
34643             "field": "queueTransfer",
34644             "description": ""
34645           },
34646           {
34647             "group": "Body",
34648             "type": "Integer",
34649             "optional": true,
34650             "field": "queueTransferTimeout",
34651             "description": ""
34652           },
34653           {
34654             "group": "Body",
34655             "type": "Boolean",
34656             "optional": true,
34657             "field": "agentTransfer",
34658             "description": ""
34659           },
34660           {
34661             "group": "Body",
34662             "type": "Integer",
34663             "optional": true,
34664             "field": "agentTransferTimeout",
34665             "description": ""
34666           },
34667           {
34668             "group": "Body",
34669             "type": "Integer",
34670             "optional": true,
34671             "field": "mandatoryDispositionPauseId",
34672             "description": "<p>Status to put when mandatory disposition is enabled</p>"
34673           },
34674           {
34675             "group": "Body",
34676             "type": "Boolean",
34677             "optional": true,
34678             "field": "mandatoryDisposition",
34679             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
34680           },
34681           {
34682             "group": "Body",
34683             "type": "String",
34684             "optional": true,
34685             "field": "description",
34686             "description": ""
34687           }
34688         ]
34689       }
34690     },
34691     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34692     "version": "0.0.0",
34693     "filename": "server/api/whatsappAccount/index.js",
34694     "groupTitle": "Whatsapp_Accounts"
34695   },
34696   {
34697     "type": "delete",
34698     "url": "/api/whatsapp/accounts/{id}",
34699     "title": "Deletes a Account",
34700     "examples": [
34701       {
34702         "title": "Example usage:",
34703         "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password} -X DELETE",
34704         "type": "json"
34705       }
34706     ],
34707     "name": "DeleteAccounts",
34708     "group": "Whatsapp_Accounts",
34709     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34710     "version": "0.0.0",
34711     "filename": "server/api/whatsappAccount/index.js",
34712     "groupTitle": "Whatsapp_Accounts"
34713   },
34714   {
34715     "type": "get",
34716     "url": "/api/whatsapp/accounts/describe",
34717     "title": "Gets table info about Accounts",
34718     "examples": [
34719       {
34720         "title": "Example usage:",
34721         "content": "curl https://{domain}/api/whatsapp/accounts/describe -v -u {name}:{password}",
34722         "type": "json"
34723       }
34724     ],
34725     "name": "DescribeAccounts",
34726     "group": "Whatsapp_Accounts",
34727     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34728     "version": "0.0.0",
34729     "filename": "server/api/whatsappAccount/index.js",
34730     "groupTitle": "Whatsapp_Accounts"
34731   },
34732   {
34733     "type": "get",
34734     "url": "/api/whatsapp/accounts",
34735     "title": "Gets a list of Accounts",
34736     "examples": [
34737       {
34738         "title": "Example usage:",
34739         "content": "curl https://{domain}/api/whatsapp/accounts -v -u {name}:{password}",
34740         "type": "json"
34741       }
34742     ],
34743     "name": "GetAccounts",
34744     "group": "Whatsapp_Accounts",
34745     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34746     "version": "0.0.0",
34747     "filename": "server/api/whatsappAccount/index.js",
34748     "groupTitle": "Whatsapp_Accounts"
34749   },
34750   {
34751     "type": "get",
34752     "url": "/api/whatsapp/accounts/{id}/users",
34753     "title": "Gets agents from whatsapp account",
34754     "examples": [
34755       {
34756         "title": "Example usage:",
34757         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users -v -u {name}:{password} -X GET",
34758         "type": "json"
34759       }
34760     ],
34761     "name": "GetAgents",
34762     "group": "Whatsapp_Accounts",
34763     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34764     "version": "0.0.0",
34765     "filename": "server/api/whatsappAccount/index.js",
34766     "groupTitle": "Whatsapp_Accounts"
34767   },
34768   {
34769     "type": "delete",
34770     "url": "/api/whatsapp/accounts/{id}/users",
34771     "title": "Removes agents from a whatsapp account",
34772     "examples": [
34773       {
34774         "title": "Example usage:",
34775         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
34776         "type": "json"
34777       }
34778     ],
34779     "name": "RemoveAgents",
34780     "group": "Whatsapp_Accounts",
34781     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34782     "version": "0.0.0",
34783     "filename": "server/api/whatsappAccount/index.js",
34784     "groupTitle": "Whatsapp_Accounts"
34785   },
34786   {
34787     "type": "delete",
34788     "url": "/api/whatsapp/accounts/{id}/canned_answers",
34789     "title": "Removes canned answers from account",
34790     "examples": [
34791       {
34792         "title": "Example usage:",
34793         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
34794         "type": "json"
34795       }
34796     ],
34797     "name": "RemoveAnswers",
34798     "group": "Whatsapp_Accounts",
34799     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34800     "version": "0.0.0",
34801     "filename": "server/api/whatsappAccount/index.js",
34802     "groupTitle": "Whatsapp_Accounts"
34803   },
34804   {
34805     "type": "delete",
34806     "url": "/api/whatsapp/accounts/{id}/dispositions",
34807     "title": "Removes dispositions from account",
34808     "examples": [
34809       {
34810         "title": "Example usage:",
34811         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
34812         "type": "json"
34813       }
34814     ],
34815     "name": "RemoveDispositions",
34816     "group": "Whatsapp_Accounts",
34817     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34818     "version": "0.0.0",
34819     "filename": "server/api/whatsappAccount/index.js",
34820     "groupTitle": "Whatsapp_Accounts"
34821   },
34822   {
34823     "type": "get",
34824     "url": "/api/whatsapp/accounts/{id}",
34825     "title": "Gets a single Account",
34826     "examples": [
34827       {
34828         "title": "Example usage:",
34829         "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password}",
34830         "type": "json"
34831       }
34832     ],
34833     "name": "ShowAccounts",
34834     "group": "Whatsapp_Accounts",
34835     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34836     "version": "0.0.0",
34837     "filename": "server/api/whatsappAccount/index.js",
34838     "groupTitle": "Whatsapp_Accounts"
34839   },
34840   {
34841     "type": "put",
34842     "url": "/api/whatsapp/messages/{id}/accept",
34843     "title": "Accepts message",
34844     "examples": [
34845       {
34846         "title": "Example usage:",
34847         "content": "curl https://{domain}/api/whatsapp/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
34848         "type": "json"
34849       }
34850     ],
34851     "name": "acceptMessage",
34852     "group": "Whatsapp_Accounts",
34853     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34854     "version": "0.0.0",
34855     "filename": "server/api/whatsappMessage/index.js",
34856     "groupTitle": "Whatsapp_Accounts"
34857   },
34858   {
34859     "type": "post",
34860     "url": "/api/whatsapp/accounts/{id}/canned_answers",
34861     "title": "Creates new canned answer",
34862     "examples": [
34863       {
34864         "title": "Example usage:",
34865         "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",
34866         "type": "json"
34867       }
34868     ],
34869     "name": "addAnswer",
34870     "group": "Whatsapp_Accounts",
34871     "parameter": {
34872       "fields": {
34873         "Body": [
34874           {
34875             "group": "Body",
34876             "type": "String",
34877             "optional": false,
34878             "field": "key",
34879             "description": ""
34880           },
34881           {
34882             "group": "Body",
34883             "type": "Text",
34884             "optional": false,
34885             "field": "value",
34886             "description": ""
34887           },
34888           {
34889             "group": "Body",
34890             "type": "String",
34891             "optional": true,
34892             "field": "description",
34893             "description": ""
34894           },
34895           {
34896             "group": "Body",
34897             "type": "Virtual",
34898             "optional": true,
34899             "field": "name",
34900             "description": ""
34901           }
34902         ]
34903       }
34904     },
34905     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34906     "version": "0.0.0",
34907     "filename": "server/api/whatsappAccount/index.js",
34908     "groupTitle": "Whatsapp_Accounts"
34909   },
34910   {
34911     "type": "post",
34912     "url": "/api/whatsapp/accounts/{id}/applications",
34913     "title": "Creates new applications",
34914     "examples": [
34915       {
34916         "title": "Example usage:",
34917         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
34918         "type": "json"
34919       }
34920     ],
34921     "name": "addApplications",
34922     "group": "Whatsapp_Accounts",
34923     "parameter": {
34924       "fields": {
34925         "Body": [
34926           {
34927             "group": "Body",
34928             "type": "Integer",
34929             "optional": false,
34930             "field": "priority",
34931             "description": ""
34932           },
34933           {
34934             "group": "Body",
34935             "type": "String",
34936             "optional": false,
34937             "field": "app",
34938             "description": ""
34939           },
34940           {
34941             "group": "Body",
34942             "type": "Text",
34943             "optional": true,
34944             "field": "appdata",
34945             "description": ""
34946           },
34947           {
34948             "group": "Body",
34949             "type": "String",
34950             "optional": true,
34951             "field": "description",
34952             "description": ""
34953           },
34954           {
34955             "group": "Body",
34956             "type": "String",
34957             "optional": true,
34958             "field": "interval",
34959             "description": ""
34960           }
34961         ]
34962       }
34963     },
34964     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34965     "version": "0.0.0",
34966     "filename": "server/api/whatsappAccount/index.js",
34967     "groupTitle": "Whatsapp_Accounts"
34968   },
34969   {
34970     "type": "post",
34971     "url": "/api/whatsapp/accounts/{id}/dispositions",
34972     "title": "Creates new disposition",
34973     "examples": [
34974       {
34975         "title": "Example usage:",
34976         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
34977         "type": "json"
34978       }
34979     ],
34980     "name": "addDisposition",
34981     "group": "Whatsapp_Accounts",
34982     "parameter": {
34983       "fields": {
34984         "Body": [
34985           {
34986             "group": "Body",
34987             "type": "String",
34988             "optional": false,
34989             "field": "name",
34990             "description": ""
34991           },
34992           {
34993             "group": "Body",
34994             "type": "String",
34995             "allowedValues": [
34996               "\"first\"",
34997               "\"second\"",
34998               "\"third\""
34999             ],
35000             "optional": false,
35001             "field": "level",
35002             "description": ""
35003           },
35004           {
35005             "group": "Body",
35006             "type": "String",
35007             "optional": true,
35008             "field": "description",
35009             "description": ""
35010           }
35011         ]
35012       }
35013     },
35014     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35015     "version": "0.0.0",
35016     "filename": "server/api/whatsappAccount/index.js",
35017     "groupTitle": "Whatsapp_Accounts"
35018   },
35019   {
35020     "type": "get",
35021     "url": "/api/whatsapp/accounts/{id}/canned_answers",
35022     "title": "Gets account canned answers",
35023     "examples": [
35024       {
35025         "title": "Example usage:",
35026         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
35027         "type": "json"
35028       }
35029     ],
35030     "name": "getAnswers",
35031     "group": "Whatsapp_Accounts",
35032     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35033     "version": "0.0.0",
35034     "filename": "server/api/whatsappAccount/index.js",
35035     "groupTitle": "Whatsapp_Accounts"
35036   },
35037   {
35038     "type": "get",
35039     "url": "/api/whatsapp/accounts/{id}/applications",
35040     "title": "Gets account applications",
35041     "examples": [
35042       {
35043         "title": "Example usage:",
35044         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -v -u {name}:{password} -X GET",
35045         "type": "json"
35046       }
35047     ],
35048     "name": "getApplications",
35049     "group": "Whatsapp_Accounts",
35050     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35051     "version": "0.0.0",
35052     "filename": "server/api/whatsappAccount/index.js",
35053     "groupTitle": "Whatsapp_Accounts"
35054   },
35055   {
35056     "type": "get",
35057     "url": "/api/whatsapp/accounts/{id}/dispositions",
35058     "title": "Gets account dispositions",
35059     "examples": [
35060       {
35061         "title": "Example usage:",
35062         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
35063         "type": "json"
35064       }
35065     ],
35066     "name": "getDispositions",
35067     "group": "Whatsapp_Accounts",
35068     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35069     "version": "0.0.0",
35070     "filename": "server/api/whatsappAccount/index.js",
35071     "groupTitle": "Whatsapp_Accounts"
35072   },
35073   {
35074     "type": "post",
35075     "url": "/api/whatsapp/accounts/{id}/notify",
35076     "title": "Notify new message",
35077     "examples": [
35078       {
35079         "title": "Example usage:",
35080         "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",
35081         "type": "json"
35082       }
35083     ],
35084     "name": "notify",
35085     "group": "Whatsapp_Accounts",
35086     "description": "<p>Motion 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>",
35087     "version": "0.0.0",
35088     "filename": "server/api/whatsappAccount/index.js",
35089     "groupTitle": "Whatsapp_Accounts"
35090   },
35091   {
35092     "type": "put",
35093     "url": "/api/whatsapp/messages/{id}/reject",
35094     "title": "Rejects message",
35095     "examples": [
35096       {
35097         "title": "Example usage:",
35098         "content": "curl https://{domain}/api/whatsapp/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
35099         "type": "json"
35100       }
35101     ],
35102     "name": "rejectMessage",
35103     "group": "Whatsapp_Accounts",
35104     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35105     "version": "0.0.0",
35106     "filename": "server/api/whatsappMessage/index.js",
35107     "groupTitle": "Whatsapp_Accounts"
35108   },
35109   {
35110     "type": "post",
35111     "url": "/api/whatsapp/accounts/{id}/send",
35112     "title": "Send new whatsapp message",
35113     "examples": [
35114       {
35115         "title": "Example usage:",
35116         "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",
35117         "type": "json"
35118       }
35119     ],
35120     "name": "sendWhatsapp",
35121     "group": "Whatsapp_Accounts",
35122     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35123     "version": "0.0.0",
35124     "filename": "server/api/whatsappAccount/index.js",
35125     "groupTitle": "Whatsapp_Accounts"
35126   },
35127   {
35128     "type": "post",
35129     "url": "/api/whatsapp/messages/{id}/status",
35130     "title": "Receive message status",
35131     "examples": [
35132       {
35133         "title": "Example usage:",
35134         "content": "curl https://{domain}/api/whatsapp/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
35135         "type": "json"
35136       }
35137     ],
35138     "name": "statusMessage",
35139     "group": "Whatsapp_Accounts",
35140     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35141     "version": "0.0.0",
35142     "filename": "server/api/whatsappMessage/index.js",
35143     "groupTitle": "Whatsapp_Accounts"
35144   },
35145   {
35146     "type": "put",
35147     "url": "/api/whatsapp/accounts/{id}",
35148     "title": "Update an existing Account",
35149     "examples": [
35150       {
35151         "title": "Example usage:",
35152         "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",
35153         "type": "json"
35154       }
35155     ],
35156     "name": "updateAccounts",
35157     "group": "Whatsapp_Accounts",
35158     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35159     "version": "0.0.0",
35160     "filename": "server/api/whatsappAccount/index.js",
35161     "groupTitle": "Whatsapp_Accounts"
35162   },
35163   {
35164     "type": "post",
35165     "url": "/api/whatsapp/applications",
35166     "title": "Creates a new Application",
35167     "examples": [
35168       {
35169         "title": "Example usage:",
35170         "content": "curl https://{domain}/api/whatsapp/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35171         "type": "json"
35172       }
35173     ],
35174     "name": "CreateApplications",
35175     "group": "Whatsapp_Applications",
35176     "parameter": {
35177       "fields": {
35178         "Body": [
35179           {
35180             "group": "Body",
35181             "type": "Integer",
35182             "optional": false,
35183             "field": "priority",
35184             "description": ""
35185           },
35186           {
35187             "group": "Body",
35188             "type": "String",
35189             "optional": false,
35190             "field": "app",
35191             "description": ""
35192           },
35193           {
35194             "group": "Body",
35195             "type": "Text",
35196             "optional": true,
35197             "field": "appdata",
35198             "description": ""
35199           },
35200           {
35201             "group": "Body",
35202             "type": "String",
35203             "optional": true,
35204             "field": "description",
35205             "description": ""
35206           },
35207           {
35208             "group": "Body",
35209             "type": "String",
35210             "optional": true,
35211             "field": "interval",
35212             "description": ""
35213           }
35214         ]
35215       }
35216     },
35217     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35218     "version": "0.0.0",
35219     "filename": "server/api/whatsappApplication/index.js",
35220     "groupTitle": "Whatsapp_Applications"
35221   },
35222   {
35223     "type": "delete",
35224     "url": "/api/whatsapp/applications/{id}",
35225     "title": "Deletes a Application",
35226     "examples": [
35227       {
35228         "title": "Example usage:",
35229         "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password} -X DELETE",
35230         "type": "json"
35231       }
35232     ],
35233     "name": "DeleteApplications",
35234     "group": "Whatsapp_Applications",
35235     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35236     "version": "0.0.0",
35237     "filename": "server/api/whatsappApplication/index.js",
35238     "groupTitle": "Whatsapp_Applications"
35239   },
35240   {
35241     "type": "get",
35242     "url": "/api/whatsapp/applications",
35243     "title": "Gets a list of Applications",
35244     "examples": [
35245       {
35246         "title": "Example usage:",
35247         "content": "curl https://{domain}/api/whatsapp/applications -v -u {name}:{password}",
35248         "type": "json"
35249       }
35250     ],
35251     "name": "GetApplications",
35252     "group": "Whatsapp_Applications",
35253     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35254     "version": "0.0.0",
35255     "filename": "server/api/whatsappApplication/index.js",
35256     "groupTitle": "Whatsapp_Applications"
35257   },
35258   {
35259     "type": "get",
35260     "url": "/api/whatsapp/applications/{id}",
35261     "title": "Gets a single Application",
35262     "examples": [
35263       {
35264         "title": "Example usage:",
35265         "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password}",
35266         "type": "json"
35267       }
35268     ],
35269     "name": "ShowApplications",
35270     "group": "Whatsapp_Applications",
35271     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35272     "version": "0.0.0",
35273     "filename": "server/api/whatsappApplication/index.js",
35274     "groupTitle": "Whatsapp_Applications"
35275   },
35276   {
35277     "type": "put",
35278     "url": "/api/whatsapp/applications/{id}",
35279     "title": "Update an existing Application",
35280     "examples": [
35281       {
35282         "title": "Example usage:",
35283         "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",
35284         "type": "json"
35285       }
35286     ],
35287     "name": "updateApplications",
35288     "group": "Whatsapp_Applications",
35289     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35290     "version": "0.0.0",
35291     "filename": "server/api/whatsappApplication/index.js",
35292     "groupTitle": "Whatsapp_Applications"
35293   },
35294   {
35295     "type": "post",
35296     "url": "/api/whatsapp/interactions/{id}/tags",
35297     "title": "Add tags to the interaction",
35298     "examples": [
35299       {
35300         "title": "Example usage:",
35301         "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",
35302         "type": "json"
35303       }
35304     ],
35305     "name": "AddTags",
35306     "group": "Whatsapp_Interactions",
35307     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35308     "version": "0.0.0",
35309     "filename": "server/api/whatsappInteraction/index.js",
35310     "groupTitle": "Whatsapp_Interactions"
35311   },
35312   {
35313     "type": "post",
35314     "url": "/api/whatsapp/interactions",
35315     "title": "Creates a new Interaction",
35316     "examples": [
35317       {
35318         "title": "Example usage:",
35319         "content": "curl https://{domain}/api/whatsapp/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35320         "type": "json"
35321       }
35322     ],
35323     "name": "CreateInteractions",
35324     "group": "Whatsapp_Interactions",
35325     "parameter": {
35326       "fields": {
35327         "Body": [
35328           {
35329             "group": "Body",
35330             "type": "Boolean",
35331             "optional": true,
35332             "field": "closed",
35333             "description": ""
35334           },
35335           {
35336             "group": "Body",
35337             "type": "String",
35338             "optional": true,
35339             "field": "closedAt",
35340             "description": ""
35341           },
35342           {
35343             "group": "Body",
35344             "type": "String",
35345             "optional": true,
35346             "field": "disposition",
35347             "description": ""
35348           },
35349           {
35350             "group": "Body",
35351             "type": "String",
35352             "optional": true,
35353             "field": "secondDisposition",
35354             "description": ""
35355           },
35356           {
35357             "group": "Body",
35358             "type": "String",
35359             "optional": true,
35360             "field": "thirdDisposition",
35361             "description": ""
35362           },
35363           {
35364             "group": "Body",
35365             "type": "String",
35366             "optional": true,
35367             "field": "note",
35368             "description": ""
35369           },
35370           {
35371             "group": "Body",
35372             "type": "String",
35373             "optional": true,
35374             "field": "phone",
35375             "description": ""
35376           },
35377           {
35378             "group": "Body",
35379             "type": "String",
35380             "optional": true,
35381             "field": "read1stAt",
35382             "description": ""
35383           },
35384           {
35385             "group": "Body",
35386             "type": "String",
35387             "allowedValues": [
35388               "\"in\"",
35389               "\"out\""
35390             ],
35391             "optional": false,
35392             "field": "firstMsgDirection",
35393             "description": ""
35394           },
35395           {
35396             "group": "Body",
35397             "type": "String",
35398             "optional": true,
35399             "field": "lastMsgAt",
35400             "description": ""
35401           },
35402           {
35403             "group": "Body",
35404             "type": "String",
35405             "allowedValues": [
35406               "\"in\"",
35407               "\"out\""
35408             ],
35409             "optional": false,
35410             "field": "lastMsgDirection",
35411             "description": ""
35412           },
35413           {
35414             "group": "Body",
35415             "type": "Boolean",
35416             "optional": true,
35417             "field": "autoreplyExecuted",
35418             "description": ""
35419           }
35420         ]
35421       }
35422     },
35423     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35424     "version": "0.0.0",
35425     "filename": "server/api/whatsappInteraction/index.js",
35426     "groupTitle": "Whatsapp_Interactions"
35427   },
35428   {
35429     "type": "delete",
35430     "url": "/api/whatsapp/interactions/{id}",
35431     "title": "Deletes a Interaction",
35432     "examples": [
35433       {
35434         "title": "Example usage:",
35435         "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password} -X DELETE",
35436         "type": "json"
35437       }
35438     ],
35439     "name": "DeleteInteractions",
35440     "group": "Whatsapp_Interactions",
35441     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35442     "version": "0.0.0",
35443     "filename": "server/api/whatsappInteraction/index.js",
35444     "groupTitle": "Whatsapp_Interactions"
35445   },
35446   {
35447     "type": "get",
35448     "url": "/api/whatsapp/interactions/describe",
35449     "title": "Gets table info about Interactions",
35450     "examples": [
35451       {
35452         "title": "Example usage:",
35453         "content": "curl https://{domain}/api/whatsapp/interactions/describe -v -u {name}:{password}",
35454         "type": "json"
35455       }
35456     ],
35457     "name": "DescribeInteractions",
35458     "group": "Whatsapp_Interactions",
35459     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35460     "version": "0.0.0",
35461     "filename": "server/api/whatsappInteraction/index.js",
35462     "groupTitle": "Whatsapp_Interactions"
35463   },
35464   {
35465     "type": "get",
35466     "url": "/api/whatsapp/interactions",
35467     "title": "Gets a list of Interactions",
35468     "examples": [
35469       {
35470         "title": "Example usage:",
35471         "content": "curl https://{domain}/api/whatsapp/interactions -v -u {name}:{password}",
35472         "type": "json"
35473       }
35474     ],
35475     "name": "GetInteractions",
35476     "group": "Whatsapp_Interactions",
35477     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35478     "version": "0.0.0",
35479     "filename": "server/api/whatsappInteraction/index.js",
35480     "groupTitle": "Whatsapp_Interactions"
35481   },
35482   {
35483     "type": "delete",
35484     "url": "/api/whatsapp/interactions/{id}/tags",
35485     "title": "Removes tags from interaction",
35486     "examples": [
35487       {
35488         "title": "Example usage:",
35489         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
35490         "type": "json"
35491       }
35492     ],
35493     "name": "RemoveTags",
35494     "group": "Whatsapp_Interactions",
35495     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35496     "version": "0.0.0",
35497     "filename": "server/api/whatsappInteraction/index.js",
35498     "groupTitle": "Whatsapp_Interactions"
35499   },
35500   {
35501     "type": "get",
35502     "url": "/api/whatsapp/interactions/{id}",
35503     "title": "Gets a single Interaction",
35504     "examples": [
35505       {
35506         "title": "Example usage:",
35507         "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password}",
35508         "type": "json"
35509       }
35510     ],
35511     "name": "ShowInteractions",
35512     "group": "Whatsapp_Interactions",
35513     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35514     "version": "0.0.0",
35515     "filename": "server/api/whatsappInteraction/index.js",
35516     "groupTitle": "Whatsapp_Interactions"
35517   },
35518   {
35519     "type": "post",
35520     "url": "/api/whatsapp/interactions/{id}/messages",
35521     "title": "Creates new messages",
35522     "examples": [
35523       {
35524         "title": "Example usage:",
35525         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35526         "type": "json"
35527       }
35528     ],
35529     "name": "addMessage",
35530     "group": "Whatsapp_Interactions",
35531     "parameter": {
35532       "fields": {
35533         "Body": [
35534           {
35535             "group": "Body",
35536             "type": "Text",
35537             "optional": false,
35538             "field": "body",
35539             "description": ""
35540           },
35541           {
35542             "group": "Body",
35543             "type": "Boolean",
35544             "optional": true,
35545             "field": "read",
35546             "description": ""
35547           },
35548           {
35549             "group": "Body",
35550             "type": "String",
35551             "allowedValues": [
35552               "\"in\"",
35553               "\"out\""
35554             ],
35555             "optional": false,
35556             "field": "direction",
35557             "description": ""
35558           },
35559           {
35560             "group": "Body",
35561             "type": "String",
35562             "optional": true,
35563             "field": "messageId",
35564             "description": ""
35565           },
35566           {
35567             "group": "Body",
35568             "type": "String",
35569             "optional": true,
35570             "field": "phone",
35571             "description": ""
35572           },
35573           {
35574             "group": "Body",
35575             "type": "String",
35576             "optional": true,
35577             "field": "readAt",
35578             "description": ""
35579           },
35580           {
35581             "group": "Body",
35582             "type": "Boolean",
35583             "optional": true,
35584             "field": "secret",
35585             "description": ""
35586           },
35587           {
35588             "group": "Body",
35589             "type": "String",
35590             "optional": true,
35591             "field": "providerName",
35592             "description": ""
35593           },
35594           {
35595             "group": "Body",
35596             "type": "Text",
35597             "optional": true,
35598             "field": "providerResponse",
35599             "description": ""
35600           }
35601         ]
35602       }
35603     },
35604     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35605     "version": "0.0.0",
35606     "filename": "server/api/whatsappInteraction/index.js",
35607     "groupTitle": "Whatsapp_Interactions"
35608   },
35609   {
35610     "type": "get",
35611     "url": "/api/whatsapp/interactions/{id}/download",
35612     "title": "Gets interaction",
35613     "examples": [
35614       {
35615         "title": "Example usage:",
35616         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/download -v -u {name}:{password} -X GET",
35617         "type": "json"
35618       }
35619     ],
35620     "name": "download",
35621     "group": "Whatsapp_Interactions",
35622     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35623     "version": "0.0.0",
35624     "filename": "server/api/whatsappInteraction/index.js",
35625     "groupTitle": "Whatsapp_Interactions"
35626   },
35627   {
35628     "type": "get",
35629     "url": "/api/whatsapp/interactions/{id}/messages",
35630     "title": "Gets interaction messages",
35631     "examples": [
35632       {
35633         "title": "Example usage:",
35634         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -v -u {name}:{password} -X GET",
35635         "type": "json"
35636       }
35637     ],
35638     "name": "getMessages",
35639     "group": "Whatsapp_Interactions",
35640     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35641     "version": "0.0.0",
35642     "filename": "server/api/whatsappInteraction/index.js",
35643     "groupTitle": "Whatsapp_Interactions"
35644   },
35645   {
35646     "type": "put",
35647     "url": "/api/whatsapp/interactions/{id}",
35648     "title": "Update an existing Interaction",
35649     "examples": [
35650       {
35651         "title": "Example usage:",
35652         "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",
35653         "type": "json"
35654       }
35655     ],
35656     "name": "updateInteractions",
35657     "group": "Whatsapp_Interactions",
35658     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35659     "version": "0.0.0",
35660     "filename": "server/api/whatsappInteraction/index.js",
35661     "groupTitle": "Whatsapp_Interactions"
35662   },
35663   {
35664     "type": "post",
35665     "url": "/api/whatsapp/messages",
35666     "title": "Creates a new Message",
35667     "examples": [
35668       {
35669         "title": "Example usage:",
35670         "content": "curl https://{domain}/api/whatsapp/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35671         "type": "json"
35672       }
35673     ],
35674     "name": "CreateMessages",
35675     "group": "Whatsapp_Messages",
35676     "parameter": {
35677       "fields": {
35678         "Body": [
35679           {
35680             "group": "Body",
35681             "type": "Text",
35682             "optional": false,
35683             "field": "body",
35684             "description": ""
35685           },
35686           {
35687             "group": "Body",
35688             "type": "Boolean",
35689             "optional": true,
35690             "field": "read",
35691             "description": ""
35692           },
35693           {
35694             "group": "Body",
35695             "type": "String",
35696             "allowedValues": [
35697               "\"in\"",
35698               "\"out\""
35699             ],
35700             "optional": false,
35701             "field": "direction",
35702             "description": ""
35703           },
35704           {
35705             "group": "Body",
35706             "type": "String",
35707             "optional": true,
35708             "field": "messageId",
35709             "description": ""
35710           },
35711           {
35712             "group": "Body",
35713             "type": "String",
35714             "optional": true,
35715             "field": "phone",
35716             "description": ""
35717           },
35718           {
35719             "group": "Body",
35720             "type": "String",
35721             "optional": true,
35722             "field": "readAt",
35723             "description": ""
35724           },
35725           {
35726             "group": "Body",
35727             "type": "Boolean",
35728             "optional": true,
35729             "field": "secret",
35730             "description": ""
35731           },
35732           {
35733             "group": "Body",
35734             "type": "String",
35735             "optional": true,
35736             "field": "providerName",
35737             "description": ""
35738           },
35739           {
35740             "group": "Body",
35741             "type": "Text",
35742             "optional": true,
35743             "field": "providerResponse",
35744             "description": ""
35745           }
35746         ]
35747       }
35748     },
35749     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35750     "version": "0.0.0",
35751     "filename": "server/api/whatsappMessage/index.js",
35752     "groupTitle": "Whatsapp_Messages"
35753   },
35754   {
35755     "type": "delete",
35756     "url": "/api/whatsapp/messages/{id}",
35757     "title": "Deletes a Message",
35758     "examples": [
35759       {
35760         "title": "Example usage:",
35761         "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password} -X DELETE",
35762         "type": "json"
35763       }
35764     ],
35765     "name": "DeleteMessages",
35766     "group": "Whatsapp_Messages",
35767     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35768     "version": "0.0.0",
35769     "filename": "server/api/whatsappMessage/index.js",
35770     "groupTitle": "Whatsapp_Messages"
35771   },
35772   {
35773     "type": "get",
35774     "url": "/api/whatsapp/messages/describe",
35775     "title": "Gets table info about Messages",
35776     "examples": [
35777       {
35778         "title": "Example usage:",
35779         "content": "curl https://{domain}/api/whatsapp/messages/describe -v -u {name}:{password}",
35780         "type": "json"
35781       }
35782     ],
35783     "name": "DescribeMessages",
35784     "group": "Whatsapp_Messages",
35785     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35786     "version": "0.0.0",
35787     "filename": "server/api/whatsappMessage/index.js",
35788     "groupTitle": "Whatsapp_Messages"
35789   },
35790   {
35791     "type": "get",
35792     "url": "/api/whatsapp/messages",
35793     "title": "Gets a list of Messages",
35794     "examples": [
35795       {
35796         "title": "Example usage:",
35797         "content": "curl https://{domain}/api/whatsapp/messages -v -u {name}:{password}",
35798         "type": "json"
35799       }
35800     ],
35801     "name": "GetMessages",
35802     "group": "Whatsapp_Messages",
35803     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35804     "version": "0.0.0",
35805     "filename": "server/api/whatsappMessage/index.js",
35806     "groupTitle": "Whatsapp_Messages"
35807   },
35808   {
35809     "type": "get",
35810     "url": "/api/whatsapp/messages/{id}",
35811     "title": "Gets a single Message",
35812     "examples": [
35813       {
35814         "title": "Example usage:",
35815         "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password}",
35816         "type": "json"
35817       }
35818     ],
35819     "name": "ShowMessages",
35820     "group": "Whatsapp_Messages",
35821     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35822     "version": "0.0.0",
35823     "filename": "server/api/whatsappMessage/index.js",
35824     "groupTitle": "Whatsapp_Messages"
35825   },
35826   {
35827     "type": "put",
35828     "url": "/api/whatsapp/messages/{id}",
35829     "title": "Update an existing Message",
35830     "examples": [
35831       {
35832         "title": "Example usage:",
35833         "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",
35834         "type": "json"
35835       }
35836     ],
35837     "name": "updateMessages",
35838     "group": "Whatsapp_Messages",
35839     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35840     "version": "0.0.0",
35841     "filename": "server/api/whatsappMessage/index.js",
35842     "groupTitle": "Whatsapp_Messages"
35843   },
35844   {
35845     "type": "post",
35846     "url": "/api/whatsapp/reports/queue",
35847     "title": "Creates a new Whatsapp Queue Report",
35848     "examples": [
35849       {
35850         "title": "Example usage:",
35851         "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",
35852         "type": "json"
35853       }
35854     ],
35855     "name": "CreateWhatsapp_Queue_Reports",
35856     "group": "Whatsapp_Queue_Reports",
35857     "parameter": {
35858       "fields": {
35859         "Body": [
35860           {
35861             "group": "Body",
35862             "type": "String",
35863             "optional": false,
35864             "field": "uniqueid",
35865             "description": ""
35866           },
35867           {
35868             "group": "Body",
35869             "type": "String",
35870             "optional": true,
35871             "field": "from",
35872             "description": ""
35873           },
35874           {
35875             "group": "Body",
35876             "type": "String",
35877             "optional": true,
35878             "field": "joinAt",
35879             "description": ""
35880           },
35881           {
35882             "group": "Body",
35883             "type": "String",
35884             "optional": true,
35885             "field": "leaveAt",
35886             "description": ""
35887           },
35888           {
35889             "group": "Body",
35890             "type": "String",
35891             "optional": true,
35892             "field": "acceptAt",
35893             "description": ""
35894           },
35895           {
35896             "group": "Body",
35897             "type": "String",
35898             "optional": true,
35899             "field": "exitAt",
35900             "description": ""
35901           },
35902           {
35903             "group": "Body",
35904             "type": "String",
35905             "optional": true,
35906             "field": "reason",
35907             "description": ""
35908           }
35909         ]
35910       }
35911     },
35912     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35913     "version": "0.0.0",
35914     "filename": "server/api/whatsappQueueReport/index.js",
35915     "groupTitle": "Whatsapp_Queue_Reports"
35916   },
35917   {
35918     "type": "delete",
35919     "url": "/api/whatsapp/reports/queue/{id}",
35920     "title": "Deletes a Whatsapp Queue Report",
35921     "examples": [
35922       {
35923         "title": "Example usage:",
35924         "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password} -X DELETE",
35925         "type": "json"
35926       }
35927     ],
35928     "name": "DeleteWhatsapp_Queue_Reports",
35929     "group": "Whatsapp_Queue_Reports",
35930     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35931     "version": "0.0.0",
35932     "filename": "server/api/whatsappQueueReport/index.js",
35933     "groupTitle": "Whatsapp_Queue_Reports"
35934   },
35935   {
35936     "type": "get",
35937     "url": "/api/whatsapp/reports/queue/describe",
35938     "title": "Gets table info about Whatsapp Queue Reports",
35939     "examples": [
35940       {
35941         "title": "Example usage:",
35942         "content": "curl https://{domain}/api/whatsapp/reports/queue/describe -v -u {name}:{password}",
35943         "type": "json"
35944       }
35945     ],
35946     "name": "DescribeWhatsapp_Queue_Reports",
35947     "group": "Whatsapp_Queue_Reports",
35948     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35949     "version": "0.0.0",
35950     "filename": "server/api/whatsappQueueReport/index.js",
35951     "groupTitle": "Whatsapp_Queue_Reports"
35952   },
35953   {
35954     "type": "get",
35955     "url": "/api/whatsapp/reports/queue",
35956     "title": "Gets a list of Whatsapp Queue Reports",
35957     "examples": [
35958       {
35959         "title": "Example usage:",
35960         "content": "curl https://{domain}/api/whatsapp/reports/queue -v -u {name}:{password}",
35961         "type": "json"
35962       }
35963     ],
35964     "name": "GetWhatsapp_Queue_Reports",
35965     "group": "Whatsapp_Queue_Reports",
35966     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35967     "version": "0.0.0",
35968     "filename": "server/api/whatsappQueueReport/index.js",
35969     "groupTitle": "Whatsapp_Queue_Reports"
35970   },
35971   {
35972     "type": "get",
35973     "url": "/api/whatsapp/reports/queue/{id}",
35974     "title": "Gets a single Whatsapp Queue Report",
35975     "examples": [
35976       {
35977         "title": "Example usage:",
35978         "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password}",
35979         "type": "json"
35980       }
35981     ],
35982     "name": "ShowWhatsapp_Queue_Reports",
35983     "group": "Whatsapp_Queue_Reports",
35984     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35985     "version": "0.0.0",
35986     "filename": "server/api/whatsappQueueReport/index.js",
35987     "groupTitle": "Whatsapp_Queue_Reports"
35988   },
35989   {
35990     "type": "put",
35991     "url": "/api/whatsapp/reports/queue/{id}",
35992     "title": "Update an existing Whatsapp Queue Report",
35993     "examples": [
35994       {
35995         "title": "Example usage:",
35996         "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",
35997         "type": "json"
35998       }
35999     ],
36000     "name": "updateWhatsapp_Queue_Reports",
36001     "group": "Whatsapp_Queue_Reports",
36002     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36003     "version": "0.0.0",
36004     "filename": "server/api/whatsappQueueReport/index.js",
36005     "groupTitle": "Whatsapp_Queue_Reports"
36006   },
36007   {
36008     "type": "post",
36009     "url": "/api/whatsapp/queues/{id}/users",
36010     "title": "Add agents to a queue",
36011     "examples": [
36012       {
36013         "title": "Example usage:",
36014         "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",
36015         "type": "json"
36016       }
36017     ],
36018     "name": "AddAgents",
36019     "group": "Whatsapp_Queues",
36020     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36021     "version": "0.0.0",
36022     "filename": "server/api/whatsappQueue/index.js",
36023     "groupTitle": "Whatsapp_Queues"
36024   },
36025   {
36026     "type": "post",
36027     "url": "/api/whatsapp/queues/{id}/teams",
36028     "title": "Add teams to a queue",
36029     "examples": [
36030       {
36031         "title": "Example usage:",
36032         "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",
36033         "type": "json"
36034       }
36035     ],
36036     "name": "AddTeams",
36037     "group": "Whatsapp_Queues",
36038     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36039     "version": "0.0.0",
36040     "filename": "server/api/whatsappQueue/index.js",
36041     "groupTitle": "Whatsapp_Queues"
36042   },
36043   {
36044     "type": "post",
36045     "url": "/api/whatsapp/queues",
36046     "title": "Creates a new Queue",
36047     "examples": [
36048       {
36049         "title": "Example usage:",
36050         "content": "curl https://{domain}/api/whatsapp/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
36051         "type": "json"
36052       }
36053     ],
36054     "name": "CreateQueues",
36055     "group": "Whatsapp_Queues",
36056     "parameter": {
36057       "fields": {
36058         "Body": [
36059           {
36060             "group": "Body",
36061             "type": "String",
36062             "optional": true,
36063             "field": "name",
36064             "description": ""
36065           },
36066           {
36067             "group": "Body",
36068             "type": "Integer",
36069             "optional": true,
36070             "field": "timeout",
36071             "description": ""
36072           },
36073           {
36074             "group": "Body",
36075             "type": "String",
36076             "allowedValues": [
36077               "\"rrmemory\"",
36078               "\"beepall\"",
36079               "\"roundrobin\""
36080             ],
36081             "optional": true,
36082             "field": "strategy",
36083             "description": ""
36084           },
36085           {
36086             "group": "Body",
36087             "type": "String",
36088             "optional": true,
36089             "field": "description",
36090             "description": ""
36091           }
36092         ]
36093       }
36094     },
36095     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36096     "version": "0.0.0",
36097     "filename": "server/api/whatsappQueue/index.js",
36098     "groupTitle": "Whatsapp_Queues"
36099   },
36100   {
36101     "type": "delete",
36102     "url": "/api/whatsapp/queues/{id}",
36103     "title": "Deletes a Queue",
36104     "examples": [
36105       {
36106         "title": "Example usage:",
36107         "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password} -X DELETE",
36108         "type": "json"
36109       }
36110     ],
36111     "name": "DeleteQueues",
36112     "group": "Whatsapp_Queues",
36113     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36114     "version": "0.0.0",
36115     "filename": "server/api/whatsappQueue/index.js",
36116     "groupTitle": "Whatsapp_Queues"
36117   },
36118   {
36119     "type": "get",
36120     "url": "/api/whatsapp/queues/describe",
36121     "title": "Gets table info about Queues",
36122     "examples": [
36123       {
36124         "title": "Example usage:",
36125         "content": "curl https://{domain}/api/whatsapp/queues/describe -v -u {name}:{password}",
36126         "type": "json"
36127       }
36128     ],
36129     "name": "DescribeQueues",
36130     "group": "Whatsapp_Queues",
36131     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36132     "version": "0.0.0",
36133     "filename": "server/api/whatsappQueue/index.js",
36134     "groupTitle": "Whatsapp_Queues"
36135   },
36136   {
36137     "type": "get",
36138     "url": "/api/whatsapp/queues/{id}/users",
36139     "title": "Gets queue agents",
36140     "examples": [
36141       {
36142         "title": "Example usage:",
36143         "content": "curl https://{domain}/api/whatsapp/queues/{id}/users -v -u {name}:{password} -X POST",
36144         "type": "json"
36145       }
36146     ],
36147     "name": "GetAgents",
36148     "group": "Whatsapp_Queues",
36149     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36150     "version": "0.0.0",
36151     "filename": "server/api/whatsappQueue/index.js",
36152     "groupTitle": "Whatsapp_Queues"
36153   },
36154   {
36155     "type": "get",
36156     "url": "/api/whatsapp/queues/{id}/members",
36157     "title": "GetMembers",
36158     "examples": [
36159       {
36160         "title": "Example usage:",
36161         "content": "curl https://{domain}/api/whatsapp/queues/{id}/members  -v -u {name}:{password}",
36162         "type": "json"
36163       }
36164     ],
36165     "name": "GetMembers",
36166     "group": "Whatsapp_Queues",
36167     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36168     "version": "0.0.0",
36169     "filename": "server/api/whatsappQueue/index.js",
36170     "groupTitle": "Whatsapp_Queues"
36171   },
36172   {
36173     "type": "get",
36174     "url": "/api/whatsapp/queues",
36175     "title": "Gets a list of Queues",
36176     "examples": [
36177       {
36178         "title": "Example usage:",
36179         "content": "curl https://{domain}/api/whatsapp/queues -v -u {name}:{password}",
36180         "type": "json"
36181       }
36182     ],
36183     "name": "GetQueues",
36184     "group": "Whatsapp_Queues",
36185     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36186     "version": "0.0.0",
36187     "filename": "server/api/whatsappQueue/index.js",
36188     "groupTitle": "Whatsapp_Queues"
36189   },
36190   {
36191     "type": "get",
36192     "url": "/api/whatsapp/queues/{id}/teams",
36193     "title": "Gets queues list",
36194     "examples": [
36195       {
36196         "title": "Example usage:",
36197         "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password}",
36198         "type": "json"
36199       }
36200     ],
36201     "name": "GetTeams",
36202     "group": "Whatsapp_Queues",
36203     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36204     "version": "0.0.0",
36205     "filename": "server/api/whatsappQueue/index.js",
36206     "groupTitle": "Whatsapp_Queues"
36207   },
36208   {
36209     "type": "delete",
36210     "url": "/api/whatsapp/queues/{id}/users",
36211     "title": "Removes agents from a queue",
36212     "examples": [
36213       {
36214         "title": "Example usage:",
36215         "content": "curl https://{domain}/api/whatsapp/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
36216         "type": "json"
36217       }
36218     ],
36219     "name": "RemoveAgents",
36220     "group": "Whatsapp_Queues",
36221     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36222     "version": "0.0.0",
36223     "filename": "server/api/whatsappQueue/index.js",
36224     "groupTitle": "Whatsapp_Queues"
36225   },
36226   {
36227     "type": "get",
36228     "url": "/api/whatsapp/queues/{id}",
36229     "title": "Gets a single Queue",
36230     "examples": [
36231       {
36232         "title": "Example usage:",
36233         "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password}",
36234         "type": "json"
36235       }
36236     ],
36237     "name": "ShowQueues",
36238     "group": "Whatsapp_Queues",
36239     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36240     "version": "0.0.0",
36241     "filename": "server/api/whatsappQueue/index.js",
36242     "groupTitle": "Whatsapp_Queues"
36243   },
36244   {
36245     "type": "put",
36246     "url": "/api/whatsapp/queues/{id}",
36247     "title": "Update an existing Queue",
36248     "examples": [
36249       {
36250         "title": "Example usage:",
36251         "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",
36252         "type": "json"
36253       }
36254     ],
36255     "name": "updateQueues",
36256     "group": "Whatsapp_Queues",
36257     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36258     "version": "0.0.0",
36259     "filename": "server/api/whatsappQueue/index.js",
36260     "groupTitle": "Whatsapp_Queues"
36261   },
36262   {
36263     "type": "post",
36264     "url": "/api/whatsapp/reports/transfer",
36265     "title": "Creates a new Whatsapp Transfer Report",
36266     "examples": [
36267       {
36268         "title": "Example usage:",
36269         "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",
36270         "type": "json"
36271       }
36272     ],
36273     "name": "CreateWhatsapp_Transfer_Reports",
36274     "group": "Whatsapp_Transfer_Reports",
36275     "parameter": {
36276       "fields": {
36277         "Body": [
36278           {
36279             "group": "Body",
36280             "type": "String",
36281             "optional": false,
36282             "field": "uniqueid",
36283             "description": ""
36284           },
36285           {
36286             "group": "Body",
36287             "type": "String",
36288             "allowedValues": [
36289               "\"account\"",
36290               "\"agent\"",
36291               "\"queue\""
36292             ],
36293             "optional": false,
36294             "field": "type",
36295             "description": ""
36296           },
36297           {
36298             "group": "Body",
36299             "type": "String",
36300             "optional": true,
36301             "field": "transferredAt",
36302             "description": ""
36303           }
36304         ]
36305       }
36306     },
36307     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36308     "version": "0.0.0",
36309     "filename": "server/api/whatsappTransferReport/index.js",
36310     "groupTitle": "Whatsapp_Transfer_Reports"
36311   },
36312   {
36313     "type": "delete",
36314     "url": "/api/whatsapp/reports/transfer/{id}",
36315     "title": "Deletes a Whatsapp Transfer Report",
36316     "examples": [
36317       {
36318         "title": "Example usage:",
36319         "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
36320         "type": "json"
36321       }
36322     ],
36323     "name": "DeleteWhatsapp_Transfer_Reports",
36324     "group": "Whatsapp_Transfer_Reports",
36325     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36326     "version": "0.0.0",
36327     "filename": "server/api/whatsappTransferReport/index.js",
36328     "groupTitle": "Whatsapp_Transfer_Reports"
36329   },
36330   {
36331     "type": "get",
36332     "url": "/api/whatsapp/reports/transfer/describe",
36333     "title": "Gets table info about Whatsapp Transfer Reports",
36334     "examples": [
36335       {
36336         "title": "Example usage:",
36337         "content": "curl https://{domain}/api/whatsapp/reports/transfer/describe -v -u {name}:{password}",
36338         "type": "json"
36339       }
36340     ],
36341     "name": "DescribeWhatsapp_Transfer_Reports",
36342     "group": "Whatsapp_Transfer_Reports",
36343     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36344     "version": "0.0.0",
36345     "filename": "server/api/whatsappTransferReport/index.js",
36346     "groupTitle": "Whatsapp_Transfer_Reports"
36347   },
36348   {
36349     "type": "get",
36350     "url": "/api/whatsapp/reports/transfer",
36351     "title": "Gets a list of Whatsapp Transfer Reports",
36352     "examples": [
36353       {
36354         "title": "Example usage:",
36355         "content": "curl https://{domain}/api/whatsapp/reports/transfer -v -u {name}:{password}",
36356         "type": "json"
36357       }
36358     ],
36359     "name": "GetWhatsapp_Transfer_Reports",
36360     "group": "Whatsapp_Transfer_Reports",
36361     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36362     "version": "0.0.0",
36363     "filename": "server/api/whatsappTransferReport/index.js",
36364     "groupTitle": "Whatsapp_Transfer_Reports"
36365   },
36366   {
36367     "type": "get",
36368     "url": "/api/whatsapp/reports/transfer/{id}",
36369     "title": "Gets a single Whatsapp Transfer Report",
36370     "examples": [
36371       {
36372         "title": "Example usage:",
36373         "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password}",
36374         "type": "json"
36375       }
36376     ],
36377     "name": "ShowWhatsapp_Transfer_Reports",
36378     "group": "Whatsapp_Transfer_Reports",
36379     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36380     "version": "0.0.0",
36381     "filename": "server/api/whatsappTransferReport/index.js",
36382     "groupTitle": "Whatsapp_Transfer_Reports"
36383   },
36384   {
36385     "type": "put",
36386     "url": "/api/whatsapp/reports/transfer/{id}",
36387     "title": "Update an existing Whatsapp Transfer Report",
36388     "examples": [
36389       {
36390         "title": "Example usage:",
36391         "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",
36392         "type": "json"
36393       }
36394     ],
36395     "name": "updateWhatsapp_Transfer_Reports",
36396     "group": "Whatsapp_Transfer_Reports",
36397     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36398     "version": "0.0.0",
36399     "filename": "server/api/whatsappTransferReport/index.js",
36400     "groupTitle": "Whatsapp_Transfer_Reports"
36401   },
36402   {
36403     "type": "post",
36404     "url": "/api/integrations/zendesk/accounts",
36405     "title": "Creates a new Zendesk Account",
36406     "examples": [
36407       {
36408         "title": "Example usage:",
36409         "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",
36410         "type": "json"
36411       }
36412     ],
36413     "name": "CreateZendesk_Accounts",
36414     "group": "Zendesk_Accounts",
36415     "parameter": {
36416       "fields": {
36417         "Body": [
36418           {
36419             "group": "Body",
36420             "type": "String",
36421             "optional": true,
36422             "field": "name",
36423             "description": ""
36424           },
36425           {
36426             "group": "Body",
36427             "type": "String",
36428             "optional": true,
36429             "field": "description",
36430             "description": ""
36431           },
36432           {
36433             "group": "Body",
36434             "type": "String",
36435             "optional": true,
36436             "field": "username",
36437             "description": ""
36438           },
36439           {
36440             "group": "Body",
36441             "type": "String",
36442             "optional": true,
36443             "field": "password",
36444             "description": ""
36445           },
36446           {
36447             "group": "Body",
36448             "type": "String",
36449             "optional": true,
36450             "field": "token",
36451             "description": ""
36452           },
36453           {
36454             "group": "Body",
36455             "type": "String",
36456             "optional": true,
36457             "field": "remoteUri",
36458             "description": ""
36459           },
36460           {
36461             "group": "Body",
36462             "type": "String",
36463             "allowedValues": [
36464               "\"password\"",
36465               "\"token\""
36466             ],
36467             "optional": true,
36468             "field": "authType",
36469             "description": ""
36470           },
36471           {
36472             "group": "Body",
36473             "type": "String",
36474             "optional": false,
36475             "field": "serverUrl",
36476             "description": ""
36477           },
36478           {
36479             "group": "Body",
36480             "type": "String",
36481             "allowedValues": [
36482               "\"integrationTab\"",
36483               "\"newTab\""
36484             ],
36485             "optional": true,
36486             "field": "type",
36487             "description": ""
36488           }
36489         ]
36490       }
36491     },
36492     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36493     "version": "0.0.0",
36494     "filename": "server/api/intZendeskAccount/index.js",
36495     "groupTitle": "Zendesk_Accounts"
36496   },
36497   {
36498     "type": "delete",
36499     "url": "/api/integrations/zendesk/accounts/{id}",
36500     "title": "Deletes a Zendesk Account",
36501     "examples": [
36502       {
36503         "title": "Example usage:",
36504         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password} -X DELETE",
36505         "type": "json"
36506       }
36507     ],
36508     "name": "DeleteZendesk_Accounts",
36509     "group": "Zendesk_Accounts",
36510     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36511     "version": "0.0.0",
36512     "filename": "server/api/intZendeskAccount/index.js",
36513     "groupTitle": "Zendesk_Accounts"
36514   },
36515   {
36516     "type": "get",
36517     "url": "/api/integrations/zendesk/accounts",
36518     "title": "Gets a list of Zendesk Accounts",
36519     "examples": [
36520       {
36521         "title": "Example usage:",
36522         "content": "curl https://{domain}/api/integrations/zendesk/accounts -v -u {name}:{password}",
36523         "type": "json"
36524       }
36525     ],
36526     "name": "GetZendesk_Accounts",
36527     "group": "Zendesk_Accounts",
36528     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36529     "version": "0.0.0",
36530     "filename": "server/api/intZendeskAccount/index.js",
36531     "groupTitle": "Zendesk_Accounts"
36532   },
36533   {
36534     "type": "get",
36535     "url": "/api/integrations/zendesk/accounts/{id}",
36536     "title": "Gets a single Zendesk Account",
36537     "examples": [
36538       {
36539         "title": "Example usage:",
36540         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password}",
36541         "type": "json"
36542       }
36543     ],
36544     "name": "ShowZendesk_Accounts",
36545     "group": "Zendesk_Accounts",
36546     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36547     "version": "0.0.0",
36548     "filename": "server/api/intZendeskAccount/index.js",
36549     "groupTitle": "Zendesk_Accounts"
36550   },
36551   {
36552     "type": "post",
36553     "url": "/api/integrations/zendesk/accounts/{id}/configurations",
36554     "title": "Creates new configuration",
36555     "examples": [
36556       {
36557         "title": "Example usage:",
36558         "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",
36559         "type": "json"
36560       }
36561     ],
36562     "name": "addConfiguration",
36563     "group": "Zendesk_Accounts",
36564     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36565     "version": "0.0.0",
36566     "filename": "server/api/intZendeskAccount/index.js",
36567     "groupTitle": "Zendesk_Accounts"
36568   },
36569   {
36570     "type": "get",
36571     "url": "/api/integrations/zendesk/accounts/{id}/configurations",
36572     "title": "Gets account configurations",
36573     "examples": [
36574       {
36575         "title": "Example usage:",
36576         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
36577         "type": "json"
36578       }
36579     ],
36580     "name": "getConfigurations",
36581     "group": "Zendesk_Accounts",
36582     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36583     "version": "0.0.0",
36584     "filename": "server/api/intZendeskAccount/index.js",
36585     "groupTitle": "Zendesk_Accounts"
36586   },
36587   {
36588     "type": "get",
36589     "url": "/api/integrations/zendesk/accounts/{id}/fields",
36590     "title": "Gets account fields",
36591     "examples": [
36592       {
36593         "title": "Example usage:",
36594         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
36595         "type": "json"
36596       }
36597     ],
36598     "name": "getFields",
36599     "group": "Zendesk_Accounts",
36600     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36601     "version": "0.0.0",
36602     "filename": "server/api/intZendeskAccount/index.js",
36603     "groupTitle": "Zendesk_Accounts"
36604   },
36605   {
36606     "type": "put",
36607     "url": "/api/integrations/zendesk/accounts/{id}",
36608     "title": "Update an existing Zendesk Account",
36609     "examples": [
36610       {
36611         "title": "Example usage:",
36612         "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",
36613         "type": "json"
36614       }
36615     ],
36616     "name": "updateZendesk_Accounts",
36617     "group": "Zendesk_Accounts",
36618     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36619     "version": "0.0.0",
36620     "filename": "server/api/intZendeskAccount/index.js",
36621     "groupTitle": "Zendesk_Accounts"
36622   },
36623   {
36624     "type": "post",
36625     "url": "/api/integrations/zendesk/configurations",
36626     "title": "Creates a new Zendesk Configuration",
36627     "examples": [
36628       {
36629         "title": "Example usage:",
36630         "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",
36631         "type": "json"
36632       }
36633     ],
36634     "name": "CreateZendesk_Configurations",
36635     "group": "Zendesk_Configurations",
36636     "parameter": {
36637       "fields": {
36638         "Body": [
36639           {
36640             "group": "Body",
36641             "type": "String",
36642             "optional": true,
36643             "field": "name",
36644             "description": ""
36645           },
36646           {
36647             "group": "Body",
36648             "type": "String",
36649             "optional": true,
36650             "field": "description",
36651             "description": ""
36652           }
36653         ]
36654       }
36655     },
36656     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36657     "version": "0.0.0",
36658     "filename": "server/api/intZendeskConfiguration/index.js",
36659     "groupTitle": "Zendesk_Configurations"
36660   },
36661   {
36662     "type": "delete",
36663     "url": "/api/integrations/zendesk/configurations/{id}",
36664     "title": "Deletes a Zendesk Configuration",
36665     "examples": [
36666       {
36667         "title": "Example usage:",
36668         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password} -X DELETE",
36669         "type": "json"
36670       }
36671     ],
36672     "name": "DeleteZendesk_Configurations",
36673     "group": "Zendesk_Configurations",
36674     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36675     "version": "0.0.0",
36676     "filename": "server/api/intZendeskConfiguration/index.js",
36677     "groupTitle": "Zendesk_Configurations"
36678   },
36679   {
36680     "type": "get",
36681     "url": "/api/integrations/zendesk/configurations",
36682     "title": "Gets a list of Zendesk Configurations",
36683     "examples": [
36684       {
36685         "title": "Example usage:",
36686         "content": "curl https://{domain}/api/integrations/zendesk/configurations -v -u {name}:{password}",
36687         "type": "json"
36688       }
36689     ],
36690     "name": "GetZendesk_Configurations",
36691     "group": "Zendesk_Configurations",
36692     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36693     "version": "0.0.0",
36694     "filename": "server/api/intZendeskConfiguration/index.js",
36695     "groupTitle": "Zendesk_Configurations"
36696   },
36697   {
36698     "type": "get",
36699     "url": "/api/integrations/zendesk/configurations/{id}",
36700     "title": "Gets a single Zendesk Configuration",
36701     "examples": [
36702       {
36703         "title": "Example usage:",
36704         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password}",
36705         "type": "json"
36706       }
36707     ],
36708     "name": "ShowZendesk_Configurations",
36709     "group": "Zendesk_Configurations",
36710     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36711     "version": "0.0.0",
36712     "filename": "server/api/intZendeskConfiguration/index.js",
36713     "groupTitle": "Zendesk_Configurations"
36714   },
36715   {
36716     "type": "get",
36717     "url": "/api/integrations/zendesk/configurations/{id}/descriptions",
36718     "title": "Gets configurations descriptions",
36719     "examples": [
36720       {
36721         "title": "Example usage:",
36722         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
36723         "type": "json"
36724       }
36725     ],
36726     "name": "getDescriptions",
36727     "group": "Zendesk_Configurations",
36728     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36729     "version": "0.0.0",
36730     "filename": "server/api/intZendeskConfiguration/index.js",
36731     "groupTitle": "Zendesk_Configurations"
36732   },
36733   {
36734     "type": "get",
36735     "url": "/api/integrations/zendesk/configurations/{id}/fields",
36736     "title": "Gets configurations fields",
36737     "examples": [
36738       {
36739         "title": "Example usage:",
36740         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
36741         "type": "json"
36742       }
36743     ],
36744     "name": "getFields",
36745     "group": "Zendesk_Configurations",
36746     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36747     "version": "0.0.0",
36748     "filename": "server/api/intZendeskConfiguration/index.js",
36749     "groupTitle": "Zendesk_Configurations"
36750   },
36751   {
36752     "type": "get",
36753     "url": "/api/integrations/zendesk/configurations/{id}/subjects",
36754     "title": "Gets configurations subjects",
36755     "examples": [
36756       {
36757         "title": "Example usage:",
36758         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
36759         "type": "json"
36760       }
36761     ],
36762     "name": "getSubjects",
36763     "group": "Zendesk_Configurations",
36764     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36765     "version": "0.0.0",
36766     "filename": "server/api/intZendeskConfiguration/index.js",
36767     "groupTitle": "Zendesk_Configurations"
36768   },
36769   {
36770     "type": "get",
36771     "url": "/api/integrations/zendesk/configurations/{id}/tags",
36772     "title": "Gets configurations tags",
36773     "examples": [
36774       {
36775         "title": "Example usage:",
36776         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
36777         "type": "json"
36778       }
36779     ],
36780     "name": "getTags",
36781     "group": "Zendesk_Configurations",
36782     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36783     "version": "0.0.0",
36784     "filename": "server/api/intZendeskConfiguration/index.js",
36785     "groupTitle": "Zendesk_Configurations"
36786   },
36787   {
36788     "type": "post",
36789     "url": "/api/integrations/zendesk/configurations/{id}/tags",
36790     "title": "Sets new tags",
36791     "examples": [
36792       {
36793         "title": "Example usage:",
36794         "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",
36795         "type": "json"
36796       }
36797     ],
36798     "name": "setTags",
36799     "group": "Zendesk_Configurations",
36800     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36801     "version": "0.0.0",
36802     "filename": "server/api/intZendeskConfiguration/index.js",
36803     "groupTitle": "Zendesk_Configurations"
36804   },
36805   {
36806     "type": "put",
36807     "url": "/api/integrations/zendesk/configurations/{id}",
36808     "title": "Update an existing Zendesk Configuration",
36809     "examples": [
36810       {
36811         "title": "Example usage:",
36812         "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",
36813         "type": "json"
36814       }
36815     ],
36816     "name": "updateZendesk_Configurations",
36817     "group": "Zendesk_Configurations",
36818     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36819     "version": "0.0.0",
36820     "filename": "server/api/intZendeskConfiguration/index.js",
36821     "groupTitle": "Zendesk_Configurations"
36822   },
36823   {
36824     "type": "post",
36825     "url": "/api/integrations/zendesk/fields",
36826     "title": "Creates a new Zendesk Field",
36827     "examples": [
36828       {
36829         "title": "Example usage:",
36830         "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",
36831         "type": "json"
36832       }
36833     ],
36834     "name": "CreateZendesk_Fields",
36835     "group": "Zendesk_Fields",
36836     "parameter": {
36837       "fields": {
36838         "Body": [
36839           {
36840             "group": "Body",
36841             "type": "String",
36842             "allowedValues": [
36843               "\"string\"",
36844               "\"variable\"",
36845               "\"customVariable\"",
36846               "\"keyValue\"",
36847               "\"picklist\""
36848             ],
36849             "optional": true,
36850             "field": "type",
36851             "description": ""
36852           },
36853           {
36854             "group": "Body",
36855             "type": "String",
36856             "optional": true,
36857             "field": "content",
36858             "description": ""
36859           },
36860           {
36861             "group": "Body",
36862             "type": "String",
36863             "optional": true,
36864             "field": "key",
36865             "description": ""
36866           },
36867           {
36868             "group": "Body",
36869             "type": "String",
36870             "allowedValues": [
36871               "\"string\"",
36872               "\"variable\"",
36873               "\"customVariable\""
36874             ],
36875             "optional": true,
36876             "field": "keyType",
36877             "description": ""
36878           },
36879           {
36880             "group": "Body",
36881             "type": "String",
36882             "optional": true,
36883             "field": "keyContent",
36884             "description": ""
36885           },
36886           {
36887             "group": "Body",
36888             "type": "String",
36889             "optional": true,
36890             "field": "idField",
36891             "description": ""
36892           },
36893           {
36894             "group": "Body",
36895             "type": "String",
36896             "optional": true,
36897             "field": "nameField",
36898             "description": ""
36899           },
36900           {
36901             "group": "Body",
36902             "type": "Boolean",
36903             "optional": true,
36904             "field": "customField",
36905             "description": ""
36906           },
36907           {
36908             "group": "Body",
36909             "type": "String",
36910             "optional": true,
36911             "field": "variableName",
36912             "description": ""
36913           }
36914         ]
36915       }
36916     },
36917     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36918     "version": "0.0.0",
36919     "filename": "server/api/intZendeskField/index.js",
36920     "groupTitle": "Zendesk_Fields"
36921   },
36922   {
36923     "type": "delete",
36924     "url": "/api/integrations/zendesk/fields/{id}",
36925     "title": "Deletes a Zendesk Field",
36926     "examples": [
36927       {
36928         "title": "Example usage:",
36929         "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password} -X DELETE",
36930         "type": "json"
36931       }
36932     ],
36933     "name": "DeleteZendesk_Fields",
36934     "group": "Zendesk_Fields",
36935     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36936     "version": "0.0.0",
36937     "filename": "server/api/intZendeskField/index.js",
36938     "groupTitle": "Zendesk_Fields"
36939   },
36940   {
36941     "type": "get",
36942     "url": "/api/integrations/zendesk/fields",
36943     "title": "Gets a list of Zendesk Fields",
36944     "examples": [
36945       {
36946         "title": "Example usage:",
36947         "content": "curl https://{domain}/api/integrations/zendesk/fields -v -u {name}:{password}",
36948         "type": "json"
36949       }
36950     ],
36951     "name": "GetZendesk_Fields",
36952     "group": "Zendesk_Fields",
36953     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36954     "version": "0.0.0",
36955     "filename": "server/api/intZendeskField/index.js",
36956     "groupTitle": "Zendesk_Fields"
36957   },
36958   {
36959     "type": "get",
36960     "url": "/api/integrations/zendesk/fields/{id}",
36961     "title": "Gets a single Zendesk Field",
36962     "examples": [
36963       {
36964         "title": "Example usage:",
36965         "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password}",
36966         "type": "json"
36967       }
36968     ],
36969     "name": "ShowZendesk_Fields",
36970     "group": "Zendesk_Fields",
36971     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36972     "version": "0.0.0",
36973     "filename": "server/api/intZendeskField/index.js",
36974     "groupTitle": "Zendesk_Fields"
36975   },
36976   {
36977     "type": "put",
36978     "url": "/api/integrations/zendesk/fields/{id}",
36979     "title": "Update an existing Zendesk Field",
36980     "examples": [
36981       {
36982         "title": "Example usage:",
36983         "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",
36984         "type": "json"
36985       }
36986     ],
36987     "name": "updateZendesk_Fields",
36988     "group": "Zendesk_Fields",
36989     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36990     "version": "0.0.0",
36991     "filename": "server/api/intZendeskField/index.js",
36992     "groupTitle": "Zendesk_Fields"
36993   },
36994   {
36995     "type": "post",
36996     "url": "/api/integrations/zoho/accounts",
36997     "title": "Creates a new Zoho Account",
36998     "examples": [
36999       {
37000         "title": "Example usage:",
37001         "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",
37002         "type": "json"
37003       }
37004     ],
37005     "name": "CreateZoho_Accounts",
37006     "group": "Zoho_Accounts",
37007     "parameter": {
37008       "fields": {
37009         "Body": [
37010           {
37011             "group": "Body",
37012             "type": "String",
37013             "optional": true,
37014             "field": "name",
37015             "description": ""
37016           },
37017           {
37018             "group": "Body",
37019             "type": "String",
37020             "optional": true,
37021             "field": "description",
37022             "description": ""
37023           },
37024           {
37025             "group": "Body",
37026             "type": "String",
37027             "optional": true,
37028             "field": "host",
37029             "description": ""
37030           },
37031           {
37032             "group": "Body",
37033             "type": "String",
37034             "optional": true,
37035             "field": "zone",
37036             "description": ""
37037           },
37038           {
37039             "group": "Body",
37040             "type": "String",
37041             "optional": true,
37042             "field": "clientId",
37043             "description": ""
37044           },
37045           {
37046             "group": "Body",
37047             "type": "String",
37048             "optional": true,
37049             "field": "clientSecret",
37050             "description": ""
37051           },
37052           {
37053             "group": "Body",
37054             "type": "String",
37055             "optional": false,
37056             "field": "serverUrl",
37057             "description": ""
37058           },
37059           {
37060             "group": "Body",
37061             "type": "String",
37062             "optional": true,
37063             "field": "code",
37064             "description": ""
37065           },
37066           {
37067             "group": "Body",
37068             "type": "String",
37069             "optional": true,
37070             "field": "refreshToken",
37071             "description": ""
37072           }
37073         ]
37074       }
37075     },
37076     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37077     "version": "0.0.0",
37078     "filename": "server/api/intZohoAccount/index.js",
37079     "groupTitle": "Zoho_Accounts"
37080   },
37081   {
37082     "type": "delete",
37083     "url": "/api/integrations/zoho/accounts/{id}",
37084     "title": "Deletes a Zoho Account",
37085     "examples": [
37086       {
37087         "title": "Example usage:",
37088         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password} -X DELETE",
37089         "type": "json"
37090       }
37091     ],
37092     "name": "DeleteZoho_Accounts",
37093     "group": "Zoho_Accounts",
37094     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37095     "version": "0.0.0",
37096     "filename": "server/api/intZohoAccount/index.js",
37097     "groupTitle": "Zoho_Accounts"
37098   },
37099   {
37100     "type": "get",
37101     "url": "/api/integrations/zoho/accounts",
37102     "title": "Gets a list of Zoho Accounts",
37103     "examples": [
37104       {
37105         "title": "Example usage:",
37106         "content": "curl https://{domain}/api/integrations/zoho/accounts -v -u {name}:{password}",
37107         "type": "json"
37108       }
37109     ],
37110     "name": "GetZoho_Accounts",
37111     "group": "Zoho_Accounts",
37112     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37113     "version": "0.0.0",
37114     "filename": "server/api/intZohoAccount/index.js",
37115     "groupTitle": "Zoho_Accounts"
37116   },
37117   {
37118     "type": "get",
37119     "url": "/api/integrations/zoho/accounts/{id}",
37120     "title": "Gets a single Zoho Account",
37121     "examples": [
37122       {
37123         "title": "Example usage:",
37124         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password}",
37125         "type": "json"
37126       }
37127     ],
37128     "name": "ShowZoho_Accounts",
37129     "group": "Zoho_Accounts",
37130     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37131     "version": "0.0.0",
37132     "filename": "server/api/intZohoAccount/index.js",
37133     "groupTitle": "Zoho_Accounts"
37134   },
37135   {
37136     "type": "post",
37137     "url": "/api/integrations/zoho/accounts/{id}/configurations",
37138     "title": "Creates new configuration",
37139     "examples": [
37140       {
37141         "title": "Example usage:",
37142         "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",
37143         "type": "json"
37144       }
37145     ],
37146     "name": "addConfiguration",
37147     "group": "Zoho_Accounts",
37148     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37149     "version": "0.0.0",
37150     "filename": "server/api/intZohoAccount/index.js",
37151     "groupTitle": "Zoho_Accounts"
37152   },
37153   {
37154     "type": "get",
37155     "url": "/api/integrations/zoho/accounts/{id}/configurations",
37156     "title": "Gets account configurations",
37157     "examples": [
37158       {
37159         "title": "Example usage:",
37160         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/configurations -v -u {name}:{password} -X GET",
37161         "type": "json"
37162       }
37163     ],
37164     "name": "getConfigurations",
37165     "group": "Zoho_Accounts",
37166     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37167     "version": "0.0.0",
37168     "filename": "server/api/intZohoAccount/index.js",
37169     "groupTitle": "Zoho_Accounts"
37170   },
37171   {
37172     "type": "get",
37173     "url": "/api/integrations/zoho/accounts/{id}/fields",
37174     "title": "Gets account fields",
37175     "examples": [
37176       {
37177         "title": "Example usage:",
37178         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/fields -v -u {name}:{password} -X GET",
37179         "type": "json"
37180       }
37181     ],
37182     "name": "getFields",
37183     "group": "Zoho_Accounts",
37184     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37185     "version": "0.0.0",
37186     "filename": "server/api/intZohoAccount/index.js",
37187     "groupTitle": "Zoho_Accounts"
37188   },
37189   {
37190     "type": "put",
37191     "url": "/api/integrations/zoho/accounts/{id}",
37192     "title": "Update an existing Zoho Account",
37193     "examples": [
37194       {
37195         "title": "Example usage:",
37196         "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",
37197         "type": "json"
37198       }
37199     ],
37200     "name": "updateZoho_Accounts",
37201     "group": "Zoho_Accounts",
37202     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37203     "version": "0.0.0",
37204     "filename": "server/api/intZohoAccount/index.js",
37205     "groupTitle": "Zoho_Accounts"
37206   },
37207   {
37208     "type": "post",
37209     "url": "/api/integrations/zoho/configurations",
37210     "title": "Creates a new Zoho Configuration",
37211     "examples": [
37212       {
37213         "title": "Example usage:",
37214         "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",
37215         "type": "json"
37216       }
37217     ],
37218     "name": "CreateZoho_Configurations",
37219     "group": "Zoho_Configurations",
37220     "parameter": {
37221       "fields": {
37222         "Body": [
37223           {
37224             "group": "Body",
37225             "type": "String",
37226             "optional": true,
37227             "field": "name",
37228             "description": ""
37229           },
37230           {
37231             "group": "Body",
37232             "type": "String",
37233             "allowedValues": [
37234               "\"lead\"",
37235               "\"contact\"",
37236               "\"nothing\""
37237             ],
37238             "optional": true,
37239             "field": "moduleCreate",
37240             "description": ""
37241           },
37242           {
37243             "group": "Body",
37244             "type": "String",
37245             "allowedValues": [
37246               "\"contact_lead\"",
37247               "\"contact\"",
37248               "\"lead\""
37249             ],
37250             "optional": true,
37251             "field": "moduleSearch",
37252             "description": ""
37253           },
37254           {
37255             "group": "Body",
37256             "type": "String",
37257             "optional": true,
37258             "field": "description",
37259             "description": ""
37260           }
37261         ]
37262       }
37263     },
37264     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37265     "version": "0.0.0",
37266     "filename": "server/api/intZohoConfiguration/index.js",
37267     "groupTitle": "Zoho_Configurations"
37268   },
37269   {
37270     "type": "delete",
37271     "url": "/api/integrations/zoho/configurations/{id}",
37272     "title": "Deletes a Zoho Configuration",
37273     "examples": [
37274       {
37275         "title": "Example usage:",
37276         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password} -X DELETE",
37277         "type": "json"
37278       }
37279     ],
37280     "name": "DeleteZoho_Configurations",
37281     "group": "Zoho_Configurations",
37282     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37283     "version": "0.0.0",
37284     "filename": "server/api/intZohoConfiguration/index.js",
37285     "groupTitle": "Zoho_Configurations"
37286   },
37287   {
37288     "type": "get",
37289     "url": "/api/integrations/zoho/configurations",
37290     "title": "Gets a list of Zoho Configurations",
37291     "examples": [
37292       {
37293         "title": "Example usage:",
37294         "content": "curl https://{domain}/api/integrations/zoho/configurations -v -u {name}:{password}",
37295         "type": "json"
37296       }
37297     ],
37298     "name": "GetZoho_Configurations",
37299     "group": "Zoho_Configurations",
37300     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37301     "version": "0.0.0",
37302     "filename": "server/api/intZohoConfiguration/index.js",
37303     "groupTitle": "Zoho_Configurations"
37304   },
37305   {
37306     "type": "get",
37307     "url": "/api/integrations/zoho/configurations/{id}",
37308     "title": "Gets a single Zoho Configuration",
37309     "examples": [
37310       {
37311         "title": "Example usage:",
37312         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password}",
37313         "type": "json"
37314       }
37315     ],
37316     "name": "ShowZoho_Configurations",
37317     "group": "Zoho_Configurations",
37318     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37319     "version": "0.0.0",
37320     "filename": "server/api/intZohoConfiguration/index.js",
37321     "groupTitle": "Zoho_Configurations"
37322   },
37323   {
37324     "type": "get",
37325     "url": "/api/integrations/zoho/configurations/{id}/descriptions",
37326     "title": "Gets configurations descriptions",
37327     "examples": [
37328       {
37329         "title": "Example usage:",
37330         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
37331         "type": "json"
37332       }
37333     ],
37334     "name": "getDescriptions",
37335     "group": "Zoho_Configurations",
37336     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37337     "version": "0.0.0",
37338     "filename": "server/api/intZohoConfiguration/index.js",
37339     "groupTitle": "Zoho_Configurations"
37340   },
37341   {
37342     "type": "get",
37343     "url": "/api/integrations/zoho/configurations/{id}/fields",
37344     "title": "Gets configurations fields",
37345     "examples": [
37346       {
37347         "title": "Example usage:",
37348         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
37349         "type": "json"
37350       }
37351     ],
37352     "name": "getFields",
37353     "group": "Zoho_Configurations",
37354     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37355     "version": "0.0.0",
37356     "filename": "server/api/intZohoConfiguration/index.js",
37357     "groupTitle": "Zoho_Configurations"
37358   },
37359   {
37360     "type": "get",
37361     "url": "/api/integrations/zoho/configurations/{id}/subjects",
37362     "title": "Gets configurations subjects",
37363     "examples": [
37364       {
37365         "title": "Example usage:",
37366         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/subjects -v -u {name}:{password} -X GET",
37367         "type": "json"
37368       }
37369     ],
37370     "name": "getSubjects",
37371     "group": "Zoho_Configurations",
37372     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37373     "version": "0.0.0",
37374     "filename": "server/api/intZohoConfiguration/index.js",
37375     "groupTitle": "Zoho_Configurations"
37376   },
37377   {
37378     "type": "put",
37379     "url": "/api/integrations/zoho/configurations/{id}",
37380     "title": "Update an existing Zoho Configuration",
37381     "examples": [
37382       {
37383         "title": "Example usage:",
37384         "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",
37385         "type": "json"
37386       }
37387     ],
37388     "name": "updateZoho_Configurations",
37389     "group": "Zoho_Configurations",
37390     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37391     "version": "0.0.0",
37392     "filename": "server/api/intZohoConfiguration/index.js",
37393     "groupTitle": "Zoho_Configurations"
37394   },
37395   {
37396     "type": "post",
37397     "url": "/api/integrations/zoho/fields",
37398     "title": "Creates a new Zoho Field",
37399     "examples": [
37400       {
37401         "title": "Example usage:",
37402         "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",
37403         "type": "json"
37404       }
37405     ],
37406     "name": "CreateZoho_Fields",
37407     "group": "Zoho_Fields",
37408     "parameter": {
37409       "fields": {
37410         "Body": [
37411           {
37412             "group": "Body",
37413             "type": "String",
37414             "allowedValues": [
37415               "\"string\"",
37416               "\"variable\"",
37417               "\"customVariable\"",
37418               "\"keyValue\"",
37419               "\"picklist\""
37420             ],
37421             "optional": true,
37422             "field": "type",
37423             "description": ""
37424           },
37425           {
37426             "group": "Body",
37427             "type": "String",
37428             "optional": true,
37429             "field": "content",
37430             "description": ""
37431           },
37432           {
37433             "group": "Body",
37434             "type": "String",
37435             "optional": true,
37436             "field": "key",
37437             "description": ""
37438           },
37439           {
37440             "group": "Body",
37441             "type": "String",
37442             "allowedValues": [
37443               "\"string\"",
37444               "\"variable\"",
37445               "\"customVariable\""
37446             ],
37447             "optional": true,
37448             "field": "keyType",
37449             "description": ""
37450           },
37451           {
37452             "group": "Body",
37453             "type": "String",
37454             "optional": true,
37455             "field": "keyContent",
37456             "description": ""
37457           },
37458           {
37459             "group": "Body",
37460             "type": "String",
37461             "optional": true,
37462             "field": "idField",
37463             "description": ""
37464           },
37465           {
37466             "group": "Body",
37467             "type": "String",
37468             "optional": true,
37469             "field": "nameField",
37470             "description": ""
37471           },
37472           {
37473             "group": "Body",
37474             "type": "Boolean",
37475             "optional": true,
37476             "field": "customField",
37477             "description": ""
37478           },
37479           {
37480             "group": "Body",
37481             "type": "String",
37482             "optional": true,
37483             "field": "variableName",
37484             "description": ""
37485           }
37486         ]
37487       }
37488     },
37489     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37490     "version": "0.0.0",
37491     "filename": "server/api/intZohoField/index.js",
37492     "groupTitle": "Zoho_Fields"
37493   },
37494   {
37495     "type": "delete",
37496     "url": "/api/integrations/zoho/fields/{id}",
37497     "title": "Deletes a Zoho Field",
37498     "examples": [
37499       {
37500         "title": "Example usage:",
37501         "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password} -X DELETE",
37502         "type": "json"
37503       }
37504     ],
37505     "name": "DeleteZoho_Fields",
37506     "group": "Zoho_Fields",
37507     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37508     "version": "0.0.0",
37509     "filename": "server/api/intZohoField/index.js",
37510     "groupTitle": "Zoho_Fields"
37511   },
37512   {
37513     "type": "get",
37514     "url": "/api/integrations/zoho/fields",
37515     "title": "Gets a list of Zoho Fields",
37516     "examples": [
37517       {
37518         "title": "Example usage:",
37519         "content": "curl https://{domain}/api/integrations/zoho/fields -v -u {name}:{password}",
37520         "type": "json"
37521       }
37522     ],
37523     "name": "GetZoho_Fields",
37524     "group": "Zoho_Fields",
37525     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37526     "version": "0.0.0",
37527     "filename": "server/api/intZohoField/index.js",
37528     "groupTitle": "Zoho_Fields"
37529   },
37530   {
37531     "type": "get",
37532     "url": "/api/integrations/zoho/fields/{id}",
37533     "title": "Gets a single Zoho Field",
37534     "examples": [
37535       {
37536         "title": "Example usage:",
37537         "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password}",
37538         "type": "json"
37539       }
37540     ],
37541     "name": "ShowZoho_Fields",
37542     "group": "Zoho_Fields",
37543     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37544     "version": "0.0.0",
37545     "filename": "server/api/intZohoField/index.js",
37546     "groupTitle": "Zoho_Fields"
37547   },
37548   {
37549     "type": "put",
37550     "url": "/api/integrations/zoho/fields/{id}",
37551     "title": "Update an existing Zoho Field",
37552     "examples": [
37553       {
37554         "title": "Example usage:",
37555         "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",
37556         "type": "json"
37557       }
37558     ],
37559     "name": "updateZoho_Fields",
37560     "group": "Zoho_Fields",
37561     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37562     "version": "0.0.0",
37563     "filename": "server/api/intZohoField/index.js",
37564     "groupTitle": "Zoho_Fields"
37565   },
37566   {
37567     "type": "post",
37568     "url": "/api/cdr",
37569     "title": "Creates a new Cdr",
37570     "examples": [
37571       {
37572         "title": "Example usage:",
37573         "content": "curl https://{domain}/api/cdr -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
37574         "type": "json"
37575       }
37576     ],
37577     "name": "CreateCdrs",
37578     "group": "cdr",
37579     "parameter": {
37580       "fields": {
37581         "Body": [
37582           {
37583             "group": "Body",
37584             "type": "String",
37585             "optional": false,
37586             "field": "calldate",
37587             "description": ""
37588           },
37589           {
37590             "group": "Body",
37591             "type": "String",
37592             "optional": true,
37593             "field": "clid",
37594             "description": ""
37595           },
37596           {
37597             "group": "Body",
37598             "type": "String",
37599             "optional": true,
37600             "field": "src",
37601             "description": ""
37602           },
37603           {
37604             "group": "Body",
37605             "type": "String",
37606             "optional": true,
37607             "field": "dst",
37608             "description": ""
37609           },
37610           {
37611             "group": "Body",
37612             "type": "String",
37613             "optional": true,
37614             "field": "dcontext",
37615             "description": ""
37616           },
37617           {
37618             "group": "Body",
37619             "type": "String",
37620             "optional": true,
37621             "field": "channel",
37622             "description": ""
37623           },
37624           {
37625             "group": "Body",
37626             "type": "String",
37627             "optional": true,
37628             "field": "dstchannel",
37629             "description": ""
37630           },
37631           {
37632             "group": "Body",
37633             "type": "String",
37634             "optional": true,
37635             "field": "lastapp",
37636             "description": ""
37637           },
37638           {
37639             "group": "Body",
37640             "type": "String",
37641             "optional": true,
37642             "field": "lastdata",
37643             "description": ""
37644           },
37645           {
37646             "group": "Body",
37647             "type": "Integer",
37648             "optional": false,
37649             "field": "duration",
37650             "description": ""
37651           },
37652           {
37653             "group": "Body",
37654             "type": "Integer",
37655             "optional": false,
37656             "field": "billsec",
37657             "description": ""
37658           },
37659           {
37660             "group": "Body",
37661             "type": "String",
37662             "optional": true,
37663             "field": "disposition",
37664             "description": ""
37665           },
37666           {
37667             "group": "Body",
37668             "type": "Integer",
37669             "optional": false,
37670             "field": "amaflags",
37671             "description": ""
37672           },
37673           {
37674             "group": "Body",
37675             "type": "String",
37676             "optional": true,
37677             "field": "accountcode",
37678             "description": ""
37679           },
37680           {
37681             "group": "Body",
37682             "type": "String",
37683             "optional": true,
37684             "field": "userfield",
37685             "description": ""
37686           },
37687           {
37688             "group": "Body",
37689             "type": "String",
37690             "optional": true,
37691             "field": "uniqueid",
37692             "description": ""
37693           },
37694           {
37695             "group": "Body",
37696             "type": "String",
37697             "optional": true,
37698             "field": "linkedid",
37699             "description": ""
37700           },
37701           {
37702             "group": "Body",
37703             "type": "String",
37704             "optional": true,
37705             "field": "sequence",
37706             "description": ""
37707           },
37708           {
37709             "group": "Body",
37710             "type": "String",
37711             "optional": true,
37712             "field": "peeraccount",
37713             "description": ""
37714           },
37715           {
37716             "group": "Body",
37717             "type": "String",
37718             "optional": true,
37719             "field": "type",
37720             "description": ""
37721           },
37722           {
37723             "group": "Body",
37724             "type": "String",
37725             "optional": true,
37726             "field": "tag",
37727             "description": ""
37728           }
37729         ]
37730       }
37731     },
37732     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37733     "version": "0.0.0",
37734     "filename": "server/api/cdr/index.js",
37735     "groupTitle": "cdr"
37736   },
37737   {
37738     "type": "delete",
37739     "url": "/api/cdr/{id}",
37740     "title": "Deletes a Cdr",
37741     "examples": [
37742       {
37743         "title": "Example usage:",
37744         "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password} -X DELETE",
37745         "type": "json"
37746       }
37747     ],
37748     "name": "DeleteCdrs",
37749     "group": "cdr",
37750     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37751     "version": "0.0.0",
37752     "filename": "server/api/cdr/index.js",
37753     "groupTitle": "cdr"
37754   },
37755   {
37756     "type": "get",
37757     "url": "/api/cdr/describe",
37758     "title": "Gets table info about Cdrs",
37759     "examples": [
37760       {
37761         "title": "Example usage:",
37762         "content": "curl https://{domain}/api/cdr/describe -v -u {name}:{password}",
37763         "type": "json"
37764       }
37765     ],
37766     "name": "DescribeCdrs",
37767     "group": "cdr",
37768     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37769     "version": "0.0.0",
37770     "filename": "server/api/cdr/index.js",
37771     "groupTitle": "cdr"
37772   },
37773   {
37774     "type": "get",
37775     "url": "/api/cdr",
37776     "title": "Gets a list of Cdrs",
37777     "examples": [
37778       {
37779         "title": "Example usage:",
37780         "content": "curl https://{domain}/api/cdr -v -u {name}:{password}",
37781         "type": "json"
37782       }
37783     ],
37784     "name": "GetCdrs",
37785     "group": "cdr",
37786     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37787     "version": "0.0.0",
37788     "filename": "server/api/cdr/index.js",
37789     "groupTitle": "cdr"
37790   },
37791   {
37792     "type": "get",
37793     "url": "/api/cdr/{id}",
37794     "title": "Gets a single Cdr",
37795     "examples": [
37796       {
37797         "title": "Example usage:",
37798         "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password}",
37799         "type": "json"
37800       }
37801     ],
37802     "name": "ShowCdrs",
37803     "group": "cdr",
37804     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37805     "version": "0.0.0",
37806     "filename": "server/api/cdr/index.js",
37807     "groupTitle": "cdr"
37808   },
37809   {
37810     "type": "put",
37811     "url": "/api/cdr/{id}",
37812     "title": "Update an existing Cdr",
37813     "examples": [
37814       {
37815         "title": "Example usage:",
37816         "content": "curl https://{domain}/api/cdr/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
37817         "type": "json"
37818       }
37819     ],
37820     "name": "updateCdrs",
37821     "group": "cdr",
37822     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37823     "version": "0.0.0",
37824     "filename": "server/api/cdr/index.js",
37825     "groupTitle": "cdr"
37826   },
37827   {
37828     "type": "post",
37829     "url": "/api/voiceQueuesLog",
37830     "title": "Creates a new VoiceQueuesLog",
37831     "examples": [
37832       {
37833         "title": "Example usage:",
37834         "content": "curl https://{domain}/api/voiceQueuesLog -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
37835         "type": "json"
37836       }
37837     ],
37838     "name": "CreateVoiceQueuesLogs",
37839     "group": "voiceQueuesLog",
37840     "parameter": {
37841       "fields": {
37842         "Body": [
37843           {
37844             "group": "Body",
37845             "type": "String",
37846             "optional": true,
37847             "field": "time",
37848             "description": ""
37849           },
37850           {
37851             "group": "Body",
37852             "type": "String",
37853             "optional": false,
37854             "field": "callid",
37855             "description": ""
37856           },
37857           {
37858             "group": "Body",
37859             "type": "String",
37860             "optional": false,
37861             "field": "queuename",
37862             "description": ""
37863           },
37864           {
37865             "group": "Body",
37866             "type": "String",
37867             "optional": false,
37868             "field": "agent",
37869             "description": ""
37870           },
37871           {
37872             "group": "Body",
37873             "type": "String",
37874             "optional": false,
37875             "field": "event",
37876             "description": ""
37877           },
37878           {
37879             "group": "Body",
37880             "type": "String",
37881             "optional": false,
37882             "field": "data",
37883             "description": ""
37884           },
37885           {
37886             "group": "Body",
37887             "type": "String",
37888             "optional": false,
37889             "field": "data1",
37890             "description": ""
37891           },
37892           {
37893             "group": "Body",
37894             "type": "String",
37895             "optional": false,
37896             "field": "data2",
37897             "description": ""
37898           },
37899           {
37900             "group": "Body",
37901             "type": "String",
37902             "optional": false,
37903             "field": "data3",
37904             "description": ""
37905           },
37906           {
37907             "group": "Body",
37908             "type": "String",
37909             "optional": false,
37910             "field": "data4",
37911             "description": ""
37912           },
37913           {
37914             "group": "Body",
37915             "type": "String",
37916             "optional": false,
37917             "field": "data5",
37918             "description": ""
37919           },
37920           {
37921             "group": "Body",
37922             "type": "String",
37923             "optional": false,
37924             "field": "dtm",
37925             "description": ""
37926           }
37927         ]
37928       }
37929     },
37930     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37931     "version": "0.0.0",
37932     "filename": "server/api/voiceQueuesLog/index.js",
37933     "groupTitle": "voiceQueuesLog"
37934   },
37935   {
37936     "type": "delete",
37937     "url": "/api/voiceQueuesLog/{id}",
37938     "title": "Deletes a VoiceQueuesLog",
37939     "examples": [
37940       {
37941         "title": "Example usage:",
37942         "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password} -X DELETE",
37943         "type": "json"
37944       }
37945     ],
37946     "name": "DeleteVoiceQueuesLogs",
37947     "group": "voiceQueuesLog",
37948     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37949     "version": "0.0.0",
37950     "filename": "server/api/voiceQueuesLog/index.js",
37951     "groupTitle": "voiceQueuesLog"
37952   },
37953   {
37954     "type": "get",
37955     "url": "/api/voiceQueuesLog",
37956     "title": "Gets a list of VoiceQueuesLogs",
37957     "examples": [
37958       {
37959         "title": "Example usage:",
37960         "content": "curl https://{domain}/api/voiceQueuesLog -v -u {name}:{password}",
37961         "type": "json"
37962       }
37963     ],
37964     "name": "GetVoiceQueuesLogs",
37965     "group": "voiceQueuesLog",
37966     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37967     "version": "0.0.0",
37968     "filename": "server/api/voiceQueuesLog/index.js",
37969     "groupTitle": "voiceQueuesLog"
37970   },
37971   {
37972     "type": "get",
37973     "url": "/api/voiceQueuesLog/{id}",
37974     "title": "Gets a single VoiceQueuesLog",
37975     "examples": [
37976       {
37977         "title": "Example usage:",
37978         "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password}",
37979         "type": "json"
37980       }
37981     ],
37982     "name": "ShowVoiceQueuesLogs",
37983     "group": "voiceQueuesLog",
37984     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37985     "version": "0.0.0",
37986     "filename": "server/api/voiceQueuesLog/index.js",
37987     "groupTitle": "voiceQueuesLog"
37988   },
37989   {
37990     "type": "put",
37991     "url": "/api/voiceQueuesLog/{id}",
37992     "title": "Update an existing VoiceQueuesLog",
37993     "examples": [
37994       {
37995         "title": "Example usage:",
37996         "content": "curl https://{domain}/api/voiceQueuesLog/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
37997         "type": "json"
37998       }
37999     ],
38000     "name": "updateVoiceQueuesLogs",
38001     "group": "voiceQueuesLog",
38002     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38003     "version": "0.0.0",
38004     "filename": "server/api/voiceQueuesLog/index.js",
38005     "groupTitle": "voiceQueuesLog"
38006   }
38007 ]